0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

wmllint: rewrite "who" magic comment to match exact macro name

Browse source 
Previously, the string only needed to match part of the macro. However, this
left too much room for unintended matches. This change is also quicker for
wmllint to process.
This commit is contained in:
Groggy Dice 2013-12-22 09:16:05 -05:00
parent 01d0a49a1d
commit 98abe1ea42
1 changed files with 24 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
data/tools/wmllint
View file

@ -79,26 +79,20 @@
# For macros used in multiple scenarios to field characters, you can tell
# wmllint to recognize them with another magic comment:
# wmllint: who <macro> is <character(s)>
# <Macro> should be a text string sufficient to distinguish the macro from
# any other; <character(s)> would be the ids of the recalled (or created)
# characters, comma-separated if there were more than one. (Enclosing <macro>
# in quotes is possible, if a space is needed at the end; for example, if a
# campaign had a "{GARARD_I $x $y}" macro and also a "GARARD_II" macro,
# "who '{GARARD_I '" would distinguish I from II.)
#
# If more characters attach to a macro in later scenarios, they can be appended
# with additional "who" magic comments (though this requires scenarios to
# be numbered or otherwise sorted to work properly, as wmllint traverses files
# in alphabetical order). If there is a character that drops out, preceding that
# person's entry with a double-minus will cause that character to be removed,
# e.g., "-- Garak".
# <Macro> should be the macro name; <character(s)> would be the ids of the
# recalled (or created) characters, comma-separated if there were more than
# one. If more characters attach to a macro in later scenarios, they can be
# appended with additional "who" magic comments (though this requires scenarios
# to be numbered or otherwise sorted to work properly, as wmllint traverses
# files in alphabetical order). If there is a character that drops out,
# preceding that person's entry with a double-minus will cause that character
# to be removed, e.g., "-- Garak".
#
# At the end of the campaign, *make sure* you use:
# wmllint: unwho ALL
# This will clear the list of "who" magic comments and tell wmllint to stop
# checking for them in later files and directories. If a specific macro is
# not used in subsequent scenarios, put "unwho <macro>" in its last scenario,
# where <macro> should be the string you originally used for "wmllint: who".
# not used in subsequent scenarios, put "unwho <macro>" in its last scenario.
#
# Similarly, it is possible to explicitly declare a unit's usage class
# with a magic comment that looks like this:
@ -1445,7 +1439,7 @@ def global_sanity_check(filename, lines):
try:
fields = lines[i].split("wmllint: who ", 1)[1].split(" is ", 1)
if len(fields) == 2:
mac = string_strip(fields[0].strip())
mac = string_strip(fields[0].strip()).strip('{}')
if whopairs.has_key(mac):
whopairs[mac] = whopairs[mac] + ", " + fields[1].strip()
else:
@ -1458,7 +1452,7 @@ def global_sanity_check(filename, lines):
whopairs.clear()
else:
try:
del whopairs[string_strip(unmac)]
del whopairs[string_strip(unmac).strip('{}')]
except KeyError:
print >>sys.stderr, '%s, line %s: magic comment "unwho %s" does not match any current keys: %s' \
% (filename, i+1, unmac, str(whopairs.keys())[1:-1])
@ -1482,8 +1476,19 @@ def global_sanity_check(filename, lines):
# assumes that such a macro is the first item on a line.
leadmac = re.match(r'{[^}\s]+.', lines[i].lstrip())
if leadmac:
if not leadmac.group().endswith('}'):
macname = leadmac.group()[1:-1]
macname = leadmac.group()[1:-1]
# Recognize macro pairings from "wmllint: who" magic
# comments.
if macname in whopairs.keys():
for who in whopairs[macname].split(","):
if who.strip().startswith("--"):
try:
present.remove(who.replace('--', '', 1).strip())
except:
ValueError
else:
present.append(who.strip())
elif not leadmac.group().endswith('}'):
# Update 1.4's {LOYAL_UNIT} macro to {NAMED_LOYAL_UNIT}. Do
# this here rather than hack_syntax so the character can be
# recognized.
@ -1511,18 +1516,6 @@ def global_sanity_check(filename, lines):
elif macname in whomacros.keys():
(args, brack, paren) = parse_macroref(0, leadmac.string)
present.append(args[whomacros[macname]])
# Recognize macro pairings from "wmllint: who" magic
# comments.
for mac in whopairs.keys():
if mac in leadmac.group(0):
for who in whopairs[mac].split(","):
if who.strip().startswith("--"):
try:
present.remove(who.replace('--', '', 1).strip())
except:
ValueError
else:
present.append(who.strip())
m = re.search("# *wmllint: recognize +(.*)", lines[i])
if m:
present.append(string_strip(m.group(1)).strip())