Lines Matching refs:entry
383 """Make the start of an entry for a parameter's validity, including a chunk of text if it is an array."""
388 entry = ValidityEntry(anchor=(param_name, 'parameter'))
395 entry += 'If {} is {}, '.format(
400 entry += "and "
402 entry += optionalpre[0].lower() + optionalpre[1:]
404 return entry
408 entry += 'Each element of '
409 return entry
437 entry += 'If '
439 entry += self.makeProseListIs(optionallengths, fmt=plf.OR)
440 entry += ' not %s, ' % self.conventions.zero
444 entry += 'and '
446 entry += self.makeParameterName(param_name)
448 # entry += ' is not {}, '.format(self.null)
449 entry += ' is not `NULL`, '
450 return entry
453 entry += self.makeOptionalPre(param)
454 return entry
457 # entry with an anchor.
458 return entry
472 entry = self.makeParamValidityPre(param, params, selector)
476 entry = ValidityEntry(anchor=(param_name, 'null'))
477 entry += 'pname:pAllocator must: be `NULL`'
478 return entry
482 entry += 'the {} member of {} must: be '.format(self.makeParameterName(param_name), self.makeParameterName(parentname))
484 entry += '{} must: be '.format(self.makeParameterName(param_name))
489 entry += 'a null-terminated UTF-8 string whose length is less than or equal to '
490 entry += self.staticArrayLength(param)
493 entry += 'a character array of length %s ' % self.staticArrayLength(param)
494 validity += entry
505 entry += 'a '
516 entry += 'null-terminated '
518 entry += pointer_text
519 entry += ' to '
521 entry += pointer_text
522 entry += ' to '
523 entry += array_text
524 entry += ' of '
528 entry += str(length)
530 entry += self.makeParameterName(str(length))
531 entry += ' '
538 entry.drop_end(5)
540 entry.drop_end(4)
547 entry += 'byte'
552 entry += 'UTF-8 string'
555 entry += 'char value'
563 entry += 'valid '
570 entry += 'or dlink:' + self.conventions.api_prefix + 'NULL_HANDLE '
572 entry += typetext
576 entry += 's'
578 return self.handleRequiredBitmask(blockname, param, paramtype, entry, 'true' if array_element_optional else None)
596 entry += 'a '
597 entry += (self.valid_pointer_text + ' to a ') * pointercount
608 entry += 'valid '
610 entry += typetext
611 return self.handleRequiredBitmask(blockname, param, paramtype, entry, param.get('optional'))
620 # entry += self.conventions.zero
621 # entry += ' or '
623 entry += 'a valid {}'.format(typetext)
625 return self.handleRequiredBitmask(blockname, param, paramtype, entry, param.get('optional'))
628 entry += 'a valid {}'.format(typetext)
629 return entry
631 def handleRequiredBitmask(self, blockname, param, paramtype, entry, optional):
634 return entry
637 return entry
642 validity += entry
653 """Make an entire validation entry for a given parameter."""
684 entry = ValidityEntry(
686 entry += self.makeParameterName(param_name)
687 entry += ' must: be '
688 entry += self.conventions.zero
690 return entry
754 """Make a validity entry for a handle's parent object.
784 entry = ValidityEntry(anchor=(param_name, 'parent'))
798 entry += template.format(self.makeParameterName(param_name))
800 entry += ' must: have been created, allocated, or retrieved from {}'.format(
803 return entry
806 """Make an asciidoc validity entry for a common ancestors between handles.
817 entry = None
858 entry = ValidityEntry(anchor=('commonparent',))
871 entry += 'Each of '
873 entry += 'Both of '
875 entry += self.makeProseList(parametertexts,
878 entry += ' that are valid handles of non-ignored parameters'
879 entry += ' must: have been created, allocated, or retrieved from the same '
880 entry += self.makeStructName(commonancestor)
882 return entry
909 entry = ValidityEntry(
911 entry += self.makeParameterName(self.structtype_member_name)
912 entry += ' must: be '
920 entry += self.makeProseList((self.makeEnumerantName(v)
922 return entry
932 entry += self.makeStructureTypeFromName(structname)
934 return entry
944 entry = ValidityEntry(
974 entry += '{} must: be {}'.format(
976 return entry
979 entry += '{} must: be {} or a pointer to a valid instance of {}'.format(self.makeParameterName(param_name), self.null,
983 entry += 'Each {} member of any structure (including this one) in the pname:{} chain '.format(
985 entry += 'must: be either {} or a pointer to a valid instance of '.format(
988 entry += self.makeProseList(extensionstructs, fmt=plf.OR)
991 validity += entry
1160 entry = ValidityEntry(anchor=('queuetype',))
1161 entry += 'The pname:queue must: support '
1162 entry += self.makeProseList(queues,
1164 entry += ' operations'
1165 validity += entry
1169 entry = ValidityEntry(anchor=('commandBuffer', 'recording'))
1170 entry += 'pname:commandBuffer must: be in the <<commandbuffers-lifecycle, recording state>>'
1171 validity += entry
1176 entry = ValidityEntry(anchor=('commandBuffer', 'cmdpool'))
1183 entry += 'The sname:VkCommandPool that pname:commandBuffer was allocated from must: support '
1185 entry += 'transfer, graphics or compute operations'
1187 entry += 'graphics or compute operations'
1192 entry += 'The sname:VkCommandPool that pname:commandBuffer was allocated from must: support '
1193 entry += self.makeProseList(queues,
1195 entry += ' operations'
1196 validity += entry
1202 entry = ValidityEntry(anchor=('renderpass',))
1203 entry += 'This command must: only be called '
1204 entry += renderpass
1205 entry += ' of a render pass instance'
1206 validity += entry
1212 entry = ValidityEntry(anchor=('videocoding',))
1213 entry += 'This command must: only be called '
1214 entry += videocoding
1215 entry += ' of a video coding scope'
1216 validity += entry
1222 entry = ValidityEntry(anchor=('bufferlevel',))
1223 entry += 'pname:commandBuffer must: be a '
1224 entry += cmdbufferlevel
1225 entry += ' sname:VkCommandBuffer'
1226 validity += entry
1270 entry = ValidityEntry(anchor=(full_length, 'arraylength'))
1273 entry += 'If '
1278 entry += self.makeProseListIs(optional_array_names,
1281 entry += ' not {}, '.format(self.null)
1285 entry += 'the value referenced by '
1288 entry += '::'.join(self.makeParameterName(part)
1291 # entry += length.get_human_readable(make_param_name=self.makeParameterName)
1293 entry += ' must: be greater than '
1294 entry += self.conventions.zero
1295 validity += entry
1326 entry = ValidityEntry()
1327 entry += extsync_prefix
1330 entry += 'each member of '
1332 entry += 'the object referenced by '
1334 entry += self.makeParameterName(param_name)
1337 entry += ', and any child handles,'
1340 entry += 'pname:'
1341 entry += str(attrib.full_reference)
1343 # entry += attrib.get_human_readable(make_param_name=self.makeParameterName)
1344 entry += ' must: be externally synchronized'
1345 validity += entry
1350 entry = ValidityEntry()
1351 entry += extsync_prefix
1352 entry += 'the sname:VkCommandPool that pname:commandBuffer was allocated from must: be externally synchronized'
1353 validity += entry
1359 entry = ValidityEntry()
1360 entry += extsync_prefix
1361 entry += elem.text
1362 entry += ' must: be externally synchronized'
1363 validity += entry
1425 entry = '|'.join(filter(None, table_items))
1427 return ('|' + entry) if entry else None