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"'
215 if 'Error' in latex_out:
216 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"'
218 if 'Error' in latex_out:
219 logger.warning("configure: TeX engine needs posix-style paths in latex files")
220 windows_style_tex_paths = 'false'
222 logger.info("configure: TeX engine needs windows-style paths in latex files")
223 windows_style_tex_paths = 'true'
224 removeFiles([tmpfname, logname, 'texput.log'])
225 return windows_style_tex_paths
228 ## Searching some useful programs
229 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
231 This function will search a program in $PATH plus given path
232 If found, return directory and program name (not the options).
234 description: description of the program
236 progs: check programs, for each prog, the first word is used
237 for searching but the whole string is used to replace
238 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
240 path: additional paths (will be prepended to the program name)
242 rc_entry: entry to outfile, can be
243 1. emtpy: no rc entry will be added
244 2. one pattern: %% will be replaced by the first found program,
245 or '' if no program is found.
246 3. several patterns for each prog and not_found. This is used
247 when different programs have different usages. If you do not
248 want not_found entry to be added to the RC file, you can specify
249 an entry for each prog and use '' for the not_found entry.
251 not_found: the value that should be used instead of '' if no program
255 # one rc entry for each progs plus not_found entry
256 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
257 logger.error("rc entry should have one item or item "
258 "for each prog and not_found.")
260 logger.info('checking for ' + description + '...')
261 ## print '(' + ','.join(progs) + ')',
262 additional_path = path
263 path = os.environ["PATH"].split(os.pathsep) + additional_path
265 if "PATHEXT" in os.environ:
266 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
268 for idx in range(len(progs)):
269 # ac_prog may have options, ac_word is the command name
271 ac_word = ac_prog.split(' ')[0]
272 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
274 if ac_word.endswith('.pl') and perl == '':
276 msg = '+checking for "' + ac_word + '"... '
278 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
281 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
282 logger.info(msg + ' yes')
283 # deal with java and perl
284 if ac_word.endswith('.class'):
285 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
286 % (java, os.path.join(ac_dir, ac_word[:-6])))
287 elif ac_word.endswith('.jar'):
288 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
289 % (java, os.path.join(ac_dir, ac_word)))
290 elif ac_word.endswith('.pl'):
291 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
292 % (perl, os.path.join(ac_dir, ac_word)))
293 elif ac_dir in additional_path:
294 ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
295 % (os.path.join(ac_dir, ac_word)))
296 # write rc entries for this command
297 if len(rc_entry) == 1:
298 addToRC(rc_entry[0].replace('%%', ac_prog))
299 elif len(rc_entry) > 1:
300 addToRC(rc_entry[idx].replace('%%', ac_prog))
301 return [ac_dir, ac_word]
303 logger.info(msg + ' no')
304 # write rc entries for 'not found'
305 if len(rc_entry) > 0: # the last one.
306 addToRC(rc_entry[-1].replace('%%', not_found))
307 return ['', not_found]
310 def checkProgAlternatives(description, progs, rc_entry = [],
311 alt_rc_entry = [], path = [], not_found = ''):
313 The same as checkProg, but additionally, all found programs will be added
316 # one rc entry for each progs plus not_found entry
317 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
318 logger.error("rc entry should have one item or item for each prog and not_found.")
320 logger.info('checking for ' + description + '...')
321 ## print '(' + ','.join(progs) + ')',
322 additional_path = path
323 path = os.environ["PATH"].split(os.pathsep) + additional_path
325 if "PATHEXT" in os.environ:
326 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
329 real_ac_word = not_found
331 for idx in range(len(progs)):
332 # ac_prog may have options, ac_word is the command name
334 ac_word = ac_prog.split(' ')[0]
335 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
337 if ac_word.endswith('.pl') and perl == '':
339 msg = '+checking for "' + ac_word + '"... '
342 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
345 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
346 logger.info(msg + ' yes')
347 pr = re.compile(r'(\\\S+)(.*)$')
349 # deal with java and perl
350 if ac_word.endswith('.class'):
351 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
352 % (java, os.path.join(ac_dir, ac_word[:-6])))
353 elif ac_word.endswith('.jar'):
354 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
355 % (java, os.path.join(ac_dir, ac_word)))
356 elif ac_word.endswith('.pl'):
357 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
358 % (perl, os.path.join(ac_dir, ac_word)))
359 elif ac_dir in additional_path:
360 ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
361 % (os.path.join(ac_dir, ac_word)))
362 # write rc entries for this command
363 if found_prime == False:
364 if len(rc_entry) == 1:
365 addToRC(rc_entry[0].replace('%%', ac_prog))
366 elif len(rc_entry) > 1:
367 addToRC(rc_entry[idx].replace('%%', ac_prog))
369 real_ac_word = ac_word
371 if len(alt_rc_entry) == 1:
372 alt_rc = alt_rc_entry[0]
374 # if no explicit alt_rc is given, construct one
375 m = pr.match(rc_entry[0])
377 alt_rc = m.group(1) + "_alternatives" + m.group(2)
378 addToRC(alt_rc.replace('%%', ac_prog))
379 elif len(alt_rc_entry) > 1:
380 alt_rc = alt_rc_entry[idx]
382 # if no explicit alt_rc is given, construct one
383 m = pr.match(rc_entry[idx])
385 alt_rc = m.group(1) + "_alternatives" + m.group(2)
386 addToRC(alt_rc.replace('%%', ac_prog))
391 if found_alt == False:
393 logger.info(msg + ' no')
395 return [real_ac_dir, real_ac_word]
396 # write rc entries for 'not found'
397 if len(rc_entry) > 0: # the last one.
398 addToRC(rc_entry[-1].replace('%%', not_found))
399 return ['', not_found]
402 def addAlternatives(rcs, alt_type):
404 Returns a \\prog_alternatives string to be used as an alternative
405 rc entry. alt_type can be a string or a list of strings.
407 r = re.compile(r'\\Format (\S+).*$')
410 alt_token = '\\%s_alternatives '
411 if isinstance(alt_type, str):
412 alt_tokens = [alt_token % alt_type]
414 alt_tokens = [alt_token % s for s in alt_type]
415 for idxx in range(len(rcs)):
419 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
421 m = r.match(rcs[idxx])
425 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
429 def listAlternatives(progs, alt_type, rc_entry = []):
431 Returns a list of \\prog_alternatives strings to be used as alternative
432 rc entries. alt_type can be a string or a list of strings.
434 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
435 logger.error("rc entry should have one item or item for each prog and not_found.")
438 for idx in range(len(progs)):
439 if len(rc_entry) == 1:
440 rcs = rc_entry[0].split('\n')
441 alt = addAlternatives(rcs, alt_type)
442 alt_rc_entry.insert(0, alt)
443 elif len(rc_entry) > 1:
444 rcs = rc_entry[idx].split('\n')
445 alt = addAlternatives(rcs, alt_type)
446 alt_rc_entry.insert(idx, alt)
450 def checkViewer(description, progs, rc_entry = [], path = []):
451 ''' The same as checkProgAlternatives, but for viewers '''
452 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
453 return checkProgAlternatives(description, progs, rc_entry,
454 alt_rc_entry, path, not_found = 'auto')
457 def checkEditor(description, progs, rc_entry = [], path = []):
458 ''' The same as checkProgAlternatives, but for editors '''
459 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
460 return checkProgAlternatives(description, progs, rc_entry,
461 alt_rc_entry, path, not_found = 'auto')
464 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
465 ''' The same as checkViewer, but do not add rc entry '''
466 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
468 return checkProgAlternatives(description, progs, rc_entry,
469 alt_rc_entry, path, not_found = 'auto')
472 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
473 ''' The same as checkViewer, but do not add rc entry '''
474 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
476 return checkProgAlternatives(description, progs, rc_entry,
477 alt_rc_entry, path, not_found = 'auto')
480 def checkViewerEditor(description, progs, rc_entry = [], path = []):
481 ''' The same as checkProgAlternatives, but for viewers and editors '''
482 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
483 return checkProgAlternatives(description, progs, rc_entry,
484 alt_rc_entry, path, not_found = 'auto')
488 ''' Check whether DTL tools are available (Windows only) '''
489 # Find programs! Returned path is not used now
490 if ((os.name == 'nt' or sys.platform == 'cygwin') and
491 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
492 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
499 ''' Check whether Inkscape is available and return the full path (Windows only) '''
502 if sys.version_info[0] < 3:
503 import _winreg as winreg
506 aReg = winreg.ConnectRegistry(None, winreg.HKEY_CLASSES_ROOT)
508 aKey = winreg.OpenKey(aReg, r"inkscape.svg\DefaultIcon")
509 val = winreg.QueryValueEx(aKey, "")
510 return str(val[0]).split('"')[1].replace('.exe', '')
511 except EnvironmentError:
513 aKey = winreg.OpenKey(aReg, r"Applications\inkscape.exe\shell\open\command")
514 val = winreg.QueryValueEx(aKey, "")
515 return str(val[0]).split('"')[1].replace('.exe', '')
516 except EnvironmentError:
519 def checkLatex(dtl_tools):
520 ''' Check latex, return lyx_check_config '''
521 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
522 path, PPLATEX = checkProg('a DVI postprocessing program', ['pplatex $$i'])
523 #-----------------------------------------------------------------
524 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
526 # check if PLATEX is pLaTeX2e
527 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
528 # run platex on chklatex.ltx and check result
529 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
530 # We have the Japanese pLaTeX2e
531 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
534 removeFiles(['chklatex.ltx', 'chklatex.log'])
535 #-----------------------------------------------------------------
536 # use LATEX to convert from latex to dvi if PPLATEX is not available
540 # Windows only: DraftDVI
541 addToRC(r'''\converter latex dvi2 "%s" "latex"
542 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % PPLATEX)
544 addToRC(r'\converter latex dvi "%s" "latex"' % PPLATEX)
547 # Check if latex is usable
548 writeToFile('chklatex.ltx', r'''
550 \ifx\undefined\documentclass\else
551 \message{ThisIsLaTeX2e}
556 # run latex on chklatex.ltx and check result
557 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
561 logger.warning("Latex not usable (not LaTeX2e) ")
562 # remove temporary files
563 removeFiles(['chklatex.ltx', 'chklatex.log'])
568 ''' Check if luatex is there '''
569 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
570 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
572 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
574 addToRC(r'\converter dviluatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
577 def checkModule(module):
578 ''' Check for a Python module, return the status '''
579 msg = 'checking for "' + module + ' module"... '
582 logger.info(msg + ' yes')
585 logger.info(msg + ' no')
589 def checkFormatEntries(dtl_tools):
590 ''' Check all formats (\Format entries) '''
591 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
592 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
594 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
595 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
597 checkViewerEditor('a Dia viewer and editor', ['dia'],
598 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
600 checkViewerEditor('an OpenDocument drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
601 rc_entry = [r'\Format odg "odg, sxd" "OpenDocument drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
603 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
604 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
606 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
607 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
609 checkViewerEditor('a SVG viewer and editor', [inkscape_name],
610 rc_entry = [r'''\Format svg "svg" SVG "" "%%" "%%" "vector" "image/svg+xml"
611 \Format svgz "svgz" "SVG (compressed)" "" "%%" "%%" "vector,zipped=native" ""'''],
612 path = [inkscape_path])
614 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
615 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
616 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
617 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
618 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
619 \Format png png PNG "" "%s" "%s" "" "image/x-png"
620 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
621 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
622 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
623 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
624 path, iv = checkViewerNoRC('a raster image viewer',
625 ['xv', 'gwenview', 'kview',
626 'eog', 'xviewer', 'ristretto', 'gpicview', 'lximage-qt',
627 'xdg-open', 'gimp-remote', 'gimp'],
628 rc_entry = [imageformats])
629 path, ie = checkEditorNoRC('a raster image editor',
630 ['gimp-remote', 'gimp'], rc_entry = [imageformats])
631 addToRC(imageformats % ((iv, ie)*10))
633 checkViewerEditor('a text editor',
634 ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate',
635 'nedit', 'gedit', 'geany', 'leafpad', 'mousepad', 'xed', 'notepad'],
636 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
637 \Format docbook sgml DocBook B "" "%%" "document,menu=export" ""
638 \Format docbook-xml xml "DocBook (XML)" "" "" "%%" "document,menu=export" "application/docbook+xml"
639 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
640 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
641 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
642 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
643 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
644 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
645 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
646 \Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"
647 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
648 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
649 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
650 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
651 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
652 \Format latexclipboard tex "LaTeX (clipboard)" "" "" "%%" "" ""
653 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
654 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
655 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
656 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
657 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
658 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
659 #Spreadsheets using ssconvert from gnumeric
660 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
661 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
662 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
663 \Format excel2 xlsx "MS Excel Office Open XML" "" "" "%%" "document" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
664 \Format html_table html "HTML Table (for spreadsheets)" "" "" "%%" "document" "text/html"
665 \Format oocalc ods "OpenDocument spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
667 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
668 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
670 checkEditor('a BibTeX editor', ['jabref', 'JabRef',
671 'pybliographic', 'bibdesk', 'gbib', 'kbib',
672 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex'
673 'xemacs', 'gvim', 'kedit', 'kwrite', 'kate',
674 'jedit', 'TeXnicCenter', 'WinEdt', 'WinShell', 'PSPad',
675 'nedit', 'gedit', 'notepad', 'geany', 'leafpad', 'mousepad'],
676 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
678 #checkProg('a Postscript interpreter', ['gs'],
679 # rc_entry = [ r'\ps_command "%%"' ])
680 checkViewer('a Postscript previewer',
681 ['kghostview', 'okular', 'qpdfview --unique',
683 'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
684 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
685 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
686 \Format eps3 eps "EPS (cropped)" "" "%%" "" "document" ""
687 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
688 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
689 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
690 checkViewer('a PDF previewer',
691 ['pdfview', 'kpdf', 'okular', 'qpdfview --unique',
692 'evince', 'xreader', 'kghostview', 'xpdf', 'SumatraPDF',
693 'acrobat', 'acroread', 'mupdf',
694 'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
695 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
696 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
697 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
698 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
699 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
700 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"
701 \Format pdf7 pdf "PDF (cropped)" "" "%%" "" "document,vector" ""
702 \Format pdf8 pdf "PDF (lower resolution)" "" "%%" "" "document,vector" ""'''])
704 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular',
706 'yap', 'dviout -Set=!m'],
707 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
708 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
710 # Windows only: DraftDVI
711 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
713 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
714 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
716 checkViewerEditor('Noteedit', ['noteedit'],
717 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
719 checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
720 rc_entry = [r'''\Format odt odt "OpenDocument (tex4ht)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
721 \Format odt2 odt "OpenDocument (eLyXer)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
722 \Format odt3 odt "OpenDocument (Pandoc)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
723 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
725 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
726 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
727 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"
728 \Format word2 docx "MS Word Office Open XML" O "%%" "%%" "document,vector,menu=export" "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
730 # entries that do not need checkProg
731 addToRC(r'''\Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
732 \Format fax "" Fax "" "" "" "document" ""
733 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
734 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
735 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
736 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
737 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document" ""
738 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document" ""
739 \Format lyx21x 21.lyx "LyX 2.1.x" "" "" "" "document" ""
740 \Format lyx22x 22.lyx "LyX 2.2.x" "" "" "" "document,menu=export" ""
741 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
742 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
743 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
744 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
745 \Format pdftex "pdftex_t, pdf_tex" PDFTEX "" "" "" "" ""
746 \Format program "" Program "" "" "" "" ""
747 \Format pstex "pstex_t, ps_tex" PSTEX "" "" "" "" ""
748 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
749 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
750 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
754 def checkConverterEntries():
755 ''' Check all converters (\converter entries) '''
756 checkProg('the pdflatex program', ['pdflatex $$i'],
757 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex"' ])
759 checkProg('XeTeX', ['xelatex $$i'],
760 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex"' ])
764 # Look for tex2lyx in this order (see bugs #3308 and #6986):
765 # 1) If we're building LyX with autotools then tex2lyx is found
766 # in the subdirectory tex2lyx with respect to the binary dir.
767 # 2) If we're building LyX with cmake then tex2lyx is found
769 # 3) If LyX was configured with a version suffix then tex2lyx
770 # will also have this version suffix.
771 # 4) Otherwise always use tex2lyx.
772 in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
773 in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
775 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
776 in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
778 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'],
779 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
780 \converter latexclipboard lyx "%% -fixedenc utf8 -f $$i $$o" ""
781 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""
782 \converter sweave lyx "%% -n -m sweave -f $$i $$o" "needauth"
783 \converter knitr lyx "%% -n -m knitr -f $$i $$o" "needauth"'''], not_found = 'tex2lyx')
785 logger.warning("Failed to find tex2lyx on your system.")
788 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
789 rc_entry = [r'''\converter literate latex "%%" ""
790 \converter literate pdflatex "%%" ""
791 \converter literate xetex "%%" ""
792 \converter literate luatex "%%" ""
793 \converter literate dviluatex "%%" ""'''])
795 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
796 rc_entry = [r'''\converter sweave latex "%%" "needauth"
797 \converter sweave pdflatex "%%" "needauth"
798 \converter sweave xetex "%%" "needauth"
799 \converter sweave luatex "%%" "needauth"
800 \converter sweave dviluatex "%%" "needauth"'''])
802 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
803 rc_entry = [r'''\converter knitr latex "%%" "needauth"
804 \converter knitr pdflatex "%%" "needauth"
805 \converter knitr xetex "%%" "needauth"
806 \converter knitr luatex "%%" "needauth"
807 \converter knitr dviluatex "%%" "needauth"'''])
809 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
810 rc_entry = [ r'\converter sweave r "%%" "needauth"' ])
812 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
813 rc_entry = [ r'\converter knitr r "%%" "needauth"' ])
815 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
816 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
817 rc_entry = [ r'\converter html latex "%%" ""',
818 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""',
819 r'\converter html latex "%%" ""',
820 r'\converter html latex "%%" ""', '' ])
822 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
823 rc_entry = [ r'\converter word latex "%%" ""' ])
825 # eLyXer: search as an executable (elyxer.py, elyxer)
826 path, elyxer = checkProg('a LyX -> HTML converter',
827 ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
828 rc_entry = [ r'\converter lyx html "%%" ""' ])
829 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
830 ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
831 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
832 path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
833 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
834 rc_entry = [ r'\converter lyx odt2 "%%" ""' ])
835 path, elyxer = checkProg('a LyX -> Word converter',
836 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
837 rc_entry = [ r'\converter lyx word "%%" ""' ])
838 if elyxer.find('elyxer') >= 0:
839 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
840 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
842 # search for HTML converters other than eLyXer
843 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
844 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i',
845 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o',
846 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
847 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
848 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
849 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
851 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
852 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'",
853 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'",
854 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
855 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
856 if htmlconv.find('htlatex') >= 0:
857 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
859 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
862 # Check if LyXBlogger is installed
863 lyxblogger_found = checkModule('lyxblogger')
865 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
866 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
869 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
870 rc_entry = [ r'\converter sxw latex "%%" ""' ])
872 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
873 rc_entry = [ r'\converter odt latex "%%" ""' ])
875 checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
876 rc_entry = [ r'\converter odt3 latex "%%" ""' ])
878 checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
879 rc_entry = [ r'\converter word2 latex "%%" ""' ])
880 # Only define a converter to pdf6, otherwise the odt format could be
881 # used as an intermediate step for export to pdf, which is not wanted.
882 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
883 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
884 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
885 # the command mk4ht oolatex $$i has to be used as default,
886 # but as this would require to have Perl installed, in MiKTeX oolatex is
887 # directly available as application.
888 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
889 # Both SuSE and debian have oolatex
890 checkProg('a LaTeX -> Open Document (tex4ht) converter', [
891 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
892 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
893 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
894 # On windows it is called latex2rt.exe
895 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
896 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
898 checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
899 rc_entry = [ r'\converter latex odt3 "%%" ""' ])
901 checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
902 rc_entry = [ r'\converter latex word2 "%%" ""' ])
904 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
905 rc_entry = [ r'\converter rtf html "%%" ""' ])
906 # Do not define a converter to pdf6, ps is a pure export format
907 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
908 rc_entry = [ r'\converter ps pdf "%%" ""' ])
910 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
911 rc_entry = [ r'\converter ps text2 "%%" ""' ])
913 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
914 rc_entry = [ r'\converter ps text3 "%%" ""' ])
915 # Need to call ps2eps in a pipe, otherwise it would name the output file
916 # depending on the extension of the input file. We do not know the input
917 # file extension in general, so the resultfile= flag would not help.
918 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
919 # This would create additional paths in the converter graph with unwanted
920 # side effects (e.g. ps->pdf via ps2pdf would create a different result
921 # than ps->eps->pdf via ps2eps and epstopdf).
922 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
923 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
925 checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
926 rc_entry = [ r'\converter pdf ps "%%" ""' ])
927 # Only define a converter from pdf6 for graphics
928 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
929 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
930 # Create one converter for a PDF produced using TeX fonts and one for a
931 # PDF produced using non-TeX fonts. This does not produce non-unique
932 # conversion paths, since a given document either uses TeX fonts or not.
933 checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
934 rc_entry = [ r'''\converter pdf2 pdf7 "%%" ""
935 \converter pdf4 pdf7 "%%" ""''' ])
936 # Create one converter for a PDF produced using TeX fonts and one for a
937 # PDF produced using non-TeX fonts. This does not produce non-unique
938 # conversion paths, since a given document either uses TeX fonts or not.
939 checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
940 rc_entry = [ r'''\converter pdf2 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""
941 \converter pdf4 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""''' ])
943 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
944 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
946 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
947 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
949 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
950 rc_entry = [ r'\converter dvi ps "%%" ""' ])
952 checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
953 rc_entry = [ r'\converter dvi eps3 "%%" ""' ])
955 checkProg('a DVI to PDF converter', ['dvipdfmx -o $$o $$i', 'dvipdfm -o $$o $$i'],
956 rc_entry = [ r'\converter dvi pdf3 "%%" ""' ])
958 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
959 rc_entry = [ r'\converter ps fax "%%" ""'])
961 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
962 if fig2dev == "fig2dev":
963 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
964 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
965 \converter fig svg "fig2dev -L svg $$i $$o" ""
966 \converter fig png "fig2dev -L png $$i $$o" ""
967 \converter svg pdftex "python -tt $$s/scripts/svg2pdftex.py $$i $$o" ""
968 \converter svg pstex "python -tt $$s/scripts/svg2pstex.py $$i $$o" ""
969 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
970 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
972 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
973 rc_entry = [ r'\converter tiff eps "%%" ""'])
975 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
977 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
978 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
979 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
981 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
982 rc_entry = [ r'\converter wmf eps "%%" ""'])
984 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
985 rc_entry = [ r'\converter emf eps "%%" ""'])
987 checkProg('a WMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
988 rc_entry = [ r'\converter wmf pdf6 "%%" ""'])
990 checkProg('an EMF -> PDF converter', [inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
991 rc_entry = [ r'\converter emf pdf6 "%%" ""'])
992 # Only define a converter to pdf6 for graphics
993 checkProg('an EPS -> PDF converter', ['epstopdf'],
994 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
996 checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
997 rc_entry = [ r'\converter eps png "%%" ""'])
999 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
1000 # free software and therefore not compiled in in many installations.
1001 # Fortunately, this is not a big problem, because we will use epstopdf to
1002 # convert from agr to pdf6 via eps without loss of quality.
1003 checkProg('a Grace -> Image converter', ['gracebat'],
1005 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
1006 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
1007 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
1008 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
1010 checkProg('a Dot -> Image converter', ['dot'],
1012 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
1013 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
1015 path, dia = checkProg('a Dia -> Image converter', ['dia'])
1017 addToRC(r'''\converter dia png "dia -e $$o -t png $$i" ""
1018 \converter dia eps "dia -e $$o -t eps $$i" ""
1019 \converter dia svg "dia -e $$o -t svg $$i" ""''')
1022 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
1023 # The eps2->eps converter then fixes the bounding box by cropping.
1024 # Although unoconv can convert to png and pdf as well, do not define
1025 # odg->png and odg->pdf converters, since the bb would be too large as well.
1026 checkProg('an OpenDocument -> EPS converter', ['libreoffice -headless -nologo -convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
1027 rc_entry = [ r'\converter odg eps2 "%%" ""'])
1029 checkProg('a SVG (compressed) -> SVG converter', ['gunzip -c $$i > $$o'],
1030 rc_entry = [ r'\converter svgz svg "%%" ""'])
1032 checkProg('a SVG -> SVG (compressed) converter', ['gzip -c $$i > $$o'],
1033 rc_entry = [ r'\converter svg svgz "%%" ""'])
1034 # Only define a converter to pdf6 for graphics
1035 # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
1036 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1037 rc_entry = [ r'''\converter svg pdf6 "%%" ""
1038 \converter svgz pdf6 "%%" ""'''],
1039 path = ['', inkscape_path])
1041 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_name + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1042 rc_entry = [ r'''\converter svg eps "%%" ""
1043 \converter svgz eps "%%" ""'''],
1044 path = ['', inkscape_path])
1046 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_name + ' --without-gui --file=$$i --export-png=$$o'],
1047 rc_entry = [ r'''\converter svg png "%%" "",
1048 \converter svgz png "%%" ""'''],
1049 path = ['', inkscape_path])
1052 # gnumeric/xls/ods to tex
1053 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
1054 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1055 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1056 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1057 \converter excel2 latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1058 \converter gnumeric html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1059 \converter oocalc html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1060 \converter excel html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1061 \converter excel2 html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1064 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1065 if (lilypond != ''):
1066 version_string = cmdOutput("lilypond --version")
1067 match = re.match('GNU LilyPond (\S+)', version_string)
1069 version_number = match.groups()[0]
1070 version = version_number.split('.')
1071 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1072 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
1073 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
1074 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
1075 logger.info('+ found LilyPond version %s.' % version_number)
1076 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1077 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
1078 \converter lilypond png "lilypond -b eps --png $$i" ""''')
1079 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1080 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
1081 logger.info('+ found LilyPond version %s.' % version_number)
1083 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
1085 logger.info('+ found LilyPond, but could not extract version number.')
1087 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1088 if (lilypond_book != ''):
1089 version_string = cmdOutput("lilypond-book --version")
1090 match = re.match('^(\S+)$', version_string)
1092 version_number = match.groups()[0]
1093 version = version_number.split('.')
1094 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1095 # Note: The --lily-output-dir flag is required because lilypond-book
1096 # does not process input again unless the input has changed,
1097 # even if the output format being requested is different. So
1098 # once a .eps file exists, lilypond-book won't create a .pdf
1099 # even when requested with --pdf. This is a problem if a user
1100 # clicks View PDF after having done a View DVI. To circumvent
1101 # this, use different output folders for eps and pdf outputs.
1102 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
1103 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1104 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
1105 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1106 addToRC(r'\converter lilypond-book dviluatex "lilypond-book --safe --latex-program=dvilualatex --lily-output-dir=ly-eps $$i" ""')
1107 logger.info('+ found LilyPond-book version %s.' % version_number)
1109 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
1111 logger.info('+ found LilyPond-book, but could not extract version number.')
1113 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1114 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
1116 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1117 # and a zip archive on Windows.
1118 # So, we configure the appropriate version according to the platform.
1119 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1121 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
1122 addToRC(cmd % "lyxzip")
1124 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
1125 addToRC(cmd % "lyxgz")
1128 # FIXME: no rc_entry? comment it out
1129 # checkProg('Image converter', ['convert $$i $$o'])
1131 # Entries that do not need checkProg
1133 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
1134 \converter docbook docbook-xml "cp $$i $$o" "xml"
1135 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
1136 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.3 -o $$o $$i" ""
1137 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o $$i" ""
1138 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.5 -o $$o $$i" ""
1139 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.6 -o $$o $$i" ""
1140 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.0 -o $$o $$i" ""
1141 \converter lyx lyx21x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.1 -o $$o $$i" ""
1142 \converter lyx lyx22x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.2 -o $$o $$i" ""
1143 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c big5 $$i" ""
1144 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_jp $$i" ""
1145 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_kr $$i" ""
1146 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -o $$o $$i" ""
1147 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -o $$o $$i" ""
1148 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -o $$o $$i" ""
1149 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
1150 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
1155 ''' Check docbook '''
1156 path, DOCBOOK = checkProg('SGML-tools 2.x (DocBook), db2x scripts or xsltproc', ['sgmltools', 'db2dvi', 'xsltproc'],
1158 r'''\converter docbook dvi "sgmltools -b dvi $$i" ""
1159 \converter docbook html "sgmltools -b html $$i" ""
1160 \converter docbook ps "sgmltools -b ps $$i" ""''',
1161 r'''\converter docbook dvi "db2dvi $$i" ""
1162 \converter docbook html "db2html $$i" ""''',
1163 r'''\converter docbook dvi "" ""
1164 \converter docbook html "" ""''',
1165 r'''\converter docbook dvi "" ""
1166 \converter docbook html "" ""'''])
1169 return ('yes', 'true', '\\def\\hasdocbook{yes}')
1171 return ('no', 'false', '')
1174 def checkOtherEntries():
1175 ''' entries other than Format and Converter '''
1176 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1177 rc_entry = [ r'\chktex_command "%%"' ])
1178 checkProgAlternatives('BibTeX or alternative programs',
1179 ['bibtex', 'bibtex8', 'biber'],
1180 rc_entry = [ r'\bibtex_command "%%"' ],
1181 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1182 checkProg('a specific Japanese BibTeX variant',
1183 ['pbibtex', 'jbibtex', 'bibtex'],
1184 rc_entry = [ r'\jbibtex_command "%%"' ])
1185 checkProgAlternatives('available index processors',
1186 ['texindy', 'makeindex -c -q', 'xindy'],
1187 rc_entry = [ r'\index_command "%%"' ],
1188 alt_rc_entry = [ r'\index_alternatives "%%"' ])
1189 checkProg('an index processor appropriate to Japanese',
1190 ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1191 rc_entry = [ r'\jindex_command "%%"' ])
1192 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1193 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1194 checkProg('a nomenclature processor', ['makeindex'],
1195 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1196 ## FIXME: OCTAVE is not used anywhere
1197 # path, OCTAVE = checkProg('Octave', ['octave'])
1198 ## FIXME: MAPLE is not used anywhere
1199 # path, MAPLE = checkProg('Maple', ['maple'])
1200 # Add the rest of the entries (no checkProg is required)
1201 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1202 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1203 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1204 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1208 def processLayoutFile(file, bool_docbook):
1209 ''' process layout file and get a line of result
1211 Declare lines look like this:
1213 \DeclareLaTeXClass[<requirements>]{<description>}
1215 Optionally, a \DeclareCategory line follows:
1217 \DeclareCategory{<category>}
1219 So for example (article.layout, scrbook.layout, svjog.layout)
1221 \DeclareLaTeXClass{article}
1222 \DeclareCategory{Articles}
1224 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1225 \DeclareCategory{Books}
1227 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1229 we'd expect this output:
1231 "article" "article" "article" "false" "article.cls" "Articles"
1232 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1233 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1235 def checkForClassExtension(x):
1236 '''if the extension for a latex class is not
1237 provided, add .cls to the classname'''
1239 return x.strip() + '.cls'
1242 classname = file.split(os.sep)[-1].split('.')[0]
1243 # return ('LaTeX', '[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1244 p = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1245 q = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1246 classdeclaration = ""
1247 categorydeclaration = '""'
1248 for line in open(file).readlines():
1249 res = p.search(line)
1250 qres = q.search(line)
1252 (classtype, optAll, opt, opt1, desc) = res.groups()
1253 avai = {'LaTeX':'false', 'DocBook':bool_docbook}[classtype]
1256 prereq_latex = checkForClassExtension(classname)
1258 prereq_list = optAll[1:-1].split(',')
1259 prereq_list = list(map(checkForClassExtension, prereq_list))
1260 prereq_latex = ','.join(prereq_list)
1261 prereq_docbook = {'true':'', 'false':'docbook'}[bool_docbook]
1262 prereq = {'LaTeX':prereq_latex, 'DocBook':prereq_docbook}[classtype]
1263 classdeclaration = ('"%s" "%s" "%s" "%s" "%s"'
1264 % (classname, opt, desc, avai, prereq))
1265 if categorydeclaration != '""':
1266 return classdeclaration + " " + categorydeclaration
1268 categorydeclaration = '"%s"' % (qres.groups()[0])
1269 if classdeclaration != "":
1270 return classdeclaration + " " + categorydeclaration
1271 if classdeclaration != "":
1272 return classdeclaration + " " + categorydeclaration
1273 logger.warning("Layout file " + file + " has no \DeclareXXClass line. ")
1277 def checkLatexConfig(check_config, bool_docbook):
1278 ''' Explore the LaTeX configuration
1279 Return None (will be passed to sys.exit()) for success.
1281 msg = 'checking LaTeX configuration... '
1282 # if --without-latex-config is forced, or if there is no previous
1283 # version of textclass.lst, re-generate a default file.
1284 if not os.path.isfile('textclass.lst') or not check_config:
1285 # remove the files only if we want to regenerate
1286 removeFiles(['textclass.lst', 'packages.lst'])
1288 # Then, generate a default textclass.lst. In case configure.py
1289 # fails, we still have something to start lyx.
1290 logger.info(msg + ' default values')
1291 logger.info('+checking list of textclasses... ')
1292 tx = open('textclass.lst', 'w')
1294 # This file declares layouts and their associated definition files
1295 # (include dir. relative to the place where this file is).
1296 # It contains only default values, since chkconfig.ltx could not be run
1297 # for some reason. Run ./configure.py if you need to update it after a
1298 # configuration change.
1300 # build the list of available layout files and convert it to commands
1303 for file in (glob.glob(os.path.join('layouts', '*.layout'))
1304 + glob.glob(os.path.join(srcdir, 'layouts', '*.layout'))):
1306 if not os.path.isfile(file):
1308 # get stuff between /xxxx.layout .
1309 classname = file.split(os.sep)[-1].split('.')[0]
1311 cleanclass = classname.replace(' ', '_')
1312 cleanclass = cleanclass.replace('-', '_')
1313 # make sure the same class is not considered twice
1314 if foundClasses.count(cleanclass) == 0: # not found before
1315 foundClasses.append(cleanclass)
1316 retval = processLayoutFile(file, bool_docbook)
1320 logger.info('\tdone')
1321 if not os.path.isfile('packages.lst') or not check_config:
1322 logger.info('+generating default list of packages... ')
1323 removeFiles(['packages.lst'])
1324 tx = open('packages.lst', 'w')
1326 logger.info('\tdone')
1327 if not check_config:
1329 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1330 logger.info(msg + '\tauto')
1331 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1332 'wrap_chkconfig.ltx'])
1334 if not os.path.isfile( 'chkconfig.ltx' ):
1335 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1337 writeToFile('wrap_chkconfig.ltx', '%s\n\\input{chkconfig.ltx}\n' % docbook_cmd)
1338 # Construct the list of classes to test for.
1339 # build the list of available layout files and convert it to commands
1341 declare = re.compile(r'^\s*#\s*\\Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}\s*$')
1342 category = re.compile(r'^\s*#\s*\\DeclareCategory{(.*)}\s*$')
1343 empty = re.compile(r'^\s*$')
1344 testclasses = list()
1345 for file in (glob.glob( os.path.join('layouts', '*.layout') )
1346 + glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) ):
1347 nodeclaration = False
1348 if not os.path.isfile(file):
1350 classname = file.split(os.sep)[-1].split('.')[0]
1353 for line in open(file).readlines():
1354 if not empty.match(line) and line[0] != '#':
1356 logger.warning("Failed to find valid \Declare line "
1357 "for layout file `%s'.\n\t=> Skipping this file!" % file)
1358 nodeclaration = True
1359 # A class, but no category declaration. Just break.
1361 if declare.search(line) != None:
1362 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1363 testclasses.append(decline)
1364 elif category.search(line) != None:
1365 catline = ("\\DeclareCategory{%s}{%s}"
1366 % (classname, category.search(line).groups()[0]))
1367 testclasses.append(catline)
1368 if catline == "" or decline == "":
1374 cl = open('chklayouts.tex', 'w')
1375 for line in testclasses:
1376 cl.write(line + '\n')
1379 # we have chklayouts.tex, then process it
1380 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1382 line = latex_out.readline()
1385 if re.match('^\+', line):
1386 logger.info(line.strip())
1387 # if the command succeeds, None will be returned
1388 ret = latex_out.close()
1390 # remove the copied file
1392 removeFiles( [ 'chkconfig.ltx' ] )
1394 # currently, values in chkconfig are only used to set
1397 for line in open('chkconfig.vars').readlines():
1398 key, val = re.sub('-', '_', line).split('=')
1400 values[key] = val.strip("'")
1401 # chk_fontenc may not exist
1403 addToRC(r'\font_encoding "%s"' % values["chk_fontenc"])
1406 # if configure successed, move textclass.lst.tmp to textclass.lst
1407 # and packages.lst.tmp to packages.lst
1408 if (os.path.isfile('textclass.lst.tmp')
1409 and len(open('textclass.lst.tmp').read()) > 0
1410 and os.path.isfile('packages.lst.tmp')
1411 and len(open('packages.lst.tmp').read()) > 0):
1412 shutil.move('textclass.lst.tmp', 'textclass.lst')
1413 shutil.move('packages.lst.tmp', 'packages.lst')
1417 def checkModulesConfig():
1418 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1420 logger.info('+checking list of modules... ')
1421 tx = open('lyxmodules.lst', 'w')
1422 tx.write('''## This file declares modules and their associated definition files.
1423 ## It has been automatically generated by configure
1424 ## Use "Options/Reconfigure" if you need to update it after a
1425 ## configuration change.
1426 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1429 # build the list of available modules
1431 # note that this searches the local directory first, then the
1432 # system directory. that way, we pick up the user's version first.
1433 for file in (glob.glob( os.path.join('layouts', '*.module') )
1434 + glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) ):
1437 if not os.path.isfile(file):
1440 filename = file.split(os.sep)[-1]
1441 filename = filename[:-7]
1442 if seen.count(filename):
1445 seen.append(filename)
1446 retval = processModuleFile(file, filename, bool_docbook)
1450 logger.info('\tdone')
1453 def processModuleFile(file, filename, bool_docbook):
1454 ''' process module file and get a line of result
1456 The top of a module file should look like this:
1457 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1459 #...body of description...
1461 #Requires: [list of required modules]
1462 #Excludes: [list of excluded modules]
1463 #Category: [category name]
1464 The last three lines are optional (though do give a category).
1466 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1468 remods = re.compile(r'\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1469 rereqs = re.compile(r'#+\s*Requires: (.*)')
1470 reexcs = re.compile(r'#+\s*Excludes: (.*)')
1471 recaty = re.compile(r'#+\s*Category: (.*)')
1472 redbeg = re.compile(r'#+\s*DescriptionBegin\s*$')
1473 redend = re.compile(r'#+\s*DescriptionEnd\s*$')
1475 modname = desc = pkgs = req = excl = catgy = ""
1476 readingDescription = False
1479 for line in open(file).readlines():
1480 if readingDescription:
1481 res = redend.search(line)
1483 readingDescription = False
1484 desc = " ".join(descLines)
1486 desc = desc.replace('"', '\\"')
1488 descLines.append(line[1:].strip())
1490 res = redbeg.search(line)
1492 readingDescription = True
1494 res = remods.search(line)
1496 (pkgs, modname) = res.groups()
1500 tmp = [s.strip() for s in pkgs.split(",")]
1501 pkgs = ",".join(tmp)
1503 res = rereqs.search(line)
1506 tmp = [s.strip() for s in req.split("|")]
1509 res = reexcs.search(line)
1512 tmp = [s.strip() for s in excl.split("|")]
1513 excl = "|".join(tmp)
1515 res = recaty.search(line)
1517 catgy = res.group(1)
1521 logger.warning("Module file without \DeclareLyXModule line. ")
1525 # this module has some latex dependencies:
1526 # append the dependencies to chkmodules.tex,
1527 # which is \input'ed by chkconfig.ltx
1528 testpackages = list()
1529 for pkg in pkgs.split(","):
1531 # this is a converter dependency: skip
1533 if pkg.endswith(".sty"):
1535 testpackages.append("\\TestPackage{%s}" % (pkg,))
1536 cm = open('chkmodules.tex', 'a')
1537 for line in testpackages:
1538 cm.write(line + '\n')
1541 return ('"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n'
1542 % (modname, filename, desc, pkgs, req, excl, catgy))
1545 def checkTeXAllowSpaces():
1546 ''' Let's check whether spaces are allowed in TeX file names '''
1547 tex_allows_spaces = 'false'
1548 if lyx_check_config:
1549 msg = "Checking whether TeX allows spaces in file names... "
1550 writeToFile('a b.tex', r'\message{working^^J}' )
1552 if os.name == 'nt' or sys.platform == 'cygwin':
1553 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1555 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1558 if 'working' in latex_out:
1559 logger.info(msg + 'yes')
1560 tex_allows_spaces = 'true'
1562 logger.info(msg + 'no')
1563 tex_allows_spaces = 'false'
1564 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1565 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1568 def rescanTeXFiles():
1569 ''' Run kpsewhich to update information about TeX files '''
1570 logger.info("+Indexing TeX files... ")
1571 if not os.path.isfile( os.path.join(srcdir, 'scripts', 'TeXFiles.py') ):
1572 logger.error("configure: error: cannot find TeXFiles.py script")
1574 interpreter = sys.executable
1575 if interpreter == '':
1576 interpreter = "python"
1577 tfp = cmdOutput(interpreter + " -tt " + '"'
1578 + os.path.join(srcdir, 'scripts', 'TeXFiles.py') + '"')
1580 logger.info("\tdone")
1583 def removeTempFiles():
1585 if not lyx_keep_temps:
1586 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1587 'chklayouts.tex', 'chkmodules.tex', 'missfont.log',
1588 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1591 if __name__ == '__main__':
1592 lyx_check_config = True
1593 lyx_kpsewhich = True
1594 outfile = 'lyxrc.defaults'
1595 lyxrc_fileformat = 20
1597 lyx_keep_temps = False
1600 ## Parse the command line
1601 for op in sys.argv[1:]: # default shell/for list is $*, the options
1602 if op in [ '-help', '--help', '-h' ]:
1603 print('''Usage: configure [options]
1605 --help show this help lines
1606 --keep-temps keep temporary files (for debug. purposes)
1607 --without-kpsewhich do not update TeX files information via kpsewhich
1608 --without-latex-config do not run LaTeX to determine configuration
1609 --with-version-suffix=suffix suffix of binary installed files
1610 --binary-dir=directory directory of binary installed files
1613 elif op == '--without-kpsewhich':
1614 lyx_kpsewhich = False
1615 elif op == '--without-latex-config':
1616 lyx_check_config = False
1617 elif op == '--keep-temps':
1618 lyx_keep_temps = True
1619 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1620 version_suffix = op[22:]
1621 elif op[0:13] == '--binary-dir=':
1622 lyx_binary_dir = op[13:]
1624 print("Unknown option %s" % op)
1627 # check if we run from the right directory
1628 srcdir = os.path.dirname(sys.argv[0])
1631 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1632 logger.error("configure: error: cannot find chkconfig.ltx script")
1635 if sys.platform == 'darwin' and len(version_suffix) > 0:
1638 dtl_tools = checkDTLtools()
1639 ## Write the first part of outfile
1640 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1641 # script. It contains default settings that have been determined by
1642 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1643 # want to customize LyX, use LyX' Preferences dialog or modify directly
1644 # the "preferences" file instead. Any setting in that file will
1645 # override the values given here.
1649 ''' % lyxrc_fileformat)
1651 LATEX = checkLatex(dtl_tools)
1652 # check java and perl before any checkProg that may require them
1653 java = checkProg('a java interpreter', ['java'])[1]
1654 perl = checkProg('a perl interpreter', ['perl'])[1]
1655 (inkscape_path, inkscape_name) = os.path.split(checkInkscape())
1656 checkFormatEntries(dtl_tools)
1657 checkConverterEntries()
1658 (chk_docbook, bool_docbook, docbook_cmd) = checkDocBook()
1659 checkTeXAllowSpaces()
1660 windows_style_tex_paths = checkTeXPaths()
1661 if windows_style_tex_paths != '':
1662 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1666 checkModulesConfig()
1667 # --without-latex-config can disable lyx_check_config
1668 ret = checkLatexConfig(lyx_check_config and LATEX != '', bool_docbook)
1670 # The return error code can be 256. Because most systems expect an error code
1671 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1672 # a None for success, 'ret is not None' is used to exit.
1673 sys.exit(ret is not None)