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 sys, os, re, shutil, glob, logging
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
70 ''' I do not really know why this is useful, but we might as well keep it.
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.
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')
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 ):
90 logger.debug('Create directory %s.' % dir)
92 logger.error('Failed to create directory %s.' % dir)
97 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
98 windows_style_tex_paths = ''
99 if os.name == 'nt' or sys.platform == 'cygwin':
100 from tempfile import mkstemp
101 fd, tmpfname = mkstemp(suffix='.ltx')
103 inpname = tmpfname.replace('\\', '/')
105 inpname = cmdOutput('cygpath -m ' + tmpfname)
106 logname = os.path.basename(inpname.replace('.ltx', '.log'))
107 inpname = inpname.replace('~', '\\string~')
108 os.write(fd, r'\relax')
110 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}"' % inpname)
111 if 'Error' in latex_out:
112 logger.warning("configure: TeX engine needs posix-style paths in latex files")
113 windows_style_tex_paths = 'false'
115 logger.info("configure: TeX engine needs windows-style paths in latex files")
116 windows_style_tex_paths = 'true'
117 removeFiles([tmpfname, logname, 'texput.log'])
118 return windows_style_tex_paths
121 ## Searching some useful programs
122 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
124 This function will search a program in $PATH plus given path
125 If found, return directory and program name (not the options).
127 description: description of the program
129 progs: check programs, for each prog, the first word is used
130 for searching but the whole string is used to replace
131 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
133 path: additional pathes
135 rc_entry: entry to outfile, can be
136 1. emtpy: no rc entry will be added
137 2. one pattern: %% will be replaced by the first found program,
138 or '' if no program is found.
139 3. several patterns for each prog and not_found. This is used
140 when different programs have different usages. If you do not
141 want not_found entry to be added to the RC file, you can specify
142 an entry for each prog and use '' for the not_found entry.
144 not_found: the value that should be used instead of '' if no program
148 # one rc entry for each progs plus not_found entry
149 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
150 logger.error("rc entry should have one item or item for each prog and not_found.")
152 logger.info('checking for ' + description + '...')
153 ## print '(' + ','.join(progs) + ')',
154 for idx in range(len(progs)):
155 # ac_prog may have options, ac_word is the command name
157 ac_word = ac_prog.split(' ')[0]
158 msg = '+checking for "' + ac_word + '"... '
159 path = os.environ["PATH"].split(os.pathsep) + path
161 if os.environ.has_key("PATHEXT"):
162 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
165 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
166 logger.info(msg + ' yes')
167 # write rc entries for this command
168 if len(rc_entry) == 1:
169 addToRC(rc_entry[0].replace('%%', ac_prog))
170 elif len(rc_entry) > 1:
171 addToRC(rc_entry[idx].replace('%%', ac_prog))
172 return [ac_dir, ac_word]
174 logger.info(msg + ' no')
175 # write rc entries for 'not found'
176 if len(rc_entry) > 0: # the last one.
177 addToRC(rc_entry[-1].replace('%%', not_found))
178 return ['', not_found]
181 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
183 The same as checkProg, but additionally, all found programs will be added
186 # one rc entry for each progs plus not_found entry
187 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
188 logger.error("rc entry should have one item or item for each prog and not_found.")
190 logger.info('checking for ' + description + '...')
191 ## print '(' + ','.join(progs) + ')',
194 real_ac_word = not_found
195 for idx in range(len(progs)):
196 # ac_prog may have options, ac_word is the command name
198 ac_word = ac_prog.split(' ')[0]
199 msg = '+checking for "' + ac_word + '"... '
200 path = os.environ["PATH"].split(os.pathsep) + path
202 if os.environ.has_key("PATHEXT"):
203 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
207 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
208 logger.info(msg + ' yes')
209 pr = re.compile(r'(\\\S+)(.*)$')
211 # write rc entries for this command
212 if found_prime == False:
213 if len(rc_entry) == 1:
214 addToRC(rc_entry[0].replace('%%', ac_prog))
215 elif len(rc_entry) > 1:
216 addToRC(rc_entry[idx].replace('%%', ac_prog))
218 real_ac_word = ac_word
220 if len(alt_rc_entry) == 1:
221 alt_rc = alt_rc_entry[0]
223 # if no explicit alt_rc is given, construct one
224 m = pr.match(rc_entry[0])
226 alt_rc = m.group(1) + "_alternatives" + m.group(2)
227 addToRC(alt_rc.replace('%%', ac_prog))
228 elif len(alt_rc_entry) > 1:
229 alt_rc = alt_rc_entry[idx]
231 # if no explicit alt_rc is given, construct one
232 m = pr.match(rc_entry[idx])
234 alt_rc = m.group(1) + "_alternatives" + m.group(2)
235 addToRC(alt_rc.replace('%%', ac_prog))
240 if found_alt == False:
242 logger.info(msg + ' no')
244 return [real_ac_dir, real_ac_word]
245 # write rc entries for 'not found'
246 if len(rc_entry) > 0: # the last one.
247 addToRC(rc_entry[-1].replace('%%', not_found))
248 return ['', not_found]
251 def addViewerAlternatives(rcs):
252 r = re.compile(r'\\Format (\S+).*$')
255 for idxx in range(len(rcs)):
259 alt = r'\viewer_alternatives ' + m.group(1) + " %%"
261 m = r.match(rcs[idxx])
265 alt += r'\viewer_alternatives ' + m.group(1) + " %%"
269 def addEditorAlternatives(rcs):
270 r = re.compile(r'\\Format (\S+).*$')
273 for idxx in range(len(rcs)):
277 alt = r'\editor_alternatives ' + m.group(1) + " %%"
279 m = r.match(rcs[idxx])
283 alt += r'\editor_alternatives ' + m.group(1) + " %%"
287 def checkViewer(description, progs, rc_entry = [], path = []):
288 ''' The same as checkProgAlternatives, but for viewers '''
289 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
290 logger.error("rc entry should have one item or item for each prog and not_found.")
293 for idx in range(len(progs)):
294 if len(rc_entry) == 1:
295 rcs = rc_entry[0].split('\n')
296 alt = addViewerAlternatives(rcs)
297 alt_rc_entry.insert(0, alt)
298 elif len(rc_entry) > 1:
299 rcs = rc_entry[idx].split('\n')
300 alt = addViewerAlternatives(rcs)
301 alt_rc_entry.insert(idx, alt)
302 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
305 def checkEditor(description, progs, rc_entry = [], path = []):
306 ''' The same as checkProgAlternatives, but for editors '''
307 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
308 logger.error("rc entry should have one item or item for each prog and not_found.")
311 for idx in range(len(progs)):
312 if len(rc_entry) == 1:
313 rcs = rc_entry[0].split('\n')
314 alt = addEditorAlternatives(rcs)
315 alt_rc_entry.insert(0, alt)
316 elif len(rc_entry) > 1:
317 rcs = rc_entry[idx].split('\n')
318 alt = addEditorAlternatives(rcs)
319 alt_rc_entry.insert(idx, alt)
320 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
323 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
324 ''' The same as checkViewer, but do not add rc entry '''
325 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
326 logger.error("rc entry should have one item or item for each prog and not_found.")
329 for idx in range(len(progs)):
330 if len(rc_entry) == 1:
331 rcs = rc_entry[0].split('\n')
332 alt = addViewerAlternatives(rcs)
333 alt_rc_entry.insert(0, alt)
334 elif len(rc_entry) > 1:
335 rcs = rc_entry[idx].split('\n')
336 alt = addViewerAlternatives(rcs)
337 alt_rc_entry.insert(idx, alt)
339 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
342 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
343 ''' The same as checkViewer, but do not add rc entry '''
344 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
345 logger.error("rc entry should have one item or item for each prog and not_found.")
348 for idx in range(len(progs)):
349 if len(rc_entry) == 1:
350 rcs = rc_entry[0].split('\n')
351 alt = addEditorAlternatives(rcs)
352 alt_rc_entry.insert(0, alt)
353 elif len(rc_entry) > 1:
354 rcs = rc_entry[idx].split('\n')
355 alt = addEditorAlternatives(rcs)
356 alt_rc_entry.insert(idx, alt)
358 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
361 def checkViewerEditor(description, progs, rc_entry = [], path = []):
362 ''' The same as checkProgAlternatives, but for viewers and editors '''
363 checkEditorNoRC(description, progs, rc_entry, path)
364 return checkViewer(description, progs, rc_entry, path)
368 ''' Check whether DTL tools are available (Windows only) '''
369 # Find programs! Returned path is not used now
370 if ((os.name == 'nt' or sys.platform == 'cygwin') and
371 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
372 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
379 def checkLatex(dtl_tools):
380 ''' Check latex, return lyx_check_config '''
381 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
382 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
383 #-----------------------------------------------------------------
384 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
386 # check if PLATEX is pLaTeX2e
387 writeToFile('chklatex.ltx', '''
391 # run platex on chklatex.ltx and check result
392 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
393 # We have the Japanese pLaTeX2e
394 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
397 removeFiles(['chklatex.ltx', 'chklatex.log'])
398 #-----------------------------------------------------------------
399 # use LATEX to convert from latex to dvi if PPLATEX is not available
403 # Windows only: DraftDVI
404 addToRC(r'''\converter latex dvi2 "%s" "latex"
405 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
407 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
410 # Check if latex is usable
411 writeToFile('chklatex.ltx', '''
412 \\nonstopmode\\makeatletter
413 \\ifx\\undefined\\documentclass\\else
414 \\message{ThisIsLaTeX2e}
418 # run latex on chklatex.ltx and check result
419 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
423 logger.warning("Latex not usable (not LaTeX2e) ")
424 # remove temporary files
425 removeFiles(['chklatex.ltx', 'chklatex.log'])
429 def checkModule(module):
430 ''' Check for a Python module, return the status '''
431 msg = 'checking for "' + module + ' module"... '
434 logger.info(msg + ' yes')
437 logger.info(msg + ' no')
441 def checkFormatEntries(dtl_tools):
442 ''' Check all formats (\Format entries) '''
443 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
444 rc_entry = [r'\Format tgif obj Tgif "" "%%" "%%" "vector"'])
446 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
447 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector"'])
449 checkViewerEditor('a Dia viewer and editor', ['dia'],
450 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector"'])
452 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
453 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector"'])
455 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
456 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" ""'])
458 checkViewerEditor('a SVG viewer and editor', ['inkscape'],
459 rc_entry = [r'\Format svg svg SVG "" "%%" "%%" "vector"'])
461 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'],
462 rc_entry = [r'''\Format bmp bmp BMP "" "%s" "%s" ""
463 \Format gif gif GIF "" "%s" "%s" ""
464 \Format jpg jpg JPEG "" "%s" "%s" ""
465 \Format pbm pbm PBM "" "%s" "%s" ""
466 \Format pgm pgm PGM "" "%s" "%s" ""
467 \Format png png PNG "" "%s" "%s" ""
468 \Format ppm ppm PPM "" "%s" "%s" ""
469 \Format tiff tif TIFF "" "%s" "%s" ""
470 \Format xbm xbm XBM "" "%s" "%s" ""
471 \Format xpm xpm XPM "" "%s" "%s" ""'''])
472 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'],
473 rc_entry = [r'''\Format bmp bmp BMP "" "%s" "%s" ""
474 \Format gif gif GIF "" "%s" "%s" ""
475 \Format jpg jpg JPEG "" "%s" "%s" ""
476 \Format pbm pbm PBM "" "%s" "%s" ""
477 \Format pgm pgm PGM "" "%s" "%s" ""
478 \Format png png PNG "" "%s" "%s" ""
479 \Format ppm ppm PPM "" "%s" "%s" ""
480 \Format tiff tif TIFF "" "%s" "%s" ""
481 \Format xbm xbm XBM "" "%s" "%s" ""
482 \Format xpm xpm XPM "" "%s" "%s" ""'''])
483 addToRC(r'''\Format bmp bmp BMP "" "%s" "%s" ""
484 \Format gif gif GIF "" "%s" "%s" ""
485 \Format jpg jpg JPEG "" "%s" "%s" ""
486 \Format pbm pbm PBM "" "%s" "%s" ""
487 \Format pgm pgm PGM "" "%s" "%s" ""
488 \Format png png PNG "" "%s" "%s" ""
489 \Format ppm ppm PPM "" "%s" "%s" ""
490 \Format tiff tif TIFF "" "%s" "%s" ""
491 \Format xbm xbm XBM "" "%s" "%s" ""
492 \Format xpm xpm XPM "" "%s" "%s" ""''' % \
493 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
495 checkViewerEditor('a text editor', ['sensible-editor', 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
496 'nedit', 'gedit', 'notepad'],
497 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" ""
498 \Format asciiimage asc "Plain text (image)" "" "" "%%" ""
499 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" ""
500 \Format dateout tmp "date (output)" "" "" "%%" ""
501 \Format docbook sgml DocBook B "" "%%" "document"
502 \Format docbook-xml xml "Docbook (XML)" "" "" "%%" "document"
503 \Format dot dot "Graphviz Dot" "" "" "%%" "vector"
504 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document"
505 \Format literate nw NoWeb N "" "%%" "document"
506 \Format sweave Rnw "Sweave" S "" "%%" "document"
507 \Format lilypond ly "LilyPond music" "" "" "%%" "vector"
508 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document"
509 \Format latex tex "LaTeX (plain)" L "" "%%" "document"
510 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document"
511 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
512 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document"
513 \Format text txt "Plain text" a "" "%%" "document"
514 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
515 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
516 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
517 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
518 #Spreadsheets using ssconvert from gnumeric
519 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
520 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document"
521 \Format excel xls "Excel spreadsheet" "" "" "%%" "document"
522 \Format oocalc ods "OpenOffice spreadsheet" "" "" "%%" "document"'''])
524 path, xhtmlview = checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
525 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document"'])
527 addToRC(r'\Format xhtml xhtml "LyXHTML" y "" "" "document"')
529 checkEditor('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
530 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
531 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
532 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
533 'nedit', 'gedit', 'notepad'],
534 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
536 #checkProg('a Postscript interpreter', ['gs'],
537 # rc_entry = [ r'\ps_command "%%"' ])
538 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
539 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
540 \Format ps ps Postscript t "%%" "" "document,vector"'''])
541 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
542 checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
544 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
545 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
546 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"
547 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector"
548 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector"'''])
550 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
551 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector"
552 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector"'''])
554 # Windows only: DraftDVI
555 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
557 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
558 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
560 checkViewerEditor('Noteedit', ['noteedit'],
561 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
563 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['swriter', 'oowriter', 'abiword'],
564 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector"
565 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"'''])
567 checkViewerEditor('a Rich Text and Word viewer', ['swriter', 'oowriter', 'abiword'],
568 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector"
569 \Format word doc "MS Word" W "%%" "%%" "document,vector"'''])
571 # entries that do not need checkProg
572 addToRC(r'''\Format date "" "date command" "" "" "" ""
573 \Format csv csv "Table (CSV)" "" "" "" "document"
574 \Format fax "" Fax "" "" "" "document"
575 \Format lyx lyx LyX "" "" "" ""
576 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document"
577 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document"
578 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document"
579 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document"
580 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
581 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
582 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
583 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
584 \Format lyxpreview-lytex lyxpreview-lytex "LyX Preview (LilyPond book)" "" "" "" ""
585 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
586 \Format pdftex pdftex_t PDFTEX "" "" "" ""
587 \Format program "" Program "" "" "" ""
588 \Format pstex pstex_t PSTEX "" "" "" ""
589 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
590 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
591 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
595 def checkConverterEntries():
596 ''' Check all converters (\converter entries) '''
597 checkProg('the pdflatex program', ['pdflatex $$i'],
598 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
600 checkProg('XeTeX', ['xelatex $$i'],
601 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
603 checkProg('LuaTeX', ['lualatex $$i'],
604 rc_entry = [ r'\converter luatex pdf5 "%%" "latex=lualatex"' ])
606 checkProg('LuaTeX (DVI)', ['dvilualatex $$i'],
607 rc_entry = [ r'\converter luatex dvi3 "%%" "latex=lualatex"' ])
609 ''' If we're running LyX in-place then tex2lyx will be found in
610 ../src/tex2lyx. Add this directory to the PATH temporarily and
612 Use PATH to avoid any problems with paths-with-spaces.
614 path_orig = os.environ["PATH"]
615 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
616 os.pathsep + path_orig
618 # First search for tex2lyx with version suffix (bug 6986)
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" ""'''])
623 os.environ["PATH"] = path_orig
626 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
627 rc_entry = [r'''\converter literate latex "%%" ""
628 \converter literate pdflatex "%%" ""'''])
630 checkProg('a Sweave -> LaTeX converter', ['Rscript --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$e $$r'],
631 rc_entry = [r'''\converter sweave latex "%%" ""
632 \converter sweave pdflatex "%%" ""'''])
634 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
635 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
636 rc_entry = [ r'\converter html latex "%%" ""' ])
638 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
639 rc_entry = [ r'\converter word latex "%%" ""' ])
641 # eLyXer: search as an executable (elyxer.py, elyxer)
642 path, elyxer = checkProg('a LyX -> HTML converter',
643 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
644 rc_entry = [ r'\converter lyx html "%%" ""' ])
645 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
646 ['elyxer.py --html --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
647 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
648 if elyxer.find('elyxer') >= 0:
649 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
650 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
652 # search for HTML converters other than eLyXer
653 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
654 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
655 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
656 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
657 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
658 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
659 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
661 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
662 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
663 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
664 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
665 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
666 if htmlconv.find('htlatex') >= 0:
667 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
669 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
672 # Check if LyXBlogger is installed
673 lyxblogger_found = checkModule('lyxblogger')
675 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document"')
676 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
679 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
680 rc_entry = [ r'\converter sxw latex "%%" ""' ])
682 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
683 rc_entry = [ r'\converter odt latex "%%" ""' ])
684 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
685 # the command mk4ht oolatex $$i has to be used as default,
686 # but as this would require to have Perl installed, in MiKTeX oolatex is
687 # directly available as application.
688 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
689 # Both SuSE and debian have oolatex
690 checkProg('a LaTeX -> Open Document converter', [
691 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
692 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
693 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
694 # On windows it is called latex2rt.exe
695 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
696 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
698 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
699 rc_entry = [ r'\converter rtf html "%%" ""' ])
701 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
702 rc_entry = [ r'\converter ps pdf "%%" ""' ])
704 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
705 rc_entry = [ r'\converter ps text2 "%%" ""' ])
707 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
708 rc_entry = [ r'\converter ps text3 "%%" ""' ])
710 checkProg('a PS to EPS converter', ['ps2eps $$i'],
711 rc_entry = [ r'\converter ps eps "%%" ""' ])
713 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
714 rc_entry = [ r'\converter pdf ps "%%" ""' ])
716 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
717 rc_entry = [ r'\converter pdf eps "%%" ""' ])
719 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
720 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
722 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
723 rc_entry = [ r'\converter dvi ps "%%" ""' ])
725 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
726 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
728 path, dvipng = checkProg('dvipng', ['dvipng'])
729 path, dv2dt = checkProg('DVI to DTL converter', ['dv2dt'])
730 if dvipng == "dvipng" and dv2dt == 'dv2dt':
731 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
733 # set empty converter to override the default imagemagick
734 addToRC(r'\converter lyxpreview png "" ""')
736 addToRC(r'\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
738 # set empty converter to override the default imagemagick
739 addToRC(r'\converter lyxpreview ppm "" ""')
741 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
742 rc_entry = [ r'\converter ps fax "%%" ""'])
744 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
745 if fig2dev == "fig2dev":
746 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
747 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
748 \converter fig png "fig2dev -L png $$i $$o" ""
749 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
750 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
752 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
753 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
755 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
757 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
758 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
759 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
762 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
763 rc_entry = [ r'\converter wmf eps "%%" ""'])
765 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
766 rc_entry = [ r'\converter emf eps "%%" ""'])
768 checkProg('an EPS -> PDF converter', ['epstopdf'],
769 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
771 # no agr -> pdf converter, since the pdf library used by gracebat is not
772 # free software and therefore not compiled in in many installations.
773 # Fortunately, this is not a big problem, because we will use epstopdf to
774 # convert from agr to pdf via eps without loss of quality.
775 checkProg('a Grace -> Image converter', ['gracebat'],
777 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
778 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
779 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
780 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
783 checkProg('a Dot -> Image converter', ['dot'],
785 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
786 \converter dot png "dot -Tpng $$i -o $$o" ""''',
789 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
790 rc_entry = [ r'\converter dia png "%%" ""'])
792 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
793 rc_entry = [ r'\converter dia eps "%%" ""'])
795 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', 'inkscape --file=$$p/$$i --export-area-drawing --without-gui --export-pdf=$$p/$$o'],
796 rc_entry = [ r'\converter svg pdf "%%" ""'])
798 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', 'inkscape --file=$$p/$$i --export-area-drawing --without-gui --export-eps=$$p/$$o'],
799 rc_entry = [ r'\converter svg eps "%%" ""'])
800 # the PNG export via Inkscape must not have the full path ($$p) for the file
801 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
802 rc_entry = [ r'\converter svg png "%%" ""'])
805 # gnumeric/xls/ods to tex
806 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
807 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
808 \converter ods latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
809 \converter xls latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""''',
812 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
814 version_string = cmdOutput("lilypond --version")
815 match = re.match('GNU LilyPond (\S+)', version_string)
817 version_number = match.groups()[0]
818 version = version_number.split('.')
819 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
820 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
821 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
822 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
823 logger.info('+ found LilyPond version %s.' % version_number)
824 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
825 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
826 \converter lilypond png "lilypond -b eps --png $$i" ""''')
827 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
828 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf --safe $$i" ""')
829 logger.info('+ found LilyPond version %s.' % version_number)
831 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
833 logger.info('+ found LilyPond, but could not extract version number.')
835 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
836 if (lilypond_book != ''):
837 version_string = cmdOutput("lilypond-book --version")
838 match = re.match('^(\S+)$', version_string)
840 version_number = match.groups()[0]
841 version = version_number.split('.')
842 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
844 addToRC(r'\converter lyxpreview-lytex ppm "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
846 # set empty converter to override the default imagemagick
847 addToRC(r'\converter lyxpreview-lytex ppm "" ""')
848 if dvipng == "dvipng" and dv2dt == 'dv2dt':
849 addToRC(r'\converter lyxpreview-lytex png "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
851 # set empty converter to override the default imagemagick
852 addToRC(r'\converter lyxpreview-lytex png "" ""')
853 # Note: The --lily-output-dir flag is required because lilypond-book
854 # does not process input again unless the input has changed,
855 # even if the output format being requested is different. So
856 # once a .eps file exists, lilypond-book won't create a .pdf
857 # even when requested with --pdf. This is a problem if a user
858 # clicks View PDF after having done a View DVI. To circumvent
859 # this, use different output folders for eps and pdf outputs.
860 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
861 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
862 logger.info('+ found LilyPond-book version %s.' % version_number)
864 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
866 logger.info('+ found LilyPond-book, but could not extract version number.')
868 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
869 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
871 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
872 # and a zip archive on Windows.
873 # So, we configure the appropriate version according to the platform.
874 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$i" ""'
876 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document"')
877 addToRC(cmd % "lyxzip")
879 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document"')
880 addToRC(cmd % "lyxgz")
883 # FIXME: no rc_entry? comment it out
884 # checkProg('Image converter', ['convert $$i $$o'])
886 # Entries that do not need checkProg
887 addToRC(r'''\converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
888 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
889 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
890 \converter docbook docbook-xml "cp $$i $$o" "xml"
891 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
892 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
893 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
894 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
895 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
896 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
897 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
898 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
899 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
900 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
901 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
906 ''' Check docbook '''
907 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
909 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
910 \converter docbook html "sgmltools -b html $$i" ""''',
911 r'''\converter docbook dvi "db2dvi $$i" ""
912 \converter docbook html "db2html $$i" ""''',
913 r'''\converter docbook dvi "" ""
914 \converter docbook html "" ""''',
915 r'''\converter docbook dvi "" ""
916 \converter docbook html "" ""'''])
919 return ('yes', 'true', '\\def\\hasdocbook{yes}')
921 return ('no', 'false', '')
924 def checkOtherEntries():
925 ''' entries other than Format and Converter '''
926 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
927 rc_entry = [ r'\chktex_command "%%"' ])
928 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
929 rc_entry = [ r'\bibtex_command "%%"' ],
930 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
931 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
932 rc_entry = [ r'\jbibtex_command "%%"' ])
933 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
934 rc_entry = [ r'\index_command "%%"' ],
935 alt_rc_entry = [ r'\index_alternatives "%%"' ])
936 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
937 rc_entry = [ r'\jindex_command "%%"' ])
938 path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
939 rc_entry = [ r'\splitindex_command "%%"' ])
941 checkProg('the splitindex processor (java version)', ['splitindex.class'],
942 rc_entry = [ r'\splitindex_command "java splitindex"' ])
943 checkProg('a nomenclature processor', ['makeindex'],
944 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
945 ## FIXME: OCTAVE is not used anywhere
946 # path, OCTAVE = checkProg('Octave', ['octave'])
947 ## FIXME: MAPLE is not used anywhere
948 # path, MAPLE = checkProg('Maple', ['maple'])
949 checkProg('a spool command', ['lp', 'lpr'],
951 r'''\print_spool_printerprefix "-d "
952 \print_spool_command "lp"''',
953 r'''\print_spool_printerprefix "-P",
954 \print_spool_command "lpr"''',
956 # Add the rest of the entries (no checkProg is required)
957 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
958 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
959 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
960 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
964 def processLayoutFile(file, bool_docbook):
965 ''' process layout file and get a line of result
967 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
969 \DeclareLaTeXClass{article}
970 \DeclareLaTeXClass[scrbook]{book (koma-script)}
971 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
975 "article" "article" "article" "false" "article.cls"
976 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
977 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
979 def checkForClassExtension(x):
980 '''if the extension for a latex class is not
981 provided, add .cls to the classname'''
983 return x.strip() + '.cls'
986 classname = file.split(os.sep)[-1].split('.')[0]
987 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
988 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
989 for line in open(file).readlines():
992 (classtype, optAll, opt, opt1, desc) = res.groups()
993 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
996 prereq_latex = checkForClassExtension(classname)
998 prereq_list = optAll[1:-1].split(',')
999 prereq_list = map(checkForClassExtension, prereq_list)
1000 prereq_latex = ','.join(prereq_list)
1001 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1002 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1003 return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
1004 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1008 def checkLatexConfig(check_config, bool_docbook):
1009 ''' Explore the LaTeX configuration
1010 Return None (will be passed to sys.exit()) for success.
1012 msg = 'checking LaTeX configuration... '
1013 # if --without-latex-config is forced, or if there is no previous
1014 # version of textclass.lst, re-generate a default file.
1015 if not os.path.isfile('textclass.lst') or not check_config:
1016 # remove the files only if we want to regenerate
1017 removeFiles(['textclass.lst', 'packages.lst'])
1019 # Then, generate a default textclass.lst. In case configure.py
1020 # fails, we still have something to start lyx.
1021 logger.info(msg + ' default values')
1022 logger.info('+checking list of textclasses... ')
1023 tx = open('textclass.lst', 'w')
1025 # This file declares layouts and their associated definition files
1026 # (include dir. relative to the place where this file is).
1027 # It contains only default values, since chkconfig.ltx could not be run
1028 # for some reason. Run ./configure.py if you need to update it after a
1029 # configuration change.
1031 # build the list of available layout files and convert it to commands
1034 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1035 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1037 if not os.path.isfile(file):
1039 # get stuff between /xxxx.layout .
1040 classname = file.split(os.sep)[-1].split('.')[0]
1042 cleanclass = classname.replace(' ', '_')
1043 cleanclass = cleanclass.replace('-', '_')
1044 # make sure the same class is not considered twice
1045 if foundClasses.count(cleanclass) == 0: # not found before
1046 foundClasses.append(cleanclass)
1047 retval = processLayoutFile(file, bool_docbook)
1051 logger.info('\tdone')
1052 if not check_config:
1054 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1055 logger.info(msg + '\tauto')
1056 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
1057 'chkconfig.classes', 'chklayouts.tex'])
1059 if not os.path.isfile( 'chkconfig.ltx' ):
1060 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1062 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1063 # Construct the list of classes to test for.
1064 # build the list of available layout files and convert it to commands
1066 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1067 empty = re.compile(r'^\s*$')
1068 testclasses = list()
1069 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1070 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1071 if not os.path.isfile(file):
1073 classname = file.split(os.sep)[-1].split('.')[0]
1074 for line in open(file).readlines():
1075 if not empty.match(line) and line[0] != '#':
1076 logger.error("Failed to find \Declare line for layout file `" + file + "'")
1078 if declare.search(line) == None:
1080 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1083 cl = open('chklayouts.tex', 'w')
1084 for line in testclasses:
1085 cl.write(line + '\n')
1088 # we have chklayouts.tex, then process it
1089 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
1091 line = fout.readline()
1094 if re.match('^\+', line):
1095 logger.info(line.strip())
1096 # if the command succeeds, None will be returned
1099 # currently, values in chhkconfig are only used to set
1102 for line in open('chkconfig.vars').readlines():
1103 key, val = re.sub('-', '_', line).split('=')
1105 values[key] = val.strip("'")
1106 # chk_fontenc may not exist
1108 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1111 if rmcopy: # remove the copied file
1112 removeFiles( [ 'chkconfig.ltx' ] )
1113 # if configure successed, move textclass.lst.tmp to textclass.lst
1114 # and packages.lst.tmp to packages.lst
1115 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1116 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1117 shutil.move('textclass.lst.tmp', 'textclass.lst')
1118 shutil.move('packages.lst.tmp', 'packages.lst')
1122 def checkModulesConfig():
1123 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1125 logger.info('+checking list of modules... ')
1126 tx = open('lyxmodules.lst', 'w')
1127 tx.write('''## This file declares modules and their associated definition files.
1128 ## It has been automatically generated by configure
1129 ## Use "Options/Reconfigure" if you need to update it after a
1130 ## configuration change.
1131 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1133 # build the list of available modules
1135 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1136 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1139 if not os.path.isfile(file):
1141 retval = processModuleFile(file, bool_docbook)
1145 logger.info('\tdone')
1148 def processModuleFile(file, bool_docbook):
1149 ''' process module file and get a line of result
1151 The top of a module file should look like this:
1152 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1154 #...body of description...
1156 #Requires: [list of required modules]
1157 #Excludes: [list of excluded modules]
1158 #Category: [category name]
1159 The last three lines are optional (though do give a category).
1161 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1163 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1164 rereqs = re.compile(r'#+\s*Requires: (.*)')
1165 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1166 recaty = re.compile(r'#+\s*Category: (.*)')
1167 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1168 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1170 modname = desc = pkgs = req = excl = catgy = ""
1171 readingDescription = False
1173 filename = file.split(os.sep)[-1]
1174 filename = filename[:-7]
1176 for line in open(file).readlines():
1177 if readingDescription:
1178 res = redend.search(line)
1180 readingDescription = False
1181 desc = " ".join(descLines)
1183 desc = desc.replace('"', '\\"')
1185 descLines.append(line[1:].strip())
1187 res = redbeg.search(line)
1189 readingDescription = True
1191 res = remods.search(line)
1193 (pkgs, modname) = res.groups()
1197 tmp = [s.strip() for s in pkgs.split(",")]
1198 pkgs = ",".join(tmp)
1200 res = rereqs.search(line)
1203 tmp = [s.strip() for s in req.split("|")]
1206 res = reexcs.search(line)
1209 tmp = [s.strip() for s in excl.split("|")]
1210 excl = "|".join(tmp)
1212 res = recaty.search(line)
1214 catgy = res.group(1)
1218 logger.warning("Module file without \DeclareLyXModule line. ")
1222 # this module has some latex dependencies:
1223 # append the dependencies to chkmodules.tex,
1224 # which is \input'ed by chkconfig.ltx
1225 testpackages = list()
1226 for pkg in pkgs.split(","):
1228 # this is a converter dependency: skip
1230 if pkg.endswith(".sty"):
1232 testpackages.append("\\TestPackage{%s}" % (pkg,))
1233 cm = open('chkmodules.tex', 'a')
1234 for line in testpackages:
1235 cm.write(line + '\n')
1238 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1242 def checkTeXAllowSpaces():
1243 ''' Let's check whether spaces are allowed in TeX file names '''
1244 tex_allows_spaces = 'false'
1245 if lyx_check_config:
1246 msg = "Checking whether TeX allows spaces in file names... "
1247 writeToFile('a b.tex', r'\message{working^^J}' )
1250 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1252 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1255 if 'working' in latex_out:
1256 logger.info(msg + 'yes')
1257 tex_allows_spaces = 'true'
1259 logger.info(msg + 'no')
1260 tex_allows_spaces = 'false'
1261 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1262 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1265 def removeTempFiles():
1267 if not lyx_keep_temps:
1268 removeFiles(['chkconfig.vars', \
1269 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
1270 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1271 'chklatex.ltx', 'chklatex.log'])
1274 if __name__ == '__main__':
1275 lyx_check_config = True
1276 outfile = 'lyxrc.defaults'
1278 lyx_keep_temps = False
1280 ## Parse the command line
1281 for op in sys.argv[1:]: # default shell/for list is $*, the options
1282 if op in [ '-help', '--help', '-h' ]:
1283 print '''Usage: configure [options]
1285 --help show this help lines
1286 --keep-temps keep temporary files (for debug. purposes)
1287 --without-latex-config do not run LaTeX to determine configuration
1288 --with-version-suffix=suffix suffix of binary installed files
1291 elif op == '--without-latex-config':
1292 lyx_check_config = False
1293 elif op == '--keep-temps':
1294 lyx_keep_temps = True
1295 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1296 version_suffix = op[22:]
1298 print "Unknown option", op
1301 # check if we run from the right directory
1302 srcdir = os.path.dirname(sys.argv[0])
1305 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1306 logger.error("configure: error: cannot find chkconfig.ltx script")
1310 windows_style_tex_paths = checkTeXPaths()
1311 dtl_tools = checkDTLtools()
1312 ## Write the first part of outfile
1313 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1314 # script. It contains default settings that have been determined by
1315 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1316 # want to customize LyX, use LyX' Preferences dialog or modify directly
1317 # the "preferences" file instead. Any setting in that file will
1318 # override the values given here.
1321 LATEX = checkLatex(dtl_tools)
1322 checkFormatEntries(dtl_tools)
1323 checkConverterEntries()
1324 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1325 checkTeXAllowSpaces()
1326 if windows_style_tex_paths != '':
1327 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1329 checkModulesConfig()
1330 # --without-latex-config can disable lyx_check_config
1331 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1333 # The return error code can be 256. Because most systems expect an error code
1334 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1335 # a None for success, 'ret is not None' is used to exit.
1336 sys.exit(ret is not None)