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     IconPalette = re.compile(r'^[^#]*IconPalette\s+"[^"]+"\s+"([^"]*)"')
  48     Toolbar = re.compile(r'^[^#]*Toolbar\s+"[^"]+"\s+"([^"]*)"')
  49     Item = re.compile(r'[^#]*Item\s+"([^"]*)"')
  50     TableInsert = re.compile(r'[^#]*TableInsert\s+"([^"]*)"')
  51     for src in input_files:
  52         input = open(src)
  53         for lineno, line in enumerate(input.readlines()):
  54             if Submenu.match(line):
  55                 (string,) = Submenu.match(line).groups()
  56                 string = string.replace('_', ' ')
  57             elif Popupmenu.match(line):
  58                 (string,) = Popupmenu.match(line).groups()
  59             elif IconPalette.match(line):
  60                 (string,) = IconPalette.match(line).groups()
  61             elif Toolbar.match(line):
  62                 (string,) = Toolbar.match(line).groups()
  63             elif Item.match(line):
  64                 (string,) = Item.match(line).groups()
  65             elif TableInsert.match(line):
  66                 (string,) = TableInsert.match(line).groups()
  67             else:
  68                 continue
  69             string = string.replace('"', '')
  70             if string != "":
  71                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
  72                     (relativePath(src, base), lineno+1, string)
  73         input.close()
  74     output.close()
  75
  76
  77 def layouts_l10n(input_files, output, base):
  78     '''Generate pot file from lib/layouts/*.{layout,inc,module}'''
  79     out = open(output, 'w')
  80     Style = re.compile(r'^Style\s+(.*)', re.IGNORECASE)
  81     # include ???LabelString???, but exclude comment lines
  82     LabelString = re.compile(r'^[^#]*LabelString\S*\s+(.*)')
  83     GuiName = re.compile(r'\s*GuiName\s+(.*)')
  84     ListName = re.compile(r'\s*ListName\s+(.*)')
  85     CategoryName = re.compile(r'\s*Category\s+(.*)')
  86     NameRE = re.compile(r'DeclareLyXModule.*{(.*)}')
  87     InsetLayout = re.compile(r'^InsetLayout\s+\"?(.*)\"?')
  88     FlexCheck = re.compile(r'^Flex:(.*)')
  89     DescBegin = re.compile(r'#+\s*DescriptionBegin\s*$')
  90     DescEnd = re.compile(r'#+\s*DescriptionEnd\s*$')
  91     Category = re.compile(r'#Category: (.*)$')
  92     I18nPreamble = re.compile(r'\s*(Lang)|(Babel)Preamble\s*$')
  93     EndI18nPreamble = re.compile(r'\s*End(Lang)|(Babel)Preamble\s*$')
  94     I18nString = re.compile(r'_\(([^\)]+)\)')
  95     CounterFormat = re.compile(r'\s*PrettyFormat\s+"?(.*)"?')
  96     CiteFormat = re.compile(r'\s*CiteFormat')
  97     KeyVal = re.compile(r'^\s*_\w+\s+(.*)$')
  98     End = re.compile(r'\s*End')
  99
 100     for src in input_files:
 101         readingDescription = False
 102         readingI18nPreamble = False
 103         readingCiteFormats = False
 104         descStartLine = -1
 105         descLines = []
 106         lineno = 0
 107         for line in open(src).readlines():
 108             lineno += 1
 109             if readingDescription:
 110                 res = DescEnd.search(line)
 111                 if res != None:
 112                     readingDescription = False
 113                     desc = " ".join(descLines)
 114                     writeString(out, src, base, lineno + 1, desc)
 115                     continue
 116                 descLines.append(line[1:].strip())
 117                 continue
 118             res = DescBegin.search(line)
 119             if res != None:
 120                 readingDescription = True
 121                 descStartLine = lineno
 122                 continue
 123             if readingI18nPreamble:
 124                 res = EndI18nPreamble.search(line)
 125                 if res != None:
 126                     readingI18nPreamble = False
 127                     continue
 128                 res = I18nString.search(line)
 129                 if res != None:
 130                     string = res.group(1)
 131                     writeString(out, src, base, lineno, string)
 132                 continue
 133             res = I18nPreamble.search(line)
 134             if res != None:
 135                 readingI18nPreamble = True
 136                 continue
 137             res = NameRE.search(line)
 138             if res != None:
 139                 string = res.group(1)
 140                 string = string.replace('\\', '\\\\').replace('"', '')
 141                 if string != "":
 142                     print >> out, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 143                         (relativePath(src, base), lineno + 1, string)
 144                 continue
 145             res = Style.search(line)
 146             if res != None:
 147                 string = res.group(1)
 148                 string = string.replace('_', ' ')
 149                 writeString(out, src, base, lineno, string)
 150                 continue
 151             res = LabelString.search(line)
 152             if res != None:
 153                 string = res.group(1)
 154                 writeString(out, src, base, lineno, string)
 155                 continue
 156             res = GuiName.search(line)
 157             if res != None:
 158                 string = res.group(1)
 159                 writeString(out, src, base, lineno, string)
 160                 continue
 161             res = CategoryName.search(line)
 162             if res != None:
 163                 string = res.group(1)
 164                 writeString(out, src, base, lineno, string)
 165                 continue
 166             res = ListName.search(line)
 167             if res != None:
 168                 string = res.group(1)
 169                 writeString(out, src, base, lineno, string)
 170                 continue
 171             res = InsetLayout.search(line)
 172             if res != None:
 173                 string = res.group(1)
 174                 string = string.replace('_', ' ')
 175                 writeString(out, src, base, lineno, string)
 176                 m = FlexCheck.search(string)
 177                 if m:
 178                   writeString(out, src, base, lineno, m.group(1))
 179                 continue
 180             res = Category.search(line)
 181             if res != None:
 182                 string = res.group(1)
 183                 writeString(out, src, base, lineno, string)
 184                 continue
 185             res = CounterFormat.search(line)
 186             if res != None:
 187                 string = res.group(1)
 188                 writeString(out, src, base, lineno, string)
 189                 continue
 190             res = CiteFormat.search(line)
 191             if res != None:
 192                 readingCiteFormats = True
 193             res = End.search(line)
 194             if res != None and readingCiteFormats:
 195                 readingCiteFormats = False
 196             if readingCiteFormats:
 197                 res = KeyVal.search(line)
 198                 if res != None:
 199                     val = res.group(1)
 200                     writeString(out, src, base, lineno, val)
 201
 202     out.close()
 203
 204
 205 def qt4_l10n(input_files, output, base):
 206     '''Generate pot file from src/frontends/qt4/ui/*.ui'''
 207     output = open(output, 'w')
 208     pat = re.compile(r'\s*<string>(.*)</string>')
 209     prop = re.compile(r'\s*<property.*name.*=.*shortcut')
 210     for src in input_files:
 211         input = open(src)
 212         skipNextLine = False
 213         for lineno, line in enumerate(input.readlines()):
 214             # skip the line after <property name=shortcut>
 215             if skipNextLine:
 216                 skipNextLine = False
 217                 continue
 218             if prop.match(line):
 219                 skipNextLine = True
 220                 continue
 221             # get lines that match <string>...</string>
 222             if pat.match(line):
 223                 (string,) = pat.match(line).groups()
 224                 string = string.replace('&amp;', '&').replace('&lt;', '<').replace('&gt;', '>')
 225                 string = string.replace('\\', '\\\\').replace('"', r'\"')
 226                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 227                     (relativePath(src, base), lineno+1, string)
 228         input.close()
 229     output.close()
 230
 231
 232 def languages_l10n(input_files, output, base):
 233     '''Generate pot file from lib/languages'''
 234     out = open(output, 'w')
 235     GuiName = re.compile(r'^[^#]*GuiName\s+(.*)')
 236
 237     for src in input_files:
 238         descStartLine = -1
 239         descLines = []
 240         lineno = 0
 241         for line in open(src).readlines():
 242             lineno += 1
 243             res = GuiName.search(line)
 244             if res != None:
 245                 string = res.group(1)
 246                 writeString(out, src, base, lineno, string)
 247                 continue
 248
 249     out.close()
 250
 251
 252 def external_l10n(input_files, output, base):
 253     '''Generate pot file from lib/external_templates'''
 254     output = open(output, 'w')
 255     Template = re.compile(r'^Template\s+(.*)')
 256     GuiName = re.compile(r'\s*GuiName\s+(.*)')
 257     HelpTextStart = re.compile(r'\s*HelpText\s')
 258     HelpTextSection = re.compile(r'\s*(\S.*)\s*$')
 259     HelpTextEnd = re.compile(r'\s*HelpTextEnd\s')
 260     i = -1
 261     for src in input_files:
 262         input = open(src)
 263         inHelp = False
 264         hadHelp = False
 265         prev_help_string = ''
 266         for lineno, line in enumerate(input.readlines()):
 267             if Template.match(line):
 268                 (string,) = Template.match(line).groups()
 269             elif GuiName.match(line):
 270                 (string,) = GuiName.match(line).groups()
 271             elif inHelp:
 272                 if HelpTextEnd.match(line):
 273                     if hadHelp:
 274                         print >> output, '\nmsgstr ""\n'
 275                     inHelp = False
 276                     hadHelp = False
 277                     prev_help_string = ''
 278                 elif HelpTextSection.match(line):
 279                     (help_string,) = HelpTextSection.match(line).groups()
 280                     help_string = help_string.replace('"', '')
 281                     if help_string != "" and prev_help_string == '':
 282                         print >> output, '#: %s:%d\nmsgid ""\n"%s\\n"' % \
 283                             (relativePath(src, base), lineno+1, help_string)
 284                         hadHelp = True
 285                     elif help_string != "":
 286                         print >> output, '"%s\\n"' % help_string
 287                     prev_help_string = help_string
 288             elif HelpTextStart.match(line):
 289                 inHelp = True
 290                 prev_help_string = ''
 291             else:
 292                 continue
 293             string = string.replace('"', '')
 294             if string != "" and not inHelp:
 295                 print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 296                     (relativePath(src, base), lineno+1, string)
 297         input.close()
 298     output.close()
 299
 300
 301 def formats_l10n(input_files, output, base):
 302     '''Generate pot file from configure.py'''
 303     output = open(output, 'w')
 304     GuiName = re.compile(r'.*\Format\s+\S+\s+\S+\s+"([^"]*)"\s+(\S*)\s+.*')
 305     GuiName2 = re.compile(r'.*\Format\s+\S+\s+\S+\s+([^"]\S+)\s+(\S*)\s+.*')
 306     input = open(input_files[0])
 307     for lineno, line in enumerate(input.readlines()):
 308         label = ""
 309         labelsc = ""
 310         if GuiName.match(line):
 311             label = GuiName.match(line).group(1)
 312             shortcut = GuiName.match(line).group(2).replace('"', '')
 313         elif GuiName2.match(line):
 314             label = GuiName2.match(line).group(1)
 315             shortcut = GuiName2.match(line).group(2).replace('"', '')
 316         else:
 317             continue
 318         label = label.replace('\\', '\\\\').replace('"', '')
 319         if shortcut != "":
 320             labelsc = label + "|" + shortcut
 321         if label != "":
 322             print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 323                 (relativePath(input_files[0], base), lineno+1, label)
 324         if labelsc != "":
 325             print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 326                 (relativePath(input_files[0], base), lineno+1, labelsc)
 327     input.close()
 328     output.close()
 329
 330
 331 def encodings_l10n(input_files, output, base):
 332     '''Generate pot file from lib/encodings'''
 333     output = open(output, 'w')
 334     # assuming only one encodings file
 335     #                 Encoding utf8      utf8    "Unicode (utf8)" UTF-8    variable inputenc
 336     reg = re.compile('Encoding [\w-]+\s+[\w-]+\s+"([\w \-\(\)]+)"\s+[\w-]+\s+(fixed|variable)\s+\w+.*')
 337     input = open(input_files[0])
 338     for lineno, line in enumerate(input.readlines()):
 339         if not line.startswith('Encoding'):
 340             continue
 341         if reg.match(line):
 342             print >> output, '#: %s:%d\nmsgid "%s"\nmsgstr ""\n' % \
 343                 (relativePath(input_files[0], base), lineno+1, reg.match(line).groups()[0])
 344         else:
 345             print "Error: Unable to handle line:"
 346             print line
 347             # No need to abort if the parsing fails
 348             # sys.exit(1)
 349     input.close()
 350     output.close()
 351
 352
 353
 354 Usage = '''
 355 lyx_pot.py [-b|--base top_src_dir] [-o|--output output_file] [-h|--help] [-s|src_file filename] -t|--type input_type input_files
 356
 357 where
 358     --base:
 359         path to the top source directory. default to '.'
 360     --output:
 361         output pot file, default to './lyx.pot'
 362     --src_file
 363         filename that contains a list of input files in each line
 364     --input_type can be
 365         ui: lib/ui/*
 366         layouts: lib/layouts/*
 367         qt4: qt4 ui files
 368         languages: file lib/languages
 369         encodings: file lib/encodings
 370         external: external templates file
 371         formats: formats predefined in lib/configure.py
 372 '''
 373
 374 if __name__ == '__main__':
 375     input_type = None
 376     output = 'lyx.pot'
 377     base = '.'
 378     input_files = []
 379     #
 380     optlist, args = getopt.getopt(sys.argv[1:], 'ht:o:b:s:',
 381         ['help', 'type=', 'output=', 'base=', 'src_file='])
 382     for (opt, value) in optlist:
 383         if opt in ['-h', '--help']:
 384             print Usage
 385             sys.exit(0)
 386         elif opt in ['-o', '--output']:
 387             output = value
 388         elif opt in ['-b', '--base']:
 389             base = value
 390         elif opt in ['-t', '--type']:
 391             input_type = value
 392         elif opt in ['-s', '--src_file']:
 393             input_files = [f.strip() for f in open(value)]
 394
 395     if input_type not in ['ui', 'layouts', 'modules', 'qt4', 'languages', 'encodings', 'external', 'formats'] or output is None:
 396         print 'Wrong input type or output filename.'
 397         sys.exit(1)
 398
 399     input_files += args
 400
 401     if input_type == 'ui':
 402         ui_l10n(input_files, output, base)
 403     elif input_type == 'layouts':
 404         layouts_l10n(input_files, output, base)
 405     elif input_type == 'qt4':
 406         qt4_l10n(input_files, output, base)
 407     elif input_type == 'external':
 408         external_l10n(input_files, output, base)
 409     elif input_type == 'formats':
 410         formats_l10n(input_files, output, base)
 411     elif input_type == 'encodings':
 412         encodings_l10n(input_files, output, base)
 413     else:
 414         languages_l10n(input_files, output, base)
 415
 416