' % css for line in lines: line = line.strip() if inlisting: if line and line[0] != '!': outstr += "\n
" inlisting = False else: if not line: outstr += "
" continue if line[0] == '!': outstr += "
\n"
inlisting = True
bracketdepth = curlydepth = 0
line = line.replace("<", "<").replace(">", ">").replace("&", "&")
if inlisting:
outstr += line[1:] + "\n"
else:
outstr += line + "\n"
if not inlisting:
outstr += "\n"
else:
outstr += "\n"
outstr = outstr.replace("", "")
outstr = outstr.replace("\n\n", "\n")
return outstr
class CrossRefLister(CrossRef):
"Cross-reference generator with reporting functions"
def xrefdump(self, pred=None):
"Report resolved macro references."
sorted = self.xref.keys()
sorted.sort()
for name in sorted:
for defn in self.xref[name]:
if pred and not pred(name, defn):
continue
if defn.undef:
type = "local"
else:
type = "global"
nrefs = len(defn.references)
if nrefs == 0:
print "%s: %s macro %s is unused" % (defn, type, name)
else:
print "%s: %s macro %s is used in %d files:" % (defn, type, name, nrefs)
defn.dump_references()
sorted = self.fileref.keys()
sorted.sort()
for name in sorted:
defloc = self.fileref[name]
if pred and not pred(name, defloc):
continue
nrefs = len(defloc.references)
if nrefs == 0:
print "Resource %s is unused" % defloc
else:
print "Resource %s is used in %d files:" % (defloc, nrefs)
defloc.dump_references()
def unresdump(self):
"Report unresolved references, arity mismatches, duplicate unit IDs."
# First the unresolved references
if len(self.unresolved) == 0 and len(self.missing) == 0:
print "# No unresolved references"
else:
#print self.fileref.keys()
for (name, reference) in self.unresolved + self.missing:
print "%s: Unresolved reference -> %s" % (reference, name)
mismatched = []
sorted = self.xref.keys()
sorted.sort()
for name in sorted:
for defn in self.xref[name]:
m = defn.mismatches()
if m.references:
mismatched.append((name, m))
# Then the type mismatches
if mismatched:
print "# Mismatched references:"
for (n, m) in mismatched:
print "%s: macro %s(%s) has mismatches:" % (m, n, ", ".join(["{}={}".format(x, formaltype(x)) for x in m.args]))
for (file, refs) in m.references.items():
for (ln, args) in refs:
print '"%s", line %d: %s(%s) with signature (%s)' % (file, ln, n, ", ".join(args), ", ".join(["{}={}".format(f, actualtype(a)) for f,a in zip(m.args, args)]))
def undersized(self):
"Report undersized images that cannot be safely overlaid on a hex."
try:
from PIL import Image
for (namespace, filename) in xref.filelist.generator():
if filename.endswith(".png"):
try:
im = Image.open(filename)
(x, y) = im.size
if x <= 60 or y <= 60:
print "%s: %d by %d" % (filename, x, y)
except IOError:
sys.stderr.write("%s: PIL internal error\n" % filename)
except ImportError:
sys.stderr.write("Install Python Imaging Library to enable size check.\n")
def duplicates(self, exportonly):
"Dump duplicate unit IDs."
duplicate_latch = False
for (key, value) in self.unit_ids.items():
if len(value) > 1:
if exportonly and not [x for x in value if self.exports(x.namespace)]:
continue
if not duplicate_latch:
print "# Duplicate IDs"
duplicate_latch = True
print "%s: occurs %d times as unit ID" % (key, len(value))
for ref in value:
print "%s: exported=%s" % (ref, self.exports(ref.namespace))
def typelist(self, branch):
"Dump actual and formal arguments for macros in specified file"
already_seen = []
sorted = self.xref.keys()
sorted.sort()
for name in sorted:
for defn in self.xref[name]:
for (filename, refs) in defn.references.items():
if filename.endswith(branch):
if name not in already_seen:
already_seen.append(name)
print "%s: macro %s(%s):" % (defn, name, ", ".join(["{}={}".format(x, formaltype(x)) for x in defn.args]))
for (ln, args) in refs:
print '"%s", line %d: %s(%s) with signature (%s)' % (filename, ln, name, ", ".join(args), ", ".join(["{}={}".format(f, actualtype(a)) for f,a in zip(defn.args, args)]))
def deflist(self, pred=None):
"List all resource definitions."
sorted = self.xref.keys()
sorted.sort()
for name in sorted:
for defn in self.xref[name]:
if not pred or pred(name, defn):
print "macro", name, " ".join(["{}={}".format(x, formaltype(x)) for x in defn.args])
sorted = self.fileref.keys()
sorted.sort()
for name in sorted:
defloc = self.fileref[name]
if not pred or pred(name, defloc):
print "resource", name
sorted = self.unit_ids.keys()
sorted.sort()
for uid in sorted:
print "unit", uid
def unchecked(self, fp):
"List all macro definitions with untyped formals."
unchecked = []
defcount = 0
callcount = 0
unresolvedcount = 0
for name in self.xref.keys():
for defn in self.xref[name]:
defcount += 1
callcount += len(defn.references)
if None in map(formaltype, defn.args):
for (i, d) in enumerate(defn.args):
if formaltype(d) is None:
defn.args[i] += "?"
unchecked.append((name, defn))
unresolvedcount += len(defn.references)
if unchecked:
print "# %d of %d (%d%%) macro definitions and %d of %d calls (%d%%) have untyped formals:" \
% (len(unchecked),
defcount,
int((100 * len(unchecked)) / defcount),
unresolvedcount,
callcount,
int((100 * unresolvedcount) / callcount))
unchecked.sort(lambda a, b: cmp(a[1], b[1]))
for (name, defn) in unchecked:
print "%s: %s(%s)" % (defn, name, ", ".join(defn.args))
def extracthelp(self, pref, fp):
"Deliver all macro help comments in HTML form."
# Bug: finds only the first definition of each macro in scope.
doclist = self.xref.keys()
doclist = [x for x in doclist if self.xref[x][0].docstring.count("\n") > 1]
doclist.sort(lambda x, y: cmp(self.xref[x][0], self.xref[y][0]))
outstr = ""
filename = None
filenamelist = []
counted = 0
for name in doclist:
entry = self.xref[name][0]
if entry.filename != filename:
if counted:
outstr += "\n"
counted += 1
filename = entry.filename
if filename.startswith(pref):
displayname = filename[len(pref):]
else:
displayname = filename
outstr += "(top)
\n" outstr += "(top)
\n" linkheaderstr = "Covered macro files:" for filename in filenamelist: linkheaderstr += " " linkheaderstr += filename + "" linkheaderstr += "
\n" fp.write(linkheaderstr) fp.write(outstr) if __name__ == "__main__": def help(): sys.stderr.write("""\ Usage: wmlscope [options] dirpath Options may be any of these: -h, --help Emit this help message and quit -c, --crossreference Report resolved macro references (implies -w 1) -C, --collisions Report duplicate resource files -d, --definitions Make definition list -e regexp, --exclude regexp Ignore files matching the specified regular expression -f regexp, --from regexp Report only on things defined in files matching regexp -l, --listfiles List files that will be processed -r ddd, --refcount=ddd Report only on macros w/references in ddd files -t fname, --typelist fname List actual & formal argtypes for calls in fname -u, --unresolved Report unresolved macro references -w, --warnlevel Set to 1 to warn of duplicate macro definitions --force-used regexp Ignore refcount 0 on names matching regexp --extracthelp Extract help from macro definition comments. --unchecked Report all macros with untyped formals. Options may be followed by any number of directiories to check. If no directories are given, all files under the current directory are checked. """) try: # Process options (options, arguments) = getopt.getopt(sys.argv[1:], "cCdhe:f:lpr:t:uw:", [ 'crossreference', 'collisions', 'definitions', 'exclude=', 'extracthelp', 'force-used=', 'from=', 'help', 'listfiles', 'progress', 'refcount=', 'typelist=', 'unchecked', 'unresolved', 'warnlevel=', ]) crossreference = definitions = listfiles = unresolved = extracthelp = False from_restrict = None refcount_restrict = None forceused = [] exclude = [] warnlevel = 0 collisions = False typelist = None unchecked = False progress = False for (switch, val) in options: if switch in ('-h', '--help'): help() sys.exit(0) if switch in ('-f', '--from'): from_restrict = val elif switch in ('-c', '--crossreference'): crossreference = True warnlevel = 1 elif switch in ('-C', '--collisions'): collisions = True elif switch in ('-d', '--definitions'): definitions = True elif switch in ('-e', '--exclude'): exclude.append(val) elif switch == '--extracthelp': extracthelp = True elif switch == '--force-used': forceused.append(val) elif switch in ('-l', '--listfiles'): listfiles = True elif switch in ('-p', '--progress'): progress = True elif switch in ('-r', '--refcount'): refcount_restrict = int(val) elif switch == '--unchecked': unchecked = True elif switch in ('-t', '--typelist'): typelist = val elif switch in ('-u', '--unresolved'): unresolved = True elif switch in ('-w', '--warnlevel'): warnlevel = int(val) # in certain situations, Windows' command prompt appends a double quote # to the command line parameters. This block takes care of this issue. for i,arg in enumerate(arguments): if arg.endswith('"'): arguments[i] = arg[:-1] forceused = "|".join(forceused) if len(arguments): dirpath = [] for arg in arguments: globarg = glob.glob(arg) for globbed in globarg: dirpath.append(globbed) else: dirpath = ['.'] if not extracthelp: print "# Wmlscope reporting on %s" % time.ctime() print "# Invocation: %s" % " ".join(sys.argv) print "# Working directory: %s" % os.getcwd() starttime = time.time() xref = CrossRefLister(dirpath, "|".join(exclude), warnlevel, progress) if not extracthelp: print "#Cross-reference time: %d seconds" % (time.time()-starttime) if extracthelp: xref.extracthelp(dirpath[0], sys.stdout) elif unchecked: xref.unchecked(sys.stdout) elif listfiles: for (namespace, filename) in xref.filelist.generator(): print filename if collisions: collisions = [] for (namespace, filename) in xref.filelist.generator(): ifp = open(filename) collisions.append(hashlib.md5(ifp.read()).digest()) ifp.close() collisions = zip(xref.filelist.flatten(), collisions) hashcounts = {} for (n, h) in collisions: hashcounts[h] = hashcounts.get(h, 0) + 1 collisions = [(n,h) for (n,h) in collisions if hashcounts[h] > 1] collisions.sort(lambda (n1, h1), (n2, h2): cmp(h1, h2)) lasthash = None for (n, h) in collisions: if h != lasthash: print "%%" lasthash = h print n xref.duplicates(exportonly=False) elif typelist: xref.typelist(typelist) elif crossreference or definitions or listfiles or unresolved: def predicate(name, defloc): if from_restrict and not re.search(from_restrict, defloc.filename): return False if refcount_restrict!=None \ and len(defloc.references) != refcount_restrict \ or (refcount_restrict == 0 and forceused and re.search(forceused, name)): return False return True if crossreference: if xref.noxref: print >>sys.stderr, "wmlscope: can't make cross-reference, input included a definitions file." else: xref.xrefdump(predicate) if definitions: xref.deflist(predicate) if unresolved: #xref.undersized() xref.unresdump() xref.duplicates(exportonly=True) except KeyboardInterrupt: print >>sys.stderr, "wmlscope: aborted." # wmlscope ends here