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, stat
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)
59 def cmdOutput(cmd, async = False):
60 '''utility function: run a command and get its output as a string
62 async: if False, return whole output as a string, otherwise
63 return the stdout handle from which the output can be
64 read (the caller is then responsible for closing it)
68 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
71 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
72 stdout=subprocess.PIPE, universal_newlines=True)
76 output = pipe.stdout.read()
82 ''' On Windows, return the short version of "path" if possible '''
84 from ctypes import windll, create_unicode_buffer
85 GetShortPathName = windll.kernel32.GetShortPathNameW
86 shortlen = GetShortPathName(path, 0, 0)
87 shortpath = create_unicode_buffer(shortlen)
88 if GetShortPathName(path, shortpath, shortlen):
89 return shortpath.value
94 ''' I do not really know why this is useful, but we might as well keep it.
96 Only set these to C if already set. These must not be set unconditionally
97 because not all systems understand e.g. LANG=C (notably SCO).
98 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
99 Non-C LC_CTYPE values break the ctype check.
101 os.environ['LANG'] = os.getenv('LANG', 'C')
102 os.environ['LC'] = os.getenv('LC_ALL', 'C')
103 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
104 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
107 def copy_tree(src, dst, preserve_symlinks=False, level=0):
108 ''' Copy an entire directory tree 'src' to a new location 'dst'.
110 Code inspired from distutils.copy_tree.
111 Copying ignores non-regular files and the cache directory.
112 Pipes may be present as leftovers from LyX for lyx-server.
114 If 'preserve_symlinks' is true, symlinks will be
115 copied as symlinks (on platforms that support them!); otherwise
116 (the default), the destination of the symlink will be copied.
119 if not os.path.isdir(src):
121 "cannot copy tree '%s': not a directory" % src
123 names = os.listdir(src)
124 except os.error, (errno, errstr):
126 "error listing files in '%s': %s" % (src, errstr)
128 if not os.path.isdir(dst):
134 src_name = os.path.join(src, name)
135 dst_name = os.path.join(dst, name)
136 if preserve_symlinks and os.path.islink(src_name):
137 link_dest = os.readlink(src_name)
138 os.symlink(link_dest, dst_name)
139 outputs.append(dst_name)
140 elif level == 0 and name == 'cache':
141 logger.info("Skip cache %s", src_name)
142 elif os.path.isdir(src_name):
144 copy_tree(src_name, dst_name, preserve_symlinks, level=(level + 1)))
145 elif stat.S_ISREG(os.stat(src_name).st_mode) or os.path.islink(src_name):
146 shutil.copy2(src_name, dst_name)
147 outputs.append(dst_name)
149 logger.info("Ignore non-regular file %s", src_name)
155 ''' Check for upgrade from previous version '''
157 basename = os.path.basename( cwd )
158 lyxrc = os.path.join(cwd, outfile)
159 if not os.path.isfile( lyxrc ) and basename.endswith( version_suffix ) :
160 logger.info('Checking for upgrade from previous version.')
161 parent = os.path.dirname(cwd)
162 appname = basename[:(-len(version_suffix))]
163 for version in ['-2.1', '-2.0', '-1.6' ]:
164 logger.debug('Checking for upgrade from previous version ' + version)
165 previous = os.path.join(parent, appname + version)
166 logger.debug('previous = ' + previous)
167 if os.path.isdir( previous ):
168 logger.info('Found directory "%s".', previous)
169 copy_tree( previous, cwd, True )
170 logger.info('Content copied to directory "%s".', cwd)
174 def createDirectories():
175 ''' Create the build directories if necessary '''
176 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
177 'layouts', 'scripts', 'templates', 'ui' ]:
178 if not os.path.isdir( dir ):
181 logger.debug('Create directory %s.' % dir)
183 logger.error('Failed to create directory %s.' % dir)
188 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
189 windows_style_tex_paths = ''
191 return windows_style_tex_paths
192 if os.name == 'nt' or sys.platform == 'cygwin':
193 from tempfile import mkstemp
194 fd, tmpfname = mkstemp(suffix='.ltx')
196 from locale import getdefaultlocale
197 language, encoding = getdefaultlocale()
200 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
202 inpname = cmdOutput('cygpath -m ' + tmpfname)
203 logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
204 inpname = inpname.replace('~', '\\string~')
205 os.write(fd, r'\relax')
207 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
208 if 'Error' in latex_out:
209 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
210 if 'Error' in latex_out:
211 logger.warning("configure: TeX engine needs posix-style paths in latex files")
212 windows_style_tex_paths = 'false'
214 logger.info("configure: TeX engine needs windows-style paths in latex files")
215 windows_style_tex_paths = 'true'
216 removeFiles([tmpfname, logname, 'texput.log'])
217 return windows_style_tex_paths
220 ## Searching some useful programs
221 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
223 This function will search a program in $PATH plus given path
224 If found, return directory and program name (not the options).
226 description: description of the program
228 progs: check programs, for each prog, the first word is used
229 for searching but the whole string is used to replace
230 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
232 path: additional paths (will be prepended to the program name)
234 rc_entry: entry to outfile, can be
235 1. emtpy: no rc entry will be added
236 2. one pattern: %% will be replaced by the first found program,
237 or '' if no program is found.
238 3. several patterns for each prog and not_found. This is used
239 when different programs have different usages. If you do not
240 want not_found entry to be added to the RC file, you can specify
241 an entry for each prog and use '' for the not_found entry.
243 not_found: the value that should be used instead of '' if no program
247 # one rc entry for each progs plus not_found entry
248 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
249 logger.error("rc entry should have one item or item for each prog and not_found.")
251 logger.info('checking for ' + description + '...')
252 ## print '(' + ','.join(progs) + ')',
253 additional_path = path
254 path = os.environ["PATH"].split(os.pathsep) + additional_path
256 if "PATHEXT" in os.environ:
257 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
259 for idx in range(len(progs)):
260 # ac_prog may have options, ac_word is the command name
262 ac_word = ac_prog.split(' ')[0]
263 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
265 if ac_word.endswith('.pl') and perl == '':
267 msg = '+checking for "' + ac_word + '"... '
269 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
272 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
273 logger.info(msg + ' yes')
274 # deal with java and perl
275 if ac_word.endswith('.class'):
276 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
277 elif ac_word.endswith('.jar'):
278 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
279 elif ac_word.endswith('.pl'):
280 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
281 elif ac_dir in additional_path:
282 ac_prog = ac_prog.replace(ac_word, r'\"%s\"' % (os.path.join(ac_dir, ac_word)))
283 # write rc entries for this command
284 if len(rc_entry) == 1:
285 addToRC(rc_entry[0].replace('%%', ac_prog))
286 elif len(rc_entry) > 1:
287 addToRC(rc_entry[idx].replace('%%', ac_prog))
288 return [ac_dir, ac_word]
290 logger.info(msg + ' no')
291 # write rc entries for 'not found'
292 if len(rc_entry) > 0: # the last one.
293 addToRC(rc_entry[-1].replace('%%', not_found))
294 return ['', not_found]
297 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
299 The same as checkProg, but additionally, all found programs will be added
302 # one rc entry for each progs plus not_found entry
303 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
304 logger.error("rc entry should have one item or item for each prog and not_found.")
306 logger.info('checking for ' + description + '...')
307 ## print '(' + ','.join(progs) + ')',
308 additional_path = path
309 path = os.environ["PATH"].split(os.pathsep) + additional_path
311 if "PATHEXT" in os.environ:
312 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
315 real_ac_word = not_found
317 for idx in range(len(progs)):
318 # ac_prog may have options, ac_word is the command name
320 ac_word = ac_prog.split(' ')[0]
321 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
323 if ac_word.endswith('.pl') and perl == '':
325 msg = '+checking for "' + ac_word + '"... '
328 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
331 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
332 logger.info(msg + ' yes')
333 pr = re.compile(r'(\\\S+)(.*)$')
335 # deal with java and perl
336 if ac_word.endswith('.class'):
337 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
338 elif ac_word.endswith('.jar'):
339 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
340 elif ac_word.endswith('.pl'):
341 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
342 elif ac_dir in additional_path:
343 ac_prog = ac_prog.replace(ac_word, r'\"%s\"' % (os.path.join(ac_dir, ac_word)))
344 # write rc entries for this command
345 if found_prime == False:
346 if len(rc_entry) == 1:
347 addToRC(rc_entry[0].replace('%%', ac_prog))
348 elif len(rc_entry) > 1:
349 addToRC(rc_entry[idx].replace('%%', ac_prog))
351 real_ac_word = ac_word
353 if len(alt_rc_entry) == 1:
354 alt_rc = alt_rc_entry[0]
356 # if no explicit alt_rc is given, construct one
357 m = pr.match(rc_entry[0])
359 alt_rc = m.group(1) + "_alternatives" + m.group(2)
360 addToRC(alt_rc.replace('%%', ac_prog))
361 elif len(alt_rc_entry) > 1:
362 alt_rc = alt_rc_entry[idx]
364 # if no explicit alt_rc is given, construct one
365 m = pr.match(rc_entry[idx])
367 alt_rc = m.group(1) + "_alternatives" + m.group(2)
368 addToRC(alt_rc.replace('%%', ac_prog))
373 if found_alt == False:
375 logger.info(msg + ' no')
377 return [real_ac_dir, real_ac_word]
378 # write rc entries for 'not found'
379 if len(rc_entry) > 0: # the last one.
380 addToRC(rc_entry[-1].replace('%%', not_found))
381 return ['', not_found]
384 def addAlternatives(rcs, alt_type):
386 Returns a \\prog_alternatives string to be used as an alternative
387 rc entry. alt_type can be a string or a list of strings.
389 r = re.compile(r'\\Format (\S+).*$')
392 alt_token = '\\%s_alternatives '
393 if isinstance(alt_type, str):
394 alt_tokens = [alt_token % alt_type]
396 alt_tokens = map(lambda s: alt_token % s, alt_type)
397 for idxx in range(len(rcs)):
401 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
403 m = r.match(rcs[idxx])
407 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
411 def listAlternatives(progs, alt_type, rc_entry = []):
413 Returns a list of \\prog_alternatives strings to be used as alternative
414 rc entries. alt_type can be a string or a list of strings.
416 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
417 logger.error("rc entry should have one item or item for each prog and not_found.")
420 for idx in range(len(progs)):
421 if len(rc_entry) == 1:
422 rcs = rc_entry[0].split('\n')
423 alt = addAlternatives(rcs, alt_type)
424 alt_rc_entry.insert(0, alt)
425 elif len(rc_entry) > 1:
426 rcs = rc_entry[idx].split('\n')
427 alt = addAlternatives(rcs, alt_type)
428 alt_rc_entry.insert(idx, alt)
432 def checkViewer(description, progs, rc_entry = [], path = []):
433 ''' The same as checkProgAlternatives, but for viewers '''
434 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
435 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
438 def checkEditor(description, progs, rc_entry = [], path = []):
439 ''' The same as checkProgAlternatives, but for editors '''
440 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
441 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
444 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
445 ''' The same as checkViewer, but do not add rc entry '''
446 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
448 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
451 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
452 ''' The same as checkViewer, but do not add rc entry '''
453 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
455 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
458 def checkViewerEditor(description, progs, rc_entry = [], path = []):
459 ''' The same as checkProgAlternatives, but for viewers and editors '''
460 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
461 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
465 ''' Check whether DTL tools are available (Windows only) '''
466 # Find programs! Returned path is not used now
467 if ((os.name == 'nt' or sys.platform == 'cygwin') and
468 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
469 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
476 ''' Check whether Inkscape is available and return the full path (Windows only) '''
480 aReg = _winreg.ConnectRegistry(None, _winreg.HKEY_CLASSES_ROOT)
482 aKey = _winreg.OpenKey(aReg, r"inkscape.svg\DefaultIcon")
483 val = _winreg.QueryValueEx(aKey, "")
484 return str(val[0]).split('"')[1].replace('.exe', '')
485 except EnvironmentError:
487 aKey = _winreg.OpenKey(aReg, r"Applications\inkscape.exe\shell\open\command")
488 val = _winreg.QueryValueEx(aKey, "")
489 return str(val[0]).split('"')[1].replace('.exe', '')
490 except EnvironmentError:
493 def checkLatex(dtl_tools):
494 ''' Check latex, return lyx_check_config '''
495 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
496 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
497 #-----------------------------------------------------------------
498 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
500 # check if PLATEX is pLaTeX2e
501 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
502 # run platex on chklatex.ltx and check result
503 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
504 # We have the Japanese pLaTeX2e
505 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
508 removeFiles(['chklatex.ltx', 'chklatex.log'])
509 #-----------------------------------------------------------------
510 # use LATEX to convert from latex to dvi if PPLATEX is not available
514 # Windows only: DraftDVI
515 addToRC(r'''\converter latex dvi2 "%s" "latex"
516 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
518 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
521 # Check if latex is usable
522 writeToFile('chklatex.ltx', r'''
524 \ifx\undefined\documentclass\else
525 \message{ThisIsLaTeX2e}
530 # run latex on chklatex.ltx and check result
531 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
535 logger.warning("Latex not usable (not LaTeX2e) ")
536 # remove temporary files
537 removeFiles(['chklatex.ltx', 'chklatex.log'])
542 ''' Check if luatex is there '''
543 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
544 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
546 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
548 addToRC(r'\converter luatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
551 def checkModule(module):
552 ''' Check for a Python module, return the status '''
553 msg = 'checking for "' + module + ' module"... '
556 logger.info(msg + ' yes')
559 logger.info(msg + ' no')
563 def checkFormatEntries(dtl_tools):
564 ''' Check all formats (\Format entries) '''
565 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
566 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
568 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
569 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
571 checkViewerEditor('a Dia viewer and editor', ['dia'],
572 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
574 checkViewerEditor('an OpenDocument drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
575 rc_entry = [r'\Format odg "odg, sxd" "OpenDocument drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
577 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
578 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
580 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
581 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
583 checkViewerEditor('a SVG viewer and editor', [inkscape_name],
584 rc_entry = [r'''\Format svg "svg" SVG "" "%%" "%%" "vector" "image/svg+xml"
585 \Format svgz "svgz" "SVG (compressed)" "" "%%" "%%" "vector,zipped=native" ""'''],
586 path = [inkscape_path])
588 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
589 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
590 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
591 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
592 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
593 \Format png png PNG "" "%s" "%s" "" "image/x-png"
594 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
595 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
596 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
597 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
598 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
599 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
600 addToRC(imageformats % \
601 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
603 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
604 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
605 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
606 \Format asciiimage asc "Plain text (image)" "" "" "%%" "" ""
607 \Format asciixfig asc "Plain text (Xfig output)" "" "" "%%" "" ""
608 \Format dateout tmp "date (output)" "" "" "%%" "" ""
609 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
610 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
611 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
612 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
613 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
614 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
615 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
616 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
617 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
618 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
619 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
620 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
621 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
622 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
623 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
624 \Format latexclipboard tex "LaTeX (clipboard)" "" "" "%%" "" ""
625 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
626 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
627 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
628 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
629 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
630 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
631 #Spreadsheets using ssconvert from gnumeric
632 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
633 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
634 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
635 \Format oocalc ods "OpenDocument spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
637 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
638 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
640 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
641 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
642 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
643 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
644 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
645 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
646 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
648 #checkProg('a Postscript interpreter', ['gs'],
649 # rc_entry = [ r'\ps_command "%%"' ])
650 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'qpdfview --unique', 'evince', 'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
651 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
652 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
653 \Format eps3 eps "EPS (cropped)" "" "%%" "" "document" ""
654 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
655 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
656 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
657 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'qpdfview --unique', 'evince', 'kghostview', 'xpdf', 'SumatraPDF', 'acrobat', 'acroread', 'mupdf', \
658 'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
659 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
660 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
661 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
662 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
663 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
664 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"
665 \Format pdf7 pdf "PDF (cropped)" "" "%%" "" "document,vector" ""
666 \Format pdf8 pdf "PDF (lower resolution)" "" "%%" "" "document,vector" ""'''])
668 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
669 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
670 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
672 # Windows only: DraftDVI
673 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
675 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
676 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
678 checkViewerEditor('Noteedit', ['noteedit'],
679 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
681 checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
682 rc_entry = [r'''\Format odt odt "OpenDocument (tex4ht)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
683 \Format odt2 odt "OpenDocument (eLyXer)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
684 \Format odt3 odt "OpenDocument (Pandoc)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
685 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
687 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
688 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
689 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"
690 \Format word2 docx "MS Word Office Open XML" O "%%" "%%" "document,vector,menu=export" "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
692 # entries that do not need checkProg
693 addToRC(r'''\Format date "" "date command" "" "" "" "" ""
694 \Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
695 \Format fax "" Fax "" "" "" "document" ""
696 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
697 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
698 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
699 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
700 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document" ""
701 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document" ""
702 \Format lyx21x 21.lyx "LyX 2.1.x" "" "" "" "document,menu=export" ""
703 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
704 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
705 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
706 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
707 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
708 \Format program "" Program "" "" "" "" ""
709 \Format pstex pstex_t PSTEX "" "" "" "" ""
710 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
711 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
712 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
716 def checkConverterEntries():
717 ''' Check all converters (\converter entries) '''
718 checkProg('the pdflatex program', ['pdflatex $$i'],
719 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
721 checkProg('XeTeX', ['xelatex $$i'],
722 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
726 # Look for tex2lyx in this order (see bugs #3308 and #6986):
727 # 1) If we're building LyX with autotools then tex2lyx is found
728 # in the subdirectory tex2lyx with respect to the binary dir.
729 # 2) If we're building LyX with cmake then tex2lyx is found
731 # 3) If LyX was configured with a version suffix then tex2lyx
732 # will also have this version suffix.
733 # 4) Otherwise always use tex2lyx.
734 in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
735 in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
737 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
738 in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
740 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [in_binary_subdir, in_binary_subdir + version_suffix, in_binary_dir, in_binary_dir + version_suffix, 'tex2lyx' + version_suffix, 'tex2lyx'],
741 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
742 \converter latexclipboard lyx "%% -fixedenc utf8 -f $$i $$o" ""
743 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""
744 \converter sweave lyx "%% -n -m sweave -f $$i $$o" ""
745 \converter knitr lyx "%% -n -m knitr -f $$i $$o" ""'''], not_found = 'tex2lyx')
747 logger.warning("Failed to find tex2lyx on your system.")
750 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
751 rc_entry = [r'''\converter literate latex "%%" ""
752 \converter literate pdflatex "%%" ""
753 \converter literate xetex "%%" ""
754 \converter literate luatex "%%" ""'''])
756 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
757 rc_entry = [r'''\converter sweave latex "%%" ""
758 \converter sweave pdflatex "%%" ""
759 \converter sweave xetex "%%" ""
760 \converter sweave luatex "%%" ""'''])
762 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
763 rc_entry = [r'''\converter knitr latex "%%" ""
764 \converter knitr pdflatex "%%" ""
765 \converter knitr xetex "%%" ""
766 \converter knitr luatex "%%" ""'''])
768 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
769 rc_entry = [ r'\converter sweave r "%%" ""' ])
771 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
772 rc_entry = [ r'\converter knitr r "%%" ""' ])
774 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
775 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
776 rc_entry = [ r'\converter html latex "%%" ""', \
777 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""', \
778 r'\converter html latex "%%" ""', \
779 r'\converter html latex "%%" ""', '' ])
781 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
782 rc_entry = [ r'\converter word latex "%%" ""' ])
784 # eLyXer: search as an executable (elyxer.py, elyxer)
785 path, elyxer = checkProg('a LyX -> HTML converter',
786 ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
787 rc_entry = [ r'\converter lyx html "%%" ""' ])
788 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
789 ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
790 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
791 path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
792 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
793 rc_entry = [ r'\converter lyx odt2 "%%" ""' ])
794 path, elyxer = checkProg('a LyX -> Word converter',
795 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
796 rc_entry = [ r'\converter lyx word "%%" ""' ])
797 if elyxer.find('elyxer') >= 0:
798 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
799 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
801 # search for HTML converters other than eLyXer
802 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
803 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
804 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
805 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
806 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
807 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
808 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
810 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
811 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
812 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
813 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
814 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
815 if htmlconv.find('htlatex') >= 0:
816 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
818 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
821 # Check if LyXBlogger is installed
822 lyxblogger_found = checkModule('lyxblogger')
824 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
825 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
828 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
829 rc_entry = [ r'\converter sxw latex "%%" ""' ])
831 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
832 rc_entry = [ r'\converter odt latex "%%" ""' ])
834 checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
835 rc_entry = [ r'\converter odt3 latex "%%" ""' ])
837 checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
838 rc_entry = [ r'\converter word2 latex "%%" ""' ])
839 # Only define a converter to pdf6, otherwise the odt format could be
840 # used as an intermediate step for export to pdf, which is not wanted.
841 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
842 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
843 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
844 # the command mk4ht oolatex $$i has to be used as default,
845 # but as this would require to have Perl installed, in MiKTeX oolatex is
846 # directly available as application.
847 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
848 # Both SuSE and debian have oolatex
849 checkProg('a LaTeX -> Open Document (tex4ht) converter', [
850 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
851 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
852 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
853 # On windows it is called latex2rt.exe
854 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
855 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
857 checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
858 rc_entry = [ r'\converter latex odt3 "%%" ""' ])
860 checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
861 rc_entry = [ r'\converter latex word2 "%%" ""' ])
863 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
864 rc_entry = [ r'\converter rtf html "%%" ""' ])
865 # Do not define a converter to pdf6, ps is a pure export format
866 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
867 rc_entry = [ r'\converter ps pdf "%%" ""' ])
869 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
870 rc_entry = [ r'\converter ps text2 "%%" ""' ])
872 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
873 rc_entry = [ r'\converter ps text3 "%%" ""' ])
874 # Need to call ps2eps in a pipe, otherwise it would name the output file
875 # depending on the extension of the input file. We do not know the input
876 # file extension in general, so the resultfile= flag would not help.
877 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
878 # This would create additional paths in the converter graph with unwanted
879 # side effects (e.g. ps->pdf via ps2pdf would create a different result
880 # than ps->eps->pdf via ps2eps and epstopdf).
881 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
882 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
884 checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
885 rc_entry = [ r'\converter pdf ps "%%" ""' ])
886 # Only define a converter from pdf6 for graphics
887 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
888 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
889 # Create one converter for a PDF produced using TeX fonts and one for a
890 # PDF produced using non-TeX fonts. This does not produce non-unique
891 # conversion paths, since a given document either uses TeX fonts or not.
892 checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
893 rc_entry = [ r'''\converter pdf2 pdf7 "%%" ""
894 \converter pdf4 pdf7 "%%" ""''' ])
895 # Create one converter for a PDF produced using TeX fonts and one for a
896 # PDF produced using non-TeX fonts. This does not produce non-unique
897 # conversion paths, since a given document either uses TeX fonts or not.
898 checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
899 rc_entry = [ r'''\converter pdf2 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""
900 \converter pdf4 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""''' ])
902 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
903 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
905 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
906 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
908 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
909 rc_entry = [ r'\converter dvi ps "%%" ""' ])
911 checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
912 rc_entry = [ r'\converter dvi eps3 "%%" ""' ])
914 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
915 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
917 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
918 rc_entry = [ r'\converter ps fax "%%" ""'])
920 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
921 if fig2dev == "fig2dev":
922 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
923 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
924 \converter fig png "fig2dev -L png $$i $$o" ""
925 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
926 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
928 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
929 rc_entry = [ r'\converter tiff eps "%%" ""'])
931 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
933 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
934 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
935 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
937 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
938 rc_entry = [ r'\converter wmf eps "%%" ""'])
940 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
941 rc_entry = [ r'\converter emf eps "%%" ""'])
943 checkProg('a WMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
944 rc_entry = [ r'\converter wmf pdf6 "%%" ""'])
946 checkProg('an EMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
947 rc_entry = [ r'\converter emf pdf6 "%%" ""'])
948 # Only define a converter to pdf6 for graphics
949 checkProg('an EPS -> PDF converter', ['epstopdf'],
950 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
952 checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
953 rc_entry = [ r'\converter eps png "%%" ""'])
955 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
956 # free software and therefore not compiled in in many installations.
957 # Fortunately, this is not a big problem, because we will use epstopdf to
958 # convert from agr to pdf6 via eps without loss of quality.
959 checkProg('a Grace -> Image converter', ['gracebat'],
961 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
962 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
963 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
964 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
966 checkProg('a Dot -> Image converter', ['dot'],
968 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
969 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
971 checkProg('a Dia -> PNG converter', ['dia -e $$o -t png $$i'],
972 rc_entry = [ r'\converter dia png "%%" ""'])
974 checkProg('a Dia -> EPS converter', ['dia -e $$o -t eps $$i'],
975 rc_entry = [ r'\converter dia eps "%%" ""'])
976 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
977 # The eps2->eps converter then fixes the bounding box by cropping.
978 # Although unoconv can convert to png and pdf as well, do not define
979 # odg->png and odg->pdf converters, since the bb would be too large as well.
980 checkProg('an OpenDocument -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
981 rc_entry = [ r'\converter odg eps2 "%%" ""'])
983 checkProg('a SVG (compressed) -> SVG converter', ['gunzip -c $$i > $$o'],
984 rc_entry = [ r'\converter svgz svg "%%" ""'])
986 checkProg('a SVG -> SVG (compressed) converter', ['gzip -c $$i > $$o'],
987 rc_entry = [ r'\converter svg svgz "%%" ""'])
988 # Only define a converter to pdf6 for graphics
989 # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
990 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
991 rc_entry = [ r'''\converter svg pdf6 "%%" ""
992 \converter svgz pdf6 "%%" ""'''],
993 path = ['', inkscape_path])
995 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
996 rc_entry = [ r'''\converter svg eps "%%" ""
997 \converter svgz eps "%%" ""'''],
998 path = ['', inkscape_path])
1000 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_name + ' --without-gui --file=$$i --export-png=$$o'],
1001 rc_entry = [ r'''\converter svg png "%%" "",
1002 \converter svgz png "%%" ""'''],
1003 path = ['', inkscape_path])
1006 # gnumeric/xls/ods to tex
1007 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
1008 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1009 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1010 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
1012 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1013 if (lilypond != ''):
1014 version_string = cmdOutput("lilypond --version")
1015 match = re.match('GNU LilyPond (\S+)', version_string)
1017 version_number = match.groups()[0]
1018 version = version_number.split('.')
1019 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1020 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
1021 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
1022 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
1023 logger.info('+ found LilyPond version %s.' % version_number)
1024 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1025 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
1026 \converter lilypond png "lilypond -b eps --png $$i" ""''')
1027 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1028 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
1029 logger.info('+ found LilyPond version %s.' % version_number)
1031 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
1033 logger.info('+ found LilyPond, but could not extract version number.')
1035 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1036 if (lilypond_book != ''):
1037 version_string = cmdOutput("lilypond-book --version")
1038 match = re.match('^(\S+)$', version_string)
1040 version_number = match.groups()[0]
1041 version = version_number.split('.')
1042 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1043 # Note: The --lily-output-dir flag is required because lilypond-book
1044 # does not process input again unless the input has changed,
1045 # even if the output format being requested is different. So
1046 # once a .eps file exists, lilypond-book won't create a .pdf
1047 # even when requested with --pdf. This is a problem if a user
1048 # clicks View PDF after having done a View DVI. To circumvent
1049 # this, use different output folders for eps and pdf outputs.
1050 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
1051 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1052 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
1053 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1054 logger.info('+ found LilyPond-book version %s.' % version_number)
1056 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
1058 logger.info('+ found LilyPond-book, but could not extract version number.')
1060 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1061 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
1063 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1064 # and a zip archive on Windows.
1065 # So, we configure the appropriate version according to the platform.
1066 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1068 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
1069 addToRC(cmd % "lyxzip")
1071 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
1072 addToRC(cmd % "lyxgz")
1075 # FIXME: no rc_entry? comment it out
1076 # checkProg('Image converter', ['convert $$i $$o'])
1078 # Entries that do not need checkProg
1080 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
1081 \converter date dateout "python -tt $$s/scripts/date.py %d-%m-%Y > $$o" ""
1082 \converter docbook docbook-xml "cp $$i $$o" "xml"
1083 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
1084 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -t 221 $$i > $$o" ""
1085 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -t 245 $$i > $$o" ""
1086 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -t 276 $$i > $$o" ""
1087 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -t 345 $$i > $$o" ""
1088 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -t 413 $$i > $$o" ""
1089 \converter lyx lyx21x "python -tt $$s/lyx2lyx/lyx2lyx -t 474 $$i > $$o" ""
1090 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -t 245 $$i > $$o" ""
1091 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -t 245 $$i > $$o" ""
1092 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -t 245 $$i > $$o" ""
1093 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 $$i > $$o" ""
1094 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp $$i > $$o" ""
1095 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr $$i > $$o" ""
1096 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
1097 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
1102 ''' Check docbook '''
1103 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
1105 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
1106 \converter docbook html "sgmltools -b html $$i" ""
1107 \converter docbook ps "sgmltools -b ps $$i" ""''',
1108 r'''\converter docbook dvi "db2dvi $$i" ""
1109 \converter docbook html "db2html $$i" ""''',
1110 r'''\converter docbook dvi "" ""
1111 \converter docbook html "" ""''',
1112 r'''\converter docbook dvi "" ""
1113 \converter docbook html "" ""'''])
1116 return ('yes', 'true', '\\def\\hasdocbook{yes}')
1118 return ('no', 'false', '')
1121 def checkOtherEntries():
1122 ''' entries other than Format and Converter '''
1123 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1124 rc_entry = [ r'\chktex_command "%%"' ])
1125 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
1126 rc_entry = [ r'\bibtex_command "%%"' ],
1127 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1128 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
1129 rc_entry = [ r'\jbibtex_command "%%"' ])
1130 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
1131 rc_entry = [ r'\index_command "%%"' ],
1132 alt_rc_entry = [ r'\index_alternatives "%%"' ])
1133 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1134 rc_entry = [ r'\jindex_command "%%"' ])
1135 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1136 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1137 checkProg('a nomenclature processor', ['makeindex'],
1138 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1139 ## FIXME: OCTAVE is not used anywhere
1140 # path, OCTAVE = checkProg('Octave', ['octave'])
1141 ## FIXME: MAPLE is not used anywhere
1142 # path, MAPLE = checkProg('Maple', ['maple'])
1143 # Add the rest of the entries (no checkProg is required)
1144 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1145 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1146 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1147 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1151 def processLayoutFile(file, bool_docbook):
1152 ''' process layout file and get a line of result
1154 Declare lines look like this:
1156 \DeclareLaTeXClass[<requirements>]{<description>}
1158 Optionally, a \DeclareCategory line follows:
1160 \DeclareCategory{<category>}
1162 So for example (article.layout, scrbook.layout, svjog.layout)
1164 \DeclareLaTeXClass{article}
1165 \DeclareCategory{Articles}
1167 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1168 \DeclareCategory{Books}
1170 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1172 we'd expect this output:
1174 "article" "article" "article" "false" "article.cls" "Articles"
1175 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1176 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1178 def checkForClassExtension(x):
1179 '''if the extension for a latex class is not
1180 provided, add .cls to the classname'''
1182 return x.strip() + '.cls'
1185 classname = file.split(os.sep)[-1].split('.')[0]
1186 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1187 p = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1188 q = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1189 classdeclaration = ""
1190 categorydeclaration = '""'
1191 for line in open(file).readlines():
1192 res = p.search(line)
1193 qres = q.search(line)
1195 (classtype, optAll, opt, opt1, desc) = res.groups()
1196 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1199 prereq_latex = checkForClassExtension(classname)
1201 prereq_list = optAll[1:-1].split(',')
1202 prereq_list = map(checkForClassExtension, prereq_list)
1203 prereq_latex = ','.join(prereq_list)
1204 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1205 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1206 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1207 if categorydeclaration != '""':
1208 return classdeclaration + " " + categorydeclaration
1210 categorydeclaration = '"%s"' % (qres.groups()[0])
1211 if classdeclaration != "":
1212 return classdeclaration + " " + categorydeclaration
1213 if classdeclaration != "":
1214 return classdeclaration + " " + categorydeclaration
1215 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1219 def checkLatexConfig(check_config, bool_docbook):
1220 ''' Explore the LaTeX configuration
1221 Return None (will be passed to sys.exit()) for success.
1223 msg = 'checking LaTeX configuration... '
1224 # if --without-latex-config is forced, or if there is no previous
1225 # version of textclass.lst, re-generate a default file.
1226 if not os.path.isfile('textclass.lst') or not check_config:
1227 # remove the files only if we want to regenerate
1228 removeFiles(['textclass.lst', 'packages.lst'])
1230 # Then, generate a default textclass.lst. In case configure.py
1231 # fails, we still have something to start lyx.
1232 logger.info(msg + ' default values')
1233 logger.info('+checking list of textclasses... ')
1234 tx = open('textclass.lst', 'w')
1236 # This file declares layouts and their associated definition files
1237 # (include dir. relative to the place where this file is).
1238 # It contains only default values, since chkconfig.ltx could not be run
1239 # for some reason. Run ./configure.py if you need to update it after a
1240 # configuration change.
1242 # build the list of available layout files and convert it to commands
1245 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1246 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1248 if not os.path.isfile(file):
1250 # get stuff between /xxxx.layout .
1251 classname = file.split(os.sep)[-1].split('.')[0]
1253 cleanclass = classname.replace(' ', '_')
1254 cleanclass = cleanclass.replace('-', '_')
1255 # make sure the same class is not considered twice
1256 if foundClasses.count(cleanclass) == 0: # not found before
1257 foundClasses.append(cleanclass)
1258 retval = processLayoutFile(file, bool_docbook)
1262 logger.info('\tdone')
1263 if not os.path.isfile('packages.lst') or not check_config:
1264 logger.info('+generating default list of packages... ')
1265 removeFiles(['packages.lst'])
1266 tx = open('packages.lst', 'w')
1268 logger.info('\tdone')
1269 if not check_config:
1271 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1272 logger.info(msg + '\tauto')
1273 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1274 'wrap_chkconfig.ltx'])
1276 if not os.path.isfile( 'chkconfig.ltx' ):
1277 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1279 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1280 # Construct the list of classes to test for.
1281 # build the list of available layout files and convert it to commands
1283 declare = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1284 category = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1285 empty = re.compile(r'^\s*$')
1286 testclasses = list()
1287 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1288 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1289 nodeclaration = False
1290 if not os.path.isfile(file):
1292 classname = file.split(os.sep)[-1].split('.')[0]
1295 for line in open(file).readlines():
1296 if not empty.match(line) and line[0] != '#':
1298 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1299 nodeclaration = True
1300 # A class, but no category declaration. Just break.
1302 if declare.search(line) != None:
1303 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1304 testclasses.append(decline)
1305 elif category.search(line) != None:
1306 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1307 testclasses.append(catline)
1308 if catline == "" or decline == "":
1314 cl = open('chklayouts.tex', 'w')
1315 for line in testclasses:
1316 cl.write(line + '\n')
1319 # we have chklayouts.tex, then process it
1320 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1322 line = latex_out.readline()
1325 if re.match('^\+', line):
1326 logger.info(line.strip())
1327 # if the command succeeds, None will be returned
1328 ret = latex_out.close()
1330 # remove the copied file
1332 removeFiles( [ 'chkconfig.ltx' ] )
1334 # currently, values in chkconfig are only used to set
1337 for line in open('chkconfig.vars').readlines():
1338 key, val = re.sub('-', '_', line).split('=')
1340 values[key] = val.strip("'")
1341 # chk_fontenc may not exist
1343 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1346 # if configure successed, move textclass.lst.tmp to textclass.lst
1347 # and packages.lst.tmp to packages.lst
1348 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1349 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1350 shutil.move('textclass.lst.tmp', 'textclass.lst')
1351 shutil.move('packages.lst.tmp', 'packages.lst')
1355 def checkModulesConfig():
1356 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1358 logger.info('+checking list of modules... ')
1359 tx = open('lyxmodules.lst', 'w')
1360 tx.write('''## This file declares modules and their associated definition files.
1361 ## It has been automatically generated by configure
1362 ## Use "Options/Reconfigure" if you need to update it after a
1363 ## configuration change.
1364 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1367 # build the list of available modules
1369 # note that this searches the local directory first, then the
1370 # system directory. that way, we pick up the user's version first.
1371 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1372 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1375 if not os.path.isfile(file):
1378 filename = file.split(os.sep)[-1]
1379 filename = filename[:-7]
1380 if seen.count(filename):
1383 seen.append(filename)
1384 retval = processModuleFile(file, filename, bool_docbook)
1388 logger.info('\tdone')
1391 def processModuleFile(file, filename, bool_docbook):
1392 ''' process module file and get a line of result
1394 The top of a module file should look like this:
1395 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1397 #...body of description...
1399 #Requires: [list of required modules]
1400 #Excludes: [list of excluded modules]
1401 #Category: [category name]
1402 The last three lines are optional (though do give a category).
1404 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1406 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1407 rereqs = re.compile(r'#+\s*Requires: (.*)')
1408 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1409 recaty = re.compile(r'#+\s*Category: (.*)')
1410 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1411 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1413 modname = desc = pkgs = req = excl = catgy = ""
1414 readingDescription = False
1417 for line in open(file).readlines():
1418 if readingDescription:
1419 res = redend.search(line)
1421 readingDescription = False
1422 desc = " ".join(descLines)
1424 desc = desc.replace('"', '\\"')
1426 descLines.append(line[1:].strip())
1428 res = redbeg.search(line)
1430 readingDescription = True
1432 res = remods.search(line)
1434 (pkgs, modname) = res.groups()
1438 tmp = [s.strip() for s in pkgs.split(",")]
1439 pkgs = ",".join(tmp)
1441 res = rereqs.search(line)
1444 tmp = [s.strip() for s in req.split("|")]
1447 res = reexcs.search(line)
1450 tmp = [s.strip() for s in excl.split("|")]
1451 excl = "|".join(tmp)
1453 res = recaty.search(line)
1455 catgy = res.group(1)
1459 logger.warning("Module file without \DeclareLyXModule line. ")
1463 # this module has some latex dependencies:
1464 # append the dependencies to chkmodules.tex,
1465 # which is \input'ed by chkconfig.ltx
1466 testpackages = list()
1467 for pkg in pkgs.split(","):
1469 # this is a converter dependency: skip
1471 if pkg.endswith(".sty"):
1473 testpackages.append("\\TestPackage{%s}" % (pkg,))
1474 cm = open('chkmodules.tex', 'a')
1475 for line in testpackages:
1476 cm.write(line + '\n')
1479 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1482 def checkTeXAllowSpaces():
1483 ''' Let's check whether spaces are allowed in TeX file names '''
1484 tex_allows_spaces = 'false'
1485 if lyx_check_config:
1486 msg = "Checking whether TeX allows spaces in file names... "
1487 writeToFile('a b.tex', r'\message{working^^J}' )
1489 if os.name == 'nt' or sys.platform == 'cygwin':
1490 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1492 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1495 if 'working' in latex_out:
1496 logger.info(msg + 'yes')
1497 tex_allows_spaces = 'true'
1499 logger.info(msg + 'no')
1500 tex_allows_spaces = 'false'
1501 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1502 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1505 def rescanTeXFiles():
1506 ''' Run kpsewhich to update information about TeX files '''
1507 logger.info("+Indexing TeX files... ")
1508 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1509 logger.error("configure: error: cannot find TeXFiles.py script")
1511 interpreter = sys.executable
1512 if interpreter == '':
1513 interpreter = "python"
1514 tfp = cmdOutput(interpreter + " -tt " + '"' + os.path.join(srcdir, 'scripts', 'TeXFiles.py') + '"')
1516 logger.info("\tdone")
1519 def removeTempFiles():
1521 if not lyx_keep_temps:
1522 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1523 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1524 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1527 if __name__ == '__main__':
1528 lyx_check_config = True
1529 lyx_kpsewhich = True
1530 outfile = 'lyxrc.defaults'
1531 lyxrc_fileformat = 19
1533 lyx_keep_temps = False
1536 ## Parse the command line
1537 for op in sys.argv[1:]: # default shell/for list is $*, the options
1538 if op in [ '-help', '--help', '-h' ]:
1539 print '''Usage: configure [options]
1541 --help show this help lines
1542 --keep-temps keep temporary files (for debug. purposes)
1543 --without-kpsewhich do not update TeX files information via kpsewhich
1544 --without-latex-config do not run LaTeX to determine configuration
1545 --with-version-suffix=suffix suffix of binary installed files
1546 --binary-dir=directory directory of binary installed files
1549 elif op == '--without-kpsewhich':
1550 lyx_kpsewhich = False
1551 elif op == '--without-latex-config':
1552 lyx_check_config = False
1553 elif op == '--keep-temps':
1554 lyx_keep_temps = True
1555 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1556 version_suffix = op[22:]
1557 elif op[0:13] == '--binary-dir=':
1558 lyx_binary_dir = op[13:]
1560 print "Unknown option", op
1563 # check if we run from the right directory
1564 srcdir = os.path.dirname(sys.argv[0])
1567 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1568 logger.error("configure: error: cannot find chkconfig.ltx script")
1571 if sys.platform == 'darwin' and len(version_suffix) > 0:
1574 dtl_tools = checkDTLtools()
1575 ## Write the first part of outfile
1576 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1577 # script. It contains default settings that have been determined by
1578 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1579 # want to customize LyX, use LyX' Preferences dialog or modify directly
1580 # the "preferences" file instead. Any setting in that file will
1581 # override the values given here.
1585 ''' % lyxrc_fileformat)
1587 LATEX = checkLatex(dtl_tools)
1588 # check java and perl before any checkProg that may require them
1589 java = checkProg('a java interpreter', ['java'])[1]
1590 perl = checkProg('a perl interpreter', ['perl'])[1]
1591 (inkscape_path, inkscape_name) = os.path.split(checkInkscape())
1592 checkFormatEntries(dtl_tools)
1593 checkConverterEntries()
1594 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1595 checkTeXAllowSpaces()
1596 windows_style_tex_paths = checkTeXPaths()
1597 if windows_style_tex_paths != '':
1598 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1602 checkModulesConfig()
1603 # --without-latex-config can disable lyx_check_config
1604 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1606 # The return error code can be 256. Because most systems expect an error code
1607 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1608 # a None for success, 'ret is not None' is used to exit.
1609 sys.exit(ret is not None)