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