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                 return classname, listname
  62
  63         def writeinitialdefs(self):
  64                 self.defsfile.write("def FOUR_CHAR_CODE(x): return x\n")
  65
  66         def makeblacklistnames(self):
  67                 return [
  68                         # Memory allocator functions
  69                         "CFAllocatorGetDefault",
  70                         "CFAllocatorSetDefault",
  71                         "CFAllocatorAllocate",
  72                         "CFAllocatorReallocate",
  73                         "CFAllocatorDeallocate",
  74                         "CFGetAllocator",
  75                         # Array functions we skip for now.
  76                         "CFArrayGetValueAtIndex",
  77                         # Data pointer functions. Skip for now.
  78                         "CFDataGetBytePtr",
  79                         "CFDataGetMutableBytePtr",
  80                         "CFDataGetBytes",   # XXXX Should support this one
  81                         # String functions
  82                         "CFStringGetPascalString", # Use the C-string methods.
  83                         "CFStringGetPascalStringPtr", # TBD automatically
  84                         "CFStringGetCStringPtr",
  85                         "CFStringGetCharactersPtr",
  86                         "CFStringGetCString",
  87                         "CFStringGetCharacters",
  88                         # OSX only, to be done
  89 ##                      "CFURLCreateWithFileSystemPath",
  90 ##                      "CFURLCreateStringWithFileSystemPath",
  91                         ]
  92
  93         def makegreylist(self):
  94                 return []
  95
  96         def makeblacklisttypes(self):
  97                 return [
  98                         "CFComparatorFunction", # Callback function pointer
  99                         "CFAllocatorContext", # Not interested in providing our own allocator
 100                         "void_ptr_ptr",  # Tricky. This is the initializer for arrays...
 101                         "void_ptr", # Ditto for various array lookup methods
 102                         "CFArrayApplierFunction", # Callback function pointer
 103                         "CFDictionaryApplierFunction", # Callback function pointer
 104                         "UniChar_ptr", # XXXX To be done
 105                         "const_UniChar_ptr", # XXXX To be done
 106                         "UniChar", # XXXX To be done
 107                         "va_list", # For printf-to-a-cfstring. Use Python.
 108                         "const_CFStringEncoding_ptr", # To be done, I guess
 109                         ]
 110
 111         def makerepairinstructions(self):
 112                 return [
 113                         # Buffers in CF seem to be passed as UInt8 * normally.
 114                         ([("UInt8_ptr", "*", "InMode"), ("CFIndex", "*", "InMode")],
 115                          [("UcharInBuffer", "*", "*")]),
 116
 117                         # Some functions return a const char *. Don't worry, we won't modify it.
 118                         ([("const_char_ptr", "*", "ReturnMode")],
 119                          [("return_stringptr", "*", "*")]),
 120
 121                         # base URLs are optional (pass None for NULL)
 122                         ([("CFURLRef", "baseURL", "InMode")],
 123                          [("OptionalCFURLRef", "*", "*")]),
 124
 125                         ]
 126
 127 if __name__ == "__main__":
 128         main()