Mac/Modules/cf/cfscan.py

   1 # Scan an Apple header file, generating a Python file of generator calls.
   2
   3 import sys
   4 import os
   5 BGENDIR=os.path.join(sys.prefix, ':Tools:bgen:bgen')
   6 sys.path.append(BGENDIR)
   7 from scantools import Scanner_OSX
   8 from bgenlocations import TOOLBOXDIR
   9
  10 LONG = "CoreFoundation"
  11 SHORT = "cf"
  12 OBJECTS = ("CFTypeRef",
  13                 "CFArrayRef", "CFMutableArrayRef",
  14                 "CFDataRef", "CFMutableDataRef",
  15                 "CFDictionaryRef", "CFMutableDictionaryRef",
  16                 "CFStringRef", "CFMutableStringRef",
  17                 "CFURLRef",
  18                 )
  19 # ADD object typenames here
  20
  21 def main():
  22         input = [
  23                 "CFBase.h",
  24                 "CFArray.h",
  25 ##              "CFBag.h",
  26 ##              "CFBundle.h",
  27 ##              "CFCharacterSet.h",
  28                 "CFData.h",
  29 ##              "CFDate.h",
  30                 "CFDictionary.h",
  31 ##              "CFNumber.h",
  32 ##              "CFPlugIn.h",
  33 ##              "CFPreferences.h",
  34 ##              "CFPropertyList.h",
  35 ##              "CFSet.h",
  36                 "CFString.h",
  37 ##              "CFStringEncodingExt.h",
  38 ##              "CFTimeZone.h",
  39                 "CFURL.h",
  40                 ]
  41         output = SHORT + "gen.py"
  42         defsoutput = TOOLBOXDIR + LONG + ".py"
  43         scanner = MyScanner(input, output, defsoutput)
  44         scanner.scan()
  45         scanner.gentypetest(SHORT+"typetest.py")
  46         scanner.close()
  47         print "=== Done scanning and generating, now importing the generated code... ==="
  48         exec "import " + SHORT + "support"
  49         print "=== Done.  It's up to you to compile it now! ==="
  50
  51 class MyScanner(Scanner_OSX):
  52
  53         def destination(self, type, name, arglist):
  54                 classname = "Function"
  55                 listname = "functions"
  56                 if arglist:
  57                         t, n, m = arglist[0]
  58                         if t in OBJECTS and m == "InMode":
  59                                 classname = "Method"
  60                                 listname = t + "_methods"
  61                         # Special case for the silly first AllocatorRef argument
  62                         if t == 'CFAllocatorRef' and m == 'InMode' and len(arglist) > 1:
  63                                 t, n, m = arglist[1]
  64                                 if t in OBJECTS and m == "InMode":
  65                                         classname = "MethodSkipArg1"
  66                                         listname = t + "_methods"
  67                 return classname, listname
  68
  69         def writeinitialdefs(self):
  70                 self.defsfile.write("def FOUR_CHAR_CODE(x): return x\n")
  71
  72         def makeblacklistnames(self):
  73                 return [
  74                         # Memory allocator functions
  75                         "CFAllocatorGetDefault",
  76                         "CFAllocatorSetDefault",
  77                         "CFAllocatorAllocate",
  78                         "CFAllocatorReallocate",
  79                         "CFAllocatorDeallocate",
  80                         "CFGetAllocator",
  81                         # Array functions we skip for now.
  82                         "CFArrayGetValueAtIndex",
  83                         # Data pointer functions. Skip for now.
  84                         "CFDataGetBytePtr",
  85                         "CFDataGetMutableBytePtr",
  86                         "CFDataGetBytes",   # XXXX Should support this one
  87                         # String functions
  88                         "CFStringGetPascalString", # Use the C-string methods.
  89                         "CFStringGetPascalStringPtr", # TBD automatically
  90                         "CFStringGetCStringPtr",
  91                         "CFStringGetCharactersPtr",
  92                         "CFStringGetCString",
  93                         "CFStringGetCharacters",
  94                         "CFURLCreateStringWithFileSystemPath", # Gone in later releases
  95                         ]
  96
  97         def makegreylist(self):
  98                 return []
  99
 100         def makeblacklisttypes(self):
 101                 return [
 102                         "CFComparatorFunction", # Callback function pointer
 103                         "CFAllocatorContext", # Not interested in providing our own allocator
 104                         "void_ptr_ptr",  # Tricky. This is the initializer for arrays...
 105                         "void_ptr", # Ditto for various array lookup methods
 106                         "CFArrayApplierFunction", # Callback function pointer
 107                         "CFDictionaryApplierFunction", # Callback function pointer
 108                         "UniChar_ptr", # XXXX To be done
 109                         "const_UniChar_ptr", # XXXX To be done
 110                         "UniChar", # XXXX To be done
 111                         "va_list", # For printf-to-a-cfstring. Use Python.
 112                         "const_CFStringEncoding_ptr", # To be done, I guess
 113                         ]
 114
 115         def makerepairinstructions(self):
 116                 return [
 117                         # Buffers in CF seem to be passed as UInt8 * normally.
 118                         ([("UInt8_ptr", "*", "InMode"), ("CFIndex", "*", "InMode")],
 119                          [("UcharInBuffer", "*", "*")]),
 120
 121                         # Some functions return a const char *. Don't worry, we won't modify it.
 122                         ([("const_char_ptr", "*", "ReturnMode")],
 123                          [("return_stringptr", "*", "*")]),
 124
 125                         # base URLs are optional (pass None for NULL)
 126                         ([("CFURLRef", "baseURL", "InMode")],
 127                          [("OptionalCFURLRef", "*", "*")]),
 128
 129                         ]
 130
 131 if __name__ == "__main__":
 132         main()