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