Merge pull request #251 from rpavlik/disable-extension-prototypes

Disable extension prototypes

Author: rpavlik

changes/sdk/pr.251.gh.OpenXR-SDK-Source.md

@@ -0,0 +1,6 @@
+---
+- issue.174.gh.OpenXR-SDK-Source
+- issue.1554.gl
+- issue.1338.gl
+---
+Hide prototypes for extension functions unless explicitly requested by defining `XR_EXTENSION_PROTOTYPES`. These functions are not exported from the loader, so having their prototypes available is confusing and leads to link errors, etc.

specification/scripts/cgenerator.py

@@ -27,6 +27,8 @@ def __init__(self,
                  protectFeature=True,
                  protectProto=None,
                  protectProtoStr=None,
+                 protectExtensionProto=None,
+                 protectExtensionProtoStr=None,
                  apicall='',
                  apientry='',
                  apientryp='',
@@ -56,6 +58,13 @@ def __init__(self,
         set to None.
         - protectProtoStr - #ifdef/#ifndef symbol to use around prototype
         declarations, if protectProto is set
+        - protectExtensionProto - If conditional protection should be generated
+        around extension prototype declarations, set to either '#ifdef'
+        to require opt-in (#ifdef protectExtensionProtoStr) or '#ifndef'
+        to require opt-out (#ifndef protectExtensionProtoStr). Otherwise
+        set to None.
+        - protectExtensionProtoStr - #ifdef/#ifndef symbol to use around
+        extension prototype declarations, if protectExtensionProto is set
         - apicall - string to use for the function declaration prefix,
         such as APICALL on Windows.
         - apientry - string to use for the calling convention macro,
@@ -93,6 +102,12 @@ def __init__(self,
         self.protectProtoStr = protectProtoStr
         """#ifdef/#ifndef symbol to use around prototype declarations, if protectProto is set"""
 
+        self.protectExtensionProto = protectExtensionProto
+        """If conditional protection should be generated around extension prototype declarations, set to either '#ifdef' to require opt-in (#ifdef protectExtensionProtoStr) or '#ifndef' to require opt-out (#ifndef protectExtensionProtoStr). Otherwise set to None."""
+
+        self.protectExtensionProtoStr = protectExtensionProtoStr
+        """#ifdef/#ifndef symbol to use around extension prototype declarations, if protectExtensionProto is set"""
+
         self.apicall = apicall
         """string to use for the function declaration prefix, such as APICALL on Windows."""
 
@@ -186,11 +201,20 @@ def beginFeature(self, interface, emit):
         self.sections = {section: [] for section in self.ALL_SECTIONS}
         self.feature_not_empty = False
 
+    def _endProtectComment(self, protect_str, protect_directive="#ifdef"):
+        if protect_directive is None or protect_str is None:
+            raise RuntimeError("Shouldn't call in here without something to protect")
+        if "ifdef" in protect_directive:
+            return '/* ' + protect_str + ' */'
+        else:
+            return '/* !' + protect_str + ' */'
+
     def endFeature(self):
         "Actually write the interface to the output file."
         # C-specific
         if self.emit:
             if self.feature_not_empty:
+                is_core = self.featureName.startswith(self.conventions.api_prefix + "VERSION_")
                 if self.genOpts.conventions.writeFeature(self.featureExtraProtect, self.genOpts.filename):
                     self.newline()
                     if self.genOpts.protectFeature:
@@ -213,15 +237,30 @@ def endFeature(self):
                         if self.genOpts.protectProto:
                             write(self.genOpts.protectProto,
                                   self.genOpts.protectProtoStr, file=self.outFile)
+                        if self.genOpts.protectExtensionProto and not is_core:
+                            write(self.genOpts.protectExtensionProto,
+                                  self.genOpts.protectExtensionProtoStr, file=self.outFile)
                         write('\n'.join(self.sections['command']), end='', file=self.outFile)
+                        if self.genOpts.protectExtensionProto and not is_core:
+                            write('#endif',
+                                  self._endProtectComment(protect_directive=self.genOpts.protectExtensionProto,
+                                                          protect_str=self.genOpts.protectExtensionProtoStr),
+                                  file=self.outFile)
                         if self.genOpts.protectProto:
-                            write('#endif', file=self.outFile)
+                            write('#endif',
+                                  self._endProtectComment(protect_directive=self.genOpts.protectProto,
+                                                          protect_str=self.genOpts.protectProtoStr),
+                                  file=self.outFile)
                         else:
                             self.newline()
                     if self.featureExtraProtect is not None:
-                        write('#endif /*', self.featureExtraProtect, '*/', file=self.outFile)
+                        write('#endif',
+                              self._endProtectComment(protect_str=self.featureExtraProtect),
+                              file=self.outFile)
                     if self.genOpts.protectFeature:
-                        write('#endif /*', self.featureName, '*/', file=self.outFile)
+                        write('#endif',
+                              self._endProtectComment(protect_str=self.featureName),
+                              file=self.outFile)
         # Finish processing in superclass
         OutputGenerator.endFeature(self)
 

specification/scripts/genxr.py

@@ -148,6 +148,8 @@ def makeGenOpts(args):
             protectFeature    = False,
             protectProto      = '#ifndef',
             protectProtoStr   = 'XR_NO_PROTOTYPES',
+            protectExtensionProto      = '#ifdef',
+            protectExtensionProtoStr   = 'XR_EXTENSION_PROTOTYPES',
             apicall           = 'XRAPI_ATTR ',
             apientry          = 'XRAPI_CALL ',
             apientryp         = 'XRAPI_PTR *',
@@ -177,6 +179,8 @@ def makeGenOpts(args):
             protectFeature    = False,
             protectProto      = '#ifndef',
             protectProtoStr   = 'XR_NO_PROTOTYPES',
+            protectExtensionProto      = '#ifdef',
+            protectExtensionProtoStr   = 'XR_EXTENSION_PROTOTYPES',
             apicall           = 'XRAPI_ATTR ',
             apientry          = 'XRAPI_CALL ',
             apientryp         = 'XRAPI_PTR *',