Merge lp:~miroslavr256/widelands/buildcat-fixes into lp:widelands

[Miroslav Remák]

Lua files that fall under "widelands" or "widelands_console" POTs were handled differently than the rest, being parsed with xgettext options meant for C++ files. As a result, comments for translators and ngettext/pgettext/... weren't detected properly in those files.

This merge request unites 'do_compile' and 'do_compile_src' functions and also improves error handling a bit - in case something unexpected happens, merge_and_push_translations.sh shouldn't proceed with the push.

Note that as a side effect of these changes, widelands.pot and widelands_console.pot will have different headers (consistent with others). Please let me know if that's a problem.

[Miroslav Remák (miroslavr256)]

Also, are merge commits acceptable in merge requests? I am not very experienced in working with bazaar.

[GunChleoc (gunchleoc)]

I don't know what you ean by merge commits - we merge trunk into branches all the time if that is what you mean.

Changing the headers is not a problem. I'll try to have a look at the code next week :)

[Miroslav Remák (miroslavr256)]

> I don't know what you ean by merge commits - we merge trunk into branches all
> the time if that is what you mean.

Yes, that's exactly what I mean. No problem then.

[bunnybot (widelandsofficial)]

Bunnybot encountered an error while working on this merge proposal:

Running 'git pull' failed. Output:

fatal: object not found: cf1471b01c8dcf30925cc7beaa6697fd8349247e
fast-import: dumping crash report to .git/fast_import_crash_12690
fatal: Error while running fast-import

[bunnybot (widelandsofficial)]

Bunnybot encountered an error while working on this merge proposal:

Running 'git fetch bzr_origin' failed. Output:

fatal: 'bzr_origin' does not appear to be a git repository
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

[GunChleoc (gunchleoc)]

Definitely an improvement, thanks!

@bunnybot merge

=== modified file 'utils/buildcat.py'
--- utils/buildcat.py	2016-03-01 09:33:26 +0000
+++ utils/buildcat.py	2016-03-04 17:15:24 +0000
@@ -140,7 +140,7 @@
 LUAXGETTEXTOPTS+=" --language=Lua --from-code=UTF-8 -F -c\" TRANSLATORS:\""
 
 time_now = gmtime()
-# This is the header used for Lua+conf potfiles.
+# This is the header used for POT files.
 # Set it to something sensible, as much as is possible here.
 HEAD =  "# Widelands PATH/TO/FILE.PO\n"
 HEAD += "# Copyright (C) 2005-" + strftime("%Y", time_now) + " Widelands Development Team\n"
@@ -159,6 +159,9 @@
 HEAD += "\"Content-Transfer-Encoding: 8bit\\n\"\n"
 HEAD += "\n"
 
+class BuildcatError(Exception):
+    pass
+
 def are_we_in_root_directory():
     """Make sure we are called in the root directory"""
     if (not os.path.isdir("po")):
@@ -169,14 +172,14 @@
         sys.exit(1)
 
 
-def do_makedirs( dirs ):
+def do_makedirs(dirs):
     """Create subdirectories. Ignore errors"""
     try:
         os.makedirs( dirs )
     except:
         pass
 
-def pot_modify_header( potfile_in, potfile_out, header ):
+def pot_modify_header(potfile_in, potfile_out, header):
     """
     Modify the header of a translation catalog read from potfile_in to
     the given header and write out the modified catalog to potfile_out.
@@ -224,17 +227,29 @@
             potout.writelines(potin)
 
         return True
+    
+def run_xgettext(infiles, outfile, opts):
+    xgettext = subprocess.Popen("xgettext %s --files-from=- --output=\"%s\"" % \
+        (opts, outfile), shell=True, stdin=subprocess.PIPE, universal_newlines=True)
+    try:
+        for fname in infiles:
+            xgettext.stdin.write(os.path.normpath(fname) + "\n")
+        xgettext.stdin.close()
+    except IOError as err_msg:
+        raise BuildcatError("Failed to call xgettext: %s" % err_msg)
+
+    xgettext_status = xgettext.wait()
+    if (xgettext_status != 0):
+        raise BuildcatError("xgettext exited with errorcode %i" % xgettext_status)    
 
 def run_msguniq(potfile):
     msguniq_rv = os.system("msguniq \"%s\" -F --output-file=\"%s\"" % (potfile, potfile))
     if (msguniq_rv):
-        sys.stderr.write("msguniq exited with errorcode %i\n" % msguniq_rv)
-        return False
-    return True
+        raise BuildcatError("msguniq exited with errorcode %i" % msguniq_rv)
 
-def do_compile( potfile, srcfiles ):
+def do_compile(potfile, srcfiles):
     """
-    Search Lua and conf files given in srcfiles for translatable strings.
+    Search C++, Lua and conf files given in srcfiles for translatable strings.
     Merge the results and write out the corresponding pot file.
     """
     files = []
@@ -242,29 +257,24 @@
         files += glob(i)
     files = set(files)
 
+    cpp_files = set([ f for f in files if
+        os.path.splitext(f)[-1].lower() == '.cc' or os.path.splitext(f)[-1].lower() == '.h'])
     lua_files = set([ f for f in files if
         os.path.splitext(f)[-1].lower() == '.lua' ])
-    conf_files = files - lua_files
+    conf_files = files - cpp_files - lua_files
 
     temp_potfile = potfile + ".tmp"
-
-    if (os.path.exists(temp_potfile)): os.remove(temp_potfile)
-
-    # Find translatable strings in Lua files using xgettext
-    xgettext = subprocess.Popen("xgettext %s --files-from=- --output=\"%s\"" % \
-        (LUAXGETTEXTOPTS, temp_potfile), shell=True, stdin=subprocess.PIPE, universal_newlines=True)
-    try:
-        for fname in lua_files:
-            xgettext.stdin.write(os.path.normpath(fname) + "\n")
-        xgettext.stdin.close()
-    except IOError as err_msg:
-        sys.stderr.write("Failed to call xgettext: %s\n" % err_msg)
-        return False
-
-    xgettext_status = xgettext.wait()
-    if (xgettext_status != 0):
-        sys.stderr.write("xgettext exited with errorcode %i\n" % xgettext_status)
-        return False
+    if (os.path.exists(temp_potfile)):
+        os.remove(temp_potfile)
+
+    # Find translatable strings in C++ and Lua files using xgettext
+    if len(cpp_files) > 0:
+        run_xgettext(cpp_files, temp_potfile, XGETTEXTOPTS)
+    if len(lua_files) > 0:
+        if os.path.exists(temp_potfile):
+            run_xgettext(lua_files, temp_potfile, LUAXGETTEXTOPTS + " --join-existing")
+        else:
+            run_xgettext(lua_files, temp_potfile, LUAXGETTEXTOPTS)
 
     xgettext_found_something_to_translate = os.path.exists(temp_potfile)
 
@@ -281,50 +291,20 @@
         os.remove(temp_potfile)
 
         if not header_fixed:
-            return False
+            raise BuildcatError("Failed to fix header.")
 
         if (conf.found_something_to_translate):
-            # Merge the conf POT with Lua POT
+            # Merge the conf POT with C++/Lua POT
             with open(potfile, "at") as p:
                 p.write("\n" + conf.toString())
 
-            if not run_msguniq(potfile):
-                return False
+            run_msguniq(potfile)
     elif (conf.found_something_to_translate):
         with open(potfile, "wt") as p:
             p.write(HEAD + conf.toString())
 
         # Msguniq is run here only to sort POT entries by file
-        if not run_msguniq(potfile):
-            return False
-
-    return True
-
-
-
-def do_compile_src( potfile, srcfiles ):
-    """
-    Use xgettext for parse the given C++ files in srcfiles. Merge the results
-    and write out the given potfile
-    """
-    # call xgettext and supply source filenames via stdin
-    xgettext = subprocess.Popen("xgettext %s --files-from=- --output=%s" % \
-            (XGETTEXTOPTS, potfile), shell=True, stdin=subprocess.PIPE, universal_newlines=True)
-    try:
-        for one_pattern in srcfiles:
-            # 'normpath' is necessary for windows ('/' vs. '\')
-            # 'glob' handles filename wildcards
-            for one_file in glob(os.path.normpath(one_pattern)):
-                xgettext.stdin.write(one_file + "\n")
-        xgettext.stdin.close()
-    except IOError as err_msg:
-        sys.stderr.write("Failed to call xgettext: %s\n" % err_msg)
-        return False
-
-    xgettext_status = xgettext.wait()
-    if (xgettext_status != 0):
-        sys.stderr.write("xgettext exited with errorcode %i\n" % xgettext_status)
-        return False
+        run_msguniq(potfile)
 
     return True
 
@@ -375,11 +355,7 @@
             oldcwd = os.getcwd()
             os.chdir(path)
             potfile = os.path.basename(pot) + '.pot'
-            if pot.startswith('widelands'):
-                # This catalogs can be built with xgettext
-                succ = do_compile_src(potfile , srcfiles )
-            else:
-                succ = do_compile(potfile, srcfiles)
+            succ = do_compile(potfile, srcfiles)
 
             os.chdir(oldcwd)
 
@@ -480,6 +456,10 @@
     are_we_in_root_directory()
 
     # Make sure .pot files are up to date.
-    do_update_potfiles()
+    try:
+        do_update_potfiles()
+    except BuildcatError as err_msg:
+        sys.stderr.write("Error: %s\n" % err_msg);
+        sys.exit(1)
 
     print("")