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)
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 pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document"
511 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document"
512 \Format text txt "Plain text" a "" "%%" "document"
513 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document"
514 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document"
515 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document"
516 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document"''' ])
518 path, xhtmlview = checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
519 rc_entry = [r'\Format xhtml xhtml "LyXHTML" X "%%" "" "document"'])
521 addToRC(r'\Format xhtml xhtml "LyXHTML" X "" "" "document"')
523 checkEditor('a BibTeX editor', ['sensible-editor', 'jabref', 'JabRef', \
524 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
525 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
526 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
527 'nedit', 'gedit', 'notepad'],
528 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" ""''' ])
530 #checkProg('a Postscript interpreter', ['gs'],
531 # rc_entry = [ r'\ps_command "%%"' ])
532 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'evince', 'gv', 'ghostview -swap'],
533 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector"
534 \Format ps ps Postscript t "%%" "" "document,vector"'''])
535 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
536 checkViewer('a PDF previewer', ['kpdf', 'okular', 'evince', 'kghostview', 'xpdf', 'acrobat', 'acroread', \
538 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector"
539 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector"
540 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector"
541 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector"'''])
543 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
544 rc_entry = [r'\Format dvi dvi DVI D "%%" "" "document,vector"'])
546 # Windows only: DraftDVI
547 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector"')
549 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
550 rc_entry = [r'\Format html html HTML H "%%" "" "document"'])
552 checkViewerEditor('Noteedit', ['noteedit'],
553 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector"'])
555 checkViewerEditor('an OpenDocument/OpenOffice viewer', ['swriter', 'oowriter', 'abiword'],
556 rc_entry = [r'''\Format odt odt OpenDocument "" "%%" "%%" "document,vector"
557 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector"'''])
559 checkViewerEditor('a Rich Text and Word viewer', ['swriter', 'oowriter', 'abiword'],
560 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "" "" "document,vector"
561 \Format word doc "MS Word" W "" "" "document,vector"'''])
563 # entried that do not need checkProg
564 addToRC(r'''\Format date "" "date command" "" "" "" ""
565 \Format csv csv "Table (CSV)" "" "" "" "document"
566 \Format fax "" Fax "" "" "" "document"
567 \Format lyx lyx LyX "" "" "" ""
568 \Format lyx13x lyx13 "LyX 1.3.x" "" "" "" "document"
569 \Format lyx14x lyx14 "LyX 1.4.x" "" "" "" "document"
570 \Format lyx15x lyx15 "LyX 1.5.x" "" "" "" "document"
571 \Format lyx16x lyx16 "LyX 1.6.x" "" "" "" "document"
572 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document"
573 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document"
574 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document"
575 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" ""
576 \Format lyxpreview-lytex lyxpreview-lytex "LyX Preview (LilyPond book)" "" "" "" ""
577 \Format lyxpreview-platex lyxpreview-platex "LyX Preview (pLaTeX)" "" "" "" ""
578 \Format pdftex pdftex_t PDFTEX "" "" "" ""
579 \Format program "" Program "" "" "" ""
580 \Format pstex pstex_t PSTEX "" "" "" ""
581 \Format wmf wmf "Windows Metafile" "" "" "" "vector"
582 \Format emf emf "Enhanced Metafile" "" "" "" "vector"
583 \Format wordhtml html "HTML (MS Word)" "" "" "" "document"
587 def checkConverterEntries():
588 ''' Check all converters (\converter entries) '''
589 checkProg('the pdflatex program', ['pdflatex $$i'],
590 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex"' ])
592 checkProg('XeTeX', ['xelatex $$i'],
593 rc_entry = [ r'\converter xetex pdf4 "%%" "latex"' ])
595 ''' If we're running LyX in-place then tex2lyx will be found in
596 ../src/tex2lyx. Add this directory to the PATH temporarily and
598 Use PATH to avoid any problems with paths-with-spaces.
600 path_orig = os.environ["PATH"]
601 os.environ["PATH"] = os.path.join('..', 'src', 'tex2lyx') + \
602 os.pathsep + path_orig
604 checkProg('a LaTeX/Noweb -> LyX converter', ['tex2lyx', 'tex2lyx' + version_suffix],
605 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
606 \converter literate lyx "%% -n -f $$i $$o" ""'''])
608 os.environ["PATH"] = path_orig
611 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
612 rc_entry = [r'''\converter literate latex "%%" ""
613 \converter literate pdflatex "%%" ""'''])
615 checkProg('a Sweave -> LaTeX converter', ['R CMD Sweave $$i'],
616 rc_entry = [r'''\converter sweave latex "%%" ""
617 \converter sweave pdflatex "%%" ""'''])
619 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex $$i', \
620 'htmltolatex -input $$i -output $$o', 'java -jar htmltolatex.jar -input $$i -output $$o'],
621 rc_entry = [ r'\converter html latex "%%" ""' ])
623 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
624 rc_entry = [ r'\converter word latex "%%" ""' ])
626 # eLyXer: search as a Python module and then as an executable (elyxer.py, elyxer)
627 elyxerfound = checkModule('elyxer')
629 addToRC(r'''\converter lyx html "python -m elyxer --directory $$r $$i $$o" ""''')
631 path, elyxer = checkProg('a LyX -> HTML converter',
632 ['elyxer.py --directory $$r $$i $$o', 'elyxer --directory $$r $$i $$o'],
633 rc_entry = [ r'\converter lyx html "%%" ""' ])
634 if elyxer.find('elyxer') >= 0:
638 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
640 # search for other converters than eLyXer
641 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
642 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
643 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
644 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
645 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
646 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
647 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
649 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
651 # Check if LyxBlogger is installed.
652 path, lyxblogger = checkProg('A LyX to WordPress Blog Publishing Tool',
653 ['lyxblogger $$i'], rc_entry = [])
654 if lyxblogger.find('lyxblogger') >= 0:
655 addToRC(r'\Format blog blog "LyxBlogger" "" "" "" "document"')
656 addToRC(r'\converter xhtml blog "lyxblogger $$i" ""')
659 addToRC(r'''\converter lyx wordhtml "python -m elyxer --html --directory $$r $$i $$o" ""''')
661 path, elyxer = checkProg('a LyX -> MS Word converter',
662 ['elyxer.py --directory $$r $$i $$o', 'elyxer --html --directory $$r $$i $$o'],
663 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
664 if elyxer.find('elyxer') >= 0:
668 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
670 # search for other converters than eLyXer
671 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
672 path, htmlconv = checkProg('a LaTeX -> MS Word converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
673 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
674 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
675 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
676 if htmlconv.find('htlatex') >= 0:
677 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
679 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
682 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
683 rc_entry = [ r'\converter sxw latex "%%" ""' ])
685 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
686 rc_entry = [ r'\converter odt latex "%%" ""' ])
687 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
688 # the command mk4ht oolatex $$i has to be used as default,
689 # but as this would require to have Perl installed, in MiKTeX oolatex is
690 # directly available as application.
691 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
692 # Both SuSE and debian have oolatex
693 checkProg('a LaTeX -> Open Document converter', [
694 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
695 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
696 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
697 # On windows it is called latex2rt.exe
698 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
699 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
701 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
702 rc_entry = [ r'\converter rtf html "%%" ""' ])
704 checkProg('a PS to PDF converter', ['ps2pdf13 $$i $$o'],
705 rc_entry = [ r'\converter ps pdf "%%" ""' ])
707 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
708 rc_entry = [ r'\converter ps text2 "%%" ""' ])
710 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
711 rc_entry = [ r'\converter ps text3 "%%" ""' ])
713 checkProg('a PS to EPS converter', ['ps2eps $$i'],
714 rc_entry = [ r'\converter ps eps "%%" ""' ])
716 checkProg('a PDF to PS converter', ['pdf2ps $$i $$o', 'pdftops $$i $$o'],
717 rc_entry = [ r'\converter pdf ps "%%" ""' ])
719 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
720 rc_entry = [ r'\converter pdf eps "%%" ""' ])
722 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
723 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
725 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
726 rc_entry = [ r'\converter dvi ps "%%" ""' ])
728 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
729 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
731 path, dvipng = checkProg('dvipng', ['dvipng'])
732 if dvipng == "dvipng":
733 addToRC(r'\converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py" ""')
735 addToRC(r'\converter lyxpreview png "" ""')
737 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
738 rc_entry = [ r'\converter ps fax "%%" ""'])
740 checkProg('a FIG -> EPS/PPM converter', ['fig2dev'],
742 r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
743 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
744 \converter fig png "fig2dev -L png $$i $$o" ""''',
747 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
748 rc_entry = [ r'\converter tiff eps "%%" ""', ''])
750 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
752 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
753 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
754 \converter tgif pdf "tgif -print -color -pdf -stdout $$i > $$o" ""''',
757 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
758 rc_entry = [ r'\converter wmf eps "%%" ""'])
760 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i'],
761 rc_entry = [ r'\converter emf eps "%%" ""'])
763 checkProg('an EPS -> PDF converter', ['epstopdf'],
764 rc_entry = [ r'\converter eps pdf "epstopdf --outfile=$$o $$i" ""', ''])
766 # no agr -> pdf converter, since the pdf library used by gracebat is not
767 # free software and therefore not compiled in in many installations.
768 # Fortunately, this is not a big problem, because we will use epstopdf to
769 # convert from agr to pdf via eps without loss of quality.
770 checkProg('a Grace -> Image converter', ['gracebat'],
772 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
773 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
774 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
775 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""''',
778 checkProg('a Dot -> Image converter', ['dot'],
780 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
781 \converter dot pdf "dot -Tpdf $$i -o $$o" ""
782 \converter dot png "dot -Tpng $$i -o $$o" ""''',
785 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
786 rc_entry = [ r'\converter dia png "%%" ""'])
788 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
789 rc_entry = [ r'\converter dia eps "%%" ""'])
791 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'],
792 rc_entry = [ r'\converter svg pdf "%%" ""'])
794 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'],
795 rc_entry = [ r'\converter svg eps "%%" ""'])
796 # the PNG export via Inkscape must not have the full path ($$p) for the file
797 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', 'inkscape --without-gui --file=$$i --export-png=$$o'],
798 rc_entry = [ r'\converter svg png "%%" ""'])
801 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
803 version_string = cmdOutput("lilypond --version")
804 match = re.match('GNU LilyPond (\S+)', version_string)
806 version_number = match.groups()[0]
807 version = version_number.split('.')
808 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
809 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps --ps $$i" ""
810 \converter lilypond png "lilypond -dbackend=eps --png $$i" ""''')
811 addToRC(r'\converter lilypond pdf "lilypond -dbackend=eps --pdf $$i" ""')
812 logger.info('+ found LilyPond version %s.' % version_number)
813 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
814 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps $$i" ""
815 \converter lilypond png "lilypond -b eps --png $$i" ""''')
816 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
817 addToRC(r'\converter lilypond pdf "lilypond -b eps --pdf $$i" ""')
818 logger.info('+ found LilyPond version %s.' % version_number)
820 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
822 logger.info('+ found LilyPond, but could not extract version number.')
824 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
825 if (lilypond_book != ''):
826 version_string = cmdOutput("lilypond-book --version")
827 match = re.match('^(\S+)$', version_string)
829 version_number = match.groups()[0]
830 version = version_number.split('.')
831 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 1):
832 addToRC(r'\converter lyxpreview-lytex ppm "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
833 if dvipng == "dvipng":
834 addToRC(r'\converter lyxpreview-lytex png "python -tt $$s/scripts/lyxpreview-lytex2bitmap.py" ""')
836 addToRC(r'\converter lyxpreview-lytex png "" ""')
837 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
838 # Note: The --lily-output-dir flag is required because lilypond-book
839 # does not process input again unless the input has changed,
840 # even if the output format being requested is different. So
841 # once a .eps file exists, lilypond-book won't create a .pdf
842 # even when requested with --pdf. This is a problem if a user
843 # clicks View PDF after having done a View DVI. To circumvent
844 # this, use different output folders for eps and pdf outputs.
845 addToRC(r'\converter lilypond-book latex "lilypond-book --lily-output-dir=ly-eps $$i" ""')
846 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
847 logger.info('+ found LilyPond-book version %s.' % version_number)
848 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 1):
849 addToRC(r'\converter lilypond-book latex "lilypond-book $$i" ""')
850 logger.info('+ found LilyPond-book version %s.' % version_number)
852 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
854 logger.info('+ found LilyPond-book, but could not extract version number.')
856 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
857 rc_entry = [ r'\converter noteedit lilypond "%%" ""', ''])
859 # FIXME: no rc_entry? comment it out
860 # checkProg('Image converter', ['convert $$i $$o'])
862 # Entries that do not need checkProg
863 addToRC(r'''\converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py" ""
864 \converter lyxpreview-platex ppm "python -tt $$s/scripts/lyxpreview-platex2bitmap.py" ""
865 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
866 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
867 \converter docbook docbook-xml "cp $$i $$o" "xml"
868 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
869 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
870 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""
871 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
872 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
873 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
874 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
875 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
876 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
877 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
878 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
879 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
880 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
885 ''' Check docbook '''
886 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
888 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
889 \converter docbook html "sgmltools -b html $$i" ""''',
890 r'''\converter docbook dvi "db2dvi $$i" ""
891 \converter docbook html "db2html $$i" ""''',
892 r'''\converter docbook dvi "" ""
893 \converter docbook html "" ""''',
894 r'''\converter docbook dvi "" ""
895 \converter docbook html "" ""'''])
898 return ('yes', 'true', '\\def\\hasdocbook{yes}')
900 return ('no', 'false', '')
903 def checkOtherEntries():
904 ''' entries other than Format and Converter '''
905 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
906 rc_entry = [ r'\chktex_command "%%"' ])
907 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
908 rc_entry = [ r'\bibtex_command "%%"' ],
909 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
910 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
911 rc_entry = [ r'\jbibtex_command "%%"' ])
912 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q'],
913 rc_entry = [ r'\index_command "%%"' ],
914 alt_rc_entry = [ r'\index_alternatives "%%"' ])
915 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
916 rc_entry = [ r'\jindex_command "%%"' ])
917 path, splitindex = checkProg('the splitindex processor', ['splitindex.pl', 'splitindex'],
918 rc_entry = [ r'\splitindex_command "%%"' ])
920 checkProg('the splitindex processor (java version)', ['splitindex.class'],
921 rc_entry = [ r'\splitindex_command "java splitindex"' ])
922 checkProg('a nomenclature processor', ['makeindex'],
923 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
924 ## FIXME: OCTAVE is not used anywhere
925 # path, OCTAVE = checkProg('Octave', ['octave'])
926 ## FIXME: MAPLE is not used anywhere
927 # path, MAPLE = checkProg('Maple', ['maple'])
928 checkProg('a spool command', ['lp', 'lpr'],
930 r'''\print_spool_printerprefix "-d "
931 \print_spool_command "lp"''',
932 r'''\print_spool_printerprefix "-P",
933 \print_spool_command "lpr"''',
935 # Add the rest of the entries (no checkProg is required)
936 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
937 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
938 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
939 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
943 def processLayoutFile(file, bool_docbook):
944 ''' process layout file and get a line of result
946 Declare lines look like this: (article.layout, scrbook.layout, svjog.layout)
948 \DeclareLaTeXClass{article}
949 \DeclareLaTeXClass[scrbook]{book (koma-script)}
950 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
954 "article" "article" "article" "false" "article.cls"
955 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls"
956 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo"
958 def checkForClassExtension(x):
959 '''if the extension for a latex class is not
960 provided, add .cls to the classname'''
962 return x.strip() + '.cls'
965 classname = file.split(os.sep)[-1].split('.')[0]
966 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
967 p = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
968 for line in open(file).readlines():
971 (classtype, optAll, opt, opt1, desc) = res.groups()
972 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
975 prereq_latex = checkForClassExtension(classname)
977 prereq_list = optAll[1:-1].split(',')
978 prereq_list = map(checkForClassExtension, prereq_list)
979 prereq_latex = ','.join(prereq_list)
980 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
981 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
982 return '"%s" "%s" "%s" "%s" "%s"\n' % (classname, opt, desc, avai, prereq)
983 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
987 def checkLatexConfig(check_config, bool_docbook):
988 ''' Explore the LaTeX configuration
989 Return None (will be passed to sys.exit()) for success.
991 msg = 'checking LaTeX configuration... '
992 # if --without-latex-config is forced, or if there is no previous
993 # version of textclass.lst, re-generate a default file.
994 if not os.path.isfile('textclass.lst') or not check_config:
995 # remove the files only if we want to regenerate
996 removeFiles(['textclass.lst', 'packages.lst'])
998 # Then, generate a default textclass.lst. In case configure.py
999 # fails, we still have something to start lyx.
1000 logger.info(msg + ' default values')
1001 logger.info('+checking list of textclasses... ')
1002 tx = open('textclass.lst', 'w')
1004 # This file declares layouts and their associated definition files
1005 # (include dir. relative to the place where this file is).
1006 # It contains only default values, since chkconfig.ltx could not be run
1007 # for some reason. Run ./configure.py if you need to update it after a
1008 # configuration change.
1010 # build the list of available layout files and convert it to commands
1013 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1014 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1016 if not os.path.isfile(file):
1018 # get stuff between /xxxx.layout .
1019 classname = file.split(os.sep)[-1].split('.')[0]
1021 cleanclass = classname.replace(' ', '_')
1022 cleanclass = cleanclass.replace('-', '_')
1023 # make sure the same class is not considered twice
1024 if foundClasses.count(cleanclass) == 0: # not found before
1025 foundClasses.append(cleanclass)
1026 retval = processLayoutFile(file, bool_docbook)
1030 logger.info('\tdone')
1031 if not check_config:
1033 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1034 logger.info(msg + '\tauto')
1035 removeFiles(['wrap_chkconfig.ltx', 'chkconfig.vars', \
1036 'chkconfig.classes', 'chklayouts.tex'])
1038 if not os.path.isfile( 'chkconfig.ltx' ):
1039 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1041 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1042 # Construct the list of classes to test for.
1043 # build the list of available layout files and convert it to commands
1045 declare = re.compile(r'\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}')
1046 empty = re.compile(r'^\s*$')
1047 testclasses = list()
1048 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1049 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1050 if not os.path.isfile(file):
1052 classname = file.split(os.sep)[-1].split('.')[0]
1053 for line in open(file).readlines():
1054 if not empty.match(line) and line[0] != '#':
1055 logger.error("Failed to find \Declare line for layout file `" + file + "'")
1057 if declare.search(line) == None:
1059 testclasses.append("\\TestDocClass{%s}{%s}" % (classname, line[1:].strip()))
1062 cl = open('chklayouts.tex', 'w')
1063 for line in testclasses:
1064 cl.write(line + '\n')
1067 # we have chklayouts.tex, then process it
1068 fout = os.popen(LATEX + ' wrap_chkconfig.ltx')
1070 line = fout.readline()
1073 if re.match('^\+', line):
1074 logger.info(line.strip())
1075 # if the command succeeds, None will be returned
1078 # currently, values in chhkconfig are only used to set
1081 for line in open('chkconfig.vars').readlines():
1082 key, val = re.sub('-', '_', line).split('=')
1084 values[key] = val.strip("'")
1085 # chk_fontenc may not exist
1087 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1090 if rmcopy: # remove the copied file
1091 removeFiles( [ 'chkconfig.ltx' ] )
1092 # if configure successed, move textclass.lst.tmp to textclass.lst
1093 # and packages.lst.tmp to packages.lst
1094 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1095 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1096 shutil.move('textclass.lst.tmp', 'textclass.lst')
1097 shutil.move('packages.lst.tmp', 'packages.lst')
1101 def checkModulesConfig():
1102 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1104 logger.info('+checking list of modules... ')
1105 tx = open('lyxmodules.lst', 'w')
1106 tx.write('''## This file declares modules and their associated definition files.
1107 ## It has been automatically generated by configure
1108 ## Use "Options/Reconfigure" if you need to update it after a
1109 ## configuration change.
1110 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1112 # build the list of available modules
1114 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1115 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1118 if not os.path.isfile(file):
1120 retval = processModuleFile(file, bool_docbook)
1124 logger.info('\tdone')
1127 def processModuleFile(file, bool_docbook):
1128 ''' process module file and get a line of result
1130 The top of a module file should look like this:
1131 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1133 #...body of description...
1135 #Requires: [list of required modules]
1136 #Excludes: [list of excluded modules]
1137 #Category: [category name]
1138 The last three lines are optional (though do give a category).
1140 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1142 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1143 rereqs = re.compile(r'#+\s*Requires: (.*)')
1144 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1145 recaty = re.compile(r'#+\s*Category: (.*)')
1146 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1147 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1149 modname = desc = pkgs = req = excl = catgy = ""
1150 readingDescription = False
1152 filename = file.split(os.sep)[-1]
1153 filename = filename[:-7]
1155 for line in open(file).readlines():
1156 if readingDescription:
1157 res = redend.search(line)
1159 readingDescription = False
1160 desc = " ".join(descLines)
1162 desc = desc.replace('"', '\\"')
1164 descLines.append(line[1:].strip())
1166 res = redbeg.search(line)
1168 readingDescription = True
1170 res = remods.search(line)
1172 (pkgs, modname) = res.groups()
1176 tmp = [s.strip() for s in pkgs.split(",")]
1177 pkgs = ",".join(tmp)
1179 res = rereqs.search(line)
1182 tmp = [s.strip() for s in req.split("|")]
1185 res = reexcs.search(line)
1188 tmp = [s.strip() for s in excl.split("|")]
1189 excl = "|".join(tmp)
1191 res = recaty.search(line)
1193 catgy = res.group(1)
1197 logger.warning("Module file without \DeclareLyXModule line. ")
1201 # this module has some latex dependencies:
1202 # append the dependencies to chkmodules.tex,
1203 # which is \input'ed by chkconfig.ltx
1204 testpackages = list()
1205 for pkg in pkgs.split(","):
1207 # this is a converter dependency: skip
1209 if pkg.endswith(".sty"):
1211 testpackages.append("\\TestPackage{%s}" % (pkg,))
1212 cm = open('chkmodules.tex', 'a')
1213 for line in testpackages:
1214 cm.write(line + '\n')
1217 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1221 def checkTeXAllowSpaces():
1222 ''' Let's check whether spaces are allowed in TeX file names '''
1223 tex_allows_spaces = 'false'
1224 if lyx_check_config:
1225 msg = "Checking whether TeX allows spaces in file names... "
1226 writeToFile('a b.tex', r'\message{working^^J}' )
1229 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}" """)
1231 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}' """)
1234 if 'working' in latex_out:
1235 logger.info(msg + 'yes')
1236 tex_allows_spaces = 'true'
1238 logger.info(msg + 'no')
1239 tex_allows_spaces = 'false'
1240 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1241 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1244 def removeTempFiles():
1246 if not lyx_keep_temps:
1247 removeFiles(['chkconfig.vars', \
1248 'wrap_chkconfig.ltx', 'wrap_chkconfig.log', \
1249 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1250 'chklatex.ltx', 'chklatex.log'])
1253 if __name__ == '__main__':
1254 lyx_check_config = True
1255 outfile = 'lyxrc.defaults'
1257 lyx_keep_temps = False
1259 ## Parse the command line
1260 for op in sys.argv[1:]: # default shell/for list is $*, the options
1261 if op in [ '-help', '--help', '-h' ]:
1262 print '''Usage: configure [options]
1264 --help show this help lines
1265 --keep-temps keep temporary files (for debug. purposes)
1266 --without-latex-config do not run LaTeX to determine configuration
1267 --with-version-suffix=suffix suffix of binary installed files
1270 elif op == '--without-latex-config':
1271 lyx_check_config = False
1272 elif op == '--keep-temps':
1273 lyx_keep_temps = True
1274 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1275 version_suffix = op[22:]
1277 print "Unknown option", op
1280 # check if we run from the right directory
1281 srcdir = os.path.dirname(sys.argv[0])
1284 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1285 logger.error("configure: error: cannot find chkconfig.ltx script")
1289 windows_style_tex_paths = checkTeXPaths()
1290 dtl_tools = checkDTLtools()
1291 ## Write the first part of outfile
1292 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1293 # script. It contains default settings that have been determined by
1294 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1295 # want to customize LyX, use LyX' Preferences dialog or modify directly
1296 # the "preferences" file instead. Any setting in that file will
1297 # override the values given here.
1300 LATEX = checkLatex(dtl_tools)
1301 checkFormatEntries(dtl_tools)
1302 checkConverterEntries()
1303 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1304 checkTeXAllowSpaces()
1305 if windows_style_tex_paths != '':
1306 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1308 checkModulesConfig()
1309 # --without-latex-config can disable lyx_check_config
1310 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1312 # The return error code can be 256. Because most systems expect an error code
1313 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1314 # a None for success, 'ret is not None' is used to exit.
1315 sys.exit(ret is not None)