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 from __future__ import print_function
12 import glob, logging, os, re, shutil, subprocess, sys, stat
15 logging.basicConfig(level = logging.DEBUG,
16 format = '%(levelname)s: %(message)s', # ignore application name
17 filename = 'configure.log',
20 # Add a handler to log to console
21 console = logging.StreamHandler()
22 console.setLevel(logging.INFO) # the console only print out general information
23 formatter = logging.Formatter('%(message)s') # only print out the message itself
24 console.setFormatter(formatter)
25 logger = logging.getLogger('LyX')
26 logger.addHandler(console)
28 def writeToFile(filename, lines, append = False):
29 " utility function: write or append lines to filename "
31 file = open(filename, 'a')
33 file = open(filename, 'w')
39 ''' utility function: shortcut for appending lines to outfile
40 add newline at the end of lines.
42 if lines.strip() != '':
43 writeToFile(outfile, lines + '\n', append = True)
44 logger.debug('Add to RC:\n' + lines + '\n\n')
47 def removeFiles(filenames):
48 '''utility function: 'rm -f'
49 ignore errors when file does not exist, or is a directory.
51 for file in filenames:
54 logger.debug('Removing file %s' % file)
56 logger.debug('Failed to remove file %s' % file)
60 def cmdOutput(cmd, async = False):
61 '''utility function: run a command and get its output as a string
63 async: if False, return whole output as a string, otherwise
64 return the stdout handle from which the output can be
65 read (the caller is then responsible for closing it)
69 if sys.version_info[0] < 3:
70 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
72 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwd()) + '&' + cmd
75 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE, \
76 stdout=subprocess.PIPE, universal_newlines=True)
80 output = pipe.stdout.read()
86 ''' On Windows, return the short version of "path" if possible '''
88 from ctypes import windll, create_unicode_buffer
89 GetShortPathName = windll.kernel32.GetShortPathNameW
90 shortlen = GetShortPathName(path, 0, 0)
91 shortpath = create_unicode_buffer(shortlen)
92 if GetShortPathName(path, shortpath, shortlen):
93 return shortpath.value
98 ''' I do not really know why this is useful, but we might as well keep it.
100 Only set these to C if already set. These must not be set unconditionally
101 because not all systems understand e.g. LANG=C (notably SCO).
102 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
103 Non-C LC_CTYPE values break the ctype check.
105 os.environ['LANG'] = os.getenv('LANG', 'C')
106 os.environ['LC'] = os.getenv('LC_ALL', 'C')
107 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
108 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
111 def copy_tree(src, dst, preserve_symlinks=False, level=0):
112 ''' Copy an entire directory tree 'src' to a new location 'dst'.
114 Code inspired from distutils.copy_tree.
115 Copying ignores non-regular files and the cache directory.
116 Pipes may be present as leftovers from LyX for lyx-server.
118 If 'preserve_symlinks' is true, symlinks will be
119 copied as symlinks (on platforms that support them!); otherwise
120 (the default), the destination of the symlink will be copied.
123 if not os.path.isdir(src):
124 raise FileError("cannot copy tree '%s': not a directory" % src)
126 names = os.listdir(src)
127 except os.error as oserror:
128 (errno, errstr) = oserror.args
129 raise FileError("error listing files in '%s': %s" % (src, errstr))
131 if not os.path.isdir(dst):
137 src_name = os.path.join(src, name)
138 dst_name = os.path.join(dst, name)
139 if preserve_symlinks and os.path.islink(src_name):
140 link_dest = os.readlink(src_name)
141 os.symlink(link_dest, dst_name)
142 outputs.append(dst_name)
143 elif level == 0 and name == 'cache':
144 logger.info("Skip cache %s", src_name)
145 elif os.path.isdir(src_name):
147 copy_tree(src_name, dst_name, preserve_symlinks, level=(level + 1)))
148 elif stat.S_ISREG(os.stat(src_name).st_mode) or os.path.islink(src_name):
149 shutil.copy2(src_name, dst_name)
150 outputs.append(dst_name)
152 logger.info("Ignore non-regular file %s", src_name)
158 ''' Check for upgrade from previous version '''
160 basename = os.path.basename( cwd )
161 lyxrc = os.path.join(cwd, outfile)
162 if not os.path.isfile( lyxrc ) and basename.endswith( version_suffix ) :
163 logger.info('Checking for upgrade from previous version.')
164 parent = os.path.dirname(cwd)
165 appname = basename[:(-len(version_suffix))]
166 for version in ['-2.1', '-2.0', '-1.6' ]:
167 logger.debug('Checking for upgrade from previous version ' + version)
168 previous = os.path.join(parent, appname + version)
169 logger.debug('previous = ' + previous)
170 if os.path.isdir( previous ):
171 logger.info('Found directory "%s".', previous)
172 copy_tree( previous, cwd, True )
173 logger.info('Content copied to directory "%s".', cwd)
177 def createDirectories():
178 ''' Create the build directories if necessary '''
179 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd', \
180 'layouts', 'scripts', 'templates', 'ui' ]:
181 if not os.path.isdir( dir ):
184 logger.debug('Create directory %s.' % dir)
186 logger.error('Failed to create directory %s.' % dir)
191 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
192 windows_style_tex_paths = ''
194 return windows_style_tex_paths
195 if os.name == 'nt' or sys.platform == 'cygwin':
196 from tempfile import mkstemp
197 fd, tmpfname = mkstemp(suffix='.ltx')
199 from locale import getdefaultlocale
200 language, encoding = getdefaultlocale()
203 if sys.version_info[0] < 3:
204 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
206 inpname = shortPath(str(tmpfname, encoding)).replace('\\', '/')
208 inpname = cmdOutput('cygpath -m ' + tmpfname)
209 logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
210 inpname = inpname.replace('~', '\\string~')
211 os.write(fd, r'\relax')
213 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"' % inpname)
214 if 'Error' in latex_out:
215 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"' % inpname)
216 if 'Error' in latex_out:
217 logger.warning("configure: TeX engine needs posix-style paths in latex files")
218 windows_style_tex_paths = 'false'
220 logger.info("configure: TeX engine needs windows-style paths in latex files")
221 windows_style_tex_paths = 'true'
222 removeFiles([tmpfname, logname, 'texput.log'])
223 return windows_style_tex_paths
226 ## Searching some useful programs
227 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
229 This function will search a program in $PATH plus given path
230 If found, return directory and program name (not the options).
232 description: description of the program
234 progs: check programs, for each prog, the first word is used
235 for searching but the whole string is used to replace
236 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
238 path: additional paths (will be prepended to the program name)
240 rc_entry: entry to outfile, can be
241 1. emtpy: no rc entry will be added
242 2. one pattern: %% will be replaced by the first found program,
243 or '' if no program is found.
244 3. several patterns for each prog and not_found. This is used
245 when different programs have different usages. If you do not
246 want not_found entry to be added to the RC file, you can specify
247 an entry for each prog and use '' for the not_found entry.
249 not_found: the value that should be used instead of '' if no program
253 # one rc entry for each progs plus not_found entry
254 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
255 logger.error("rc entry should have one item or item for each prog and not_found.")
257 logger.info('checking for ' + description + '...')
258 ## print '(' + ','.join(progs) + ')',
259 additional_path = path
260 path = os.environ["PATH"].split(os.pathsep) + additional_path
262 if "PATHEXT" in os.environ:
263 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
265 for idx in range(len(progs)):
266 # ac_prog may have options, ac_word is the command name
268 ac_word = ac_prog.split(' ')[0]
269 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
271 if ac_word.endswith('.pl') and perl == '':
273 msg = '+checking for "' + ac_word + '"... '
275 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
278 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
279 logger.info(msg + ' yes')
280 # deal with java and perl
281 if ac_word.endswith('.class'):
282 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
283 elif ac_word.endswith('.jar'):
284 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
285 elif ac_word.endswith('.pl'):
286 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
287 elif ac_dir in additional_path:
288 ac_prog = ac_prog.replace(ac_word, r'\"%s\"' % (os.path.join(ac_dir, ac_word)))
289 # write rc entries for this command
290 if len(rc_entry) == 1:
291 addToRC(rc_entry[0].replace('%%', ac_prog))
292 elif len(rc_entry) > 1:
293 addToRC(rc_entry[idx].replace('%%', ac_prog))
294 return [ac_dir, ac_word]
296 logger.info(msg + ' no')
297 # write rc entries for 'not found'
298 if len(rc_entry) > 0: # the last one.
299 addToRC(rc_entry[-1].replace('%%', not_found))
300 return ['', not_found]
303 def checkProgAlternatives(description, progs, rc_entry = [], alt_rc_entry = [], path = [], not_found = ''):
305 The same as checkProg, but additionally, all found programs will be added
308 # one rc entry for each progs plus not_found entry
309 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
310 logger.error("rc entry should have one item or item for each prog and not_found.")
312 logger.info('checking for ' + description + '...')
313 ## print '(' + ','.join(progs) + ')',
314 additional_path = path
315 path = os.environ["PATH"].split(os.pathsep) + additional_path
317 if "PATHEXT" in os.environ:
318 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
321 real_ac_word = not_found
323 for idx in range(len(progs)):
324 # ac_prog may have options, ac_word is the command name
326 ac_word = ac_prog.split(' ')[0]
327 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
329 if ac_word.endswith('.pl') and perl == '':
331 msg = '+checking for "' + ac_word + '"... '
334 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
337 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
338 logger.info(msg + ' yes')
339 pr = re.compile(r'(\\\S+)(.*)$')
341 # deal with java and perl
342 if ac_word.endswith('.class'):
343 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"' % (java, os.path.join(ac_dir, ac_word[:-6])))
344 elif ac_word.endswith('.jar'):
345 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"' % (java, os.path.join(ac_dir, ac_word)))
346 elif ac_word.endswith('.pl'):
347 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"' % (perl, os.path.join(ac_dir, ac_word)))
348 elif ac_dir in additional_path:
349 ac_prog = ac_prog.replace(ac_word, r'\"%s\"' % (os.path.join(ac_dir, ac_word)))
350 # write rc entries for this command
351 if found_prime == False:
352 if len(rc_entry) == 1:
353 addToRC(rc_entry[0].replace('%%', ac_prog))
354 elif len(rc_entry) > 1:
355 addToRC(rc_entry[idx].replace('%%', ac_prog))
357 real_ac_word = ac_word
359 if len(alt_rc_entry) == 1:
360 alt_rc = alt_rc_entry[0]
362 # if no explicit alt_rc is given, construct one
363 m = pr.match(rc_entry[0])
365 alt_rc = m.group(1) + "_alternatives" + m.group(2)
366 addToRC(alt_rc.replace('%%', ac_prog))
367 elif len(alt_rc_entry) > 1:
368 alt_rc = alt_rc_entry[idx]
370 # if no explicit alt_rc is given, construct one
371 m = pr.match(rc_entry[idx])
373 alt_rc = m.group(1) + "_alternatives" + m.group(2)
374 addToRC(alt_rc.replace('%%', ac_prog))
379 if found_alt == False:
381 logger.info(msg + ' no')
383 return [real_ac_dir, real_ac_word]
384 # write rc entries for 'not found'
385 if len(rc_entry) > 0: # the last one.
386 addToRC(rc_entry[-1].replace('%%', not_found))
387 return ['', not_found]
390 def addAlternatives(rcs, alt_type):
392 Returns a \\prog_alternatives string to be used as an alternative
393 rc entry. alt_type can be a string or a list of strings.
395 r = re.compile(r'\\Format (\S+).*$')
398 alt_token = '\\%s_alternatives '
399 if isinstance(alt_type, str):
400 alt_tokens = [alt_token % alt_type]
402 alt_tokens = [alt_token % s for s in alt_type]
403 for idxx in range(len(rcs)):
407 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
409 m = r.match(rcs[idxx])
413 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
417 def listAlternatives(progs, alt_type, rc_entry = []):
419 Returns a list of \\prog_alternatives strings to be used as alternative
420 rc entries. alt_type can be a string or a list of strings.
422 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
423 logger.error("rc entry should have one item or item for each prog and not_found.")
426 for idx in range(len(progs)):
427 if len(rc_entry) == 1:
428 rcs = rc_entry[0].split('\n')
429 alt = addAlternatives(rcs, alt_type)
430 alt_rc_entry.insert(0, alt)
431 elif len(rc_entry) > 1:
432 rcs = rc_entry[idx].split('\n')
433 alt = addAlternatives(rcs, alt_type)
434 alt_rc_entry.insert(idx, alt)
438 def checkViewer(description, progs, rc_entry = [], path = []):
439 ''' The same as checkProgAlternatives, but for viewers '''
440 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
441 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
444 def checkEditor(description, progs, rc_entry = [], path = []):
445 ''' The same as checkProgAlternatives, but for editors '''
446 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
447 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
450 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
451 ''' The same as checkViewer, but do not add rc entry '''
452 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
454 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
457 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
458 ''' The same as checkViewer, but do not add rc entry '''
459 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
461 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
464 def checkViewerEditor(description, progs, rc_entry = [], path = []):
465 ''' The same as checkProgAlternatives, but for viewers and editors '''
466 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
467 return checkProgAlternatives(description, progs, rc_entry, alt_rc_entry, path, not_found = 'auto')
471 ''' Check whether DTL tools are available (Windows only) '''
472 # Find programs! Returned path is not used now
473 if ((os.name == 'nt' or sys.platform == 'cygwin') and
474 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
475 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
482 ''' Check whether Inkscape is available and return the full path (Windows only) '''
485 if sys.version_info[0] < 3:
486 import _winreg as winreg
489 aReg = winreg.ConnectRegistry(None, winreg.HKEY_CLASSES_ROOT)
491 aKey = winreg.OpenKey(aReg, r"inkscape.svg\DefaultIcon")
492 val = winreg.QueryValueEx(aKey, "")
493 return str(val[0]).split('"')[1].replace('.exe', '')
494 except EnvironmentError:
496 aKey = winreg.OpenKey(aReg, r"Applications\inkscape.exe\shell\open\command")
497 val = winreg.QueryValueEx(aKey, "")
498 return str(val[0]).split('"')[1].replace('.exe', '')
499 except EnvironmentError:
502 def checkLatex(dtl_tools):
503 ''' Check latex, return lyx_check_config '''
504 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
505 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
506 #-----------------------------------------------------------------
507 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
509 # check if PLATEX is pLaTeX2e
510 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
511 # run platex on chklatex.ltx and check result
512 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
513 # We have the Japanese pLaTeX2e
514 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
517 removeFiles(['chklatex.ltx', 'chklatex.log'])
518 #-----------------------------------------------------------------
519 # use LATEX to convert from latex to dvi if PPLATEX is not available
523 # Windows only: DraftDVI
524 addToRC(r'''\converter latex dvi2 "%s" "latex"
525 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
527 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
530 # Check if latex is usable
531 writeToFile('chklatex.ltx', r'''
533 \ifx\undefined\documentclass\else
534 \message{ThisIsLaTeX2e}
539 # run latex on chklatex.ltx and check result
540 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
544 logger.warning("Latex not usable (not LaTeX2e) ")
545 # remove temporary files
546 removeFiles(['chklatex.ltx', 'chklatex.log'])
551 ''' Check if luatex is there '''
552 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
553 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
555 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
557 addToRC(r'\converter dviluatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
560 def checkModule(module):
561 ''' Check for a Python module, return the status '''
562 msg = 'checking for "' + module + ' module"... '
565 logger.info(msg + ' yes')
568 logger.info(msg + ' no')
572 def checkFormatEntries(dtl_tools):
573 ''' Check all formats (\Format entries) '''
574 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
575 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
577 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
578 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
580 checkViewerEditor('a Dia viewer and editor', ['dia'],
581 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
583 checkViewerEditor('an OpenDocument drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
584 rc_entry = [r'\Format odg "odg, sxd" "OpenDocument drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
586 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
587 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
589 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
590 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
592 checkViewerEditor('a SVG viewer and editor', [inkscape_name],
593 rc_entry = [r'''\Format svg "svg" SVG "" "%%" "%%" "vector" "image/svg+xml"
594 \Format svgz "svgz" "SVG (compressed)" "" "%%" "%%" "vector,zipped=native" ""'''],
595 path = [inkscape_path])
597 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
598 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
599 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
600 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
601 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
602 \Format png png PNG "" "%s" "%s" "" "image/x-png"
603 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
604 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
605 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
606 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
607 path, iv = checkViewerNoRC('a raster image viewer', ['xv', 'kview', 'gimp-remote', 'gimp'], rc_entry = [imageformats])
608 path, ie = checkEditorNoRC('a raster image editor', ['gimp-remote', 'gimp'], rc_entry = [imageformats])
609 addToRC(imageformats % \
610 (iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie, iv, ie) )
612 checkViewerEditor('a text editor', ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
613 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
614 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
615 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
616 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
617 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
618 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
619 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
620 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
621 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
622 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
623 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
624 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
625 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
626 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
627 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
628 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
629 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
630 \Format latexclipboard tex "LaTeX (clipboard)" "" "" "%%" "" ""
631 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
632 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
633 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
634 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
635 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
636 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
637 #Spreadsheets using ssconvert from gnumeric
638 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
639 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
640 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
641 \Format oocalc ods "OpenDocument spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
643 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
644 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
646 checkEditor('a BibTeX editor', ['jabref', 'JabRef', \
647 'pybliographic', 'bibdesk', 'gbib', 'kbib', \
648 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex' \
649 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate', \
650 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad', \
651 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
652 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
654 #checkProg('a Postscript interpreter', ['gs'],
655 # rc_entry = [ r'\ps_command "%%"' ])
656 checkViewer('a Postscript previewer', ['kghostview', 'okular', 'qpdfview --unique', 'evince', 'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
657 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
658 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
659 \Format eps3 eps "EPS (cropped)" "" "%%" "" "document" ""
660 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
661 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
662 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
663 checkViewer('a PDF previewer', ['pdfview', 'kpdf', 'okular', 'qpdfview --unique', 'evince', 'kghostview', 'xpdf', 'SumatraPDF', 'acrobat', 'acroread', 'mupdf', \
664 'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
665 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
666 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
667 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
668 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
669 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
670 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"
671 \Format pdf7 pdf "PDF (cropped)" "" "%%" "" "document,vector" ""
672 \Format pdf8 pdf "PDF (lower resolution)" "" "%%" "" "document,vector" ""'''])
674 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular', 'yap', 'dviout -Set=!m'],
675 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
676 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
678 # Windows only: DraftDVI
679 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
681 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
682 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
684 checkViewerEditor('Noteedit', ['noteedit'],
685 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
687 checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
688 rc_entry = [r'''\Format odt odt "OpenDocument (tex4ht)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
689 \Format odt2 odt "OpenDocument (eLyXer)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
690 \Format odt3 odt "OpenDocument (Pandoc)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
691 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
693 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
694 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
695 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"
696 \Format word2 docx "MS Word Office Open XML" O "%%" "%%" "document,vector,menu=export" "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
698 # entries that do not need checkProg
699 addToRC(r'''\Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
700 \Format fax "" Fax "" "" "" "document" ""
701 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
702 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
703 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
704 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
705 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document" ""
706 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document" ""
707 \Format lyx21x 21.lyx "LyX 2.1.x" "" "" "" "document" ""
708 \Format lyx22x 22.lyx "LyX 2.2.x" "" "" "" "document,menu=export" ""
709 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
710 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
711 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
712 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
713 \Format pdftex pdftex_t PDFTEX "" "" "" "" ""
714 \Format program "" Program "" "" "" "" ""
715 \Format pstex pstex_t PSTEX "" "" "" "" ""
716 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
717 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
718 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
722 def checkConverterEntries():
723 ''' Check all converters (\converter entries) '''
724 checkProg('the pdflatex program', ['pdflatex $$i'],
725 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
727 checkProg('XeTeX', ['xelatex $$i'],
728 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
732 # Look for tex2lyx in this order (see bugs #3308 and #6986):
733 # 1) If we're building LyX with autotools then tex2lyx is found
734 # in the subdirectory tex2lyx with respect to the binary dir.
735 # 2) If we're building LyX with cmake then tex2lyx is found
737 # 3) If LyX was configured with a version suffix then tex2lyx
738 # will also have this version suffix.
739 # 4) Otherwise always use tex2lyx.
740 in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
741 in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
743 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
744 in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
746 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'],
747 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
748 \converter latexclipboard lyx "%% -fixedenc utf8 -f $$i $$o" ""
749 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""
750 \converter sweave lyx "%% -n -m sweave -f $$i $$o" ""
751 \converter knitr lyx "%% -n -m knitr -f $$i $$o" ""'''], not_found = 'tex2lyx')
753 logger.warning("Failed to find tex2lyx on your system.")
756 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
757 rc_entry = [r'''\converter literate latex "%%" ""
758 \converter literate pdflatex "%%" ""
759 \converter literate xetex "%%" ""
760 \converter literate luatex "%%" ""'''])
762 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
763 rc_entry = [r'''\converter sweave latex "%%" ""
764 \converter sweave pdflatex "%%" ""
765 \converter sweave xetex "%%" ""
766 \converter sweave luatex "%%" ""'''])
768 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
769 rc_entry = [r'''\converter knitr latex "%%" ""
770 \converter knitr pdflatex "%%" ""
771 \converter knitr xetex "%%" ""
772 \converter knitr luatex "%%" ""'''])
774 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
775 rc_entry = [ r'\converter sweave r "%%" ""' ])
777 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
778 rc_entry = [ r'\converter knitr r "%%" ""' ])
780 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
781 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
782 rc_entry = [ r'\converter html latex "%%" ""', \
783 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""', \
784 r'\converter html latex "%%" ""', \
785 r'\converter html latex "%%" ""', '' ])
787 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
788 rc_entry = [ r'\converter word latex "%%" ""' ])
790 # eLyXer: search as an executable (elyxer.py, elyxer)
791 path, elyxer = checkProg('a LyX -> HTML converter',
792 ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
793 rc_entry = [ r'\converter lyx html "%%" ""' ])
794 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
795 ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
796 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
797 path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
798 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
799 rc_entry = [ r'\converter lyx odt2 "%%" ""' ])
800 path, elyxer = checkProg('a LyX -> Word converter',
801 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
802 rc_entry = [ r'\converter lyx word "%%" ""' ])
803 if elyxer.find('elyxer') >= 0:
804 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
805 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
807 # search for HTML converters other than eLyXer
808 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
809 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i', \
810 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o', \
811 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
812 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
813 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
814 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
816 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
817 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'", \
818 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'", \
819 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
820 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
821 if htmlconv.find('htlatex') >= 0:
822 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
824 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
827 # Check if LyXBlogger is installed
828 lyxblogger_found = checkModule('lyxblogger')
830 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
831 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
834 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
835 rc_entry = [ r'\converter sxw latex "%%" ""' ])
837 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
838 rc_entry = [ r'\converter odt latex "%%" ""' ])
840 checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
841 rc_entry = [ r'\converter odt3 latex "%%" ""' ])
843 checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
844 rc_entry = [ r'\converter word2 latex "%%" ""' ])
845 # Only define a converter to pdf6, otherwise the odt format could be
846 # used as an intermediate step for export to pdf, which is not wanted.
847 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
848 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
849 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
850 # the command mk4ht oolatex $$i has to be used as default,
851 # but as this would require to have Perl installed, in MiKTeX oolatex is
852 # directly available as application.
853 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
854 # Both SuSE and debian have oolatex
855 checkProg('a LaTeX -> Open Document (tex4ht) converter', [
856 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
857 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
858 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
859 # On windows it is called latex2rt.exe
860 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
861 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
863 checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
864 rc_entry = [ r'\converter latex odt3 "%%" ""' ])
866 checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
867 rc_entry = [ r'\converter latex word2 "%%" ""' ])
869 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
870 rc_entry = [ r'\converter rtf html "%%" ""' ])
871 # Do not define a converter to pdf6, ps is a pure export format
872 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
873 rc_entry = [ r'\converter ps pdf "%%" ""' ])
875 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
876 rc_entry = [ r'\converter ps text2 "%%" ""' ])
878 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
879 rc_entry = [ r'\converter ps text3 "%%" ""' ])
880 # Need to call ps2eps in a pipe, otherwise it would name the output file
881 # depending on the extension of the input file. We do not know the input
882 # file extension in general, so the resultfile= flag would not help.
883 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
884 # This would create additional paths in the converter graph with unwanted
885 # side effects (e.g. ps->pdf via ps2pdf would create a different result
886 # than ps->eps->pdf via ps2eps and epstopdf).
887 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
888 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
890 checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
891 rc_entry = [ r'\converter pdf ps "%%" ""' ])
892 # Only define a converter from pdf6 for graphics
893 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
894 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
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('a PDF cropping tool', ['pdfcrop $$i $$o'],
899 rc_entry = [ r'''\converter pdf2 pdf7 "%%" ""
900 \converter pdf4 pdf7 "%%" ""''' ])
901 # Create one converter for a PDF produced using TeX fonts and one for a
902 # PDF produced using non-TeX fonts. This does not produce non-unique
903 # conversion paths, since a given document either uses TeX fonts or not.
904 checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
905 rc_entry = [ r'''\converter pdf2 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""
906 \converter pdf4 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""''' ])
908 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
909 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
911 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
912 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
914 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
915 rc_entry = [ r'\converter dvi ps "%%" ""' ])
917 checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
918 rc_entry = [ r'\converter dvi eps3 "%%" ""' ])
920 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
921 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
923 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
924 rc_entry = [ r'\converter ps fax "%%" ""'])
926 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
927 if fig2dev == "fig2dev":
928 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
929 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
930 \converter fig svg "fig2dev -L svg $$i $$o" ""
931 \converter fig png "fig2dev -L png $$i $$o" ""
932 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
933 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
935 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
936 rc_entry = [ r'\converter tiff eps "%%" ""'])
938 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
940 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
941 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
942 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
944 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
945 rc_entry = [ r'\converter wmf eps "%%" ""'])
947 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
948 rc_entry = [ r'\converter emf eps "%%" ""'])
950 checkProg('a WMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
951 rc_entry = [ r'\converter wmf pdf6 "%%" ""'])
953 checkProg('an EMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
954 rc_entry = [ r'\converter emf pdf6 "%%" ""'])
955 # Only define a converter to pdf6 for graphics
956 checkProg('an EPS -> PDF converter', ['epstopdf'],
957 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
959 checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
960 rc_entry = [ r'\converter eps png "%%" ""'])
962 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
963 # free software and therefore not compiled in in many installations.
964 # Fortunately, this is not a big problem, because we will use epstopdf to
965 # convert from agr to pdf6 via eps without loss of quality.
966 checkProg('a Grace -> Image converter', ['gracebat'],
968 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
969 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
970 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
971 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
973 checkProg('a Dot -> Image converter', ['dot'],
975 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
976 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
978 path, dia = checkProg('a Dia -> Image converter', ['dia'])
980 addToRC(r'''\converter dia png "dia -e $$o -t png $$i" ""
981 \converter dia eps "dia -e $$o -t eps $$i" ""'
982 \converter dia svg "dia -e $$o -t svg $$i" ""''')
985 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
986 # The eps2->eps converter then fixes the bounding box by cropping.
987 # Although unoconv can convert to png and pdf as well, do not define
988 # odg->png and odg->pdf converters, since the bb would be too large as well.
989 checkProg('an OpenDocument -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
990 rc_entry = [ r'\converter odg eps2 "%%" ""'])
992 checkProg('a SVG (compressed) -> SVG converter', ['gunzip -c $$i > $$o'],
993 rc_entry = [ r'\converter svgz svg "%%" ""'])
995 checkProg('a SVG -> SVG (compressed) converter', ['gzip -c $$i > $$o'],
996 rc_entry = [ r'\converter svg svgz "%%" ""'])
997 # Only define a converter to pdf6 for graphics
998 # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
999 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1000 rc_entry = [ r'''\converter svg pdf6 "%%" ""
1001 \converter svgz pdf6 "%%" ""'''],
1002 path = ['', inkscape_path])
1004 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1005 rc_entry = [ r'''\converter svg eps "%%" ""
1006 \converter svgz eps "%%" ""'''],
1007 path = ['', inkscape_path])
1009 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_name + ' --without-gui --file=$$i --export-png=$$o'],
1010 rc_entry = [ r'''\converter svg png "%%" "",
1011 \converter svgz png "%%" ""'''],
1012 path = ['', inkscape_path])
1015 # gnumeric/xls/ods to tex
1016 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
1017 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1018 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1019 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""'''])
1021 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1022 if (lilypond != ''):
1023 version_string = cmdOutput("lilypond --version")
1024 match = re.match('GNU LilyPond (\S+)', version_string)
1026 version_number = match.groups()[0]
1027 version = version_number.split('.')
1028 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1029 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
1030 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
1031 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
1032 logger.info('+ found LilyPond version %s.' % version_number)
1033 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1034 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
1035 \converter lilypond png "lilypond -b eps --png $$i" ""''')
1036 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1037 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
1038 logger.info('+ found LilyPond version %s.' % version_number)
1040 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
1042 logger.info('+ found LilyPond, but could not extract version number.')
1044 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1045 if (lilypond_book != ''):
1046 version_string = cmdOutput("lilypond-book --version")
1047 match = re.match('^(\S+)$', version_string)
1049 version_number = match.groups()[0]
1050 version = version_number.split('.')
1051 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1052 # Note: The --lily-output-dir flag is required because lilypond-book
1053 # does not process input again unless the input has changed,
1054 # even if the output format being requested is different. So
1055 # once a .eps file exists, lilypond-book won't create a .pdf
1056 # even when requested with --pdf. This is a problem if a user
1057 # clicks View PDF after having done a View DVI. To circumvent
1058 # this, use different output folders for eps and pdf outputs.
1059 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
1060 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1061 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
1062 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1063 logger.info('+ found LilyPond-book version %s.' % version_number)
1065 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
1067 logger.info('+ found LilyPond-book, but could not extract version number.')
1069 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1070 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
1072 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1073 # and a zip archive on Windows.
1074 # So, we configure the appropriate version according to the platform.
1075 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1077 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
1078 addToRC(cmd % "lyxzip")
1080 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
1081 addToRC(cmd % "lyxgz")
1084 # FIXME: no rc_entry? comment it out
1085 # checkProg('Image converter', ['convert $$i $$o'])
1087 # Entries that do not need checkProg
1089 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
1090 \converter docbook docbook-xml "cp $$i $$o" "xml"
1091 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
1092 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.3 -o $$o $$i" ""
1093 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o $$i" ""
1094 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.5 -o $$o $$i" ""
1095 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.6 -o $$o $$i" ""
1096 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.0 -o $$o $$i" ""
1097 \converter lyx lyx21x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.1 -o $$o $$i" ""
1098 \converter lyx lyx22x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.2 -o $$o $$i" ""
1099 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c big5 $$i" ""
1100 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_jp $$i" ""
1101 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_kr $$i" ""
1102 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -o $$o $$i" ""
1103 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -o $$o $$i" ""
1104 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -o $$o $$i" ""
1105 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
1106 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
1111 ''' Check docbook '''
1112 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
1114 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
1115 \converter docbook html "sgmltools -b html $$i" ""
1116 \converter docbook ps "sgmltools -b ps $$i" ""''',
1117 r'''\converter docbook dvi "db2dvi $$i" ""
1118 \converter docbook html "db2html $$i" ""''',
1119 r'''\converter docbook dvi "" ""
1120 \converter docbook html "" ""''',
1121 r'''\converter docbook dvi "" ""
1122 \converter docbook html "" ""'''])
1125 return ('yes', 'true', '\\def\\hasdocbook{yes}')
1127 return ('no', 'false', '')
1130 def checkOtherEntries():
1131 ''' entries other than Format and Converter '''
1132 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1133 rc_entry = [ r'\chktex_command "%%"' ])
1134 checkProgAlternatives('BibTeX or alternative programs', ['bibtex', 'bibtex8', 'biber'],
1135 rc_entry = [ r'\bibtex_command "%%"' ],
1136 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1137 checkProg('a specific Japanese BibTeX variant', ['pbibtex', 'jbibtex', 'bibtex'],
1138 rc_entry = [ r'\jbibtex_command "%%"' ])
1139 checkProgAlternatives('available index processors', ['texindy', 'makeindex -c -q', 'xindy'],
1140 rc_entry = [ r'\index_command "%%"' ],
1141 alt_rc_entry = [ r'\index_alternatives "%%"' ])
1142 checkProg('an index processor appropriate to Japanese', ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1143 rc_entry = [ r'\jindex_command "%%"' ])
1144 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1145 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1146 checkProg('a nomenclature processor', ['makeindex'],
1147 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1148 ## FIXME: OCTAVE is not used anywhere
1149 # path, OCTAVE = checkProg('Octave', ['octave'])
1150 ## FIXME: MAPLE is not used anywhere
1151 # path, MAPLE = checkProg('Maple', ['maple'])
1152 # Add the rest of the entries (no checkProg is required)
1153 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1154 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1155 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1156 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1160 def processLayoutFile(file, bool_docbook):
1161 ''' process layout file and get a line of result
1163 Declare lines look like this:
1165 \DeclareLaTeXClass[<requirements>]{<description>}
1167 Optionally, a \DeclareCategory line follows:
1169 \DeclareCategory{<category>}
1171 So for example (article.layout, scrbook.layout, svjog.layout)
1173 \DeclareLaTeXClass{article}
1174 \DeclareCategory{Articles}
1176 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1177 \DeclareCategory{Books}
1179 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1181 we'd expect this output:
1183 "article" "article" "article" "false" "article.cls" "Articles"
1184 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1185 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1187 def checkForClassExtension(x):
1188 '''if the extension for a latex class is not
1189 provided, add .cls to the classname'''
1191 return x.strip() + '.cls'
1194 classname = file.split(os.sep)[-1].split('.')[0]
1195 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1196 p = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1197 q = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1198 classdeclaration = ""
1199 categorydeclaration = '""'
1200 for line in open(file).readlines():
1201 res = p.search(line)
1202 qres = q.search(line)
1204 (classtype, optAll, opt, opt1, desc) = res.groups()
1205 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1208 prereq_latex = checkForClassExtension(classname)
1210 prereq_list = optAll[1:-1].split(',')
1211 prereq_list = list(map(checkForClassExtension, prereq_list))
1212 prereq_latex = ','.join(prereq_list)
1213 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1214 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1215 classdeclaration = '"%s" "%s" "%s" "%s" "%s"' % (classname, opt, desc, avai, prereq)
1216 if categorydeclaration != '""':
1217 return classdeclaration + " " + categorydeclaration
1219 categorydeclaration = '"%s"' % (qres.groups()[0])
1220 if classdeclaration != "":
1221 return classdeclaration + " " + categorydeclaration
1222 if classdeclaration != "":
1223 return classdeclaration + " " + categorydeclaration
1224 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1228 def checkLatexConfig(check_config, bool_docbook):
1229 ''' Explore the LaTeX configuration
1230 Return None (will be passed to sys.exit()) for success.
1232 msg = 'checking LaTeX configuration... '
1233 # if --without-latex-config is forced, or if there is no previous
1234 # version of textclass.lst, re-generate a default file.
1235 if not os.path.isfile('textclass.lst') or not check_config:
1236 # remove the files only if we want to regenerate
1237 removeFiles(['textclass.lst', 'packages.lst'])
1239 # Then, generate a default textclass.lst. In case configure.py
1240 # fails, we still have something to start lyx.
1241 logger.info(msg + ' default values')
1242 logger.info('+checking list of textclasses... ')
1243 tx = open('textclass.lst', 'w')
1245 # This file declares layouts and their associated definition files
1246 # (include dir. relative to the place where this file is).
1247 # It contains only default values, since chkconfig.ltx could not be run
1248 # for some reason. Run ./configure.py if you need to update it after a
1249 # configuration change.
1251 # build the list of available layout files and convert it to commands
1254 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1255 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1257 if not os.path.isfile(file):
1259 # get stuff between /xxxx.layout .
1260 classname = file.split(os.sep)[-1].split('.')[0]
1262 cleanclass = classname.replace(' ', '_')
1263 cleanclass = cleanclass.replace('-', '_')
1264 # make sure the same class is not considered twice
1265 if foundClasses.count(cleanclass) == 0: # not found before
1266 foundClasses.append(cleanclass)
1267 retval = processLayoutFile(file, bool_docbook)
1271 logger.info('\tdone')
1272 if not os.path.isfile('packages.lst') or not check_config:
1273 logger.info('+generating default list of packages... ')
1274 removeFiles(['packages.lst'])
1275 tx = open('packages.lst', 'w')
1277 logger.info('\tdone')
1278 if not check_config:
1280 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1281 logger.info(msg + '\tauto')
1282 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1283 'wrap_chkconfig.ltx'])
1285 if not os.path.isfile( 'chkconfig.ltx' ):
1286 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1288 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1289 # Construct the list of classes to test for.
1290 # build the list of available layout files and convert it to commands
1292 declare = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1293 category = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1294 empty = re.compile(r'^\s*$')
1295 testclasses = list()
1296 for file in glob.glob( os.path.join('layouts', '*.layout') ) + \
1297 glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) :
1298 nodeclaration = False
1299 if not os.path.isfile(file):
1301 classname = file.split(os.sep)[-1].split('.')[0]
1304 for line in open(file).readlines():
1305 if not empty.match(line) and line[0] != '#':
1307 logger.warning("Failed to find valid \Declare line for layout file `" + file + "'.\n\t=> Skipping this file!")
1308 nodeclaration = True
1309 # A class, but no category declaration. Just break.
1311 if declare.search(line) != None:
1312 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1313 testclasses.append(decline)
1314 elif category.search(line) != None:
1315 catline = "\\DeclareCategory{%s}{%s}" % (classname, category.search(line).groups()[0])
1316 testclasses.append(catline)
1317 if catline == "" or decline == "":
1323 cl = open('chklayouts.tex', 'w')
1324 for line in testclasses:
1325 cl.write(line + '\n')
1328 # we have chklayouts.tex, then process it
1329 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1331 line = latex_out.readline()
1334 if re.match('^\+', line):
1335 logger.info(line.strip())
1336 # if the command succeeds, None will be returned
1337 ret = latex_out.close()
1339 # remove the copied file
1341 removeFiles( [ 'chkconfig.ltx' ] )
1343 # currently, values in chkconfig are only used to set
1346 for line in open('chkconfig.vars').readlines():
1347 key, val = re.sub('-', '_', line).split('=')
1349 values[key] = val.strip("'")
1350 # chk_fontenc may not exist
1352 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1355 # if configure successed, move textclass.lst.tmp to textclass.lst
1356 # and packages.lst.tmp to packages.lst
1357 if os.path.isfile('textclass.lst.tmp') and len(open('textclass.lst.tmp').read()) > 0 \
1358 and os.path.isfile('packages.lst.tmp') and len(open('packages.lst.tmp').read()) > 0:
1359 shutil.move('textclass.lst.tmp', 'textclass.lst')
1360 shutil.move('packages.lst.tmp', 'packages.lst')
1364 def checkModulesConfig():
1365 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1367 logger.info('+checking list of modules... ')
1368 tx = open('lyxmodules.lst', 'w')
1369 tx.write('''## This file declares modules and their associated definition files.
1370 ## It has been automatically generated by configure
1371 ## Use "Options/Reconfigure" if you need to update it after a
1372 ## configuration change.
1373 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1376 # build the list of available modules
1378 # note that this searches the local directory first, then the
1379 # system directory. that way, we pick up the user's version first.
1380 for file in glob.glob( os.path.join('layouts', '*.module') ) + \
1381 glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) :
1384 if not os.path.isfile(file):
1387 filename = file.split(os.sep)[-1]
1388 filename = filename[:-7]
1389 if seen.count(filename):
1392 seen.append(filename)
1393 retval = processModuleFile(file, filename, bool_docbook)
1397 logger.info('\tdone')
1400 def processModuleFile(file, filename, bool_docbook):
1401 ''' process module file and get a line of result
1403 The top of a module file should look like this:
1404 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1406 #...body of description...
1408 #Requires: [list of required modules]
1409 #Excludes: [list of excluded modules]
1410 #Category: [category name]
1411 The last three lines are optional (though do give a category).
1413 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1415 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1416 rereqs = re.compile(r'#+\s*Requires: (.*)')
1417 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1418 recaty = re.compile(r'#+\s*Category: (.*)')
1419 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1420 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1422 modname = desc = pkgs = req = excl = catgy = ""
1423 readingDescription = False
1426 for line in open(file).readlines():
1427 if readingDescription:
1428 res = redend.search(line)
1430 readingDescription = False
1431 desc = " ".join(descLines)
1433 desc = desc.replace('"', '\\"')
1435 descLines.append(line[1:].strip())
1437 res = redbeg.search(line)
1439 readingDescription = True
1441 res = remods.search(line)
1443 (pkgs, modname) = res.groups()
1447 tmp = [s.strip() for s in pkgs.split(",")]
1448 pkgs = ",".join(tmp)
1450 res = rereqs.search(line)
1453 tmp = [s.strip() for s in req.split("|")]
1456 res = reexcs.search(line)
1459 tmp = [s.strip() for s in excl.split("|")]
1460 excl = "|".join(tmp)
1462 res = recaty.search(line)
1464 catgy = res.group(1)
1468 logger.warning("Module file without \DeclareLyXModule line. ")
1472 # this module has some latex dependencies:
1473 # append the dependencies to chkmodules.tex,
1474 # which is \input'ed by chkconfig.ltx
1475 testpackages = list()
1476 for pkg in pkgs.split(","):
1478 # this is a converter dependency: skip
1480 if pkg.endswith(".sty"):
1482 testpackages.append("\\TestPackage{%s}" % (pkg,))
1483 cm = open('chkmodules.tex', 'a')
1484 for line in testpackages:
1485 cm.write(line + '\n')
1488 return '"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n' % (modname, filename, desc, pkgs, req, excl, catgy)
1491 def checkTeXAllowSpaces():
1492 ''' Let's check whether spaces are allowed in TeX file names '''
1493 tex_allows_spaces = 'false'
1494 if lyx_check_config:
1495 msg = "Checking whether TeX allows spaces in file names... "
1496 writeToFile('a b.tex', r'\message{working^^J}' )
1498 if os.name == 'nt' or sys.platform == 'cygwin':
1499 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1501 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1504 if 'working' in latex_out:
1505 logger.info(msg + 'yes')
1506 tex_allows_spaces = 'true'
1508 logger.info(msg + 'no')
1509 tex_allows_spaces = 'false'
1510 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1511 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1514 def rescanTeXFiles():
1515 ''' Run kpsewhich to update information about TeX files '''
1516 logger.info("+Indexing TeX files... ")
1517 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1518 logger.error("configure: error: cannot find TeXFiles.py script")
1520 interpreter = sys.executable
1521 if interpreter == '':
1522 interpreter = "python"
1523 tfp = cmdOutput(interpreter + " -tt " + '"' + os.path.join(srcdir, 'scripts', 'TeXFiles.py') + '"')
1525 logger.info("\tdone")
1528 def removeTempFiles():
1530 if not lyx_keep_temps:
1531 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1532 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1533 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1536 if __name__ == '__main__':
1537 lyx_check_config = True
1538 lyx_kpsewhich = True
1539 outfile = 'lyxrc.defaults'
1540 lyxrc_fileformat = 19
1542 lyx_keep_temps = False
1545 ## Parse the command line
1546 for op in sys.argv[1:]: # default shell/for list is $*, the options
1547 if op in [ '-help', '--help', '-h' ]:
1548 print('''Usage: configure [options]
1550 --help show this help lines
1551 --keep-temps keep temporary files (for debug. purposes)
1552 --without-kpsewhich do not update TeX files information via kpsewhich
1553 --without-latex-config do not run LaTeX to determine configuration
1554 --with-version-suffix=suffix suffix of binary installed files
1555 --binary-dir=directory directory of binary installed files
1558 elif op == '--without-kpsewhich':
1559 lyx_kpsewhich = False
1560 elif op == '--without-latex-config':
1561 lyx_check_config = False
1562 elif op == '--keep-temps':
1563 lyx_keep_temps = True
1564 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1565 version_suffix = op[22:]
1566 elif op[0:13] == '--binary-dir=':
1567 lyx_binary_dir = op[13:]
1569 print("Unknown option %s" % op)
1572 # check if we run from the right directory
1573 srcdir = os.path.dirname(sys.argv[0])
1576 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1577 logger.error("configure: error: cannot find chkconfig.ltx script")
1580 if sys.platform == 'darwin' and len(version_suffix) > 0:
1583 dtl_tools = checkDTLtools()
1584 ## Write the first part of outfile
1585 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1586 # script. It contains default settings that have been determined by
1587 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1588 # want to customize LyX, use LyX' Preferences dialog or modify directly
1589 # the "preferences" file instead. Any setting in that file will
1590 # override the values given here.
1594 ''' % lyxrc_fileformat)
1596 LATEX = checkLatex(dtl_tools)
1597 # check java and perl before any checkProg that may require them
1598 java = checkProg('a java interpreter', ['java'])[1]
1599 perl = checkProg('a perl interpreter', ['perl'])[1]
1600 (inkscape_path, inkscape_name) = os.path.split(checkInkscape())
1601 checkFormatEntries(dtl_tools)
1602 checkConverterEntries()
1603 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1604 checkTeXAllowSpaces()
1605 windows_style_tex_paths = checkTeXPaths()
1606 if windows_style_tex_paths != '':
1607 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1611 checkModulesConfig()
1612 # --without-latex-config can disable lyx_check_config
1613 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1615 # The return error code can be 256. Because most systems expect an error code
1616 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1617 # a None for success, 'ret is not None' is used to exit.
1618 sys.exit(ret is not None)