lib/configure.py

   1 #! /usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 #
   4 # file configure.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 # Full author contact details are available in file CREDITS.
  10
  11 import glob, logging, os, re, shutil, subprocess, sys
  12
  13 # set up logging
  14 logging.basicConfig(level = logging.DEBUG,
  15     format = '%(levelname)s: %(message)s', # ignore application name
  16     filename = 'configure.log',
  17     filemode = 'w')
  18 #
  19 # Add a handler to log to console
  20 console = logging.StreamHandler()
  21 console.setLevel(logging.INFO) # the console only print out general information
  22 formatter = logging.Formatter('%(message)s') # only print out the message itself
  23 console.setFormatter(formatter)
  24 logger = logging.getLogger('LyX')
  25 logger.addHandler(console)
  26
  27 def writeToFile(filename, lines, append = False):
  28     " utility function: write or append lines to filename "
  29     if append:
  30         file = open(filename, 'a')
  31     else:
  32         file = open(filename, 'w')
  33     file.write(lines)
  34     file.close()
  35
  36
  37 def addToRC(lines):
  38     ''' utility function: shortcut for appending lines to outfile
  39         add newline at the end of lines.
  40     '''
  41     if lines.strip() != '':
  42         writeToFile(outfile, lines + '\n', append = True)
  43         logger.debug('Add to RC:\n' + lines + '\n\n')
  44
  45
  46 def removeFiles(filenames):
  47     '''utility function: 'rm -f'
  48         ignore errors when file does not exist, or is a directory.
  49     '''
  50     for file in filenames:
  51         try:
  52             os.remove(file)
  53             logger.debug('Removing file %s' % file)
  54         except:
  55             logger.debug('Failed to remove file %s' % file)
  56             pass
  57
  58
  59 def cmdOutput(cmd, async = False):
  60     '''utility function: run a command and get its output as a string
  61         cmd: command to run
  62         async: if False, return whole output as a string, otherwise
  63                return the stdout handle from which the output can be
  64                read (the caller is then responsible for closing it)
  65     '''
  66     if os.name == 'nt':
  67         b = False
  68         cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
  69     else:
  70         b = True
  71     pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
  72                             stdout=subprocess.PIPE, universal_newlines=True)
  73     pipe.stdin.close()
  74     if async:
  75         return pipe.stdout
  76     output = pipe.stdout.read()
  77     pipe.stdout.close()
  78     return output.strip()
  79
  80
  81 def shortPath(path):
  82     ''' On Windows, return the short version of "path" if possible '''
  83     if os.name == 'nt':
  84         from ctypes import windll, create_unicode_buffer
  85         GetShortPathName = windll.kernel32.GetShortPathNameW
  86         shortlen = GetShortPathName(path, 0, 0)
  87         shortpath = create_unicode_buffer(shortlen)
  88         if GetShortPathName(path, shortpath, shortlen):
  89             return shortpath.value
  90     return path
  91
  92
  93 def setEnviron():
  94     ''' I do not really know why this is useful, but we might as well keep it.
  95         NLS nuisances.
  96         Only set these to C if already set.  These must not be set unconditionally
  97         because not all systems understand e.g. LANG=C (notably SCO).
  98         Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
  99         Non-C LC_CTYPE values break the ctype check.
 100     '''
 101     os.environ['LANG'] = os.getenv('LANG', 'C')
 102     os.environ['LC'] = os.getenv('LC_ALL', 'C')
 103     os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
 104     os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
 105
 106
 107 def createDirectories():
 108     ''' Create the build directories if necessary '''
 109     for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
 110         'layouts', 'scripts', 'templates', 'ui' ]:
 111         if not os.path.isdir( dir ):
 112             try:
 113                 os.mkdir( dir)
 114                 logger.debug('Create directory %s.' % dir)
 115             except:
 116                 logger.error('Failed to create directory %s.' % dir)
 117                 sys.exit(1)
 118
 119
 120 def checkTeXPaths():
 121     ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
 122     windows_style_tex_paths = ''
 123     if LATEX == '':
 124         return windows_style_tex_paths
 125     if os.name == 'nt' or sys.platform == 'cygwin':
 126         from tempfile import mkstemp
 127         fd, tmpfname = mkstemp(suffix='.ltx')
 128         if os.name == 'nt':
 129             from locale import getdefaultlocale
 130             language, encoding = getdefaultlocale()
 131             if encoding == None:
 132                 encoding = 'latin1'
 133             inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
 134         else:
 135             inpname = cmdOutput('cygpath -m ' + tmpfname)
 136         logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
 137         inpname = inpname.replace('~', '\\string~')
 138         os.write(fd, r'\relax')
 139         os.close(fd)
 140         latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
 141         if 'Error' in latex_out:
 142             latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
 143         if 'Error' in latex_out:
 144             logger.warning("configure: TeX engine needs posix-style paths in latex files")
 145             windows_style_tex_paths = 'false'
 146         else:
 147             logger.info("configure: TeX engine needs windows-style paths in latex files")
 148             windows_style_tex_paths = 'true'
 149         removeFiles([tmpfname, logname, 'texput.log'])
 150     return windows_style_tex_paths
 151
 152
 153 ## Searching some useful programs
 154 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
 155     '''
 156         This function will search a program in $PATH plus given path
 157         If found, return directory and program name (not the options).
 158
 159         description: description of the program
 160
 161         progs: check programs, for each prog, the first word is used
 162             for searching but the whole string is used to replace
 163             %% for a rc_entry. So, feel free to add '$$i' etc for programs.
 164
 165         path: additional pathes
 166
 167         rc_entry: entry to outfile, can be
 168             1. emtpy: no rc entry will be added
 169             2. one pattern: %% will be replaced by the first found program,
 170                 or '' if no program is found.
 171             3. several patterns for each prog and not_found. This is used
 172                 when different programs have different usages. If you do not
 173                 want not_found entry to be added to the RC file, you can specify
 174                 an entry for each prog and use '' for the not_found entry.
 175
 176         not_found: the value that should be used instead of '' if no program
 177             was found
 178
 179     '''
 180     # one rc entry for each progs plus not_found entry
 181     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 182         logger.error("rc entry should have one item or item for each prog and not_found.")
 183         sys.exit(2)
 184     logger.info('checking for ' + description + '...')
 185     ## print '(' + ','.join(progs) + ')',
 186     global java, perl
 187     for idx in range(len(progs)):
 188         # ac_prog may have options, ac_word is the command name
 189         ac_prog = progs[idx]
 190         ac_word = ac_prog.split(' ')[0]
 191         if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
 192             continue
 193         if ac_word.endswith('.pl') and perl == '':
 194             continue
 195         msg = '+checking for "' + ac_word + '"... '
 196         path = os.environ["PATH"].split(os.pathsep) + path
 197         extlist = ['']
 198         if "PATHEXT" in os.environ:
 199             extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 200         for ac_dir in path:
 201             for ext in extlist:
 202                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 203                     logger.info(msg + ' yes')
 204                     # deal with java and perl
 205                     if ac_word.endswith('.class'):
 206                         ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
 207                     elif ac_word.endswith('.jar'):
 208                         ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
 209                     elif ac_word.endswith('.pl'):
 210                         ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
 211                     # write rc entries for this command
 212                     if len(rc_entry) == 1:
 213                         addToRC(rc_entry[0].replace('%%', ac_prog))
 214                     elif len(rc_entry) > 1:
 215                         addToRC(rc_entry[idx].replace('%%', ac_prog))
 216                     return [ac_dir, ac_word]
 217         # if not successful
 218         logger.info(msg + ' no')
 219     # write rc entries for 'not found'
 220     if len(rc_entry) > 0:  # the last one.
 221         addToRC(rc_entry[-1].replace('%%', not_found))
 222     return ['', not_found]
 223
 224
 225 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
 226     '''
 227         The same as checkProg, but additionally, all found programs will be added
 228         as alt_rc_entries
 229     '''
 230     # one rc entry for each progs plus not_found entry
 231     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 232         logger.error("rc entry should have one item or item for each prog and not_found.")
 233         sys.exit(2)
 234     logger.info('checking for ' + description + '...')
 235     ## print '(' + ','.join(progs) + ')',
 236     found_prime = False
 237     real_ac_dir = ''
 238     real_ac_word = not_found
 239     global java, perl
 240     for idx in range(len(progs)):
 241         # ac_prog may have options, ac_word is the command name
 242         ac_prog = progs[idx]
 243         ac_word = ac_prog.split(' ')[0]
 244         if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
 245             continue
 246         if ac_word.endswith('.pl') and perl == '':
 247             continue
 248         msg = '+checking for "' + ac_word + '"... '
 249         path = os.environ["PATH"].split(os.pathsep) + path
 250         extlist = ['']
 251         if "PATHEXT" in os.environ:
 252             extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
 253         found_alt = False
 254         for ac_dir in path:
 255             for ext in extlist:
 256                 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
 257                     logger.info(msg + ' yes')
 258                     pr = re.compile(r'(\\\S+)(.*)$')
 259                     m = None
 260                     # deal with java and perl
 261                     if ac_word.endswith('.class'):
 262                         ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
 263                     elif ac_word.endswith('.jar'):
 264                         ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
 265                     elif ac_word.endswith('.pl'):
 266                         ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
 267                     # write rc entries for this command
 268                     if found_prime == False:
 269                         if len(rc_entry) == 1:
 270                             addToRC(rc_entry[0].replace('%%', ac_prog))
 271                         elif len(rc_entry) > 1:
 272                             addToRC(rc_entry[idx].replace('%%', ac_prog))
 273                         real_ac_dir = ac_dir
 274                         real_ac_word = ac_word
 275                         found_prime = True
 276                     if len(alt_rc_entry) == 1:
 277                         alt_rc = alt_rc_entry[0]
 278                         if alt_rc == "":
 279                             # if no explicit alt_rc is given, construct one
 280                             m = pr.match(rc_entry[0])
 281                             if m:
 282                                 alt_rc = m.group(1) + "_alternatives" + m.group(2)
 283                         addToRC(alt_rc.replace('%%', ac_prog))
 284                     elif len(alt_rc_entry) > 1:
 285                         alt_rc = alt_rc_entry[idx]
 286                         if alt_rc == "":
 287                             # if no explicit alt_rc is given, construct one
 288                             m = pr.match(rc_entry[idx])
 289                             if m:
 290                                 alt_rc = m.group(1) + "_alternatives" + m.group(2)
 291                         addToRC(alt_rc.replace('%%', ac_prog))
 292                     found_alt = True
 293                     break
 294             if found_alt:
 295                 break
 296         if found_alt == False:
 297             # if not successful
 298             logger.info(msg + ' no')
 299     if found_prime:
 300         return [real_ac_dir, real_ac_word]
 301     # write rc entries for 'not found'
 302     if len(rc_entry) > 0:  # the last one.
 303         addToRC(rc_entry[-1].replace('%%', not_found))
 304     return ['', not_found]
 305
 306
 307 def addAlternatives(rcs, alt_type):
 308     '''
 309         Returns a \\prog_alternatives string to be used as an alternative
 310         rc entry.  alt_type can be a string or a list of strings.
 311     '''
 312     r = re.compile(r'\\Format (\S+).*$')
 313     m = None
 314     alt = ''
 315     alt_token = '\\%s_alternatives '
 316     if isinstance(alt_type, str):
 317         alt_tokens = [alt_token % alt_type]
 318     else:
 319         alt_tokens = map(lambda s: alt_token % s, alt_type)
 320     for idxx in range(len(rcs)):
 321         if len(rcs) == 1:
 322             m = r.match(rcs[0])
 323             if m:
 324                 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
 325         elif len(rcs) > 1:
 326             m = r.match(rcs[idxx])
 327             if m:
 328                 if idxx > 0:
 329                     alt += '\n'
 330                 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
 331     return alt
 332
 333
 334 def listAlternatives(progs, alt_type, rc_entry = []):
 335     '''
 336         Returns a list of \\prog_alternatives strings to be used as alternative
 337         rc entries.  alt_type can be a string or a list of strings.
 338     '''
 339     if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
 340         logger.error("rc entry should have one item or item for each prog and not_found.")
 341         sys.exit(2)
 342     alt_rc_entry = []
 343     for idx in range(len(progs)):
 344         if len(rc_entry) == 1:
 345             rcs = rc_entry[0].split('\n')
 346             alt = addAlternatives(rcs, alt_type)
 347             alt_rc_entry.insert(0, alt)
 348         elif len(rc_entry) > 1:
 349             rcs = rc_entry[idx].split('\n')
 350             alt = addAlternatives(rcs, alt_type)
 351             alt_rc_entry.insert(idx, alt)
 352     return alt_rc_entry
 353
 354
 355 def checkViewer(description, progs, rc_entry = [], path = []):
 356     ''' The same as checkProgAlternatives, but for viewers '''
 357     alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
 358     return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
 359
 360
 361 def checkEditor(description, progs, rc_entry = [], path = []):
 362     ''' The same as checkProgAlternatives, but for editors '''
 363     alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
 364     return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
 365
 366
 367 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
 368     ''' The same as checkViewer, but do not add rc entry '''
 369     alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
 370     rc_entry = []
 371     return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
 372
 373
 374 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
 375     ''' The same as checkViewer, but do not add rc entry '''
 376     alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
 377     rc_entry = []
 378     return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
 379
 380
 381 def checkViewerEditor(description, progs, rc_entry = [], path = []):
 382     ''' The same as checkProgAlternatives, but for viewers and editors '''
 383     alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
 384     return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
 385
 386
 387 def checkDTLtools():
 388     ''' Check whether DTL tools are available (Windows only) '''
 389     # Find programs! Returned path is not used now
 390     if ((os.name == 'nt' or sys.platform == 'cygwin') and
 391             checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
 392             checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
 393         dtl_tools = True
 394     else:
 395         dtl_tools = False
 396     return dtl_tools
 397
 398
 399 def checkLatex(dtl_tools):
 400     ''' Check latex, return lyx_check_config '''
 401     path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
 402     path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
 403     #-----------------------------------------------------------------
 404     path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
 405     if PLATEX != '':
 406         # check if PLATEX is pLaTeX2e
 407         writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
 408         # run platex on chklatex.ltx and check result
 409         if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
 410             # We have the Japanese pLaTeX2e
 411             addToRC(r'\converter platex     dvi        "%s -kanji=$$E $$i"      "latex=platex"' % PLATEX)
 412             addToRC(r'\converter platex     dvi4       "%s $$i"                 "latex=platex"' % PLATEX)
 413         else:
 414             PLATEX = ''
 415             removeFiles(['chklatex.ltx', 'chklatex.log'])
 416     #-----------------------------------------------------------------
 417     # use LATEX to convert from latex to dvi if PPLATEX is not available
 418     if PPLATEX == '':
 419         PPLATEX = LATEX
 420     if dtl_tools:
 421         # Windows only: DraftDVI
 422         addToRC(r'''\converter latex      dvi2       "%s"       "latex"
 423 \converter dvi2       dvi        "python -tt $$s/scripts/clean_dvi.py $$i $$o"  ""''' % PPLATEX)
 424     else:
 425         addToRC(r'\converter latex      dvi        "%s" "latex"' % PPLATEX)
 426     # no latex
 427     if LATEX != '':
 428         # Check if latex is usable
 429         writeToFile('chklatex.ltx', r'''
 430 \nonstopmode
 431 \ifx\undefined\documentclass\else
 432   \message{ThisIsLaTeX2e}
 433 \fi
 434 \makeatletter
 435 \@@end
 436 ''')
 437         # run latex on chklatex.ltx and check result
 438         if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
 439             # valid latex2e
 440             return LATEX
 441         else:
 442             logger.warning("Latex not usable (not LaTeX2e) ")
 443         # remove temporary files
 444         removeFiles(['chklatex.ltx', 'chklatex.log'])
 445     return ''
 446
 447
 448 def checkLuatex():
 449     ''' Check if luatex is there and usable '''
 450     path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
 451     path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
 452     if LUATEX != '':
 453     # luatex binary is there
 454         msg = "checking if LuaTeX is usable ..."
 455         # Check if luatex is usable
 456         writeToFile('luatest.tex', r'''
 457 \nonstopmode
 458 \documentclass{minimal}
 459 \usepackage{fontspec}
 460 \begin{document}
 461 .
 462 \end{document}
 463 ''')
 464         # run lualatex on luatest.tex and check result
 465         luatest = cmdOutput(LUATEX + ' luatest.tex')
 466         if luatest.find('XeTeX is required to compile this document') != -1:
 467             # fontspec/luatex too old! We do not support this version.
 468             logger.info(msg + ' no (probably not recent enough)')
 469         elif luatest.find('! LaTeX Error: File `fontspec.sty\' not found') != -1:
 470             # fontspec missing
 471             logger.info(msg + ' no (missing fontspec)')
 472         else:
 473             # working luatex
 474             logger.info(msg + ' yes')
 475             addToRC(r'\converter luatex      pdf5       "%s"    "latex=lualatex"' % LUATEX)
 476             if DVILUATEX != '':
 477                 addToRC(r'\converter luatex      dvi3        "%s"       "latex=dvilualatex"' % DVILUATEX)
 478         # remove temporary files
 479         removeFiles(['luatest.tex', 'luatest.log', 'luatest.aux', 'luatest.pdf'])
 480
 481
 482 def checkModule(module):
 483     ''' Check for a Python module, return the status '''
 484     msg = 'checking for "' + module + ' module"... '
 485     try:
 486       __import__(module)
 487       logger.info(msg + ' yes')
 488       return True
 489     except ImportError:
 490       logger.info(msg + ' no')
 491       return False
 492
 493
 494 def checkFormatEntries(dtl_tools):
 495     ''' Check all formats (\Format entries) '''
 496     checkViewerEditor('a Tgif viewer and editor', ['tgif'],
 497         rc_entry = [r'\Format tgif      "obj, tgo" Tgif                 "" "%%" "%%"    "vector"        "application/x-tgif"'])
 498     #
 499     checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
 500         rc_entry = [r'\Format fig        fig     FIG                    "" "%%" "%%"    "vector"        "application/x-xfig"'])
 501     #
 502     checkViewerEditor('a Dia viewer and editor', ['dia'],
 503         rc_entry = [r'\Format dia        dia     DIA                    "" "%%" "%%"    "vector,zipped=native", "application/x-dia-diagram"'])
 504     #
 505     checkViewerEditor('an OpenOffice drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
 506         rc_entry = [r'\Format odg        "odg, sxd" "OpenOffice drawing"   "" "%%"      "%%"    "vector,zipped=native"  "application/vnd.oasis.opendocument.graphics"'])
 507     #
 508     checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
 509         rc_entry = [r'\Format agr        agr     Grace                  "" "%%" "%%"    "vector"        ""'])
 510     #
 511     checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
 512         rc_entry = [r'\Format fen        fen     FEN                    "" "%%" "%%"    ""      ""'])
 513     #
 514     checkViewerEditor('a SVG viewer and editor', ['inkscape'],
 515         rc_entry = [r'\Format svg        svg     SVG                    "" "%%" "%%"    "vector"        "image/svg+xml"'])
 516     #
 517     imageformats = r'''\Format bmp        bmp     BMP                    "" "%s"        "%s"    ""      "image/x-bmp"
 518 \Format gif        gif     GIF                    "" "%s"       "%s"    ""      "image/gif"
 519 \Format jpg       "jpg, jpeg" JPEG                "" "%s"       "%s"    ""      "image/jpeg"
 520 \Format pbm        pbm     PBM                    "" "%s"       "%s"    ""      "image/x-portable-bitmap"
 521 \Format pgm        pgm     PGM                    "" "%s"       "%s"    ""      "image/x-portable-graymap"
 522 \Format png        png     PNG                    "" "%s"       "%s"    ""      "image/x-png"
 523 \Format ppm        ppm     PPM                    "" "%s"       "%s"    ""      "image/x-portable-pixmap"
 524 \Format tiff       tif     TIFF                   "" "%s"       "%s"    ""      "image/tiff"
 525 \Format xbm        xbm     XBM                    "" "%s"       "%s"    ""      "image/x-xbitmap"
 526 \Format xpm        xpm     XPM                    "" "%s"       "%s"    ""      "image/x-xpixmap"'''
 527     path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
 528     path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
 529     addToRC(imageformats % \
 530         (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
 531     #
 532     checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 533         'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
 534         rc_entry = [r'''\Format asciichess asc    "Plain text (chess output)"  "" ""    "%%"    ""      ""
 535 \Format asciiimage asc    "Plain text (image)"         "" ""    "%%"    ""      ""
 536 \Format asciixfig  asc    "Plain text (Xfig output)"   "" ""    "%%"    ""      ""
 537 \Format dateout    tmp    "date (output)"         "" "" "%%"    ""      ""
 538 \Format docbook    sgml    DocBook                B  "" "%%"    "document,menu=export"  ""
 539 \Format docbook-xml xml   "DocBook (XML)"         "" "" "%%"    "document,menu=export"  "application/docbook+xml"
 540 \Format dot        dot    "Graphviz Dot"          "" "" "%%"    "vector"        "text/vnd.graphviz"
 541 \Format dviluatex  tex    "LaTeX (dviluatex)"     "" "" "%%"    "document,menu=export"  ""
 542 \Format platex     tex    "LaTeX (pLaTeX)"        "" "" "%%"    "document,menu=export"  ""
 543 \Format literate   nw      NoWeb                  N  "" "%%"    "document,menu=export"  ""
 544 \Format sweave     Rnw    "Sweave"                S  "" "%%"    "document,menu=export"  ""
 545 \Format r          R      "R/S code"              "" "" "%%"    "document,menu=export"  ""
 546 \Format knitr      Rnw    "Rnw (knitr)"           "" "" "%%"    "document,menu=export"  ""
 547 \Format lilypond   ly     "LilyPond music"        "" "" "%%"    "vector"        "text/x-lilypond"
 548 \Format lilypond-book    lytex "LilyPond book (LaTeX)"   "" ""  "%%"    "document,menu=export"  ""
 549 \Format latex      tex    "LaTeX (plain)"         L  "" "%%"    "document,menu=export"  "text/x-tex"
 550 \Format luatex     tex    "LaTeX (LuaTeX)"        "" "" "%%"    "document,menu=export"  ""
 551 \Format pdflatex   tex    "LaTeX (pdflatex)"      "" "" "%%"    "document,menu=export"  ""
 552 \Format xetex      tex    "LaTeX (XeTeX)"         "" "" "%%"    "document,menu=export"  ""
 553 \Format text       txt    "Plain text"            a  "" "%%"    "document,menu=export"  "text/plain"
 554 \Format text2      txt    "Plain text (pstotext)" "" "" "%%"    "document"      ""
 555 \Format text3      txt    "Plain text (ps2ascii)" "" "" "%%"    "document"      ""
 556 \Format text4      txt    "Plain text (catdvi)"   "" "" "%%"    "document"      ""
 557 \Format textparagraph txt "Plain Text, Join Lines" "" ""        "%%"    "document"      ""
 558 \Format beamer.info pdf.info   "Info (Beamer)"         "" ""   "%%"    "document,menu=export"   ""''' ])
 559    #Spreadsheets using ssconvert from gnumeric
 560     checkViewer('gnumeric spreadsheet software', ['gnumeric'],
 561       rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" ""    "%%"   "document"       "application/x-gnumeric"
 562 \Format excel      xls    "Excel spreadsheet"      "" "" "%%"    "document"     "application/vnd.ms-excel"
 563 \Format oocalc     ods    "OpenOffice spreadsheet" "" "" "%%"    "document"     "application/vnd.oasis.opendocument.spreadsheet"'''])
 564  #
 565     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 566         rc_entry = [r'\Format xhtml      xhtml   "LyXHTML"              y "%%" ""    "document,menu=export"     "application/xhtml+xml"'])
 567  #
 568     checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
 569         'pybliographic', 'bibdesk', 'gbib', 'kbib', \
 570         'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
 571         'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
 572         'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
 573         'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
 574         rc_entry = [r'''\Format bibtex bib    "BibTeX"         "" ""    "%%"    ""      "text/x-bibtex"''' ])
 575     #
 576     #checkProg('a Postscript interpreter', ['gs'],
 577     #  rc_entry = [ r'\ps_command "%%"' ])
 578     checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
 579         rc_entry = [r'''\Format eps        eps     EPS                    "" "%%"       ""      "vector"        "image/x-eps"
 580 \Format eps2       eps    "EPS (uncropped)"       "" "%%"       ""      "vector"        ""
 581 \Format ps         ps      Postscript             t  "%%"       ""      "document,vector,menu=export"   "application/postscript"'''])
 582     # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
 583     checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
 584                     'gv', 'ghostview'],
 585         rc_entry = [r'''\Format pdf        pdf    "PDF (ps2pdf)"          P  "%%"       ""      "document,vector,menu=export"   "application/pdf"
 586 \Format pdf2       pdf    "PDF (pdflatex)"        F  "%%"       ""      "document,vector,menu=export"   ""
 587 \Format pdf3       pdf    "PDF (dvipdfm)"         m  "%%"       ""      "document,vector,menu=export"   ""
 588 \Format pdf4       pdf    "PDF (XeTeX)"           X  "%%"       ""      "document,vector,menu=export"   ""
 589 \Format pdf5       pdf    "PDF (LuaTeX)"          u  "%%"       ""      "document,vector,menu=export"   ""'''])
 590     #
 591     checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
 592         rc_entry = [r'''\Format dvi        dvi     DVI                    D  "%%"       ""      "document,vector,menu=export"   "application/x-dvi"
 593 \Format dvi3       dvi     "DVI (LuaTeX)"          V  "%%"      ""      "document,vector,menu=export"   ""
 594 \Format dvi4       dvi     "DVI (pLaTeX)"          V  "%%"      ""      "document,vector,menu=export"   ""'''])
 595     if dtl_tools:
 596         # Windows only: DraftDVI
 597         addToRC(r'\Format dvi2       dvi     DraftDVI               ""  ""      ""      "vector"        ""')
 598     #
 599     checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
 600         rc_entry = [r'\Format html      "html, htm" HTML                H  "%%" ""      "document,menu=export"  "text/html"'])
 601     #
 602     checkViewerEditor('Noteedit', ['noteedit'],
 603         rc_entry = [r'\Format noteedit   not     Noteedit               "" "%%" "%%"    "vector"        ""'])
 604     #
 605     checkViewerEditor('an OpenDocument/OpenOffice viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 606         rc_entry = [r'''\Format odt        odt     OpenDocument           "" "%%"       "%%"    "document,vector,menu=export"   "application/vnd.oasis.opendocument.text"
 607 \Format sxw        sxw    "OpenOffice.Org (sxw)"  "" "" ""      "document,vector"       "application/vnd.sun.xml.writer"'''])
 608     #
 609     checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
 610         rc_entry = [r'''\Format rtf        rtf    "Rich Text Format"      "" "%%"       "%%"    "document,vector,menu=export"   "application/rtf"
 611 \Format word       doc    "MS Word"               W  "%%"       "%%"    "document,vector,menu=export"   "application/msword"'''])
 612     #
 613     # entries that do not need checkProg
 614     addToRC(r'''\Format date       ""     "date command"          "" "" ""      ""      ""
 615 \Format csv        csv    "Table (CSV)"           "" "" ""      "document"      "text/csv"
 616 \Format fax        ""      Fax                    "" "" ""      "document"      ""
 617 \Format lyx        lyx     LyX                    "" "" ""      ""      "application/x-lyx"
 618 \Format lyx13x     13.lyx "LyX 1.3.x"             "" "" ""      "document"      ""
 619 \Format lyx14x     14.lyx "LyX 1.4.x"             "" "" ""      "document"      ""
 620 \Format lyx15x     15.lyx "LyX 1.5.x"             "" "" ""      "document"      ""
 621 \Format lyx16x     16.lyx "LyX 1.6.x"             "" "" ""      "document,menu=export"  ""
 622 \Format lyx20x     20.lyx "LyX 2.0.x"             "" "" ""      "document,menu=export"  ""
 623 \Format clyx       cjklyx "CJK LyX 1.4.x (big5)"  "" "" ""      "document"      ""
 624 \Format jlyx       cjklyx "CJK LyX 1.4.x (euc-jp)" "" ""        ""      "document"      ""
 625 \Format klyx       cjklyx "CJK LyX 1.4.x (euc-kr)" "" ""        ""      "document"      ""
 626 \Format lyxpreview lyxpreview "LyX Preview"       "" "" ""      ""      ""
 627 \Format pdftex     pdftex_t PDFTEX                "" "" ""      ""      ""
 628 \Format program    ""      Program                "" "" ""      ""      ""
 629 \Format pstex      pstex_t PSTEX                  "" "" ""      ""      ""
 630 \Format wmf        wmf    "Windows Metafile"      "" "" ""      "vector"        "image/x-wmf"
 631 \Format emf        emf    "Enhanced Metafile"     "" "" ""      "vector"        "image/x-emf"
 632 \Format wordhtml  "html, htm" "HTML (MS Word)"    "" "" ""      "document"      ""
 633 ''')
 634
 635
 636 def checkConverterEntries():
 637     ''' Check all converters (\converter entries) '''
 638     checkProg('the pdflatex program', ['pdflatex $$i'],
 639         rc_entry = [ r'\converter pdflatex   pdf2       "%%"    "latex=pdflatex"' ])
 640
 641     checkProg('XeTeX', ['xelatex $$i'],
 642         rc_entry = [ r'\converter xetex      pdf4       "%%"    "latex=xelatex"' ])
 643
 644     checkLuatex()
 645
 646     # Look for tex2lyx in this order (see bugs #3308 and #6986):
 647     #   1)  If we're running LyX in-place then tex2lyx will be found
 648     #       in ../src/tex2lyx with respect to the srcdir.
 649     #   2)  If LyX was configured with a version suffix then tex2lyx
 650     #       will also have this version suffix.
 651     #   3)  Otherwise always use tex2lyx.
 652     in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
 653     in_place = os.path.abspath(in_place)
 654
 655     path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_place, 'tex2lyx' + version_suffix, 'tex2lyx'],
 656         rc_entry = [r'''\converter latex      lyx        "%% -f $$i $$o"        ""
 657 \converter literate   lyx        "%% -n -m noweb -f $$i $$o"    ""'''], not_found = 'tex2lyx')
 658     if path == '':
 659         logger.warning("Failed to find tex2lyx on your system.")
 660
 661     #
 662     checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
 663         rc_entry = [r'''\converter literate   latex      "%%"   ""
 664 \converter literate   pdflatex      "%%"        ""
 665 \converter literate   luatex        "%%"        ""'''])
 666     #
 667     checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
 668         rc_entry = [r'''\converter sweave   latex      "%%"     ""
 669 \converter sweave   pdflatex   "%%"     ""
 670 \converter sweave   xetex      "%%"     ""
 671 \converter sweave   luatex     "%%"     ""'''])
 672     #
 673     checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
 674         rc_entry = [r'''\converter knitr   latex      "%%"      ""
 675 \converter knitr   pdflatex   "%%"      ""
 676 \converter knitr   xetex      "%%"      ""
 677 \converter knitr   luatex     "%%"      ""'''])
 678     #
 679     checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
 680         rc_entry = [ r'\converter sweave      r      "%%"    ""' ])
 681     #
 682     checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
 683         rc_entry = [ r'\converter knitr      r      "%%"    ""' ])
 684     #
 685     checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i',
 686         'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
 687         rc_entry = [ r'\converter html       latex      "%%"    ""' ])
 688     #
 689     checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
 690         rc_entry = [ r'\converter word       latex      "%%"    ""' ])
 691
 692     # eLyXer: search as an executable (elyxer.py, elyxer)
 693     path, elyxer = checkProg('a LyX -> HTML converter',
 694         ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
 695         rc_entry = [ r'\converter lyx      html       "%%"      ""' ])
 696     path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
 697         ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
 698         rc_entry = [ r'\converter lyx      wordhtml       "%%"  ""' ])
 699     if elyxer.find('elyxer') >= 0:
 700       addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 701       addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
 702     else:
 703       # search for HTML converters other than eLyXer
 704       # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 705       path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
 706           '/usr/share/tex4ht/htlatex $$i', 'tth  -t -e2 -L$$b < $$i > $$o', \
 707           'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
 708           rc_entry = [ r'\converter latex      html       "%%"  "needaux"' ])
 709       if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
 710         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 711       else:
 712         addToRC(r'''\copier    html       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 713       path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
 714           "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
 715           "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
 716           rc_entry = [ r'\converter latex      wordhtml   "%%"  "needaux"' ])
 717       if htmlconv.find('htlatex') >= 0:
 718         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
 719       else:
 720         addToRC(r'''\copier    wordhtml       "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
 721
 722
 723     # Check if LyXBlogger is installed
 724     lyxblogger_found = checkModule('lyxblogger')
 725     if lyxblogger_found:
 726       addToRC(r'\Format    blog       blog       "LyXBlogger"           "" "" ""  "document"  ""')
 727       addToRC(r'\converter xhtml      blog       "python -m lyxblogger $$i"       ""')
 728
 729     #
 730     checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
 731         rc_entry = [ r'\converter sxw        latex      "%%"    ""' ])
 732     #
 733     checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
 734         rc_entry = [ r'\converter odt        latex      "%%"    ""' ])
 735     #
 736     checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
 737         rc_entry = [ r'\converter odt        pdf        "%%"    ""' ])
 738     # According to http://www.tug.org/applications/tex4ht/mn-commands.html
 739     # the command mk4ht oolatex $$i has to be used as default,
 740     # but as this would require to have Perl installed, in MiKTeX oolatex is
 741     # directly available as application.
 742     # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
 743     # Both SuSE and debian have oolatex
 744     checkProg('a LaTeX -> Open Document converter', [
 745         'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
 746         'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
 747         rc_entry = [ r'\converter latex      odt        "%%"    "needaux"' ])
 748     # On windows it is called latex2rt.exe
 749     checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
 750         rc_entry = [ r'\converter latex      rtf        "%%"    "needaux"' ])
 751     #
 752     checkProg('a RTF -> HTML converter', ['unrtf --html  $$i > $$o'],
 753         rc_entry = [ r'\converter rtf      html        "%%"     ""' ])
 754     #
 755     checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
 756         rc_entry = [ r'\converter ps         pdf        "%%"    ""' ])
 757     #
 758     checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
 759         rc_entry = [ r'\converter ps         text2      "%%"    ""' ])
 760     #
 761     checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
 762         rc_entry = [ r'\converter ps         text3      "%%"    ""' ])
 763     # Need to call ps2eps in a pipe, otherwise it would name the output file
 764     # depending on the extension of the input file. We do not know the input
 765     # file extension in general, so the resultfile= flag would not help.
 766     # Since ps2eps crops the image, we do not use it to convert from ps->eps.
 767     # This would create additional paths in the converter graph with unwanted
 768     # side effects (e.g. ps->pdf via ps2pdf would create a different result
 769     # than ps->eps->pdf via ps2eps and epstopdf).
 770     checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
 771         rc_entry = [ r'\converter eps2       eps      "%%"      ""' ])
 772     #
 773     checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
 774         rc_entry = [ r'\converter pdf         ps        "%%"    ""' ])
 775     #
 776     checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
 777         rc_entry = [ r'\converter pdf         eps        "%%"   ""' ])
 778     #
 779     checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
 780         rc_entry = [ r'\converter pdf2         beamer.info        "%%"  ""' ])
 781     #
 782     checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
 783         rc_entry = [ r'\converter dvi        text4      "%%"    ""' ])
 784     #
 785     checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
 786         rc_entry = [ r'\converter dvi        ps         "%%"    ""' ])
 787     #
 788     checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
 789         rc_entry = [ r'\converter dvi        pdf3       "%%"    ""' ])
 790     #
 791     checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
 792         rc_entry = [ r'\converter ps         fax        "%%"    ""'])
 793     #
 794     path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
 795     if fig2dev == "fig2dev":
 796         addToRC(r'''\converter fig        eps        "fig2dev -L eps $$i $$o"   ""
 797 \converter fig        ppm        "fig2dev -L ppm $$i $$o"       ""
 798 \converter fig        png        "fig2dev -L png $$i $$o"       ""
 799 \converter fig        pdftex     "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
 800 \converter fig        pstex      "python -tt $$s/scripts/fig2pstex.py $$i $$o"  ""''')
 801     #
 802     checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
 803         rc_entry = [ r'\converter tiff       eps        "%%"    ""', ''])
 804     #
 805     checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
 806         rc_entry = [
 807             r'''\converter tgif       eps        "tgif -print -color -eps -stdout $$i > $$o"    ""
 808 \converter tgif       png        "tgif -print -color -png -o $$d $$i"   ""
 809 \converter tgif       pdf        "tgif -print -color -pdf -stdout $$i > $$o"    ""''',
 810             ''])
 811     #
 812     checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 813         rc_entry = [ r'\converter wmf        eps        "%%"    ""'])
 814     #
 815     checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
 816         rc_entry = [ r'\converter emf        eps        "%%"    ""'])
 817     #
 818     checkProg('an EPS -> PDF converter', ['epstopdf'],
 819         rc_entry = [ r'\converter eps        pdf        "epstopdf --outfile=$$o $$i"    ""', ''])
 820     #
 821     checkProg('an EPS -> PNG converter', ['convert $$i $$o'],
 822         rc_entry = [ r'\converter eps        png        "%%"    ""', ''])
 823     #
 824     # no agr -> pdf converter, since the pdf library used by gracebat is not
 825     # free software and therefore not compiled in in many installations.
 826     # Fortunately, this is not a big problem, because we will use epstopdf to
 827     # convert from agr to pdf via eps without loss of quality.
 828     checkProg('a Grace -> Image converter', ['gracebat'],
 829         rc_entry = [
 830             r'''\converter agr        eps        "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null"       ""
 831 \converter agr        png        "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null"       ""
 832 \converter agr        jpg        "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null"      ""
 833 \converter agr        ppm        "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null"       ""''',
 834             ''])
 835     #
 836     checkProg('a Dot -> Image converter', ['dot'],
 837         rc_entry = [
 838             r'''\converter dot        eps        "dot -Teps $$i -o $$o" ""
 839 \converter dot        png        "dot -Tpng $$i -o $$o" ""''',
 840             ''])
 841     #
 842     checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
 843         rc_entry = [ r'\converter dia        png        "%%"    ""'])
 844     #
 845     checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
 846         rc_entry = [ r'\converter dia        eps        "%%"    ""'])
 847     # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
 848     # The eps2->eps converter then fixes the bounding box by cropping.
 849     # Although unoconv can convert to png and pdf as well, do not define
 850     # odg->png and odg->pdf converters, since the bb would be too large as well.
 851     checkProg('an OpenOffice -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
 852         rc_entry = [ r'\converter odg        eps2       "%%"    ""'])
 853     #
 854     checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
 855         rc_entry = [ r'\converter svg        pdf        "%%"    ""'])
 856     #
 857     checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
 858         rc_entry = [ r'\converter svg        eps        "%%"    ""'])
 859     #
 860     checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
 861         rc_entry = [ r'\converter svg        png        "%%"    ""'])
 862
 863     #
 864     # gnumeric/xls/ods to tex
 865     checkProg('a spreadsheet -> latex converter', ['ssconvert'],
 866        rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 867 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
 868 \converter excel  latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
 869 ''])
 870
 871     path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
 872     if (lilypond != ''):
 873         version_string = cmdOutput("lilypond --version")
 874         match = re.match('GNU LilyPond (\S+)', version_string)
 875         if match:
 876             version_number = match.groups()[0]
 877             version = version_number.split('.')
 878             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
 879                 addToRC(r'''\converter lilypond   eps        "lilypond -dbackend=eps -dsafe --ps $$i"   ""
 880 \converter lilypond   png        "lilypond -dbackend=eps -dsafe --png $$i"      ""''')
 881                 addToRC(r'\converter lilypond   pdf        "lilypond -dbackend=eps -dsafe --pdf $$i"    ""')
 882                 logger.info('+  found LilyPond version %s.' % version_number)
 883             elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
 884                 addToRC(r'''\converter lilypond   eps        "lilypond -b eps --ps --safe $$i"  ""
 885 \converter lilypond   png        "lilypond -b eps --png $$i"    ""''')
 886                 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
 887                     addToRC(r'\converter lilypond   pdf        "lilypond -b eps --pdf --safe $$i"       ""')
 888                 logger.info('+  found LilyPond version %s.' % version_number)
 889             else:
 890                 logger.info('+  found LilyPond, but version %s is too old.' % version_number)
 891         else:
 892             logger.info('+  found LilyPond, but could not extract version number.')
 893     #
 894     path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
 895     if (lilypond_book != ''):
 896         version_string = cmdOutput("lilypond-book --version")
 897         match = re.match('^(\S+)$', version_string)
 898         if match:
 899             version_number = match.groups()[0]
 900             version = version_number.split('.')
 901             if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
 902                 # Note: The --lily-output-dir flag is required because lilypond-book
 903                 #       does not process input again unless the input has changed,
 904                 #       even if the output format being requested is different. So
 905                 #       once a .eps file exists, lilypond-book won't create a .pdf
 906                 #       even when requested with --pdf. This is a problem if a user
 907                 #       clicks View PDF after having done a View DVI. To circumvent
 908                 #       this, use different output folders for eps and pdf outputs.
 909                 addToRC(r'\converter lilypond-book latex    "lilypond-book --safe --lily-output-dir=ly-eps $$i"                                ""')
 910                 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
 911                 addToRC(r'\converter lilypond-book xetex    "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i"  ""')
 912                 addToRC(r'\converter lilypond-book luatex   "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
 913                 logger.info('+  found LilyPond-book version %s.' % version_number)
 914             else:
 915                 logger.info('+  found LilyPond-book, but version %s is too old.' % version_number)
 916         else:
 917             logger.info('+  found LilyPond-book, but could not extract version number.')
 918     #
 919     checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
 920         rc_entry = [ r'\converter noteedit   lilypond   "%%"    ""', ''])
 921     #
 922     # Currently, lyxpak outputs a gzip compressed tar archive on *nix
 923     # and a zip archive on Windows.
 924     # So, we configure the appropriate version according to the platform.
 925     cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
 926     if os.name == 'nt':
 927         addToRC(r'\Format lyxzip     zip    "LyX Archive (zip)"     "" "" ""  "document,menu=export"    ""')
 928         addToRC(cmd % "lyxzip")
 929     else:
 930         addToRC(r'\Format lyxgz      gz     "LyX Archive (tar.gz)"  "" "" ""  "document,menu=export"    ""')
 931         addToRC(cmd % "lyxgz")
 932
 933     #
 934     # FIXME: no rc_entry? comment it out
 935     # checkProg('Image converter', ['convert $$i $$o'])
 936     #
 937     # Entries that do not need checkProg
 938     addToRC(r'''
 939 \converter csv        lyx        "python -tt $$s/scripts/csv2lyx.py $$i $$o"    ""
 940 \converter date       dateout    "python -tt $$s/scripts/date.py %d-%m-%Y > $$o"        ""
 941 \converter docbook    docbook-xml "cp $$i $$o"  "xml"
 942 \converter fen        asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o"  ""
 943 \converter lyx        lyx13x     "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o"      ""
 944 \converter lyx        lyx14x     "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o"      ""
 945 \converter lyx        lyx15x     "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o"      ""
 946 \converter lyx        lyx16x     "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o"      ""
 947 \converter lyx        lyx20x     "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o"      ""
 948 \converter lyx        clyx       "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o"      ""
 949 \converter lyx        jlyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o"    ""
 950 \converter lyx        klyx       "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o"    ""
 951 \converter clyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o"     ""
 952 \converter jlyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o"   ""
 953 \converter klyx       lyx        "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o"   ""
 954 \converter lyxpreview png        "python -tt $$s/scripts/lyxpreview2bitmap.py --png"    ""
 955 \converter lyxpreview ppm        "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm"    ""
 956 ''')
 957
 958
 959 def checkDocBook():
 960     ''' Check docbook '''
 961     path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
 962         rc_entry = [
 963             r'''\converter docbook    dvi        "sgmltools -b dvi $$i" ""
 964 \converter docbook    html       "sgmltools -b html $$i"        ""''',
 965             r'''\converter docbook    dvi        "db2dvi $$i"   ""
 966 \converter docbook    html       "db2html $$i"  ""''',
 967             r'''\converter docbook    dvi        ""     ""
 968 \converter docbook    html       "" ""''',
 969             r'''\converter docbook    dvi        ""     ""
 970 \converter docbook    html       ""     ""'''])
 971     #
 972     if DOCBOOK != '':
 973         return ('yes', 'true', '\\def\\hasdocbook{yes}')
 974     else:
 975         return ('no', 'false', '')
 976
 977
 978 def checkOtherEntries():
 979     ''' entries other than Format and Converter '''
 980     checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
 981         rc_entry = [ r'\chktex_command "%%"' ])
 982     checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
 983         rc_entry = [ r'\bibtex_command "%%"' ],
 984         alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
 985     checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
 986         rc_entry = [ r'\jbibtex_command "%%"' ])
 987     checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
 988         rc_entry = [ r'\index_command "%%"' ],
 989         alt_rc_entry = [ r'\index_alternatives "%%"' ])
 990     checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
 991         rc_entry = [ r'\jindex_command "%%"' ])
 992     checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
 993         'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
 994     checkProg('a nomenclature processor', ['makeindex'],
 995         rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
 996     ## FIXME: OCTAVE is not used anywhere
 997     # path, OCTAVE = checkProg('Octave', ['octave'])
 998     ## FIXME: MAPLE is not used anywhere
 999     # path, MAPLE = checkProg('Maple', ['maple'])
1000     checkProg('a spool command', ['lp', 'lpr'],
1001         rc_entry = [
1002             r'''\print_spool_printerprefix "-d "
1003 \print_spool_command "lp"''',
1004             r'''\print_spool_printerprefix "-P",
1005 \print_spool_command "lpr"''',
1006             ''])
1007     # Add the rest of the entries (no checkProg is required)
1008     addToRC(r'''\copier    fig        "python -tt $$s/scripts/fig_copy.py $$i $$o"
1009 \copier    pstex      "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1010 \copier    pdftex     "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1011 \copier    program    "python -tt $$s/scripts/ext_copy.py $$i $$o"
1012 ''')
1013
1014
1015 def processLayoutFile(file, bool_docbook):
1016     ''' process layout file and get a line of result
1017
1018         Declare lines look like this:
1019
1020         \DeclareLaTeXClass[<requirements>]{<description>}
1021
1022         Optionally, a \DeclareCategory line follows:
1023
1024         \DeclareCategory{<category>}
1025
1026         So for example (article.layout, scrbook.layout, svjog.layout)
1027
1028         \DeclareLaTeXClass{article}
1029         \DeclareCategory{Articles}
1030
1031         \DeclareLaTeXClass[scrbook]{book (koma-script)}
1032         \DeclareCategory{Books}
1033
1034         \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1035
1036         we'd expect this output:
1037
1038         "article" "article" "article" "false" "article.cls" "Articles"
1039         "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1040         "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1041     '''
1042     def checkForClassExtension(x):
1043         '''if the extension for a latex class is not
1044            provided, add .cls to the classname'''
1045         if not '.' in x:
1046             return x.strip() + '.cls'
1047         else:
1048             return x.strip()
1049     classname = file.split(os.sep)[-1].split('.')[0]
1050     # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1051     p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1052     q = re.compile(r'\DeclareCategory{(.*)}')
1053     classdeclaration = ""
1054     categorydeclaration = '""'
1055     for line in open(file).readlines():
1056         res = p.search(line)
1057         qres = q.search(line)
1058         if res != None:
1059             (classtype, optAll, opt, opt1, desc) = res.groups()
1060             avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1061             if opt == None:
1062                 opt = classname
1063                 prereq_latex = checkForClassExtension(classname)
1064             else:
1065                 prereq_list = optAll[1:-1].split(',')
1066                 prereq_list = map(checkForClassExtension, prereq_list)
1067                 prereq_latex = ','.join(prereq_list)
1068             prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1069             prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1070             classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1071             if categorydeclaration != '""':
1072                 return classdeclaration + " " + categorydeclaration
1073         if qres != None:
1074              categorydeclaration = '"%s"' % (qres.groups()[0])
1075              if classdeclaration != "":
1076                  return classdeclaration + " " + categorydeclaration
1077     if classdeclaration != "":
1078         return classdeclaration + " " + categorydeclaration
1079     logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1080     return ""
1081
1082
1083 def checkLatexConfig(check_config, bool_docbook):
1084     ''' Explore the LaTeX configuration
1085         Return None (will be passed to sys.exit()) for success.
1086     '''
1087     msg = 'checking LaTeX configuration... '
1088     # if --without-latex-config is forced, or if there is no previous
1089     # version of textclass.lst, re-generate a default file.
1090     if not os.path.isfile('textclass.lst') or not check_config:
1091         # remove the files only if we want to regenerate
1092         removeFiles(['textclass.lst', 'packages.lst'])
1093         #
1094         # Then, generate a default textclass.lst. In case configure.py
1095         # fails, we still have something to start lyx.
1096         logger.info(msg + ' default values')
1097         logger.info('+checking list of textclasses... ')
1098         tx = open('textclass.lst', 'w')
1099         tx.write('''
1100 # This file declares layouts and their associated definition files
1101 # (include dir. relative to the place where this file is).
1102 # It contains only default values, since chkconfig.ltx could not be run
1103 # for some reason. Run ./configure.py if you need to update it after a
1104 # configuration change.
1105 ''')
1106         # build the list of available layout files and convert it to commands
1107         # for chkconfig.ltx
1108         foundClasses = []
1109         for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1110             glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1111             # valid file?
1112             if not os.path.isfile(file):
1113                 continue
1114             # get stuff between /xxxx.layout .
1115             classname = file.split(os.sep)[-1].split('.')[0]
1116             #  tr ' -' '__'`
1117             cleanclass = classname.replace(' ', '_')
1118             cleanclass = cleanclass.replace('-', '_')
1119             # make sure the same class is not considered twice
1120             if foundClasses.count(cleanclass) == 0: # not found before
1121                 foundClasses.append(cleanclass)
1122                 retval = processLayoutFile(file, bool_docbook)
1123                 if retval != "":
1124                     tx.write(retval)
1125         tx.close()
1126         logger.info('\tdone')
1127     if not os.path.isfile('packages.lst') or not check_config:
1128         logger.info('+generating default list of packages... ')
1129         removeFiles(['packages.lst'])
1130         tx = open('packages.lst', 'w')
1131         tx.close()
1132         logger.info('\tdone')
1133     if not check_config:
1134         return None
1135     # the following will generate textclass.lst.tmp, and packages.lst.tmp
1136     logger.info(msg + '\tauto')
1137     removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1138         'wrap_chkconfig.ltx'])
1139     rmcopy = False
1140     if not os.path.isfile( 'chkconfig.ltx' ):
1141         shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1142         rmcopy = True
1143     writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1144     # Construct the list of classes to test for.
1145     # build the list of available layout files and convert it to commands
1146     # for chkconfig.ltx
1147     declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1148     category = re.compile(r'\DeclareCategory{(.*)}')
1149     empty = re.compile(r'^\s*$')
1150     testclasses = list()
1151     for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1152         glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1153         nodeclaration = False
1154         if not os.path.isfile(file):
1155             continue
1156         classname = file.split(os.sep)[-1].split('.')[0]
1157         decline = ""
1158         catline = ""
1159         for line in open(file).readlines():
1160             if not empty.match(line) and line[0] != '#':
1161                 if decline == "":
1162                     logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1163                     nodeclaration = True
1164                 # A class, but no category declaration. Just break.
1165                 break
1166             if declare.search(line) != None:
1167                 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1168                 testclasses.append(decline)
1169             elif category.search(line) != None:
1170                 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1171                 testclasses.append(catline)
1172             if catline == "" or decline == "":
1173                 continue
1174             break
1175         if nodeclaration:
1176             continue
1177     testclasses.sort()
1178     cl = open('chklayouts.tex', 'w')
1179     for line in testclasses:
1180         cl.write(line + '\n')
1181     cl.close()
1182     #
1183     # we have chklayouts.tex, then process it
1184     latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1185     while True:
1186         line = latex_out.readline()
1187         if not line:
1188             break;
1189         if re.match('^\+', line):
1190             logger.info(line.strip())
1191     # if the command succeeds, None will be returned
1192     ret = latex_out.close()
1193     #
1194     # remove the copied file
1195     if rmcopy:
1196         removeFiles( [ 'chkconfig.ltx' ] )
1197     #
1198     # currently, values in chkconfig are only used to set
1199     # \font_encoding
1200     values = {}
1201     for line in open('chkconfig.vars').readlines():
1202         key, val = re.sub('-', '_', line).split('=')
1203         val = val.strip()
1204         values[key] = val.strip("'")
1205     # chk_fontenc may not exist
1206     try:
1207         addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1208     except:
1209         pass
1210     # if configure successed, move textclass.lst.tmp to textclass.lst
1211     # and packages.lst.tmp to packages.lst
1212     if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1213         and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1214         shutil.move('textclass.lst.tmp', 'textclass.lst')
1215         shutil.move('packages.lst.tmp', 'packages.lst')
1216     return ret
1217
1218
1219 def checkModulesConfig():
1220   removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1221
1222   logger.info('+checking list of modules... ')
1223   tx = open('lyxmodules.lst', 'w')
1224   tx.write('''## This file declares modules and their associated definition files.
1225 ## It has been automatically generated by configure
1226 ## Use "Options/Reconfigure" if you need to update it after a
1227 ## configuration change.
1228 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1229 ''')
1230
1231   # build the list of available modules
1232   seen = []
1233   # note that this searches the local directory first, then the
1234   # system directory. that way, we pick up the user's version first.
1235   for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1236       glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1237       # valid file?
1238       logger.info(file)
1239       if not os.path.isfile(file):
1240           continue
1241
1242       filename = file.split(os.sep)[-1]
1243       filename = filename[:-7]
1244       if seen.count(filename):
1245           continue
1246
1247       seen.append(filename)
1248       retval = processModuleFile(file, filename, bool_docbook)
1249       if retval != "":
1250           tx.write(retval)
1251   tx.close()
1252   logger.info('\tdone')
1253
1254
1255 def processModuleFile(file, filename, bool_docbook):
1256     ''' process module file and get a line of result
1257
1258         The top of a module file should look like this:
1259           #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1260           #DescriptionBegin
1261           #...body of description...
1262           #DescriptionEnd
1263           #Requires: [list of required modules]
1264           #Excludes: [list of excluded modules]
1265           #Category: [category name]
1266         The last three lines are optional (though do give a category).
1267         We expect output:
1268           "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1269     '''
1270     remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1271     rereqs = re.compile(r'#+\s*Requires: (.*)')
1272     reexcs = re.compile(r'#+\s*Excludes: (.*)')
1273     recaty = re.compile(r'#+\s*Category: (.*)')
1274     redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1275     redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1276
1277     modname = desc = pkgs = req = excl = catgy = ""
1278     readingDescription = False
1279     descLines = []
1280
1281     for line in open(file).readlines():
1282       if readingDescription:
1283         res = redend.search(line)
1284         if res != None:
1285           readingDescription = False
1286           desc = " ".join(descLines)
1287           # Escape quotes.
1288           desc = desc.replace('"', '\\"')
1289           continue
1290         descLines.append(line[1:].strip())
1291         continue
1292       res = redbeg.search(line)
1293       if res != None:
1294         readingDescription = True
1295         continue
1296       res = remods.search(line)
1297       if res != None:
1298           (pkgs, modname) = res.groups()
1299           if pkgs == None:
1300             pkgs = ""
1301           else:
1302             tmp = [s.strip() for s in pkgs.split(",")]
1303             pkgs = ",".join(tmp)
1304           continue
1305       res = rereqs.search(line)
1306       if res != None:
1307         req = res.group(1)
1308         tmp = [s.strip() for s in req.split("|")]
1309         req = "|".join(tmp)
1310         continue
1311       res = reexcs.search(line)
1312       if res != None:
1313         excl = res.group(1)
1314         tmp = [s.strip() for s in excl.split("|")]
1315         excl = "|".join(tmp)
1316         continue
1317       res = recaty.search(line)
1318       if res != None:
1319         catgy = res.group(1)
1320         continue
1321
1322     if modname == "":
1323       logger.warning("Module file without \DeclareLyXModule line. ")
1324       return ""
1325
1326     if pkgs != "":
1327         # this module has some latex dependencies:
1328         # append the dependencies to chkmodules.tex,
1329         # which is \input'ed by chkconfig.ltx
1330         testpackages = list()
1331         for pkg in pkgs.split(","):
1332             if "->" in pkg:
1333                 # this is a converter dependency: skip
1334                 continue
1335             if pkg.endswith(".sty"):
1336                 pkg = pkg[:-4]
1337             testpackages.append("\\TestPackage{%s}" % (pkg,))
1338         cm = open('chkmodules.tex', 'a')
1339         for line in testpackages:
1340             cm.write(line + '\n')
1341         cm.close()
1342
1343     return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1344
1345
1346 def checkTeXAllowSpaces():
1347     ''' Let's check whether spaces are allowed in TeX file names '''
1348     tex_allows_spaces = 'false'
1349     if lyx_check_config:
1350         msg = "Checking whether TeX allows spaces in file names... "
1351         writeToFile('a b.tex', r'\message{working^^J}' )
1352         if LATEX != '':
1353             if os.name == 'nt' or sys.platform == 'cygwin':
1354                 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1355             else:
1356                 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1357         else:
1358             latex_out = ''
1359         if 'working' in latex_out:
1360             logger.info(msg + 'yes')
1361             tex_allows_spaces = 'true'
1362         else:
1363             logger.info(msg + 'no')
1364             tex_allows_spaces = 'false'
1365         addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1366         removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1367
1368
1369 def rescanTeXFiles():
1370     ''' Run kpsewhich to update information about TeX files '''
1371     logger.info("+Indexing TeX files... ")
1372     if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1373         logger.error("configure: error: cannot find TeXFiles.py script")
1374         sys.exit(1)
1375     tfp = cmdOutput("python -tt " + os.path.join(srcdir, 'scripts', 'TeXFiles.py'))
1376     logger.info(tfp)
1377     logger.info("\tdone")
1378
1379
1380 def removeTempFiles():
1381     # Final clean-up
1382     if not lyx_keep_temps:
1383         removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1384             'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1385             'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1386
1387
1388 if __name__ == '__main__':
1389     lyx_check_config = True
1390     lyx_kpsewhich = True
1391     outfile = 'lyxrc.defaults'
1392     lyxrc_fileformat = 7
1393     rc_entries = ''
1394     lyx_keep_temps = False
1395     version_suffix = ''
1396     ## Parse the command line
1397     for op in sys.argv[1:]:   # default shell/for list is $*, the options
1398         if op in [ '-help', '--help', '-h' ]:
1399             print '''Usage: configure [options]
1400 Options:
1401     --help                   show this help lines
1402     --keep-temps             keep temporary files (for debug. purposes)
1403     --without-kpsewhich      do not update TeX files information via kpsewhich
1404     --without-latex-config   do not run LaTeX to determine configuration
1405     --with-version-suffix=suffix suffix of binary installed files
1406 '''
1407             sys.exit(0)
1408         elif op == '--without-kpsewhich':
1409             lyx_kpsewhich = False
1410         elif op == '--without-latex-config':
1411             lyx_check_config = False
1412         elif op == '--keep-temps':
1413             lyx_keep_temps = True
1414         elif op[0:22] == '--with-version-suffix=':  # never mind if op is not long enough
1415             version_suffix = op[22:]
1416         else:
1417             print "Unknown option", op
1418             sys.exit(1)
1419     #
1420     # check if we run from the right directory
1421     srcdir = os.path.dirname(sys.argv[0])
1422     if srcdir == '':
1423         srcdir = '.'
1424     if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1425         logger.error("configure: error: cannot find chkconfig.ltx script")
1426         sys.exit(1)
1427     setEnviron()
1428     createDirectories()
1429     dtl_tools = checkDTLtools()
1430     ## Write the first part of outfile
1431     writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1432 # script. It contains default settings that have been determined by
1433 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1434 # want to customize LyX, use LyX' Preferences dialog or modify directly
1435 # the "preferences" file instead. Any setting in that file will
1436 # override the values given here.
1437
1438 Format %i
1439
1440 ''' % lyxrc_fileformat)
1441     # check latex
1442     LATEX = checkLatex(dtl_tools)
1443     # check java and perl before any checkProg that may require them
1444     java = checkProg('a java interpreter', ['java'])[1]
1445     perl = checkProg('a perl interpreter', ['perl'])[1]
1446     checkFormatEntries(dtl_tools)
1447     checkConverterEntries()
1448     (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1449     checkTeXAllowSpaces()
1450     windows_style_tex_paths = checkTeXPaths()
1451     if windows_style_tex_paths != '':
1452         addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1453     checkOtherEntries()
1454     if lyx_kpsewhich:
1455         rescanTeXFiles()
1456     checkModulesConfig()
1457     # --without-latex-config can disable lyx_check_config
1458     ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1459     removeTempFiles()
1460     # The return error code can be 256. Because most systems expect an error code
1461     # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1462     # a None for success, 'ret is not None' is used to exit.
1463     sys.exit(ret is not None)