[mirror_edk2.git] / AppPkg / Applications / Python / Python-2.7.2 / Tools / bgen / bgen / scantools.py

"""\\r
\r
Tools for scanning header files in search of function prototypes.\r
\r
Often, the function prototypes in header files contain enough information\r
to automatically generate (or reverse-engineer) interface specifications\r
from them.  The conventions used are very vendor specific, but once you've\r
figured out what they are they are often a great help, and it sure beats\r
manually entering the interface specifications.  (These are needed to generate\r
the glue used to access the functions from Python.)\r
\r
In order to make this class useful, almost every component can be overridden.\r
The defaults are (currently) tuned to scanning Apple Macintosh header files,\r
although most Mac specific details are contained in header-specific subclasses.\r
"""\r
\r
import re\r
import sys\r
import os\r
import fnmatch\r
from types import *\r
try:\r
    import MacOS\r
except ImportError:\r
    MacOS = None\r
\r
try:\r
    from bgenlocations import CREATOR, INCLUDEDIR\r
except ImportError:\r
    CREATOR = None\r
    INCLUDEDIR = os.curdir\r
\r
Error = "scantools.Error"\r
\r
BEGINHTMLREPORT="""<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
<html>\r
<head>\r
<style type="text/css">\r
.unmatched {  }\r
.commentstripping { color: grey; text-decoration: line-through }\r
.comment { text-decoration: line-through }\r
.notcomment { color: black }\r
.incomplete { color: maroon }\r
.constant { color: green }\r
.pyconstant { background-color: yellow }\r
.blconstant { background-color: yellow; color: red }\r
.declaration { color: blue }\r
.pydeclaration { background-color: yellow }\r
.type { font-style: italic }\r
.name { font-weight: bold }\r
.value { font-style: italic }\r
.arglist { text-decoration: underline }\r
.blacklisted { background-color: yellow; color: red }\r
</style>\r
<title>Bgen scan report</title>\r
</head>\r
<body>\r
<h1>Bgen scan report</h1>\r
<h2>Legend</h2>\r
<p>This scan report is intended to help you debug the regular expressions\r
used by the bgen scanner. It consists of the original ".h" header file(s)\r
marked up to show you what the regular expressions in the bgen parser matched\r
for each line. NOTE: comments in the original source files may or may not be\r
shown.</p>\r
<p>The typographic conventions of this file are as follows:</p>\r
<dl>\r
<dt>comment stripping</dt>\r
<dd><pre><span class="commentstripping"><span class="notcomment">comment stripping is </span><span class="comment">/* marked up */</span><span class="notcomment"> and the line is repeated if needed</span></span></pre>\r
<p>If anything here does not appear to happen correctly look at\r
<tt>comment1_pat</tt> and <tt>comment2_pat</tt>.</p>\r
</dd>\r
<dt>constant definitions</dt>\r
<dd><pre><span class="constant">#define <span class="name">name</span> <span class="value">value</span></pre>\r
<p>Highlights name and value of the constant. Governed by <tt>sym_pat</tt>.</p>\r
</dd>\r
<dt>function declaration</dt>\r
<dd><pre><span class="declaration"><span class="type">char *</span><span class="name">rindex</span><span class="arglist">(<span class="type">const char *</span><span class="name">s</span>, <span class="type">int </span><span class="name">c</span>)</span>;</span></pre>\r
<p>Highlights type, name and argument list. <tt>type_pat</tt>,\r
<tt>name_pat</tt> and <tt>args_pat</tt> are combined into <tt>whole_pat</tt>, which\r
is what is used here.</p></dd>\r
</dd>\r
<dt>incomplete match for function declaration</dt>\r
<dd><pre><span class="incomplete"><span class="type">char *</span>foo;</span></pre>\r
<p>The beginning of this looked promising, but it did not match a function declaration.\r
In other words, it matched <tt>head_pat</tt> but not <tt>whole_pat</tt>. If the next\r
declaration has also been gobbled up you need to look at <tt>end_pat</tt>.</p>\r
</dd>\r
<dt>unrecognized input</dt>\r
<dd><pre><span class="unmatched">#include "type.h"</span></pre>\r
<p>If there are function declarations the scanner has missed (i.e. things\r
are in this class but you want them to be declarations) you need to adapt\r
<tt>head_pat</tt>.\r
</dd>\r
</dl>\r
<h2>Output</h2>\r
<pre>\r
<span class="unmatched">\r
"""\r
ENDHTMLREPORT="""</span>\r
</pre>\r
</body>\r
</html>\r
"""\r
\r
class Scanner:\r
\r
    # Set to 1 in subclass to debug your scanner patterns.\r
    debug = 0\r
\r
    def __init__(self, input = None, output = None, defsoutput = None):\r
        self.initsilent()\r
        self.initblacklists()\r
        self.initrepairinstructions()\r
        self.initpaths()\r
        self.initfiles()\r
        self.initpatterns()\r
        self.compilepatterns()\r
        self.initosspecifics()\r
        self.initusedtypes()\r
        if output:\r
            self.setoutput(output, defsoutput)\r
        if input:\r
            self.setinput(input)\r
\r
    def initusedtypes(self):\r
        self.usedtypes = {}\r
\r
    def typeused(self, type, mode):\r
        if not self.usedtypes.has_key(type):\r
            self.usedtypes[type] = {}\r
        self.usedtypes[type][mode] = None\r
\r
    def reportusedtypes(self):\r
        types = self.usedtypes.keys()\r
        types.sort()\r
        for type in types:\r
            modes = self.usedtypes[type].keys()\r
            modes.sort()\r
            self.report("%s %s", type, " ".join(modes))\r
\r
    def gentypetest(self, file):\r
        fp = open(file, "w")\r
        fp.write("types=[\n")\r
        types = self.usedtypes.keys()\r
        types.sort()\r
        for type in types:\r
            fp.write("\t'%s',\n"%type)\r
        fp.write("]\n")\r
        fp.write("""missing=0\r
for t in types:\r
    try:\r
        tt = eval(t)\r
    except NameError:\r
        print "** Missing type:", t\r
        missing = 1\r
if missing: raise "Missing Types"\r
""")\r
        fp.close()\r
\r
    def initsilent(self):\r
        self.silent = 1\r
\r
    def error(self, format, *args):\r
        if self.silent >= 0:\r
            print format%args\r
\r
    def report(self, format, *args):\r
        if not self.silent:\r
            print format%args\r
\r
    def writeinitialdefs(self):\r
        pass\r
\r
    def initblacklists(self):\r
        self.blacklistnames = self.makeblacklistnames()\r
        self.blacklisttypes = ["unknown", "-"] + self.makeblacklisttypes()\r
        self.greydictnames = self.greylist2dict(self.makegreylist())\r
\r
    def greylist2dict(self, list):\r
        rv = {}\r
        for define, namelist in list:\r
            for name in namelist:\r
                rv[name] = define\r
        return rv\r
\r
    def makeblacklistnames(self):\r
        return []\r
\r
    def makeblacklisttypes(self):\r
        return []\r
\r
    def makegreylist(self):\r
        return []\r
\r
    def initrepairinstructions(self):\r
        self.repairinstructions = self.makerepairinstructions()\r
        self.inherentpointertypes = self.makeinherentpointertypes()\r
\r
    def makerepairinstructions(self):\r
        """Parse the repair file into repair instructions.\r
\r
        The file format is simple:\r
        1) use \ to split a long logical line in multiple physical lines\r
        2) everything after the first # on a line is ignored (as comment)\r
        3) empty lines are ignored\r
        4) remaining lines must have exactly 3 colon-separated fields:\r
           functionpattern : argumentspattern : argumentsreplacement\r
        5) all patterns use shell style pattern matching\r
        6) an empty functionpattern means the same as *\r
        7) the other two fields are each comma-separated lists of triples\r
        8) a triple is a space-separated list of 1-3 words\r
        9) a triple with less than 3 words is padded at the end with "*" words\r
        10) when used as a pattern, a triple matches the type, name, and mode\r
            of an argument, respectively\r
        11) when used as a replacement, the words of a triple specify\r
            replacements for the corresponding words of the argument,\r
            with "*" as a word by itself meaning leave the original word\r
            (no other uses of "*" is allowed)\r
        12) the replacement need not have the same number of triples\r
            as the pattern\r
        """\r
        f = self.openrepairfile()\r
        if not f: return []\r
        print "Reading repair file", repr(f.name), "..."\r
        list = []\r
        lineno = 0\r
        while 1:\r
            line = f.readline()\r
            if not line: break\r
            lineno = lineno + 1\r
            startlineno = lineno\r
            while line[-2:] == '\\\n':\r
                line = line[:-2] + ' ' + f.readline()\r
                lineno = lineno + 1\r
            i = line.find('#')\r
            if i >= 0: line = line[:i]\r
            words = [s.strip() for s in line.split(':')]\r
            if words == ['']: continue\r
            if len(words) <> 3:\r
                print "Line", startlineno,\r
                print ": bad line (not 3 colon-separated fields)"\r
                print repr(line)\r
                continue\r
            [fpat, pat, rep] = words\r
            if not fpat: fpat = "*"\r
            if not pat:\r
                print "Line", startlineno,\r
                print "Empty pattern"\r
                print repr(line)\r
                continue\r
            patparts = [s.strip() for s in pat.split(',')]\r
            repparts = [s.strip() for s in rep.split(',')]\r
            patterns = []\r
            for p in patparts:\r
                if not p:\r
                    print "Line", startlineno,\r
                    print "Empty pattern part"\r
                    print repr(line)\r
                    continue\r
                pattern = p.split()\r
                if len(pattern) > 3:\r
                    print "Line", startlineno,\r
                    print "Pattern part has > 3 words"\r
                    print repr(line)\r
                    pattern = pattern[:3]\r
                else:\r
                    while len(pattern) < 3:\r
                        pattern.append("*")\r
                patterns.append(pattern)\r
            replacements = []\r
            for p in repparts:\r
                if not p:\r
                    print "Line", startlineno,\r
                    print "Empty replacement part"\r
                    print repr(line)\r
                    continue\r
                replacement = p.split()\r
                if len(replacement) > 3:\r
                    print "Line", startlineno,\r
                    print "Pattern part has > 3 words"\r
                    print repr(line)\r
                    replacement = replacement[:3]\r
                else:\r
                    while len(replacement) < 3:\r
                        replacement.append("*")\r
                replacements.append(replacement)\r
            list.append((fpat, patterns, replacements))\r
        return list\r
\r
    def makeinherentpointertypes(self):\r
        return []\r
\r
    def openrepairfile(self, filename = "REPAIR"):\r
        try:\r
            return open(filename, "rU")\r
        except IOError, msg:\r
            print repr(filename), ":", msg\r
            print "Cannot open repair file -- assume no repair needed"\r
            return None\r
\r
    def initfiles(self):\r
        self.specmine = 0\r
        self.defsmine = 0\r
        self.scanmine = 0\r
        self.htmlmine = 0\r
        self.specfile = sys.stdout\r
        self.defsfile = None\r
        self.scanfile = sys.stdin\r
        self.htmlfile = None\r
        self.lineno = 0\r
        self.line = ""\r
\r
    def initpaths(self):\r
        self.includepath = [os.curdir, INCLUDEDIR]\r
\r
    def initpatterns(self):\r
        self.head_pat = r"^EXTERN_API[^_]"\r
        self.tail_pat = r"[;={}]"\r
        self.type_pat = r"EXTERN_API" + \\r
                        r"[ \t\n]*\([ \t\n]*" + \\r
                        r"(?P<type>[a-zA-Z0-9_* \t]*[a-zA-Z0-9_*])" + \\r
                        r"[ \t\n]*\)[ \t\n]*"\r
        self.name_pat = r"(?P<name>[a-zA-Z0-9_]+)[ \t\n]*"\r
        self.args_pat = r"\((?P<args>([^\(;=\)]+|\([^\(;=\)]*\))*)\)"\r
        self.whole_pat = self.type_pat + self.name_pat + self.args_pat\r
        self.sym_pat = r"^[ \t]*(?P<name>[a-zA-Z0-9_]+)[ \t]*=" + \\r
                       r"[ \t]*(?P<defn>[-0-9_a-zA-Z'\"\(][^\t\n,;}]*),?"\r
        self.asplit_pat = r"^(?P<type>.*[^a-zA-Z0-9_])(?P<name>[a-zA-Z0-9_]+)(?P<array>\[\])?$"\r
        self.comment1_pat = r"(?P<rest>.*)//.*"\r
        # note that the next pattern only removes comments that are wholly within one line\r
        self.comment2_pat = r"(?P<rest1>.*)/\*.*\*/(?P<rest2>.*)"\r
\r
    def compilepatterns(self):\r
        for name in dir(self):\r
            if name[-4:] == "_pat":\r
                pat = getattr(self, name)\r
                prog = re.compile(pat)\r
                setattr(self, name[:-4], prog)\r
\r
    def initosspecifics(self):\r
        if MacOS and CREATOR:\r
            self.filetype = 'TEXT'\r
            self.filecreator = CREATOR\r
        else:\r
            self.filetype = self.filecreator = None\r
\r
    def setfiletype(self, filename):\r
        if MacOS and (self.filecreator or self.filetype):\r
            creator, type = MacOS.GetCreatorAndType(filename)\r
            if self.filecreator: creator = self.filecreator\r
            if self.filetype: type = self.filetype\r
            MacOS.SetCreatorAndType(filename, creator, type)\r
\r
    def close(self):\r
        self.closefiles()\r
\r
    def closefiles(self):\r
        self.closespec()\r
        self.closedefs()\r
        self.closescan()\r
        self.closehtml()\r
\r
    def closespec(self):\r
        tmp = self.specmine and self.specfile\r
        self.specfile = None\r
        if tmp: tmp.close()\r
\r
    def closedefs(self):\r
        tmp = self.defsmine and self.defsfile\r
        self.defsfile = None\r
        if tmp: tmp.close()\r
\r
    def closescan(self):\r
        tmp = self.scanmine and self.scanfile\r
        self.scanfile = None\r
        if tmp: tmp.close()\r
\r
    def closehtml(self):\r
        if self.htmlfile: self.htmlfile.write(ENDHTMLREPORT)\r
        tmp = self.htmlmine and self.htmlfile\r
        self.htmlfile = None\r
        if tmp: tmp.close()\r
\r
    def setoutput(self, spec, defs = None):\r
        self.closespec()\r
        self.closedefs()\r
        if spec:\r
            if type(spec) == StringType:\r
                file = self.openoutput(spec)\r
                mine = 1\r
            else:\r
                file = spec\r
                mine = 0\r
            self.specfile = file\r
            self.specmine = mine\r
        if defs:\r
            if type(defs) == StringType:\r
                file = self.openoutput(defs)\r
                mine = 1\r
            else:\r
                file = defs\r
                mine = 0\r
            self.defsfile = file\r
            self.defsmine = mine\r
\r
    def sethtmloutput(self, htmlfile):\r
        self.closehtml()\r
        if htmlfile:\r
            if type(htmlfile) == StringType:\r
                file = self.openoutput(htmlfile)\r
                mine = 1\r
            else:\r
                file = htmlfile\r
                mine = 0\r
            self.htmlfile = file\r
            self.htmlmine = mine\r
            self.htmlfile.write(BEGINHTMLREPORT)\r
\r
    def openoutput(self, filename):\r
        try:\r
            file = open(filename, 'w')\r
        except IOError, arg:\r
            raise IOError, (filename, arg)\r
        self.setfiletype(filename)\r
        return file\r
\r
    def setinput(self, scan = sys.stdin):\r
        if not type(scan) in (TupleType, ListType):\r
            scan = [scan]\r
        self.allscaninputs = scan\r
        self._nextinput()\r
\r
    def _nextinput(self):\r
        if not self.allscaninputs:\r
            return 0\r
        scan = self.allscaninputs[0]\r
        self.allscaninputs = self.allscaninputs[1:]\r
        self.closescan()\r
        if scan:\r
            if type(scan) == StringType:\r
                file = self.openinput(scan)\r
                mine = 1\r
            else:\r
                file = scan\r
                mine = 0\r
            self.scanfile = file\r
            self.scanmine = mine\r
        self.lineno = 0\r
        return 1\r
\r
    def openinput(self, filename):\r
        if not os.path.isabs(filename):\r
            for dir in self.includepath:\r
                fullname = os.path.join(dir, filename)\r
                #self.report("trying full name %r", fullname)\r
                try:\r
                    return open(fullname, 'rU')\r
                except IOError:\r
                    pass\r
        # If not on the path, or absolute, try default open()\r
        try:\r
            return open(filename, 'rU')\r
        except IOError, arg:\r
            raise IOError, (arg, filename)\r
\r
    def getline(self):\r
        if not self.scanfile:\r
            raise Error, "input file not set"\r
        self.line = self.scanfile.readline()\r
        if not self.line:\r
            if self._nextinput():\r
                return self.getline()\r
            raise EOFError\r
        self.lineno = self.lineno + 1\r
        return self.line\r
\r
    def scan(self):\r
        if not self.scanfile:\r
            self.error("No input file has been specified")\r
            return\r
        inputname = self.scanfile.name\r
        self.report("scanfile = %r", inputname)\r
        if not self.specfile:\r
            self.report("(No interface specifications will be written)")\r
        else:\r
            self.report("specfile = %r", self.specfile.name)\r
            self.specfile.write("# Generated from %r\n\n" % (inputname,))\r
        if not self.defsfile:\r
            self.report("(No symbol definitions will be written)")\r
        else:\r
            self.report("defsfile = %r", (self.defsfile.name,))\r
            self.defsfile.write("# Generated from %r\n\n" % (os.path.split(inputname)[1],))\r
            self.writeinitialdefs()\r
        self.alreadydone = []\r
        try:\r
            while 1:\r
                try: line = self.getline()\r
                except EOFError: break\r
                if self.debug:\r
                    self.report("LINE: %r" % (line,))\r
                match = self.comment1.match(line)\r
                if match:\r
                    self.htmlreport(line, klass='commentstripping', ranges=[(\r
                        match.start('rest'), match.end('rest'), 'notcomment')])\r
                    line = match.group('rest')\r
                    if self.debug:\r
                        self.report("\tafter comment1: %r" % (line,))\r
                match = self.comment2.match(line)\r
                while match:\r
                    if match:\r
                        self.htmlreport(line, klass='commentstripping', ranges=[\r
                            (match.start('rest1'), match.end('rest1'), 'notcomment'),\r
                            (match.start('rest2'), match.end('rest2'), 'notcomment')])\r
                    line = match.group('rest1')+match.group('rest2')\r
                    if self.debug:\r
                        self.report("\tafter comment2: %r" % (line,))\r
                    match = self.comment2.match(line)\r
                if self.defsfile:\r
                    match = self.sym.match(line)\r
                    if match:\r
                        if self.debug:\r
                            self.report("\tmatches sym.")\r
                        self.dosymdef(match, line)\r
                        continue\r
                match = self.head.match(line)\r
                if match:\r
                    if self.debug:\r
                        self.report("\tmatches head.")\r
                    self.dofuncspec()\r
                    continue\r
                self.htmlreport(line, klass='unmatched')\r
        except EOFError:\r
            self.error("Uncaught EOF error")\r
        self.reportusedtypes()\r
\r
    def dosymdef(self, match, line):\r
        name, defn = match.group('name', 'defn')\r
        self.htmlreport(line, klass='constant', ranges=[\r
            (match.start('name'), match.end('name'), 'name'),\r
            (match.start('defn'), match.end('defn'), 'value')])\r
        defn = escape8bit(defn)\r
        if self.debug:\r
            self.report("\tsym: name=%r, defn=%r" % (name, defn))\r
        if not name in self.blacklistnames:\r
            oline = "%s = %s\n" % (name, defn)\r
            self.defsfile.write(oline)\r
            self.htmlreport(oline, klass="pyconstant")\r
        else:\r
            self.defsfile.write("# %s = %s\n" % (name, defn))\r
            self.htmlreport("** no output: name is blacklisted", klass="blconstant")\r
        # XXXX No way to handle greylisted names\r
\r
    def dofuncspec(self):\r
        raw = self.line\r
        while not self.tail.search(raw):\r
            line = self.getline()\r
            if self.debug:\r
                self.report("* CONTINUATION LINE: %r" % (line,))\r
            match = self.comment1.match(line)\r
            if match:\r
                line = match.group('rest')\r
                if self.debug:\r
                    self.report("\tafter comment1: %r" % (line,))\r
            match = self.comment2.match(line)\r
            while match:\r
                line = match.group('rest1')+match.group('rest2')\r
                if self.debug:\r
                    self.report("\tafter comment1: %r" % (line,))\r
                match = self.comment2.match(line)\r
            raw = raw + line\r
        if self.debug:\r
            self.report("* WHOLE LINE: %r" % (raw,))\r
        self.processrawspec(raw)\r
        return raw\r
\r
    def processrawspec(self, raw):\r
        match = self.whole.search(raw)\r
        if not match:\r
            self.report("Bad raw spec: %r", raw)\r
            if self.debug:\r
                match = self.type.search(raw)\r
                if not match:\r
                    self.report("(Type already doesn't match)")\r
                    self.htmlreport(raw, klass='incomplete', ranges=[(\r
                        match.start('type'), match.end('type'), 'type')])\r
                else:\r
                    self.report("(but type matched)")\r
                    self.htmlreport(raw, klass='incomplete')\r
            return\r
        type, name, args = match.group('type', 'name', 'args')\r
        ranges=[\r
                (match.start('type'), match.end('type'), 'type'),\r
                (match.start('name'), match.end('name'), 'name'),\r
                (match.start('args'), match.end('args'), 'arglist')]\r
        self.htmlreport(raw, klass='declaration', ranges=ranges)\r
        modifiers = self.getmodifiers(match)\r
        type = self.pythonizename(type)\r
        name = self.pythonizename(name)\r
        if self.checkduplicate(name):\r
            self.htmlreport("*** no output generated: duplicate name", klass="blacklisted")\r
            return\r
        self.report("==> %s %s <==", type, name)\r
        if self.blacklisted(type, name):\r
            self.htmlreport("*** no output generated: function name or return type blacklisted", klass="blacklisted")\r
            self.report("*** %s %s blacklisted", type, name)\r
            return\r
        returnlist = [(type, name, 'ReturnMode')]\r
        returnlist = self.repairarglist(name, returnlist)\r
        [(type, name, returnmode)] = returnlist\r
        arglist = self.extractarglist(args)\r
        arglist = self.repairarglist(name, arglist)\r
        if self.unmanageable(type, name, arglist):\r
            self.htmlreport("*** no output generated: some argument blacklisted", klass="blacklisted")\r
            ##for arg in arglist:\r
            ##  self.report("    %r", arg)\r
            self.report("*** %s %s unmanageable", type, name)\r
            return\r
        if modifiers:\r
            self.generate(type, name, arglist, modifiers)\r
        else:\r
            self.generate(type, name, arglist)\r
\r
    def getmodifiers(self, match):\r
        return []\r
\r
    def checkduplicate(self, name):\r
        if name in self.alreadydone:\r
            self.report("Name has already been defined: %r", name)\r
            return True\r
        self.alreadydone.append(name)\r
        return False\r
\r
    def pythonizename(self, name):\r
        name = re.sub("\*", " ptr", name)\r
        name = name.strip()\r
        name = re.sub("[ \t]+", "_", name)\r
        return name\r
\r
    def extractarglist(self, args):\r
        args = args.strip()\r
        if not args or args == "void":\r
            return []\r
        parts = [s.strip() for s in args.split(",")]\r
        arglist = []\r
        for part in parts:\r
            arg = self.extractarg(part)\r
            arglist.append(arg)\r
        return arglist\r
\r
    def extractarg(self, part):\r
        mode = "InMode"\r
        part = part.strip()\r
        match = self.asplit.match(part)\r
        if not match:\r
            self.error("Indecipherable argument: %r", part)\r
            return ("unknown", part, mode)\r
        type, name, array = match.group('type', 'name', 'array')\r
        if array:\r
            # array matches an optional [] after the argument name\r
            type = type + " ptr "\r
        type = self.pythonizename(type)\r
        return self.modifyarg(type, name, mode)\r
\r
    def modifyarg(self, type, name, mode):\r
        if type[:6] == "const_":\r
            type = type[6:]\r
        elif type[-4:] == "_ptr":\r
            type = type[:-4]\r
            mode = "OutMode"\r
        elif type in self.inherentpointertypes:\r
            mode = "OutMode"\r
        if type[-4:] == "_far":\r
            type = type[:-4]\r
        return type, name, mode\r
\r
    def repairarglist(self, functionname, arglist):\r
        arglist = arglist[:]\r
        i = 0\r
        while i < len(arglist):\r
            for item in self.repairinstructions:\r
                if len(item) == 2:\r
                    pattern, replacement = item\r
                    functionpat = "*"\r
                else:\r
                    functionpat, pattern, replacement = item\r
                if not fnmatch.fnmatchcase(functionname, functionpat):\r
                    continue\r
                n = len(pattern)\r
                if i+n > len(arglist): continue\r
                current = arglist[i:i+n]\r
                for j in range(n):\r
                    if not self.matcharg(pattern[j], current[j]):\r
                        break\r
                else: # All items of the pattern match\r
                    new = self.substituteargs(\r
                            pattern, replacement, current)\r
                    if new is not None:\r
                        arglist[i:i+n] = new\r
                        i = i+len(new) # No recursive substitutions\r
                        break\r
            else: # No patterns match\r
                i = i+1\r
        return arglist\r
\r
    def matcharg(self, patarg, arg):\r
        return len(filter(None, map(fnmatch.fnmatchcase, arg, patarg))) == 3\r
\r
    def substituteargs(self, pattern, replacement, old):\r
        new = []\r
        for k in range(len(replacement)):\r
            item = replacement[k]\r
            newitem = [item[0], item[1], item[2]]\r
            for i in range(3):\r
                if item[i] == '*':\r
                    newitem[i] = old[k][i]\r
                elif item[i][:1] == '$':\r
                    index = int(item[i][1:]) - 1\r
                    newitem[i] = old[index][i]\r
            new.append(tuple(newitem))\r
        ##self.report("old: %r", old)\r
        ##self.report("new: %r", new)\r
        return new\r
\r
    def generate(self, tp, name, arglist, modifiers=[]):\r
\r
        self.typeused(tp, 'return')\r
        if modifiers:\r
            classname, listname = self.destination(tp, name, arglist, modifiers)\r
        else:\r
            classname, listname = self.destination(tp, name, arglist)\r
        if not classname or not listname:\r
            self.htmlreport("*** no output generated: self.destination() returned None", klass="blacklisted")\r
            return\r
        if not self.specfile:\r
            self.htmlreport("*** no output generated: no output file specified", klass="blacklisted")\r
            return\r
        self.specfile.write("f = %s(%s, %r,\n" % (classname, tp, name))\r
        for atype, aname, amode in arglist:\r
            self.typeused(atype, amode)\r
            self.specfile.write("    (%s, %r, %s),\n" %\r
                                (atype, aname, amode))\r
        if self.greydictnames.has_key(name):\r
            self.specfile.write("    condition=%r,\n"%(self.greydictnames[name],))\r
        self.generatemodifiers(classname, name, modifiers)\r
        self.specfile.write(")\n")\r
        self.specfile.write("%s.append(f)\n\n" % listname)\r
        if self.htmlfile:\r
            oline = "Adding to %s:\n%s(returntype=%s, name=%r" % (listname, classname, tp, name)\r
            for atype, aname, amode in arglist:\r
                oline += ",\n    (%s, %r, %s)" % (atype, aname, amode)\r
            oline += ")\n"\r
            self.htmlreport(oline, klass="pydeclaration")\r
\r
    def destination(self, type, name, arglist):\r
        return "FunctionGenerator", "functions"\r
\r
    def generatemodifiers(self, classname, name, modifiers):\r
        pass\r
\r
    def blacklisted(self, type, name):\r
        if type in self.blacklisttypes:\r
            ##self.report("return type %s is blacklisted", type)\r
            return 1\r
        if name in self.blacklistnames:\r
            ##self.report("function name %s is blacklisted", name)\r
            return 1\r
        return 0\r
\r
    def unmanageable(self, type, name, arglist):\r
        for atype, aname, amode in arglist:\r
            if atype in self.blacklisttypes:\r
                self.report("argument type %s is blacklisted", atype)\r
                return 1\r
        return 0\r
\r
    def htmlreport(self, line, klass=None, ranges=None):\r
        if not self.htmlfile: return\r
        if ranges is None:\r
            ranges = []\r
        if klass:\r
            ranges.insert(0, (0, len(line), klass))\r
        oline = ''\r
        i = 0\r
        for c in line:\r
            for b, e, name in ranges:\r
                if b == i:\r
                    oline += '<span class="%s">' % name\r
                if e == i:\r
                    oline += '</span>'\r
            i += 1\r
\r
            if c == '<': oline += '&lt;'\r
            elif c == '>': oline += '&gt;'\r
            else: oline += c\r
        for b, e, name in ranges:\r
            if b >= i:\r
                oline += '<span class="%s">' % name\r
            if e >= i:\r
                oline += '</span>'\r
        if not line or line[-1] != '\n':\r
            oline += '\n'\r
        self.htmlfile.write(oline)\r
\r
class Scanner_PreUH3(Scanner):\r
    """Scanner for Universal Headers before release 3"""\r
    def initpatterns(self):\r
        Scanner.initpatterns(self)\r
        self.head_pat = "^extern pascal[ \t]+" # XXX Mac specific!\r
        self.type_pat = "pascal[ \t\n]+(?P<type>[a-zA-Z0-9_ \t]*[a-zA-Z0-9_])[ \t\n]+"\r
        self.whole_pat = self.type_pat + self.name_pat + self.args_pat\r
        self.sym_pat = "^[ \t]*(?P<name>[a-zA-Z0-9_]+)[ \t]*=" + \\r
                       "[ \t]*(?P<defn>[-0-9'\"][^\t\n,;}]*),?"\r
\r
class Scanner_OSX(Scanner):\r
    """Scanner for modern (post UH3.3) Universal Headers """\r
    def initpatterns(self):\r
        Scanner.initpatterns(self)\r
        self.head_pat = "^EXTERN_API(_C)?"\r
        self.type_pat = "EXTERN_API(_C)?" + \\r
                        "[ \t\n]*\([ \t\n]*" + \\r
                        "(?P<type>[a-zA-Z0-9_* \t]*[a-zA-Z0-9_*])" + \\r
                        "[ \t\n]*\)[ \t\n]*"\r
        self.whole_pat = self.type_pat + self.name_pat + self.args_pat\r
        self.sym_pat = "^[ \t]*(?P<name>[a-zA-Z0-9_]+)[ \t]*=" + \\r
                       "[ \t]*(?P<defn>[-0-9_a-zA-Z'\"\(][^\t\n,;}]*),?"\r
\r
_8bit = re.compile(r"[\200-\377]")\r
\r
def escape8bit(s):\r
    if _8bit.search(s) is not None:\r
        out = []\r
        for c in s:\r
            o = ord(c)\r
            if o >= 128:\r
                out.append("\\" + hex(o)[1:])\r
            else:\r
                out.append(c)\r
        s = "".join(out)\r
    return s\r
\r
def test():\r
    input = "D:Development:THINK C:Mac #includes:Apple #includes:AppleEvents.h"\r
    output = "@aespecs.py"\r
    defsoutput = "@aedefs.py"\r
    s = Scanner(input, output, defsoutput)\r
    s.scan()\r
\r
if __name__ == '__main__':\r
    test()\r