Method genType

scripts/docgenerator.py:401–451

Generate type.

(self, typeinfo, name, alias)

                       for data in values))

    def genType(self, typeinfo, name, alias):
        """Generate type."""
        OutputGenerator.genType(self, typeinfo, name, alias)
        typeElem = typeinfo.elem
        # If the type is a struct type, traverse the embedded <member> tags
        # generating a structure. Otherwise, emit the tag text.
        category = typeElem.get('category')

        if category in ('struct', 'union'):
            # If the type is a struct type, generate it using the
            # special-purpose generator.
            self.genStruct(typeinfo, name, alias)
        elif category not in OutputGenerator.categoryToPath:
            # If there is no path, do not write output
            self.logMsg('diag', f'NOT writing include for {name} category {category}')
        else:
            body = self.genRequirements(name)
            body += self.deprecationComment(typeElem)
            # This is not appropriate for Vulkan
            # if category in ('define',):
            #    body = body.strip()
            if alias:
                # If the type is an alias, just emit a typedef declaration
                body += f'// Equivalent to {alias}\n'
                body += f"typedef {alias} {name};\n"
                self.writeInclude(OutputGenerator.categoryToPath[category],
                                  name, body, None, None, None)
                return
            elif category == 'funcpointer':
                # Only include the typedef
                decls = self.makeCDecls(typeElem)
                body += decls[1]
            else:
                # Replace <apientry /> tags with an APIENTRY-style string
                # (from self.genOpts). Copy other text through unchanged.
                # If the resulting text is an empty string, do not emit it.
                body += noneStr(typeElem.text).lstrip()
                for elem in typeElem:
                    if elem.tag == 'apientry':
                        body += self.genOpts.apientry + noneStr(elem.tail)
                    else:
                        body += noneStr(elem.text) + noneStr(elem.tail)

            if body:
                self.writeInclude(OutputGenerator.categoryToPath[category],
                                  name, body + '\n',
                                  self.deprecatedBy(typeinfo),
                                  typeinfo.deprecatedlink,
                                  typeinfo.supersededby)
            else:
                self.logMsg('diag', 'NOT writing empty include file for type', name)

    def genStructBody(self, typeinfo, typeName):
        """