po/lyx_pot.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 # file lyx_pot.py
   5 # This file is part of LyX, the document processor.
   6 # Licence details can be found in the file COPYING.
   7 #
   8 # \author Bo Peng
   9 #
  10 # Full author contact details are available in file CREDITS
  11
  12 # Usage: use
  13 #     lyx_pot.py -h
  14 # to get usage message
  15
  16 # This script will extract translatable strings from input files and write
  17 # to output in gettext .pot format.
  18 #
  19 import sys, os, re, getopt
  20
  21 def relativePath(path, base):
  22     '''return relative path from top source dir'''
  23     # full pathname of path
  24     path1 = os.path.normpath(os.path.realpath(path)).split(os.sep)
  25     path2 = os.path.normpath(os.path.realpath(base)).split(os.sep)
  26     if path1[:len(path2)] != path2:
  27         print "Path %s is not under top source directory" % path
  28     path3 = os.path.join(*path1[len(path2):]);
  29     # replace all \ by / such that we get the same comments on Windows and *nix
  30     path3 = path3.replace('\\', '/')
  31     return path3
  32
  33
  34 def writeString(outfile, infile, basefile, lineno, string):
  35     string = string.replace('\\', '\\\\').replace('"', '')
  36     if string == "":
  37         return
  38     print >> outfile, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
  39         (relativePath(infile, basefile), lineno, string)
  40
  41
  42 def ui_l10n(input_files, output, base):
  43     '''Generate pot file from lib/ui/*'''
  44     output = open(output, 'w')
  45     Submenu = re.compile(r'^[^#]*Submenu\s+"([^"]*)"')
  46     Popupmenu = re.compile(r'^[^#]*PopupMenu\s+"[^"]+"\s+"([^"]*)"')
  47     Toolbar = re.compile(r'^[^#]*Toolbar\s+"[^"]+"\s+"([^"]*)"')
  48     Item = re.compile(r'[^#]*Item\s+"([^"]*)"')
  49     TableInsert = re.compile(r'[^#]*TableInsert\s+"([^"]*)"')
  50     for src in input_files:
  51         input = open(src)
  52         for lineno, line in enumerate(input.readlines()):
  53             if Submenu.match(line):
  54                 (string,) = Submenu.match(line).groups()
  55                 string = string.replace('_', ' ')
  56             elif Popupmenu.match(line):
  57                 (string,) = Popupmenu.match(line).groups()
  58             elif Toolbar.match(line):
  59                 (string,) = Toolbar.match(line).groups()
  60             elif Item.match(line):
  61                 (string,) = Item.match(line).groups()
  62             elif TableInsert.match(line):
  63                 (string,) = TableInsert.match(line).groups()
  64             else:
  65                 continue
  66             string = string.replace('"', '')
  67             if string != "":
  68                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
  69                     (relativePath(src, base), lineno+1, string)
  70         input.close()
  71     output.close()
  72
  73
  74 def layouts_l10n(input_files, output, base):
  75     '''Generate pot file from lib/layouts/*.{layout,inc,module}'''
  76     out = open(output, 'w')
  77     Style = re.compile(r'^Style\s+(.*)')
  78     # include ???LabelString???, but exclude comment lines
  79     LabelString = re.compile(r'^[^#]*LabelString\S*\s+(.*)')
  80     GuiName = re.compile(r'\s*GuiName\s+(.*)')
  81     ListName = re.compile(r'\s*ListName\s+(.*)')
  82     CategoryName = re.compile(r'\s*Category\s+(.*)')
  83     NameRE = re.compile(r'DeclareLyXModule.*{(.*)}')
  84     DescBegin = re.compile(r'#+\s*DescriptionBegin\s*$')
  85     DescEnd = re.compile(r'#+\s*DescriptionEnd\s*$')
  86
  87     for src in input_files:
  88         readingDescription = False
  89         descStartLine = -1
  90         descLines = []
  91         lineno = 0
  92         for line in open(src).readlines():
  93             lineno += 1
  94             if readingDescription:
  95                 res = DescEnd.search(line)
  96                 if res != None:
  97                     readingDescription = False
  98                     desc = " ".join(descLines)
  99                     writeString(out, src, base, lineno + 1, desc)
 100                     continue
 101                 descLines.append(line[1:].strip())
 102                 continue
 103             res = DescBegin.search(line)
 104             if res != None:
 105                 readingDescription = True
 106                 descStartLine = lineno
 107                 continue
 108             res = NameRE.search(line)
 109             if res != None:
 110                 string = res.group(1)
 111                 string = string.replace('\\', '\\\\').replace('"', '')
 112                 if string != "":
 113                     print >> out, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 114                         (relativePath(src, base), lineno + 1, string)
 115                 continue
 116             res = Style.search(line)
 117             if res != None:
 118                 string = res.group(1)
 119                 string = string.replace('_', ' ')
 120                 writeString(out, src, base, lineno, string)
 121                 continue
 122             res = LabelString.search(line)
 123             if res != None:
 124                 string = res.group(1)
 125                 writeString(out, src, base, lineno, string)
 126                 continue
 127             res = GuiName.search(line)
 128             if res != None:
 129                 string = res.group(1)
 130                 writeString(out, src, base, lineno, string)
 131                 continue
 132             res = CategoryName.search(line)
 133             if res != None:
 134                 string = res.group(1)
 135                 writeString(out, src, base, lineno, string)
 136                 continue
 137             res = ListName.search(line)
 138             if res != None:
 139                 string = res.group(1)
 140                 writeString(out, src, base, lineno, string)
 141                 continue
 142     out.close()
 143
 144
 145 def qt4_l10n(input_files, output, base):
 146     '''Generate pot file from src/frontends/qt4/ui/*.ui'''
 147     output = open(output, 'w')
 148     pat = re.compile(r'\s*<string>(.*)</string>')
 149     prop = re.compile(r'\s*<property.*name.*=.*shortcut')
 150     for src in input_files:
 151         input = open(src)
 152         skipNextLine = False
 153         for lineno, line in enumerate(input.readlines()):
 154             # skip the line after <property name=shortcut>
 155             if skipNextLine:
 156                 skipNextLine = False
 157                 continue
 158             if prop.match(line):
 159                 skipNextLine = True
 160                 continue
 161             # get lines that match <string>...</string>
 162             if pat.match(line):
 163                 (string,) = pat.match(line).groups()
 164                 string = string.replace('&amp;', '&').replace('&lt;', '<').replace('&gt;', '>').replace('"', r'\"')
 165                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 166                     (relativePath(src, base), lineno+1, string)
 167         input.close()
 168     output.close()
 169
 170
 171 def languages_l10n(input_files, output, base):
 172     '''Generate pot file from lib/language'''
 173     output = open(output, 'w')
 174     # assuming only one language file
 175     reg = re.compile('[\w-]+\s+[\w"]+\s+"([\w \-\(\)]+)"\s+(true|false)\s+[\w-]+\s+\w+\s+"[^"]*"')
 176     input = open(input_files[0])
 177     for lineno, line in enumerate(input.readlines()):
 178         if line[0] == '#':
 179             continue
 180         # From:
 181         #   afrikaans   afrikaans       "Afrikaans"     false  iso8859-15 af_ZA  ""
 182         # To:
 183         #   #: lib/languages:2
 184         #   msgid "Afrikaans"
 185         #   msgstr ""
 186         if reg.match(line):
 187             print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 188                 (relativePath(input_files[0], base), lineno+1, reg.match(line).groups()[0])
 189         else:
 190             print "Error: Unable to handle line:"
 191             print line
 192             # No need to abort if the parsing fails (e.g. "ignore" language has no encoding)
 193             # sys.exit(1)
 194     input.close()
 195     output.close()
 196
 197
 198 def external_l10n(input_files, output, base):
 199     '''Generate pot file from lib/external_templates'''
 200     output = open(output, 'w')
 201     Template = re.compile(r'^Template\s+(.*)')
 202     GuiName = re.compile(r'\s*GuiName\s+(.*)')
 203     HelpTextStart = re.compile(r'\s*HelpText\s')
 204     HelpTextSection = re.compile(r'\s*(\S.*)\s*$')
 205     HelpTextEnd = re.compile(r'\s*HelpTextEnd\s')
 206     i = -1
 207     for src in input_files:
 208         input = open(src)
 209         inHelp = False
 210         hadHelp = False
 211         prev_help_string = ''
 212         for lineno, line in enumerate(input.readlines()):
 213             if Template.match(line):
 214                 (string,) = Template.match(line).groups()
 215             elif GuiName.match(line):
 216                 (string,) = GuiName.match(line).groups()
 217             elif inHelp:
 218                 if HelpTextEnd.match(line):
 219                     if hadHelp:
 220                         print >> output, '\nmsgstr ""\n'
 221                     inHelp = False
 222                     hadHelp = False
 223                     prev_help_string = ''
 224                 elif HelpTextSection.match(line):
 225                     (help_string,) = HelpTextSection.match(line).groups()
 226                     help_string = help_string.replace('"', '')
 227                     if help_string != "" and prev_help_string == '':
 228                         print >> output, '#: %s:%d\nmsgid ""\n"%s\\n"' % \
 229                             (relativePath(src, base), lineno+1, help_string)
 230                         hadHelp = True
 231                     elif help_string != "":
 232                         print >> output, '"%s\\n"' % help_string
 233                     prev_help_string = help_string
 234             elif HelpTextStart.match(line):
 235                 inHelp = True
 236                 prev_help_string = ''
 237             else:
 238                 continue
 239             string = string.replace('"', '')
 240             if string != "" and not inHelp:
 241                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 242                     (relativePath(src, base), lineno+1, string)
 243         input.close()
 244     output.close()
 245
 246
 247 Usage = '''
 248 lyx_pot.py [-b|--base top_src_dir] [-o|--output output_file] [-h|--help] -t|--type input_type input_files
 249
 250 where
 251     --base:
 252         path to the top source directory. default to '.'
 253     --output:
 254         output pot file, default to './lyx.pot'
 255     --input_type can be
 256         ui: lib/ui/*
 257         layouts: lib/layouts/*
 258         qt4: qt4 ui files
 259         languages: file lib/languages
 260         external: external templates file
 261 '''
 262
 263 if __name__ == '__main__':
 264     input_type = None
 265     output = 'lyx.pot'
 266     base = '.'
 267     #
 268     optlist, args = getopt.getopt(sys.argv[1:], 'ht:o:b:',
 269         ['help', 'type=', 'output=', 'base='])
 270     for (opt, value) in optlist:
 271         if opt in ['-h', '--help']:
 272             print Usage
 273             sys.exit(0)
 274         elif opt in ['-o', '--output']:
 275             output = value
 276         elif opt in ['-b', '--base']:
 277             base = value
 278         elif opt in ['-t', '--type']:
 279             input_type = value
 280     if input_type not in ['ui', 'layouts', 'modules', 'qt4', 'languages', 'external'] or output is None:
 281         print 'Wrong input type or output filename.'
 282         sys.exit(1)
 283     if input_type == 'ui':
 284         ui_l10n(args, output, base)
 285     elif input_type == 'layouts':
 286         layouts_l10n(args, output, base)
 287     elif input_type == 'qt4':
 288         qt4_l10n(args, output, base)
 289     elif input_type == 'external':
 290         external_l10n(args, output, base)
 291     else:
 292         languages_l10n(args, output, base)
 293