Mac/Modules/file/filescan.py

   1 # Scan an Apple header file, generating a Python file of generator calls.
   2
   3 import sys
   4 import os
   5 from bgenlocations import TOOLBOXDIR, BGENDIR
   6 sys.path.append(BGENDIR)
   7 from scantools import Scanner_OSX
   8
   9 LONG = "Files"
  10 SHORT = "file"
  11
  12 def main():
  13         input = ["Files.h", "Aliases.h", "Finder.h"]
  14         output = SHORT + "gen.py"
  15         defsoutput = TOOLBOXDIR + LONG + ".py"
  16         scanner = MyScanner(input, output, defsoutput)
  17         scanner.scan()
  18         scanner.close()
  19         scanner.gentypetest(SHORT+"typetest.py")
  20         print "=== Testing definitions output code ==="
  21         execfile(defsoutput, {}, {})
  22         print "=== Done scanning and generating, now importing the generated code... ==="
  23         exec "import " + SHORT + "support"
  24         print "=== Done.  It's up to you to compile it now! ==="
  25
  26 class MyScanner(Scanner_OSX):
  27
  28         def destination(self, type, name, arglist):
  29                 classname = "Function"
  30                 listname = "functions"
  31                 if arglist:
  32                         # Funny special case
  33                         if len(arglist) > 2:
  34                                 t, n, m = arglist[1]
  35                                 if t == "AliasHandle" and m == "InMode":
  36                                         classname = "Arg2MethodGenerator"
  37                                         listname = "alias_methods"
  38                                         return classname, listname
  39                         # Normal cases
  40                         t, n, m = arglist[0]
  41                         if t == "AliasHandle" and m == "InMode":
  42                                 classname = "Method"
  43                                 listname = "alias_methods"
  44                         if t == "FSSpec_ptr" and m == "InMode":
  45                                 classname = "Method"
  46                                 listname = "fsspec_methods"
  47                         if t == "FSRef_ptr" and m == "InMode":
  48                                 classname = "Method"
  49                                 listname = "fsref_methods"
  50                 return classname, listname
  51
  52         def makeblacklistnames(self):
  53                 return [
  54                         # Constants with incompatible definitions
  55                         "kioACAccessOwnerMask",
  56                         "kFSCatInfoReserved",
  57                         "kFSIterateReserved",
  58                         "kSystemFolderType",
  59
  60                         "FSRefMakePath", # Do this manually
  61 #                       "ResolveAlias", # Do this manually
  62 #                       "ResolveAliasWithMountFlags", # Do this manually
  63 #                       "FollowFinderAlias", # Do this manually
  64
  65                         "FSRead", # Couldn't be bothered
  66                         "FSWrite", # ditto
  67                         "FSReadFork", # ditto
  68                         "FSWriteFork", # ditto
  69
  70                         # Old routines:
  71                         "GetWDInfo",
  72                         "OpenWD",
  73                         "CloseWD",
  74                         "FInitQueue",
  75                         "rstflock",
  76                         "setflock",
  77                         "setfinfo",
  78                         "fsrename",
  79                         "fsdelete",
  80                         "create",
  81                         "flushvol",
  82                         "eject",
  83                         "umountvol",
  84                         "setvol",
  85                         "getvol",
  86                         "getfinfo",
  87                         "getvinfo",
  88                         "fsopen",
  89                         "RstFLock",
  90                         "SetFLock",
  91                         "SetFInfo",
  92                         "Rename",
  93                         "OpenRF",
  94                         "FSDelete",
  95                         "Create",
  96                         "GetVol",
  97                         "GetFInfo",
  98                         "GetVInfo",
  99                         "FSOpen",
 100                         "Eject",
 101                         "SetVol",
 102                         "openrf",
 103                         "unmountvol",
 104                         "OpenDF",
 105
 106                         ]
 107
 108         def makegreylist(self):
 109                 return [
 110                         ('#if TARGET_API_MAC_OSX', [
 111                                 'FNNotifyAll',
 112                                 'FNNotifyByPath',
 113                                 'FNNotify',
 114                         ])]
 115
 116         def makeblacklisttypes(self):
 117                 return [
 118                         "CInfoPBPtr", # Old stuff
 119                         "CMovePBPtr", # Old stuff
 120                         "ParmBlkPtr", # Old stuff
 121                         "HParmBlkPtr", # Old stuff
 122                         "DTPBPtr", # Old stuff
 123                         "FCBPBPtr", # Old stuff
 124                         "QHdrPtr", # Old stuff
 125                         "CSParamPtr", # Old stuff
 126                         "FSCatalogBulkParam", # old stuff
 127                         "FSForkCBInfoParam", # old stuff
 128                         "FSForkIOParam", # old stuff
 129                         "FSRefParam",  # old stuff
 130                         "FSVolumeInfoParam", # old stuff
 131                         "WDPBPtr", # old stuff
 132                         "XCInfoPBPtr", # old stuff
 133                         "XVolumeParamPtr", # old stuff
 134
 135
 136                         "CatPositionRec", # State variable, not too difficult
 137                         "FSIterator", # Should become an object
 138                         "FSForkInfo", # Lots of fields, difficult struct
 139                         "FSSearchParams", # Also catsearch stuff
 140                         "FSVolumeInfo", # big struct
 141                         "FSVolumeInfo_ptr", # big struct
 142
 143                         "IOCompletionProcPtr", # proc pointer
 144                         "IOCompletionUPP", # Proc pointer
 145                         "AliasFilterProcPtr",
 146                         "AliasFilterUPP",
 147
 148                         ]
 149
 150         def makerepairinstructions(self):
 151                 return [
 152                         # Various ways to give pathnames
 153                         ([('char_ptr', '*', 'InMode')],
 154                          [('stringptr', '*', 'InMode')]
 155                         ),
 156
 157                         # Unicode filenames passed as length, buffer
 158                         ([('UniCharCount', '*', 'InMode'),
 159                           ('UniChar_ptr', '*', 'InMode')],
 160                          [('UnicodeReverseInBuffer', '*', 'InMode')]
 161                         ),
 162                         # Wrong guess
 163                         ([('Str63', 'theString', 'InMode')],
 164                          [('Str63', 'theString', 'OutMode')]),
 165
 166                         # Yet another way to give a pathname:-)
 167                         ([('short', 'fullPathLength', 'InMode'),
 168                           ('void_ptr', 'fullPath', 'InMode')],
 169                          [('FullPathName', 'fullPath', 'InMode')]),
 170
 171                         # Various ResolveAliasFileXXXX functions
 172                         ([('FSSpec', 'theSpec', 'OutMode')],
 173                          [('FSSpec_ptr', 'theSpec', 'InOutMode')]),
 174
 175                         ([('FSRef', 'theRef', 'OutMode')],
 176                          [('FSRef_ptr', 'theRef', 'InOutMode')]),
 177
 178                         # The optional FSSpec to all ResolveAlias and NewAlias methods
 179                         ([('FSSpec_ptr', 'fromFile', 'InMode')],
 180                  [('OptFSSpecPtr', 'fromFile', 'InMode')]),
 181
 182                         ([('FSRef_ptr', 'fromFile', 'InMode')],
 183                  [('OptFSRefPtr', 'fromFile', 'InMode')]),
 184
 185 ##              # FSCatalogInfo input handling
 186 ##                      ([('FSCatalogInfoBitmap', 'whichInfo', 'InMode'),
 187 ##                ('FSCatalogInfo_ptr', 'catalogInfo', 'InMode')],
 188 ##               [('FSCatalogInfoAndBitmap_in', 'catalogInfo', 'InMode')]),
 189 ##
 190 ##              # FSCatalogInfo output handling
 191 ##                      ([('FSCatalogInfoBitmap', 'whichInfo', 'InMode'),
 192 ##                ('FSCatalogInfo', 'catalogInfo', 'OutMode')],
 193 ##               [('FSCatalogInfoAndBitmap_out', 'catalogInfo', 'InOutMode')]),
 194 ##
 195
 196                 ]
 197
 198
 199         def writeinitialdefs(self):
 200                 self.defsfile.write("def FOUR_CHAR_CODE(x): return x\n")
 201                 self.defsfile.write("true = True\n")
 202                 self.defsfile.write("false = False\n")
 203
 204 if __name__ == "__main__":
 205         main()