2 # -*- coding: utf-8 -*-
5 # This file is part of LyX, the document processor.
6 # Licence details can be found in the file COPYING.
9 # Full author contact details are available in file CREDITS.
11 import glob, logging, os, re, shutil, subprocess, sys
14 logging.basicConfig(level = logging.DEBUG,
15 format = '%(levelname)s: %(message)s', # ignore application name
16 filename = 'configure.log',
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)
27 def writeToFile(filename, lines, append = False):
28 " utility function: write or append lines to filename "
30 file = open(filename, 'a')
32 file = open(filename, 'w')
38 ''' utility function: shortcut for appending lines to outfile
39 add newline at the end of lines.
41 if lines.strip() != '':
42 writeToFile(outfile, lines + '\n', append = True)
43 logger.debug('Add to RC:\n' + lines + '\n\n')
46 def removeFiles(filenames):
47 '''utility function: 'rm -f'
48 ignore errors when file does not exist, or is a directory.
50 for file in filenames:
53 logger.debug('Removing file %s' % file)
55 logger.debug('Failed to remove file %s' % file)
60 '''utility function: run a command and get its output as a string
65 cmd = 'cmd /d /c ' + cmd
68 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
69 stdout=subprocess.PIPE, universal_newlines=True)
71 output = pipe.stdout.read()
77 ''' I do not really know why this is useful, but we might as well keep it.
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.
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')
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 ):
97 logger.debug('Create directory %s.' % dir)
99 logger.error('Failed to create directory %s.' % dir)
104 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
105 windows_style_tex_paths = ''
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')
112 from ctypes import windll, create_unicode_buffer
113 GetShortPathName = windll.kernel32.GetShortPathNameW
114 longname = unicode(tmpfname)
115 shortlen = GetShortPathName(longname, 0, 0)
116 shortname = create_unicode_buffer(shortlen)
117 if GetShortPathName(longname, shortname, shortlen):
118 inpname = shortname.value.replace('\\', '/')
120 inpname = tmpfname.replace('\\', '/')
122 inpname = cmdOutput('cygpath -m ' + tmpfname)
123 logname = os.path.basename(inpname.replace('.ltx', '.log'))
124 inpname = inpname.replace('~', '\\string~')
125 os.write(fd, r'\relax')
127 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
128 if 'Error' in latex_out:
129 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
130 if 'Error' in latex_out:
131 logger.warning("configure: TeX engine needs posix-style paths in latex files")
132 windows_style_tex_paths = 'false'
134 logger.info("configure: TeX engine needs windows-style paths in latex files")
135 windows_style_tex_paths = 'true'
136 removeFiles([tmpfname, logname, 'texput.log'])
137 return windows_style_tex_paths
140 ## Searching some useful programs
141 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
143 This function will search a program in $PATH plus given path
144 If found, return directory and program name (not the options).
146 description: description of the program
148 progs: check programs, for each prog, the first word is used
149 for searching but the whole string is used to replace
150 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
152 path: additional pathes
154 rc_entry: entry to outfile, can be
155 1. emtpy: no rc entry will be added
156 2. one pattern: %% will be replaced by the first found program,
157 or '' if no program is found.
158 3. several patterns for each prog and not_found. This is used
159 when different programs have different usages. If you do not
160 want not_found entry to be added to the RC file, you can specify
161 an entry for each prog and use '' for the not_found entry.
163 not_found: the value that should be used instead of '' if no program
167 # one rc entry for each progs plus not_found entry
168 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
169 logger.error("rc entry should have one item or item for each prog and not_found.")
171 logger.info('checking for ' + description + '...')
172 ## print '(' + ','.join(progs) + ')',
173 for idx in range(len(progs)):
174 # ac_prog may have options, ac_word is the command name
176 ac_word = ac_prog.split(' ')[0]
177 msg = '+checking for "' + ac_word + '"... '
178 path = os.environ["PATH"].split(os.pathsep) + path
180 if "PATHEXT" in os.environ:
181 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
184 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
185 logger.info(msg + ' yes')
186 # write rc entries for this command
187 if len(rc_entry) == 1:
188 addToRC(rc_entry[0].replace('%%', ac_prog))
189 elif len(rc_entry) > 1:
190 addToRC(rc_entry[idx].replace('%%', ac_prog))
191 return [ac_dir, ac_word]
193 logger.info(msg + ' no')
194 # write rc entries for 'not found'
195 if len(rc_entry) > 0: # the last one.
196 addToRC(rc_entry[-1].replace('%%', not_found))
197 return ['', not_found]
200 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
202 The same as checkProg, but additionally, all found programs will be added
205 # one rc entry for each progs plus not_found entry
206 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
207 logger.error("rc entry should have one item or item for each prog and not_found.")
209 logger.info('checking for ' + description + '...')
210 ## print '(' + ','.join(progs) + ')',
213 real_ac_word = not_found
214 for idx in range(len(progs)):
215 # ac_prog may have options, ac_word is the command name
217 ac_word = ac_prog.split(' ')[0]
218 msg = '+checking for "' + ac_word + '"... '
219 path = os.environ["PATH"].split(os.pathsep) + path
221 if "PATHEXT" in os.environ:
222 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
226 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
227 logger.info(msg + ' yes')
228 pr = re.compile(r'(\\\S+)(.*)$')
230 # write rc entries for this command
231 if found_prime == False:
232 if len(rc_entry) == 1:
233 addToRC(rc_entry[0].replace('%%', ac_prog))
234 elif len(rc_entry) > 1:
235 addToRC(rc_entry[idx].replace('%%', ac_prog))
237 real_ac_word = ac_word
239 if len(alt_rc_entry) == 1:
240 alt_rc = alt_rc_entry[0]
242 # if no explicit alt_rc is given, construct one
243 m = pr.match(rc_entry[0])
245 alt_rc = m.group(1) + "_alternatives" + m.group(2)
246 addToRC(alt_rc.replace('%%', ac_prog))
247 elif len(alt_rc_entry) > 1:
248 alt_rc = alt_rc_entry[idx]
250 # if no explicit alt_rc is given, construct one
251 m = pr.match(rc_entry[idx])
253 alt_rc = m.group(1) + "_alternatives" + m.group(2)
254 addToRC(alt_rc.replace('%%', ac_prog))
259 if found_alt == False:
261 logger.info(msg + ' no')
263 return [real_ac_dir, real_ac_word]
264 # write rc entries for 'not found'
265 if len(rc_entry) > 0: # the last one.
266 addToRC(rc_entry[-1].replace('%%', not_found))
267 return ['', not_found]
270 def addAlternatives(rcs, alt_type):
272 Returns a \\prog_alternatives string to be used as an alternative
273 rc entry. alt_type can be a string or a list of strings.
275 r = re.compile(r'\\Format (\S+).*$')
278 alt_token = '\\%s_alternatives '
279 if isinstance(alt_type, str):
280 alt_tokens = [alt_token % alt_type]
282 alt_tokens = map(lambda s: alt_token % s, alt_type)
283 for idxx in range(len(rcs)):
287 alt = '\n'.join([s + m.group(1) + " %%" for s in alt_tokens])
289 m = r.match(rcs[idxx])
293 alt += '\n'.join([s + m.group(1) + " %%" for s in alt_tokens])
297 def listAlternatives(progs, alt_type, rc_entry = []):
299 Returns a list of \\prog_alternatives strings to be used as alternative
300 rc entries. alt_type can be a string or a list of strings.
302 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
303 logger.error("rc entry should have one item or item for each prog and not_found.")
306 for idx in range(len(progs)):
307 if len(rc_entry) == 1:
308 rcs = rc_entry[0].split('\n')
309 alt = addAlternatives(rcs, alt_type)
310 alt_rc_entry.insert(0, alt)
311 elif len(rc_entry) > 1:
312 rcs = rc_entry[idx].split('\n')
313 alt = addAlternatives(rcs, alt_type)
314 alt_rc_entry.insert(idx, alt)
318 def checkViewer(description, progs, rc_entry = [], path = []):
319 ''' The same as checkProgAlternatives, but for viewers '''
320 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
321 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
324 def checkEditor(description, progs, rc_entry = [], path = []):
325 ''' The same as checkProgAlternatives, but for editors '''
326 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
327 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
330 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
331 ''' The same as checkViewer, but do not add rc entry '''
332 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
334 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
337 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
338 ''' The same as checkViewer, but do not add rc entry '''
339 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
341 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
344 def checkViewerEditor(description, progs, rc_entry = [], path = []):
345 ''' The same as checkProgAlternatives, but for viewers and editors '''
346 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
347 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
351 ''' Check whether DTL tools are available (Windows only) '''
352 # Find programs! Returned path is not used now
353 if ((os.name == 'nt' or sys.platform == 'cygwin') and
354 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
355 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
362 def checkLatex(dtl_tools):
363 ''' Check latex, return lyx_check_config '''
364 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
365 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
366 #-----------------------------------------------------------------
367 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
369 # check if PLATEX is pLaTeX2e
370 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
371 # run platex on chklatex.ltx and check result
372 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
373 # We have the Japanese pLaTeX2e
374 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
377 removeFiles(['chklatex.ltx', 'chklatex.log'])
378 #-----------------------------------------------------------------
379 # use LATEX to convert from latex to dvi if PPLATEX is not available
383 # Windows only: DraftDVI
384 addToRC(r'''\converter latex dvi2 "%s" "latex"
385 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
387 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
390 # Check if latex is usable
391 writeToFile('chklatex.ltx', r'''
393 \ifx\undefined\documentclass\else
394 \message{ThisIsLaTeX2e}
399 # run latex on chklatex.ltx and check result
400 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
404 logger.warning("Latex not usable (not LaTeX2e) ")
405 # remove temporary files
406 removeFiles(['chklatex.ltx', 'chklatex.log'])
411 ''' Check if luatex is there and usable '''
412 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
413 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
415 # luatex binary is there
416 msg = "checking if LuaTeX is usable ..."
417 # Check if luatex is usable
418 writeToFile('luatest.tex', r'''
420 \documentclass{minimal}
421 \usepackage{fontspec}
426 # run lualatex on luatest.tex and check result
427 luatest = cmdOutput(LUATEX + ' luatest.tex')
428 if luatest.find('XeTeX is required to compile this document') != -1:
429 # fontspec/luatex too old! We do not support this version.
430 logger.info(msg + ' no (probably not recent enough)')
431 elif luatest.find('! LaTeX Error: File `fontspec.sty\' not found') != -1:
433 logger.info(msg + ' no (missing fontspec)')
436 logger.info(msg + ' yes')
437 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
439 addToRC(r'\converter luatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
440 # remove temporary files
441 removeFiles(['luatest.tex', 'luatest.log', 'luatest.aux', 'luatest.pdf'])
444 def checkModule(module):
445 ''' Check for a Python module, return the status '''
446 msg = 'checking for "' + module + ' module"... '
449 logger.info(msg + ' yes')
452 logger.info(msg + ' no')
456 def checkFormatEntries(dtl_tools):
457 ''' Check all formats (\Format entries) '''
458 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
459 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
461 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
462 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
464 checkViewerEditor('a Dia viewer and editor', ['dia'],
465 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector"'])
467 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
468 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
470 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
471 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
473 checkViewerEditor('a SVG viewer and editor', ['inkscape'],
474 rc_entry = [r'\Format svg svg SVG "" "%%" "%%" "vector"'])
476 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'],
477 rc_entry = [r'''\Format bmp bmp BMP "" "%s" "%s" ""
478 \Format gif gif GIF "" "%s" "%s" ""
479 \Format jpg jpg JPEG "" "%s" "%s" ""
480 \Format pbm pbm PBM "" "%s" "%s" ""
481 \Format pgm pgm PGM "" "%s" "%s" ""
482 \Format png png PNG "" "%s" "%s" ""
483 \Format ppm ppm PPM "" "%s" "%s" ""
484 \Format tiff tif TIFF "" "%s" "%s" ""
485 \Format xbm xbm XBM "" "%s" "%s" ""
486 \Format xpm xpm XPM "" "%s" "%s" ""'''])
487 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'],
488 rc_entry = [r'''\Format bmp bmp BMP "" "%s" "%s" ""
489 \Format gif gif GIF "" "%s" "%s" ""
490 \Format jpg jpg JPEG "" "%s" "%s" ""
491 \Format pbm pbm PBM "" "%s" "%s" ""
492 \Format pgm pgm PGM "" "%s" "%s" ""
493 \Format png png PNG "" "%s" "%s" ""
494 \Format ppm ppm PPM "" "%s" "%s" ""
495 \Format tiff tif TIFF "" "%s" "%s" ""
496 \Format xbm xbm XBM "" "%s" "%s" ""
497 \Format xpm xpm XPM "" "%s" "%s" ""'''])
498 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
499 \Format gif gif GIF "" "%s" "%s" ""
500 \Format jpg jpg JPEG "" "%s" "%s" ""
501 \Format pbm pbm PBM "" "%s" "%s" ""
502 \Format pgm pgm PGM "" "%s" "%s" ""
503 \Format png png PNG "" "%s" "%s" ""
504 \Format ppm ppm PPM "" "%s" "%s" ""
505 \Format tiff tif TIFF "" "%s" "%s" ""
506 \Format xbm xbm XBM "" "%s" "%s" ""
507 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
508 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
510 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
511 'nedit', 'gedit', 'notepad'],
512 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
513 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
514 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
515 \Format dateout tmp "date (output)" "" "" "%%" ""
516 \Format docbook sgml DocBook B "" "%%" "document,menu=export"
517 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export"
518 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
519 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export"
520 \Format literate nw NoWeb N "" "%%" "document,menu=export"
521 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export"
522 \Format r R "R/S code" "" "" "%%" "document,menu=export"
523 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
524 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export"
525 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export"
526 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export"
527 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export"
528 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export"
529 \Format text txt "Plain text" a "" "%%" "document,menu=export"
530 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
531 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
532 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
533 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
534 #Spreadsheets using ssconvert from gnumeric
535 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
536 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document"
537 \Format excel xls "Excel spreadsheet" "" "" "%%" "document"
538 \Format oocalc ods "OpenOffice spreadsheet" "" "" "%%" "document"'''])
540 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
541 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export"'])
543 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
544 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
545 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
546 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
547 'nedit', 'gedit', 'notepad'],
548 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
550 #checkProg('a Postscript interpreter', ['gs'],
551 # rc_entry = [ r'\ps_command "%%"' ])
552 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
553 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
554 \Format ps ps Postscript t "%%" "" "document,vector,menu=export"'''])
555 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
556 checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
558 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export"
559 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export"
560 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export"
561 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export"
562 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export"'''])
564 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
565 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export"
566 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export"'''])
568 # Windows only: DraftDVI
569 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
571 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
572 rc_entry = [r'\Format html html HTML H "%%" "" "document,menu=export"'])
574 checkViewerEditor('Noteedit', ['noteedit'],
575 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
577 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['swriter', 'oowriter', 'abiword'],
578 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector,menu=export"
579 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"'''])
581 checkViewerEditor('a Rich Text and Word viewer', ['swriter', 'oowriter', 'abiword'],
582 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export"
583 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export"'''])
585 # entries that do not need checkProg
586 addToRC(r'''\Format date "" "date command" "" "" "" ""
587 \Format csv csv "Table (CSV)" "" "" "" "document"
588 \Format fax "" Fax "" "" "" "document"
589 \Format lyx lyx LyX "" "" "" ""
590 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document"
591 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document"
592 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document"
593 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document,menu=export"
594 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document,menu=export"
595 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
596 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
597 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
598 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
599 \Format lyxpreview-lytex lyxpreview-lytex "LyX Preview (LilyPond book)" "" "" "" ""
600 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
601 \Format pdftex pdftex_t PDFTEX "" "" "" ""
602 \Format program "" Program "" "" "" ""
603 \Format pstex pstex_t PSTEX "" "" "" ""
604 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
605 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
606 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
610 def checkConverterEntries(java='', perl=''):
611 ''' Check all converters (\converter entries) '''
612 checkProg('the pdflatex program', ['pdflatex $$i'],
613 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
615 checkProg('XeTeX', ['xelatex $$i'],
616 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
620 # Look for tex2lyx in this order (see bugs #3308 and #6986):
621 # 1) If we're running LyX in-place then tex2lyx will be found
622 # in ../src/tex2lyx with respect to the srcdir.
623 # 2) If LyX was configured with a version suffix then tex2lyx
624 # will also have this version suffix.
625 # 3) Otherwise always use tex2lyx.
626 in_place = os.path.join(srcdir, '..', 'src', 'tex2lyx', 'tex2lyx')
627 in_place = os.path.abspath(in_place)
629 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_place, 'tex2lyx' + version_suffix, 'tex2lyx'],
630 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
631 \converter literate lyx "%% -n -f $$i $$o" ""'''], not_found = 'tex2lyx')
633 logger.warning("Failed to find tex2lyx on your system.")
636 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
637 rc_entry = [r'''\converter literate latex "%%" ""
638 \converter literate pdflatex "%%" ""'''])
640 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
641 rc_entry = [r'''\converter sweave latex "%%" ""
642 \converter sweave pdflatex "%%" ""
643 \converter sweave xetex "%%" ""
644 \converter sweave luatex "%%" ""'''])
646 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
647 rc_entry = [ r'\converter sweave r "%%" ""' ])
649 path, htmltolatex = checkProg('an HTML -> LaTeX converter', ['html2latex $$i',
650 'gnuhtml2latex $$i', 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar'],
651 rc_entry = [ r'\converter html latex "%%" ""',
652 r'\converter html latex "%%" ""',
653 r'\converter html latex "%%" ""', '', ''] )
654 if htmltolatex == 'htmltolatex.jar' and java != '':
655 addToRC(r'\converter html latex "%s -jar \"%s\" -input $$i -output $$o" ""'
656 % (java, os.path.join(path, htmltolatex)))
658 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
659 rc_entry = [ r'\converter word latex "%%" ""' ])
661 # eLyXer: search as an executable (elyxer.py, elyxer)
662 path, elyxer = checkProg('a LyX -> HTML converter',
663 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
664 rc_entry = [ r'\converter lyx html "%%" ""' ])
665 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
666 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
667 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
668 if elyxer.find('elyxer') >= 0:
669 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
670 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
672 # search for HTML converters other than eLyXer
673 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
674 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
675 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
676 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
677 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
678 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
679 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
681 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
682 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
683 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
684 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
685 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
686 if htmlconv.find('htlatex') >= 0:
687 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
689 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
692 # Check if LyXBlogger is installed
693 lyxblogger_found = checkModule('lyxblogger')
695 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document"')
696 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
699 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
700 rc_entry = [ r'\converter sxw latex "%%" ""' ])
702 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
703 rc_entry = [ r'\converter odt latex "%%" ""' ])
704 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
705 # the command mk4ht oolatex $$i has to be used as default,
706 # but as this would require to have Perl installed, in MiKTeX oolatex is
707 # directly available as application.
708 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
709 # Both SuSE and debian have oolatex
710 checkProg('a LaTeX -> Open Document converter', [
711 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
712 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
713 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
714 # On windows it is called latex2rt.exe
715 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
716 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
718 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
719 rc_entry = [ r'\converter rtf html "%%" ""' ])
721 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
722 rc_entry = [ r'\converter ps pdf "%%" ""' ])
724 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
725 rc_entry = [ r'\converter ps text2 "%%" ""' ])
727 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
728 rc_entry = [ r'\converter ps text3 "%%" ""' ])
730 checkProg('a PS to EPS converter', ['ps2eps $$i'],
731 rc_entry = [ r'\converter ps eps "%%" ""' ])
733 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
734 rc_entry = [ r'\converter pdf ps "%%" ""' ])
736 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
737 rc_entry = [ r'\converter pdf eps "%%" ""' ])
739 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
740 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
742 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
743 rc_entry = [ r'\converter dvi ps "%%" ""' ])
745 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
746 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
748 path, dvipng = checkProg('dvipng', ['dvipng'])
749 path, dv2dt = checkProg('DVI to DTL converter', ['dv2dt'])
750 if dvipng == "dvipng" and dv2dt == 'dv2dt':
751 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""')
753 # set empty converter to override the default imagemagick
754 addToRC(r'\converter lyxpreview png "" ""')
756 addToRC(r'\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""')
758 # set empty converter to override the default imagemagick
759 addToRC(r'\converter lyxpreview ppm "" ""')
761 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
762 rc_entry = [ r'\converter ps fax "%%" ""'])
764 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
765 if fig2dev == "fig2dev":
766 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
767 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
768 \converter fig png "fig2dev -L png $$i $$o" ""
769 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
770 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
772 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
773 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
775 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
777 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
778 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
779 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
782 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
783 rc_entry = [ r'\converter wmf eps "%%" ""'])
785 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
786 rc_entry = [ r'\converter emf eps "%%" ""'])
788 checkProg('an EPS -> PDF converter', ['epstopdf'],
789 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
791 # no agr -> pdf converter, since the pdf library used by gracebat is not
792 # free software and therefore not compiled in in many installations.
793 # Fortunately, this is not a big problem, because we will use epstopdf to
794 # convert from agr to pdf via eps without loss of quality.
795 checkProg('a Grace -> Image converter', ['gracebat'],
797 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
798 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
799 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
800 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
803 checkProg('a Dot -> Image converter', ['dot'],
805 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
806 \converter dot png "dot -Tpng $$i -o $$o" ""''',
809 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
810 rc_entry = [ r'\converter dia png "%%" ""'])
812 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
813 rc_entry = [ r'\converter dia eps "%%" ""'])
815 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
816 rc_entry = [ r'\converter svg pdf "%%" ""'])
818 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
819 rc_entry = [ r'\converter svg eps "%%" ""'])
821 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
822 rc_entry = [ r'\converter svg png "%%" ""'])
825 # gnumeric/xls/ods to tex
826 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
827 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
828 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
829 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
832 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
834 version_string = cmdOutput("lilypond --version")
835 match = re.match('GNU LilyPond (\S+)', version_string)
837 version_number = match.groups()[0]
838 version = version_number.split('.')
839 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
840 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
841 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
842 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
843 logger.info('+ found LilyPond version %s.' % version_number)
844 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
845 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
846 \converter lilypond png "lilypond -b eps --png $$i" ""''')
847 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
848 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf --safe $$i" ""')
849 logger.info('+ found LilyPond version %s.' % version_number)
851 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
853 logger.info('+ found LilyPond, but could not extract version number.')
855 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
856 if (lilypond_book != ''):
857 version_string = cmdOutput("lilypond-book --version")
858 match = re.match('^(\S+)$', version_string)
860 version_number = match.groups()[0]
861 version = version_number.split('.')
862 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
864 addToRC(r'\converter lyxpreview-lytex ppm "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
866 # set empty converter to override the default imagemagick
867 addToRC(r'\converter lyxpreview-lytex ppm "" ""')
868 if dvipng == "dvipng" and dv2dt == 'dv2dt':
869 addToRC(r'\converter lyxpreview-lytex png "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
871 # set empty converter to override the default imagemagick
872 addToRC(r'\converter lyxpreview-lytex png "" ""')
873 # Note: The --lily-output-dir flag is required because lilypond-book
874 # does not process input again unless the input has changed,
875 # even if the output format being requested is different. So
876 # once a .eps file exists, lilypond-book won't create a .pdf
877 # even when requested with --pdf. This is a problem if a user
878 # clicks View PDF after having done a View DVI. To circumvent
879 # this, use different output folders for eps and pdf outputs.
880 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
881 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
882 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
883 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
884 logger.info('+ found LilyPond-book version %s.' % version_number)
886 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
888 logger.info('+ found LilyPond-book, but could not extract version number.')
890 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
891 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
893 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
894 # and a zip archive on Windows.
895 # So, we configure the appropriate version according to the platform.
896 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$i" ""'
898 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export"')
899 addToRC(cmd % "lyxzip")
901 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export"')
902 addToRC(cmd % "lyxgz")
905 # FIXME: no rc_entry? comment it out
906 # checkProg('Image converter', ['convert $$i $$o'])
908 # Entries that do not need checkProg
909 addToRC(r'''\converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
910 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
911 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
912 \converter docbook docbook-xml "cp $$i $$o" "xml"
913 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
914 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
915 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
916 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
917 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
918 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
919 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
920 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
921 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
922 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
923 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
924 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
929 ''' Check docbook '''
930 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
932 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
933 \converter docbook html "sgmltools -b html $$i" ""''',
934 r'''\converter docbook dvi "db2dvi $$i" ""
935 \converter docbook html "db2html $$i" ""''',
936 r'''\converter docbook dvi "" ""
937 \converter docbook html "" ""''',
938 r'''\converter docbook dvi "" ""
939 \converter docbook html "" ""'''])
942 return ('yes', 'true', '\\def\\hasdocbook{yes}')
944 return ('no', 'false', '')
947 def checkOtherEntries(java='', perl=''):
948 ''' entries other than Format and Converter '''
949 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
950 rc_entry = [ r'\chktex_command "%%"' ])
951 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
952 rc_entry = [ r'\bibtex_command "%%"' ],
953 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
954 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
955 rc_entry = [ r'\jbibtex_command "%%"' ])
956 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
957 rc_entry = [ r'\index_command "%%"' ],
958 alt_rc_entry = [ r'\index_alternatives "%%"' ])
959 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
960 rc_entry = [ r'\jindex_command "%%"' ])
961 path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
962 'splitindex.class'], rc_entry = ['', r'\splitindex_command "%%"', '', ''])
963 if splitindex == 'splitindex.pl' and perl != '':
964 addToRC(r'\splitindex_command "%s -w \"%s\""' % (perl, os.path.join(path, splitindex)))
965 elif splitindex == 'splitindex.class' and java != '':
966 addToRC(r'\splitindex_command "%s \"%s\""' % (java, os.path.join(path, 'splitindex')))
967 checkProg('a nomenclature processor', ['makeindex'],
968 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
969 ## FIXME: OCTAVE is not used anywhere
970 # path, OCTAVE = checkProg('Octave', ['octave'])
971 ## FIXME: MAPLE is not used anywhere
972 # path, MAPLE = checkProg('Maple', ['maple'])
973 checkProg('a spool command', ['lp', 'lpr'],
975 r'''\print_spool_printerprefix "-d "
976 \print_spool_command "lp"''',
977 r'''\print_spool_printerprefix "-P",
978 \print_spool_command "lpr"''',
980 # Add the rest of the entries (no checkProg is required)
981 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
982 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
983 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
984 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
988 def processLayoutFile(file, bool_docbook):
989 ''' process layout file and get a line of result
991 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
993 \DeclareLaTeXClass{article}
994 \DeclareLaTeXClass[scrbook]{book (koma-script)}
995 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
999 "article" "article" "article" "false" "article.cls"
1000 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
1001 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
1003 def checkForClassExtension(x):
1004 '''if the extension for a latex class is not
1005 provided, add .cls to the classname'''
1007 return x.strip() + '.cls'
1010 classname = file.split(os.sep)[-1].split('.')[0]
1011 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1012 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1013 for line in open(file).readlines():
1014 res = p.search(line)
1016 (classtype, optAll, opt, opt1, desc) = res.groups()
1017 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1020 prereq_latex = checkForClassExtension(classname)
1022 prereq_list = optAll[1:-1].split(',')
1023 prereq_list = map(checkForClassExtension, prereq_list)
1024 prereq_latex = ','.join(prereq_list)
1025 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1026 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1027 return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
1028 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1032 def checkLatexConfig(check_config, bool_docbook):
1033 ''' Explore the LaTeX configuration
1034 Return None (will be passed to sys.exit()) for success.
1036 msg = 'checking LaTeX configuration... '
1037 # if --without-latex-config is forced, or if there is no previous
1038 # version of textclass.lst, re-generate a default file.
1039 if not os.path.isfile('textclass.lst') or not check_config:
1040 # remove the files only if we want to regenerate
1041 removeFiles(['textclass.lst', 'packages.lst'])
1043 # Then, generate a default textclass.lst. In case configure.py
1044 # fails, we still have something to start lyx.
1045 logger.info(msg + ' default values')
1046 logger.info('+checking list of textclasses... ')
1047 tx = open('textclass.lst', 'w')
1049 # This file declares layouts and their associated definition files
1050 # (include dir. relative to the place where this file is).
1051 # It contains only default values, since chkconfig.ltx could not be run
1052 # for some reason. Run ./configure.py if you need to update it after a
1053 # configuration change.
1055 # build the list of available layout files and convert it to commands
1058 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1059 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1061 if not os.path.isfile(file):
1063 # get stuff between /xxxx.layout .
1064 classname = file.split(os.sep)[-1].split('.')[0]
1066 cleanclass = classname.replace(' ', '_')
1067 cleanclass = cleanclass.replace('-', '_')
1068 # make sure the same class is not considered twice
1069 if foundClasses.count(cleanclass) == 0: # not found before
1070 foundClasses.append(cleanclass)
1071 retval = processLayoutFile(file, bool_docbook)
1075 logger.info('\tdone')
1076 if not check_config:
1078 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1079 logger.info(msg + '\tauto')
1080 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1081 'wrap_chkconfig.ltx'])
1083 if not os.path.isfile( 'chkconfig.ltx' ):
1084 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1086 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1087 # Construct the list of classes to test for.
1088 # build the list of available layout files and convert it to commands
1090 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1091 empty = re.compile(r'^\s*$')
1092 testclasses = list()
1093 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1094 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1095 nodeclaration = False
1096 if not os.path.isfile(file):
1098 classname = file.split(os.sep)[-1].split('.')[0]
1099 for line in open(file).readlines():
1100 if not empty.match(line) and line[0] != '#':
1101 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1102 nodeclaration = True
1104 if declare.search(line) == None:
1106 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1111 cl = open('chklayouts.tex', 'w')
1112 for line in testclasses:
1113 cl.write(line + '\n')
1116 # we have chklayouts.tex, then process it
1118 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx')
1119 for line in latex_out.splitlines():
1120 if re.match('^\+', line):
1121 logger.info(line.strip())
1122 # return None if the command succeeds
1123 if line == "+Inspection done.":
1126 # remove the copied file
1128 removeFiles( [ 'chkconfig.ltx' ] )
1130 # currently, values in chhkconfig are only used to set
1133 for line in open('chkconfig.vars').readlines():
1134 key, val = re.sub('-', '_', line).split('=')
1136 values[key] = val.strip("'")
1137 # chk_fontenc may not exist
1139 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1142 # if configure successed, move textclass.lst.tmp to textclass.lst
1143 # and packages.lst.tmp to packages.lst
1144 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1145 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1146 shutil.move('textclass.lst.tmp', 'textclass.lst')
1147 shutil.move('packages.lst.tmp', 'packages.lst')
1151 def checkModulesConfig():
1152 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1154 logger.info('+checking list of modules... ')
1155 tx = open('lyxmodules.lst', 'w')
1156 tx.write('''## This file declares modules and their associated definition files.
1157 ## It has been automatically generated by configure
1158 ## Use "Options/Reconfigure" if you need to update it after a
1159 ## configuration change.
1160 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1163 # build the list of available modules
1165 # note that this searches the local directory first, then the
1166 # system directory. that way, we pick up the user's version first.
1167 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1168 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1171 if not os.path.isfile(file):
1174 filename = file.split(os.sep)[-1]
1175 filename = filename[:-7]
1176 if seen.count(filename):
1179 seen.append(filename)
1180 retval = processModuleFile(file, filename, bool_docbook)
1184 logger.info('\tdone')
1187 def processModuleFile(file, filename, bool_docbook):
1188 ''' process module file and get a line of result
1190 The top of a module file should look like this:
1191 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1193 #...body of description...
1195 #Requires: [list of required modules]
1196 #Excludes: [list of excluded modules]
1197 #Category: [category name]
1198 The last three lines are optional (though do give a category).
1200 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1202 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1203 rereqs = re.compile(r'#+\s*Requires: (.*)')
1204 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1205 recaty = re.compile(r'#+\s*Category: (.*)')
1206 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1207 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1209 modname = desc = pkgs = req = excl = catgy = ""
1210 readingDescription = False
1213 for line in open(file).readlines():
1214 if readingDescription:
1215 res = redend.search(line)
1217 readingDescription = False
1218 desc = " ".join(descLines)
1220 desc = desc.replace('"', '\\"')
1222 descLines.append(line[1:].strip())
1224 res = redbeg.search(line)
1226 readingDescription = True
1228 res = remods.search(line)
1230 (pkgs, modname) = res.groups()
1234 tmp = [s.strip() for s in pkgs.split(",")]
1235 pkgs = ",".join(tmp)
1237 res = rereqs.search(line)
1240 tmp = [s.strip() for s in req.split("|")]
1243 res = reexcs.search(line)
1246 tmp = [s.strip() for s in excl.split("|")]
1247 excl = "|".join(tmp)
1249 res = recaty.search(line)
1251 catgy = res.group(1)
1255 logger.warning("Module file without \DeclareLyXModule line. ")
1259 # this module has some latex dependencies:
1260 # append the dependencies to chkmodules.tex,
1261 # which is \input'ed by chkconfig.ltx
1262 testpackages = list()
1263 for pkg in pkgs.split(","):
1265 # this is a converter dependency: skip
1267 if pkg.endswith(".sty"):
1269 testpackages.append("\\TestPackage{%s}" % (pkg,))
1270 cm = open('chkmodules.tex', 'a')
1271 for line in testpackages:
1272 cm.write(line + '\n')
1275 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1278 def checkTeXAllowSpaces():
1279 ''' Let's check whether spaces are allowed in TeX file names '''
1280 tex_allows_spaces = 'false'
1281 if lyx_check_config:
1282 msg = "Checking whether TeX allows spaces in file names... "
1283 writeToFile('a b.tex', r'\message{working^^J}' )
1285 if os.name == 'nt' or sys.platform == 'cygwin':
1286 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1288 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1291 if 'working' in latex_out:
1292 logger.info(msg + 'yes')
1293 tex_allows_spaces = 'true'
1295 logger.info(msg + 'no')
1296 tex_allows_spaces = 'false'
1297 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1298 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1301 def removeTempFiles():
1303 if not lyx_keep_temps:
1304 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1305 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1306 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1309 if __name__ == '__main__':
1310 lyx_check_config = True
1311 outfile = 'lyxrc.defaults'
1312 lyxrc_fileformat = 1
1314 lyx_keep_temps = False
1316 ## Parse the command line
1317 for op in sys.argv[1:]: # default shell/for list is $*, the options
1318 if op in [ '-help', '--help', '-h' ]:
1319 print '''Usage: configure [options]
1321 --help show this help lines
1322 --keep-temps keep temporary files (for debug. purposes)
1323 --without-latex-config do not run LaTeX to determine configuration
1324 --with-version-suffix=suffix suffix of binary installed files
1327 elif op == '--without-latex-config':
1328 lyx_check_config = False
1329 elif op == '--keep-temps':
1330 lyx_keep_temps = True
1331 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1332 version_suffix = op[22:]
1334 print "Unknown option", op
1337 # check if we run from the right directory
1338 srcdir = os.path.dirname(sys.argv[0])
1341 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1342 logger.error("configure: error: cannot find chkconfig.ltx script")
1346 dtl_tools = checkDTLtools()
1347 ## Write the first part of outfile
1348 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1349 # script. It contains default settings that have been determined by
1350 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1351 # want to customize LyX, use LyX' Preferences dialog or modify directly
1352 # the "preferences" file instead. Any setting in that file will
1353 # override the values given here.
1357 ''' % lyxrc_fileformat)
1359 LATEX = checkLatex(dtl_tools)
1360 checkFormatEntries(dtl_tools)
1361 java = checkProg('a java interpreter', ['java'])[1]
1362 perl = checkProg('a perl interpreter', ['perl'])[1]
1363 checkConverterEntries(java, perl)
1364 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1365 checkTeXAllowSpaces()
1366 windows_style_tex_paths = checkTeXPaths()
1367 if windows_style_tex_paths != '':
1368 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1369 checkOtherEntries(java, perl)
1370 checkModulesConfig()
1371 # --without-latex-config can disable lyx_check_config
1372 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1374 # The return error code can be 256. Because most systems expect an error code
1375 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1376 # a None for success, 'ret is not None' is used to exit.
1377 sys.exit(ret is not None)