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