From fcba9f498da6bf555e104557a95b34d698402b56 Mon Sep 17 00:00:00 2001 From: "Ignacio R. Morelle" Date: Fri, 11 Aug 2017 03:41:44 -0400 Subject: [PATCH] wmlunits: Refactoring and quote clean-up --- data/tools/unit_tree/html_output.py | 359 +++++++++++++++------------- data/tools/unit_tree/overview.py | 53 ++-- 2 files changed, 223 insertions(+), 189 deletions(-) diff --git a/data/tools/unit_tree/html_output.py b/data/tools/unit_tree/html_output.py index 0bbf4bca290..fc5cc8c21a1 100644 --- a/data/tools/unit_tree/html_output.py +++ b/data/tools/unit_tree/html_output.py @@ -14,14 +14,49 @@ import wesnoth.wmlparser3 as wmlparser3 PICS_LOCATION = "../../pics" -HTML_ENTITY_HORIZONTAL_BAR = '―' -HTML_ENTITY_MULTIPLICATION_SIGN = '×' -HTML_ENTITY_FIGURE_DASH = '‒' +# Icons for mainline terrains used on the unit details page +TERRAIN_ICONS = { + "fungus": "forest/mushrooms-tile", + "cave": "cave/floor6", + "sand": "sand/beach", + "reef": "water/reef-tropical-tile", + "hills": "hills/regular", + "swamp_water": "swamp/water-tile", + "shallow_water": "water/coast-tile", + "castle": "castle/castle-tile", + "mountains": "mountains/snow-tile", + "deep_water": "water/ocean-tile", + "flat": "grass/green-symbol", + "forest": "forest/pine-tile", + "frozen": "frozen/ice", + "village": "village/human-tile", + "impassable": "void/void", + "unwalkable": "unwalkable/lava", + "rails": "misc/rails-ne-sw", +} -HTML_HEADER = ''' +# Omit these terrains from the terrain info report on the unit details page +HIDDEN_TERRAINS = [ + "off_map", "off_map2", "fog", "shroud", "impassable", "void", "rails" +] + +# Damage tpye ids and associated icons used on the details page +RESISTANCES = [ + ("blade", "attacks/sword-human.png"), + ("pierce", "attacks/spear.png"), + ("impact", "attacks/club.png"), + ("fire", "attacks/fireball.png"), + ("cold", "attacks/iceball.png"), + ("arcane", "attacks/faerie-fire.png") +] + +WESMERE_CSS_VERSION = "1.1.0" +WESMERE_CSS_PREFIX = "https://www.wesnoth.org" + +WESMERE_HEADER = '''\ - + @@ -29,8 +64,8 @@ HTML_HEADER = ''' - - + + %(title)s - Wesnoth Units Database @@ -38,9 +73,8 @@ HTML_HEADER = ''' -
'''.strip() +
-TOP_BAR = ''' -
'''.strip() +
''' -HTML_FOOTER = ''' +WESMERE_FOOTER = '''\
%(generation_note)s
@@ -92,13 +126,37 @@ HTML_FOOTER = '''
-'''.strip() +''' HTML_CLEAR_FLOATS = '
' +HTML_ENTITY_HORIZONTAL_BAR = '―' +HTML_ENTITY_MULTIPLICATION_SIGN = '×' +HTML_ENTITY_FIGURE_DASH = '‒' + +PRE_PLACEHOLDER_CAMPAIGNS = "PLACE CAMPAIGNS HERE\n" +PRE_PLACEHOLDER_ERAS = "PLACE ERAS HERE\n" + +def website_header(title='', path='../../', classes=[]): + """Returns the website header with the specified parameters.""" + return WESMERE_HEADER % { + "title": title, + "path": path, + "cssprefix": WESMERE_CSS_PREFIX, + "cssver": WESMERE_CSS_VERSION, + "classes": ' '.join(['wmlunits'] + classes)} + +def website_footer(timestamp=''): + """Returns the website footer, including the current timestamp.""" + if not timestamp: + timestamp = "Last updated on " + time.ctime() + "." + return WESMERE_FOOTER % { "generation_note": timestamp } + + all_written_html_files = [] error_only_once = {} + def error_message(message): if message in error_only_once: return @@ -131,6 +189,42 @@ def cleantext(text, quote=True): return text return html.escape(text, quote) +def resistance_rating_color_class(resistance): + """Return a color class adequate for the provided unit resistance value.""" + if resistance < 0: + return 'red' + elif resistance <= 20: + return 'yellow' + elif resistance <= 40: + return 'olive' + else: + return 'green' + +def defense_rating_color_class(defense): + """Return a color class adequate for the provided terrain defense value.""" + if defense <= 10: + return 'red' + elif defense <= 30: + return 'yellow' + elif defense <= 50: + return 'olive' + else: + return 'green' + +def mvtcost_rating_color_class(str_mvtcost, str_moves): + """Return a color class adequate for the provided movement cost value.""" + cost = int_fallback(str_mvtcost, 99) + moves = int_fallback(str_moves) + if cost >= moves: + return 'gray' + elif cost > moves/2: + return 'red' + elif cost > 1: + return 'yellow' + else: + return 'green' + + class MyFile: """ Python 2 is a bit weird with encodings, really should switch this to @@ -373,8 +467,6 @@ class HTMLOutput: langlist = list(languages.keys()) langlist.sort() - write(TOP_BAR % {"path" : "../../"}) - write('
') write('\n') else: @@ -428,13 +541,13 @@ class HTMLOutput: # Campaigns x = self.translate("addon_type^Campaign", "wesnoth") add_menu("campaigns_menu", x) - write("PLACE CAMPAIGNS HERE\n") + write(PRE_PLACEHOLDER_CAMPAIGNS) end_menu() # Eras x = self.translate("Era", "wesnoth") add_menu("eras_menu", x) - write("PLACE ERAS HERE\n") + write(PRE_PLACEHOLDER_ERAS) end_menu() # Races / Factions @@ -490,8 +603,6 @@ class HTMLOutput: # Add entries for the races also to the navbar itself. if not self.is_era: - class Entry: - pass races = {} for uid, u in list(self.wesnoth.unit_lookup.items()): @@ -540,31 +651,31 @@ class HTMLOutput: # Languages x = self.translate("Language", "wesnoth") - add_menu2("languages_menu", x) + add_menu("languages_menu", x, is_table_container=True) cell = 0 col = 0 colcount = 5 lastcell = len(langlist) - 1 - write("") - write("") + write('
') + write('') for lang in langlist: cell += 1 col += 1 - write("") + write('') if cell % colcount == 0: if cell < lastcell: - write("") + write('') col = 0 if col: for i in range(colcount - col + 1, colcount): - write("") - write("") - write("
") + write('') filename = self.target if self.addon == 'mainline' else 'mainline.html' url = cleanurl('../%s/%s' % (lang, filename)) # TODO: Maybe use the language name instead of its code for the label? add_menuitem(url, lang, title=languages[lang], standalone=True) - write("
") + write('') + write('') + write('') end_menu(is_table_container=True) write('
  • Build Report
    • ') @@ -656,16 +767,16 @@ class HTMLOutput: return attacks def write_units(self): - def write(x): - self.output.write(x) - def _(x, c="wesnoth"): - return self.translate(x, c) + def write(line): + self.output.write(line) + def _(msgid, textdomain="wesnoth"): + return self.translate(msgid, textdomain) + rows = self.unitgrid - write("\n") - write("") + write('
    \n') for i in range(6): - write("" % i) - write("") + write('' % i) + write('') pic = image_collector.add_image("general", "../../../images/misc/leader-crown.png", @@ -673,7 +784,7 @@ class HTMLOutput: crownimage = cleanurl(os.path.join(PICS_LOCATION, pic)) ms = None for row in range(len(rows)): - write("\n") + write('\n') for column in range(6): hspan, vspan, un = rows[row][column] if vspan: @@ -681,9 +792,9 @@ class HTMLOutput: if hspan == 1 and vspan == 1: pass elif hspan == 1: - attributes += " rowspan=\"%d\"" % vspan + attributes += ' rowspan="%d"' % vspan elif vspan == 1: - attributes += " colspan=\"%d\"" % hspan + attributes += ' colspan="%d"' % hspan if un and isinstance(un, helpers.GroupNode): # Find the current multiplayer side so we can show the @@ -700,14 +811,14 @@ class HTMLOutput: racename = un.name # TODO: we need to use a unique race id instead of a potentially duplicate # name for the header id and link target! - attributes += " id=\"%s\" class=\"raceheader\"" % cleantext(racename) - write("") - write("%s" % (cleanurl(racename), cleantext(racename, quote=False))) - write("\n") + attributes += ' id="%s" class="raceheader"' % cleantext(racename) + write('') + write('%s' % (cleanurl(racename), cleantext(racename, quote=False))) + write('\n') elif un: u = un.unit - attributes += " class=\"unitcell\"" - write("" % attributes) + attributes += ' class="unitcell"' + write('' % attributes) def uval(name): return self.wesnoth.get_unit_value(u, name, @@ -747,7 +858,7 @@ class HTMLOutput: if crown == " ♚": write('
    ' % image) write('(image)' % crownimage) - write("
    ") + write('') else: write('(image)' % image) @@ -771,7 +882,7 @@ class HTMLOutput: if anames: write('\n
    ') write(cleantext(", ".join(anames))) - write("
    ") + write('') # Write info about attacks. write('\n
    ') @@ -809,11 +920,8 @@ class HTMLOutput: def write_units_tree(self, grouper, title, add_parents): html_title = cleantext(title) - self.output.write(HTML_HEADER % { - "path": "../../", - "title": html_title, - "classes": "wmlunits-tree", - }) + self.output.write(website_header(title=html_title, + classes=['wmlunits-tree'])) n = self.analyze_units(grouper, add_parents) self.write_navbar("units_tree") @@ -827,16 +935,15 @@ class HTMLOutput: self.output.write(HTML_CLEAR_FLOATS) self.output.write('
    ') - self.output.write(HTML_FOOTER % { - "generation_note": "Last updated on " + time.ctime() + "."}) + self.output.write(website_footer()) return n def write_unit_report(self, output, unit): - def write(x): - self.output.write(x) - def _(x, c="wesnoth"): - return self.translate(x, c) + def write(line): + self.output.write(line) + def _(msgid, textdomain="wesnoth"): + return self.translate(msgid, textdomain) def find_attr(what, key): if unit.movetype: @@ -866,10 +973,8 @@ class HTMLOutput: display_name = cleantext(uname) self.output = output - write(HTML_HEADER % { - "path": "../../", - "title": display_name, - "classes": "wmlunits-unit"}) + write(website_header(title=display_name, + classes=['wmlunits-unit'])) self.write_navbar("unit_report") self.output.write('
    ') @@ -884,7 +989,7 @@ class HTMLOutput: write('
    ') - write("

    %s

    \n" % display_name) + write('

    %s

    \n' % display_name) write('
    ') if female: @@ -1000,7 +1105,7 @@ class HTMLOutput: write('
    ') attacks = self.get_recursive_attacks(unit) for attack in attacks: - write("") + write('') aid = attack.get_text_val("name") aname = T(attack, "description") @@ -1016,17 +1121,17 @@ class HTMLOutput: icon = os.path.join(PICS_LOCATION, "unit$elves-wood$shaman.png") else: icon = os.path.join(PICS_LOCATION, image_add.id_name) - write("" % cleanurl(icon)) + write('' % cleanurl(icon)) - write("" % cleantext(_(r), quote=False)) + write('
    %s' % cleantext(_(r), quote=False)) n = attack.get_text_val("number") x = attack.get_text_val("damage") x = '%s %s %s' % (cleantext(x, quote=False), HTML_ENTITY_MULTIPLICATION_SIGN, cleantext(n, quote=False)) - write("' % cleantext(_(t), quote=False)) @@ -1041,35 +1146,16 @@ class HTMLOutput: else: error_message("Warning: Weapon special %s has no name for %s.\n" % (special.name.decode("utf8"), uid)) - write("" % "
    ".join(s)) - write("") - write("
    \"(image)\"/(image)%s" % cleantext(aname, quote=False)) + write('%s' % cleantext(aname, quote=False)) r = T(attack, "range") - write("
    %s    		%s" % x) + write('%s' % x) t = T(attack, "type") write('
    %s    		%s
    \n") - - def resistance_rating_color_class(resistance): - # Logic from src/help/help_topic_generators.cpp and src/units/helper.cpp @ 1.13.8+dev - if resistance < 0: - return 'red' - elif resistance <= 20: - return 'yellow' - elif resistance <= 40: - return 'olive' - else: - return 'green' + write('%s' % '
    '.join(s)) + write('') + write('\n') # Write info about resistances. - resistances = [ - ("blade", "attacks/sword-human.png"), - ("pierce", "attacks/spear.png"), - ("impact", "attacks/club.png"), - ("fire", "attacks/fireball.png"), - ("cold", "attacks/iceball.png"), - ("arcane", "attacks/faerie-fire.png")] - - write("

    %s

    \n" % _("Resistances: ").strip(" :")) - write("\n") + write('

    %s

    \n' % _("Resistances: ").strip(" :")) + write('
    \n') write('') row = 0 - for rid, ricon in resistances: + for rid, ricon in RESISTANCES: special, resist_str = find_attr("resistance", rid) r = 100 if resist_str == '-' else 100 - int(resist_str) resist_classes = ['num'] @@ -1077,7 +1163,7 @@ class HTMLOutput: if resist_rating: resist_classes.append('rating-' + resist_rating) try: - resist_str = "%d%%" % r + resist_str = '%d%%' % r except ValueError: error_message("Warning: Invalid resistance %s for %s.\n" % ( r, uid)) @@ -1085,9 +1171,9 @@ class HTMLOutput: if special: rcell += ' class="special"' if row % 2 == 0: - write("\n") + write('\n') else: - write("") + write('') picname = image_collector.add_image(self.addon, ricon, no_tc=True) icon = os.path.join(PICS_LOCATION, picname) write('\n' % (icon, )) @@ -1095,7 +1181,7 @@ class HTMLOutput: if row % 2 == 1: write('\n') row += 1 - write("
    (icon)
    \n") + write('\n') # end left column write('
    ') @@ -1136,68 +1222,22 @@ class HTMLOutput: already = {} for tstring, t in list(terrains.items()): tid = t.get_text_val("id") - if tid in ["off_map", "off_map2", "fog", "shroud", "impassable", - "void", "rails"]: - continue - if t.get_all(att="aliasof"): - continue - if tid in already: + if tid in HIDDEN_TERRAINS or t.get_all(att="aliasof") or tid in already: continue already[tid] = 1 name = T(t, "name") ticon = t.get_text_val("symbol_image") if not ticon: ticon = t.get_text_val("icon_image") - # Use nice images for known mainline terrain types - if tid == "fungus": ticon = "forest/mushrooms-tile" - elif tid == "cave": ticon = "cave/floor6" - elif tid == "sand": ticon = "sand/beach" - elif tid == "reef": ticon = "water/reef-tropical-tile" - elif tid == "hills": ticon = "hills/regular" - elif tid == "swamp_water": ticon = "swamp/water-tile" - elif tid == "shallow_water": ticon = "water/coast-tile" - elif tid == "castle": ticon = "castle/castle-tile" - elif tid == "mountains": ticon = "mountains/snow-tile" - elif tid == "deep_water": ticon = "water/ocean-tile" - elif tid == "flat": ticon = "grass/green-symbol" - elif tid == "forest": ticon = "forest/pine-tile" - elif tid == "frozen": ticon = "frozen/ice" - elif tid == "village": ticon = "village/human-tile" - elif tid == "impassable": ticon = "void/void" - elif tid == "unwalkable": ticon = "unwalkable/lava" - elif tid == "rails": ticon = "misc/rails-ne-sw" - + if tid in TERRAIN_ICONS: + ticon = TERRAIN_ICONS[tid] if ticon: terrainlist.append((name, tid, ticon)) else: error_message("Terrain " + tid + " has no symbol_image\n") terrainlist.sort() - def defense_rating_color_class(defense): - # Logic from src/help/help_topic_generators.cpp @ 1.13.8+dev - if defense <= 10: - return 'red' - elif defense <= 30: - return 'yellow' - elif defense <= 50: - return 'olive' - else: - return 'green' - - def mvtcost_rating_color_class(str_mvtcost, str_moves): - cost = int_fallback(str_mvtcost, 99) - moves = int_fallback(str_moves) - # Logic from src/help/help_topic_generators.cpp @ 1.13.8+dev - if cost >= moves: - return 'gray' - elif cost > moves/2: - return 'red' - elif cost > 1: - return 'yellow' - else: - return 'green' - for tname, tid, ticon in terrainlist: not_from_race, move_cost = find_attr("movement_costs", tid) classes_cost = ['mvtcost'] @@ -1243,8 +1283,8 @@ class HTMLOutput: (cleantext(tname, quote=False), ' '.join(classes_cost), move_cost, ' '.join(classes_defense), defense)) - write("\n") - write("\n") + write('\n') + write('\n') write('') # right column @@ -1253,8 +1293,7 @@ class HTMLOutput: self.output.write(HTML_CLEAR_FLOATS) write('') # main - self.output.write(HTML_FOOTER % { - "generation_note": "Last updated on " + time.ctime() + "."}) + self.output.write(website_footer()) def generate_campaign_report(addon, isocode, campaign, wesnoth): @@ -1402,8 +1441,8 @@ def html_postprocess_file(filename, isocode, batchlist): f = open(filename, "r+b") html = f.read().decode("utf8") - html = html.replace("PLACE CAMPAIGNS HERE\n", chtml) - html = html.replace("PLACE ERAS HERE\n", ehtml) + html = html.replace(PRE_PLACEHOLDER_CAMPAIGNS, chtml) + html = html.replace(PRE_PLACEHOLDER_ERAS, ehtml) f.seek(0) f.write(html.encode("utf8")) f.close() diff --git a/data/tools/unit_tree/overview.py b/data/tools/unit_tree/overview.py index cb0a6cceea3..4657388c5f4 100755 --- a/data/tools/unit_tree/overview.py +++ b/data/tools/unit_tree/overview.py @@ -10,13 +10,12 @@ def write_addon_overview(folder, addon): name = addon["name"] - path = "../" title = html_output.cleantext("Build Report for " + name) generation_note = "Last updated on " + time.ctime() + "." - w(html_output.HTML_HEADER % locals()) - - w(html_output.TOP_BAR % locals()) + w(html_output.website_header(path="../", + title=title, + classes=["wmlunits-report"])) w('
    ') @@ -25,11 +24,11 @@ def write_addon_overview(folder, addon): w('

    ' + html_output.cleantext(name) + '

    ') if eras: - w("

    Eras

    ') campaigns = addon.get("campaigns", []) if campaigns: @@ -37,17 +36,17 @@ def write_addon_overview(folder, addon): for campaign in campaigns: cpath = os.path.join("en_US", campaign["id"] + ".html") w('
  • ' + html_output.cleantext(campaign["name"], quote=False) + '
    • ') - w("") + w('') - w("
    ") + w('
    ') if os.path.exists(os.path.join(folder, "error.log")): w('

    Warnings or errors were found: log

    ') w('

    Back to the full report

    ') - w("
    ") + w('
    ') w('
    ') - w(html_output.HTML_FOOTER % locals()) + w(html_output.website_footer()) def main(folder): @@ -55,14 +54,9 @@ def main(folder): def w(x): out.write(x + "\n") - path = "" - title = "Database Build Report" - generation_note = "generated on " + time.ctime() - classes = "wmlunits-report" - - w(html_output.HTML_HEADER % locals()) - - w(html_output.TOP_BAR % locals()) + w(html_output.website_header(path="", + title="Database Build Report", + classes=["wmlunits-report"])) w('

    Database Build Report

    ') @@ -126,7 +120,8 @@ def main(folder): return "" mo = re.match(".*--preprocess-defines(.*)", line) - if mo: return "Defines: " + mo.group(1) + "
    " + if mo: + return "Defines: " + mo.group(1) + '
    ' for s in source: line = line.replace(s, "WML") @@ -136,34 +131,34 @@ def main(folder): out = "" for row in rows: row = row.strip() - out += row + "
    " + out += row + '
    ' return out htmlerr = open(error_html, "w") - htmlerr.write("") + htmlerr.write('') lines_count = 0 for line in text.splitlines(): line = line.strip() if line in ["", "", "", ""]: - htmlerr.write("

    ") + htmlerr.write('

    ') elif line in ["", "", "", ""]: - htmlerr.write("

    ") + htmlerr.write('

    ') else: err_html = postprocess(line) - lines_count += err_html.count("") + htmlerr.write('') total_lines += lines_count total_error_logs += 1 w('%s (%d lines)' % (html_output.cleanurl(error_name), error_kind, lines_count)) - w("") + w('') count += 1 - w("") + w('') - w("") + w('') w('Total (for %d addons):' % count) w('' + str(total_n) + '') w('' + str(total_error_logs) + ' (' + str(total_lines) + ' lines)') @@ -173,7 +168,7 @@ def main(folder): w(' ') - w(html_output.HTML_FOOTER % locals()) + w(html_output.website_footer()) if __name__ == "__main__": main(sys.argv[1])