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, errno, re, shutil, subprocess, sys, stat
14 if sys.version_info[0] < 3:
20 logging.basicConfig(level = logging.DEBUG,
21 format = '%(levelname)s: %(message)s', # ignore application name
22 filename = 'configure.log',
25 # Add a handler to log to console
26 console = logging.StreamHandler()
27 console.setLevel(logging.INFO) # the console only print out general information
28 formatter = logging.Formatter('%(message)s') # only print out the message itself
29 console.setFormatter(formatter)
30 logger = logging.getLogger('LyX')
31 logger.addHandler(console)
33 def quoteIfSpace(name):
34 " utility function: quote name if it contains spaces "
36 return '"' + name + '"'
40 def writeToFile(filename, lines, append = False):
41 " utility function: write or append lines to filename "
43 file = open(filename, 'a')
45 file = open(filename, 'w')
51 ''' utility function: shortcut for appending lines to outfile
52 add newline at the end of lines.
55 writeToFile(outfile, lines + '\n', append = True)
56 logger.debug('Add to RC:\n' + lines + '\n\n')
59 def removeFiles(filenames):
60 '''utility function: 'rm -f'
61 ignore errors when file does not exist, or is a directory.
63 for file in filenames:
66 logger.debug('Removing file %s' % file)
68 if e.errno == errno.ENOENT: # no such file or directory
69 logger.debug('No need to remove file %s (it does not exists)' % file)
70 elif e.errno == errno.EISDIR: # is a directory
71 logger.debug('Failed to remove file %s (it is a directory)' % file)
73 logger.debug('Failed to remove file %s' % file)
77 def cmdOutput(cmd, asynchronous = False):
78 '''utility function: run a command and get its output as a string
80 asynchronous: if False, return whole output as a string, otherwise
81 return the stdout handle from which the output can be
82 read (the caller is then responsible for closing it)
86 if sys.version_info[0] < 3:
87 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwdu()) + '&' + cmd
89 cmd = 'cmd /d /c pushd ' + shortPath(os.getcwd()) + '&' + cmd
92 pipe = subprocess.Popen(cmd, shell=b, close_fds=b, stdin=subprocess.PIPE,
93 stdout=subprocess.PIPE, universal_newlines=True)
97 output = pipe.stdout.read()
103 ''' On Windows, return the short version of "path" if possible '''
105 from ctypes import windll, create_unicode_buffer
106 GetShortPathName = windll.kernel32.GetShortPathNameW
107 shortlen = GetShortPathName(path, 0, 0)
108 shortpath = create_unicode_buffer(shortlen)
109 if GetShortPathName(path, shortpath, shortlen):
110 return shortpath.value
115 ''' I do not really know why this is useful, but we might as well keep it.
117 Only set these to C if already set. These must not be set unconditionally
118 because not all systems understand e.g. LANG=C (notably SCO).
119 Fixing LC_MESSAGES prevents Solaris sh from translating var values in set!
120 Non-C LC_CTYPE values break the ctype check.
122 os.environ['LANG'] = os.getenv('LANG', 'C')
123 os.environ['LC'] = os.getenv('LC_ALL', 'C')
124 os.environ['LC_MESSAGE'] = os.getenv('LC_MESSAGE', 'C')
125 os.environ['LC_CTYPE'] = os.getenv('LC_CTYPE', 'C')
128 def copy_tree(src, dst, preserve_symlinks=False, level=0):
129 ''' Copy an entire directory tree 'src' to a new location 'dst'.
131 Code inspired from distutils.copy_tree.
132 Copying ignores non-regular files and the cache directory.
133 Pipes may be present as leftovers from LyX for lyx-server.
135 If 'preserve_symlinks' is true, symlinks will be
136 copied as symlinks (on platforms that support them!); otherwise
137 (the default), the destination of the symlink will be copied.
140 if not os.path.isdir(src):
141 raise FileError("cannot copy tree '%s': not a directory" % src)
143 names = os.listdir(src)
144 except os.error as oserror:
145 (errno, errstr) = oserror.args
146 raise FileError("error listing files in '%s': %s" % (src, errstr))
148 if not os.path.isdir(dst):
154 src_name = os.path.join(src, name)
155 dst_name = os.path.join(dst, name)
156 if preserve_symlinks and os.path.islink(src_name):
157 link_dest = os.readlink(src_name)
158 os.symlink(link_dest, dst_name)
159 outputs.append(dst_name)
160 elif level == 0 and name == 'cache':
161 logger.info("Skip cache %s", src_name)
162 elif os.path.isdir(src_name):
164 copy_tree(src_name, dst_name, preserve_symlinks, level=(level + 1)))
165 elif stat.S_ISREG(os.stat(src_name).st_mode) or os.path.islink(src_name):
166 shutil.copy2(src_name, dst_name)
167 outputs.append(dst_name)
169 logger.info("Ignore non-regular file %s", src_name)
175 ''' Check for upgrade from previous version '''
177 basename = os.path.basename( cwd )
178 lyxrc = os.path.join(cwd, outfile)
179 if not os.path.isfile( lyxrc ) and basename.endswith( version_suffix ) :
180 logger.info('Checking for upgrade from previous version.')
181 parent = os.path.dirname(cwd)
182 appname = basename[:(-len(version_suffix))]
183 for version in ['-2.3', '-2.2', '-2.1', '-2.0', '-1.6' ]:
184 logger.debug('Checking for upgrade from previous version ' + version)
185 previous = os.path.join(parent, appname + version)
186 logger.debug('previous = ' + previous)
187 if os.path.isdir( previous ):
188 logger.info('Found directory "%s".', previous)
189 copy_tree( previous, cwd, True )
190 logger.info('Content copied from directory "%s".', previous)
194 def createDirectories():
195 ''' Create the build directories if necessary '''
196 for dir in ['bind', 'clipart', 'doc', 'examples', 'images', 'kbd',
197 'layouts', 'scripts', 'templates', 'ui' ]:
198 if not os.path.isdir( dir ):
201 logger.debug('Create directory %s.' % dir)
203 logger.error('Failed to create directory %s.' % dir)
208 ''' Determine the path-style needed by the TeX engine on Win32 (Cygwin) '''
209 windows_style_tex_paths = ''
211 return windows_style_tex_paths
212 if os.name == 'nt' or sys.platform == 'cygwin':
213 from tempfile import mkstemp
214 fd, tmpfname = mkstemp(suffix='.ltx')
216 encoding = sys.getfilesystemencoding()
217 if sys.version_info[0] < 3:
218 inpname = shortPath(unicode(tmpfname, encoding)).replace('\\', '/')
220 inpname = shortPath(tmpfname).replace('\\', '/')
222 inpname = cmdOutput('cygpath -m ' + tmpfname)
223 logname = os.path.basename(re.sub("(?i).ltx", ".log", inpname))
224 inpname = inpname.replace('~', '\\string~')
225 os.write(fd, b'\\relax')
227 latex_out = cmdOutput(r'latex "\nonstopmode\input{%s}\makeatletter\@@end"'
229 if 'Error' in latex_out:
230 latex_out = cmdOutput(r'latex "\nonstopmode\input{\"%s\"}\makeatletter\@@end"'
232 if 'Error' in latex_out:
233 logger.warning("configure: TeX engine needs posix-style paths in latex files")
234 windows_style_tex_paths = 'false'
236 logger.info("configure: TeX engine needs windows-style paths in latex files")
237 windows_style_tex_paths = 'true'
238 removeFiles([tmpfname, logname, 'texput.log'])
239 return windows_style_tex_paths
242 ## Searching some useful programs
243 def checkProg(description, progs, rc_entry = [], path = [], not_found = ''):
245 This function will search a program in $PATH plus given path
246 If found, return directory and program name (not the options).
248 description: description of the program
250 progs: check programs, for each prog, the first word is used
251 for searching but the whole string is used to replace
252 %% for a rc_entry. So, feel free to add '$$i' etc for programs.
254 path: additional paths (will be prepended to the program name)
256 rc_entry: entry to outfile, can be
257 1. emtpy: no rc entry will be added
258 2. one pattern: %% will be replaced by the first found program,
259 or '' if no program is found.
260 3. several patterns for each prog and not_found. This is used
261 when different programs have different usages. If you do not
262 want not_found entry to be added to the RC file, you can specify
263 an entry for each prog and use '' for the not_found entry.
265 not_found: the value that should be used instead of '' if no program
269 # one rc entry for each progs plus not_found entry
270 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
271 logger.error("rc entry should have one item or item "
272 "for each prog and not_found.")
274 logger.info('checking for ' + description + '...')
275 ## print '(' + ','.join(progs) + ')',
276 additional_path = path
277 path = os.environ["PATH"].split(os.pathsep) + additional_path
279 if "PATHEXT" in os.environ:
280 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
282 unquoted_space = re.compile(r'''((?:[^ "']|"[^"]*"|'[^']*')+)''')
283 for idx in range(len(progs)):
284 # ac_prog may have options, ac_word is the command name
285 ac_prog = progs[idx].replace('"', '\\"')
286 ac_word = unquoted_space.split(progs[idx])[1::2][0].strip('"')
287 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
289 if ac_word.endswith('.pl') and perl == '':
291 msg = '+checking for "' + ac_word + '"... '
293 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
296 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
297 logger.info(msg + ' yes')
298 # deal with java and perl
299 if ac_word.endswith('.class'):
300 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
301 % (java, os.path.join(ac_dir, ac_word[:-6])))
302 elif ac_word.endswith('.jar'):
303 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
304 % (java, os.path.join(ac_dir, ac_word)))
305 elif ac_word.endswith('.pl'):
306 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
307 % (perl, os.path.join(ac_dir, ac_word)))
308 elif ac_dir in additional_path:
309 ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
310 % (os.path.join(ac_dir, ac_word)))
311 # write rc entries for this command
312 if len(rc_entry) == 1:
313 addToRC(rc_entry[0].replace('%%', ac_prog))
314 elif len(rc_entry) > 1:
315 addToRC(rc_entry[idx].replace('%%', ac_prog))
316 return [ac_dir, ac_word]
318 logger.info(msg + ' no')
319 # write rc entries for 'not found'
320 if len(rc_entry) > 0: # the last one.
321 addToRC(rc_entry[-1].replace('%%', not_found))
322 return ['', not_found]
325 def checkProgAlternatives(description, progs, rc_entry = [],
326 alt_rc_entry = [], path = [], not_found = ''):
328 The same as checkProg, but additionally, all found programs will be added
331 # one rc entry for each progs plus not_found entry
332 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
333 logger.error("rc entry should have one item or item for each prog and not_found.")
335 logger.info('checking for ' + description + '...')
336 ## print '(' + ','.join(progs) + ')',
337 additional_path = path
338 path = os.environ["PATH"].split(os.pathsep) + additional_path
340 if "PATHEXT" in os.environ:
341 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
344 real_ac_word = not_found
346 for idx in range(len(progs)):
347 # ac_prog may have options, ac_word is the command name
349 ac_word = ac_prog.split(' ')[0]
350 if (ac_word.endswith('.class') or ac_word.endswith('.jar')) and java == '':
352 if ac_word.endswith('.pl') and perl == '':
354 msg = '+checking for "' + ac_word + '"... '
357 if hasattr(os, "access") and not os.access(ac_dir, os.F_OK):
360 if os.path.isfile( os.path.join(ac_dir, ac_word + ext) ):
361 logger.info(msg + ' yes')
362 pr = re.compile(r'(\\\S+)(.*)$')
364 # deal with java and perl
365 if ac_word.endswith('.class'):
366 ac_prog = ac_prog.replace(ac_word, r'%s \"%s\"'
367 % (java, os.path.join(ac_dir, ac_word[:-6])))
368 elif ac_word.endswith('.jar'):
369 ac_prog = ac_prog.replace(ac_word, r'%s -jar \"%s\"'
370 % (java, os.path.join(ac_dir, ac_word)))
371 elif ac_word.endswith('.pl'):
372 ac_prog = ac_prog.replace(ac_word, r'%s -w \"%s\"'
373 % (perl, os.path.join(ac_dir, ac_word)))
374 elif ac_dir in additional_path:
375 ac_prog = ac_prog.replace(ac_word, r'\"%s\"'
376 % (os.path.join(ac_dir, ac_word)))
377 # write rc entries for this command
378 if found_prime == False:
379 if len(rc_entry) == 1:
380 addToRC(rc_entry[0].replace('%%', ac_prog))
381 elif len(rc_entry) > 1:
382 addToRC(rc_entry[idx].replace('%%', ac_prog))
384 real_ac_word = ac_word
386 if len(alt_rc_entry) == 1:
387 alt_rc = alt_rc_entry[0]
389 # if no explicit alt_rc is given, construct one
390 m = pr.match(rc_entry[0])
392 alt_rc = m.group(1) + "_alternatives" + m.group(2)
393 addToRC(alt_rc.replace('%%', ac_prog))
394 elif len(alt_rc_entry) > 1:
395 alt_rc = alt_rc_entry[idx]
397 # if no explicit alt_rc is given, construct one
398 m = pr.match(rc_entry[idx])
400 alt_rc = m.group(1) + "_alternatives" + m.group(2)
401 addToRC(alt_rc.replace('%%', ac_prog))
406 if found_alt == False:
408 logger.info(msg + ' no')
410 return [real_ac_dir, real_ac_word]
411 # write rc entries for 'not found'
412 if len(rc_entry) > 0: # the last one.
413 addToRC(rc_entry[-1].replace('%%', not_found))
414 return ['', not_found]
417 def addAlternatives(rcs, alt_type):
419 Returns a \\prog_alternatives string to be used as an alternative
420 rc entry. alt_type can be a string or a list of strings.
422 r = re.compile(r'\\Format (\S+).*$')
425 alt_token = '\\%s_alternatives '
426 if isinstance(alt_type, str):
427 alt_tokens = [alt_token % alt_type]
429 alt_tokens = [alt_token % s for s in alt_type]
430 for idxx in range(len(rcs)):
434 alt = '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
436 m = r.match(rcs[idxx])
440 alt += '\n'.join([s + m.group(1) + ' "%%"' for s in alt_tokens])
444 def listAlternatives(progs, alt_type, rc_entry = []):
446 Returns a list of \\prog_alternatives strings to be used as alternative
447 rc entries. alt_type can be a string or a list of strings.
449 if len(rc_entry) > 1 and len(rc_entry) != len(progs) + 1:
450 logger.error("rc entry should have one item or item for each prog and not_found.")
453 for idx in range(len(progs)):
454 if len(rc_entry) == 1:
455 rcs = rc_entry[0].split('\n')
456 alt = addAlternatives(rcs, alt_type)
457 alt_rc_entry.insert(0, alt)
458 elif len(rc_entry) > 1:
459 rcs = rc_entry[idx].split('\n')
460 alt = addAlternatives(rcs, alt_type)
461 alt_rc_entry.insert(idx, alt)
465 def checkViewer(description, progs, rc_entry = [], path = []):
466 ''' The same as checkProgAlternatives, but for viewers '''
467 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 checkEditor(description, progs, rc_entry = [], path = []):
473 ''' The same as checkProgAlternatives, but for editors '''
474 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
475 return checkProgAlternatives(description, progs, rc_entry,
476 alt_rc_entry, path, not_found = 'auto')
479 def checkViewerNoRC(description, progs, rc_entry = [], path = []):
480 ''' The same as checkViewer, but do not add rc entry '''
481 alt_rc_entry = listAlternatives(progs, 'viewer', rc_entry)
483 return checkProgAlternatives(description, progs, rc_entry,
484 alt_rc_entry, path, not_found = 'auto')
487 def checkEditorNoRC(description, progs, rc_entry = [], path = []):
488 ''' The same as checkViewer, but do not add rc entry '''
489 alt_rc_entry = listAlternatives(progs, 'editor', rc_entry)
491 return checkProgAlternatives(description, progs, rc_entry,
492 alt_rc_entry, path, not_found = 'auto')
495 def checkViewerEditor(description, progs, rc_entry = [], path = []):
496 ''' The same as checkProgAlternatives, but for viewers and editors '''
497 alt_rc_entry = listAlternatives(progs, ['editor', 'viewer'], rc_entry)
498 return checkProgAlternatives(description, progs, rc_entry,
499 alt_rc_entry, path, not_found = 'auto')
503 ''' Check whether DTL tools are available (Windows only) '''
504 # Find programs! Returned path is not used now
505 if ((os.name == 'nt' or sys.platform == 'cygwin') and
506 checkProg('DVI to DTL converter', ['dv2dt']) != ['', ''] and
507 checkProg('DTL to DVI converter', ['dt2dv']) != ['', '']):
514 ''' Check whether Inkscape is available and return the full path (Windows only) '''
515 ''' On Mac OS (darwin) a wrapper is used - therefore the version is checked '''
516 ''' The answer of the real inkscape is validated and a fake binary used if this fails '''
517 if sys.platform == 'darwin':
518 version_string = cmdOutput("inkscape --version")
519 if version_string.startswith('Inkscape'):
522 return 'inkscape-binary'
523 elif os.name != 'nt':
525 if sys.version_info[0] < 3:
526 import _winreg as winreg
529 aReg = winreg.ConnectRegistry(None, winreg.HKEY_CLASSES_ROOT)
531 aKey = winreg.OpenKey(aReg, r"inkscape.svg\DefaultIcon")
532 val = winreg.QueryValueEx(aKey, "")
533 valentry = str(val[0])
534 if valentry.find('"') > 0:
535 return valentry.split('"')[1]
536 elif valentry.find(',') > 0:
537 return valentry.split(',')[0]
540 except EnvironmentError:
542 aKey = winreg.OpenKey(aReg, r"inkscape.SVG\shell\open\command")
543 val = winreg.QueryValueEx(aKey, "")
544 return str(val[0]).split('"')[1]
545 except EnvironmentError:
547 aKey = winreg.OpenKey(aReg, r"Applications\inkscape.exe\shell\open\command")
548 val = winreg.QueryValueEx(aKey, "")
549 return str(val[0]).split('"')[1]
550 except EnvironmentError:
554 def checkInkscapeStable():
555 ''' Check whether we use Inkscape >= 1.0 '''
556 inkscape_bin = inkscape_cl
558 # Windows needs the full path, quoted if it contains spaces
559 inkscape_bin = quoteIfSpace(os.path.join(inkscape_path, inkscape_cl))
560 version_string = cmdOutput(inkscape_bin + " --version")
561 if version_string.find(' 0.') > 0:
567 def checkLatex(dtl_tools):
568 ''' Check latex, return lyx_check_config '''
569 path, LATEX = checkProg('a Latex2e program', ['latex $$i', 'latex2e $$i'])
570 #-----------------------------------------------------------------
571 path, PLATEX = checkProg('pLaTeX, the Japanese LaTeX', ['platex $$i'])
573 # check if PLATEX is pLaTeX2e
574 writeToFile('chklatex.ltx', r'\nonstopmode\makeatletter\@@end')
575 # run platex on chklatex.ltx and check result
576 if cmdOutput(PLATEX + ' chklatex.ltx').find('pLaTeX2e') != -1:
577 # We have the Japanese pLaTeX2e
578 addToRC(r'\converter platex dvi "%s" "latex=platex"' % PLATEX)
581 removeFiles(['chklatex.ltx', 'chklatex.log'])
582 #-----------------------------------------------------------------
584 # Windows only: DraftDVI
585 addToRC(r'''\converter latex dvi2 "%s" "latex,hyperref-driver=dvips"
586 \converter dvi2 dvi "python -tt $$s/scripts/clean_dvi.py $$i $$o" ""''' % LATEX)
588 addToRC(r'\converter latex dvi "%s" "latex,hyperref-driver=dvips"' % LATEX)
591 # Check if latex is usable
592 writeToFile('chklatex.ltx', r'''
594 \ifx\undefined\documentclass\else
595 \message{ThisIsLaTeX2e}
600 # run latex on chklatex.ltx and check result
601 if cmdOutput(LATEX + ' chklatex.ltx').find('ThisIsLaTeX2e') != -1:
605 logger.warning("Latex not usable (not LaTeX2e) ")
606 # remove temporary files
607 removeFiles(['chklatex.ltx', 'chklatex.log'])
612 ''' Check if luatex is there '''
613 path, LUATEX = checkProg('LuaTeX', ['lualatex $$i'])
614 path, DVILUATEX = checkProg('LuaTeX (DVI)', ['dvilualatex $$i'])
616 addToRC(r'\converter luatex pdf5 "%s" "latex=lualatex"' % LUATEX)
618 addToRC(r'\converter dviluatex dvi3 "%s" "latex=dvilualatex"' % DVILUATEX)
621 def checkModule(module):
622 ''' Check for a Python module, return the status '''
623 msg = 'checking for "' + module + ' module"... '
626 logger.info(msg + ' yes')
629 logger.info(msg + ' no')
633 texteditors = ['xemacs', 'gvim', 'kedit', 'kwrite', 'kate',
634 'nedit', 'gedit', 'geany', 'leafpad', 'mousepad',
635 'xed', 'notepad', 'WinEdt', 'WinShell', 'PSPad']
637 def checkFormatEntries(dtl_tools):
638 ''' Check all formats (\Format entries) '''
639 checkViewerEditor('a Tgif viewer and editor', ['tgif'],
640 rc_entry = [r'\Format tgif "obj, tgo" Tgif "" "%%" "%%" "vector" "application/x-tgif"'])
642 checkViewerEditor('a FIG viewer and editor', ['xfig', 'jfig3-itext.jar', 'jfig3.jar'],
643 rc_entry = [r'\Format fig fig FIG "" "%%" "%%" "vector" "application/x-xfig"'])
645 checkViewerEditor('a Dia viewer and editor', ['dia'],
646 rc_entry = [r'\Format dia dia DIA "" "%%" "%%" "vector,zipped=native", "application/x-dia-diagram"'])
648 checkViewerEditor('an OpenDocument drawing viewer and editor', ['libreoffice', 'lodraw', 'ooffice', 'oodraw', 'soffice'],
649 rc_entry = [r'\Format odg "odg, sxd" "OpenDocument drawing" "" "%%" "%%" "vector,zipped=native" "application/vnd.oasis.opendocument.graphics"'])
651 checkViewerEditor('a Grace viewer and editor', ['xmgrace'],
652 rc_entry = [r'\Format agr agr Grace "" "%%" "%%" "vector" ""'])
654 checkViewerEditor('a FEN viewer and editor', ['xboard -lpf $$i -mode EditPosition'],
655 rc_entry = [r'\Format fen fen FEN "" "%%" "%%" "" ""'])
657 checkViewerEditor('a SVG viewer and editor', [inkscape_gui],
658 rc_entry = [r'''\Format svg "svg" SVG "" "%%" "%%" "vector" "image/svg+xml"
659 \Format svgz "svgz" "SVG (compressed)" "" "%%" "%%" "vector,zipped=native" ""'''],
660 path = [inkscape_path])
662 imageformats = r'''\Format bmp bmp BMP "" "%s" "%s" "" "image/x-bmp"
663 \Format gif gif GIF "" "%s" "%s" "" "image/gif"
664 \Format jpg "jpg, jpeg" JPEG "" "%s" "%s" "" "image/jpeg"
665 \Format pbm pbm PBM "" "%s" "%s" "" "image/x-portable-bitmap"
666 \Format pgm pgm PGM "" "%s" "%s" "" "image/x-portable-graymap"
667 \Format png png PNG "" "%s" "%s" "" "image/x-png"
668 \Format ppm ppm PPM "" "%s" "%s" "" "image/x-portable-pixmap"
669 \Format tiff tif TIFF "" "%s" "%s" "" "image/tiff"
670 \Format xbm xbm XBM "" "%s" "%s" "" "image/x-xbitmap"
671 \Format xpm xpm XPM "" "%s" "%s" "" "image/x-xpixmap"'''
672 path, iv = checkViewerNoRC('a raster image viewer',
673 ['xv', 'gwenview', 'kview',
674 'eog', 'xviewer', 'ristretto', 'gpicview', 'lximage-qt',
675 'xdg-open', 'gimp-remote', 'gimp'],
676 rc_entry = [imageformats])
677 path, ie = checkEditorNoRC('a raster image editor',
678 ['gimp-remote', 'gimp'], rc_entry = [imageformats])
679 addToRC(imageformats % ((iv, ie)*10))
681 checkViewerEditor('a text editor', texteditors,
682 rc_entry = [r'''\Format asciichess asc "Plain text (chess output)" "" "" "%%" "" ""
683 \Format docbook5 xml "DocBook 5" "" "" "%%" "document,menu=export" "application/docbook+xml"
684 \Format dot dot "Graphviz Dot" "" "" "%%" "vector" "text/vnd.graphviz"
685 \Format dviluatex tex "LaTeX (dviluatex)" "" "" "%%" "document,menu=export" ""
686 \Format platex tex "LaTeX (pLaTeX)" "" "" "%%" "document,menu=export" ""
687 \Format literate nw NoWeb N "" "%%" "document,menu=export" ""
688 \Format sweave Rnw "Sweave" S "" "%%" "document,menu=export" ""
689 \Format sweave-ja Rnw "Sweave (Japanese)" S "" "%%" "document,menu=export" ""
690 \Format r R "R/S code" "" "" "%%" "document,menu=export" ""
691 \Format knitr Rnw "Rnw (knitr)" "" "" "%%" "document,menu=export" ""
692 \Format knitr-ja Rnw "Rnw (knitr, Japanese)" "" "" "%%" "document,menu=export" ""
693 \Format lilypond-book lytex "LilyPond book (LaTeX)" "" "" "%%" "document,menu=export" ""
694 \Format lilypond-book-ja lytex "LilyPond book (pLaTeX)" "" "" "%%" "document,menu=export" ""
695 \Format latex tex "LaTeX (plain)" L "" "%%" "document,menu=export" "text/x-tex"
696 \Format luatex tex "LaTeX (LuaTeX)" "" "" "%%" "document,menu=export" ""
697 \Format pdflatex tex "LaTeX (pdflatex)" "" "" "%%" "document,menu=export" ""
698 \Format xetex tex "LaTeX (XeTeX)" "" "" "%%" "document,menu=export" ""
699 \Format latexclipboard tex "LaTeX (clipboard)" "" "" "%%" "menu=none" ""
700 \Format text txt "Plain text" a "" "%%" "document,menu=export" "text/plain"
701 \Format text2 txt "Plain text (pstotext)" "" "" "%%" "document" ""
702 \Format text3 txt "Plain text (ps2ascii)" "" "" "%%" "document" ""
703 \Format text4 txt "Plain text (catdvi)" "" "" "%%" "document" ""
704 \Format textparagraph txt "Plain Text, Join Lines" "" "" "%%" "document" ""
705 \Format beamer.info pdf.info "Info (Beamer)" "" "" "%%" "document,menu=export" ""''' ])
706 #Lilypond files have special editors, but fall back to plain text editors
707 checkViewerEditor('a lilypond editor',
708 ['frescobaldi'] + texteditors,
709 rc_entry = [r'''\Format lilypond ly "LilyPond music" "" "" "%%" "vector" "text/x-lilypond"''' ])
710 #Spreadsheets using ssconvert from gnumeric
711 checkViewer('gnumeric spreadsheet software', ['gnumeric'],
712 rc_entry = [r'''\Format gnumeric gnumeric "Gnumeric spreadsheet" "" "" "%%" "document" "application/x-gnumeric"
713 \Format excel xls "Excel spreadsheet" "" "" "%%" "document" "application/vnd.ms-excel"
714 \Format excel2 xlsx "MS Excel Office Open XML" "" "" "%%" "document" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
715 \Format xhtml_table xhtml "XHTML Table (for spreadsheets)" "" "" "%%" "document" ""
716 \Format html_table html "HTML Table (for spreadsheets)" "" "" "%%" "document" ""
717 \Format oocalc ods "OpenDocument spreadsheet" "" "" "%%" "document" "application/vnd.oasis.opendocument.spreadsheet"'''])
719 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
720 rc_entry = [r'\Format xhtml xhtml "LyXHTML" y "%%" "" "document,menu=export" "application/xhtml+xml"'])
722 checkEditor('a BibTeX editor', ['jabref', 'JabRef',
723 'pybliographic', 'bibdesk', 'gbib', 'kbib',
724 'kbibtex', 'sixpack', 'bibedit', 'tkbibtex', 'TeXnicCenter'] +
726 rc_entry = [r'''\Format bibtex bib "BibTeX" "" "" "%%" "" "text/x-bibtex"''' ])
728 #checkProg('a Postscript interpreter', ['gs'],
729 # rc_entry = [ r'\ps_command "%%"' ])
730 checkViewer('a Postscript previewer',
731 ['kghostview', 'okular', 'qpdfview --unique',
733 'gv', 'ghostview -swap', 'gsview64', 'gsview32'],
734 rc_entry = [r'''\Format eps eps EPS "" "%%" "" "vector" "image/x-eps"
735 \Format eps2 eps "EPS (uncropped)" "" "%%" "" "vector" ""
736 \Format eps3 eps "EPS (cropped)" "" "%%" "" "document" ""
737 \Format ps ps Postscript t "%%" "" "document,vector,menu=export" "application/postscript"'''])
738 # for xdg-open issues look here: http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg151818.html
739 # maybe use "bestApplication()" from https://github.com/jleclanche/python-mime
740 # the MIME type is set for pdf6, because that one needs to be autodetectable by libmime
741 checkViewer('a PDF previewer',
742 ['pdfview', 'kpdf', 'okular', 'qpdfview --unique',
743 'evince', 'xreader', 'kghostview', 'xpdf', 'SumatraPDF',
744 'acrobat', 'acroread', 'mupdf',
745 'gv', 'ghostview', 'AcroRd32', 'gsview64', 'gsview32'],
746 rc_entry = [r'''\Format pdf pdf "PDF (ps2pdf)" P "%%" "" "document,vector,menu=export" ""
747 \Format pdf2 pdf "PDF (pdflatex)" F "%%" "" "document,vector,menu=export" ""
748 \Format pdf3 pdf "PDF (dvipdfm)" m "%%" "" "document,vector,menu=export" ""
749 \Format pdf4 pdf "PDF (XeTeX)" X "%%" "" "document,vector,menu=export" ""
750 \Format pdf5 pdf "PDF (LuaTeX)" u "%%" "" "document,vector,menu=export" ""
751 \Format pdf6 pdf "PDF (graphics)" "" "%%" "" "vector" "application/pdf"
752 \Format pdf7 pdf "PDF (cropped)" "" "%%" "" "document,vector" ""
753 \Format pdf8 pdf "PDF (lower resolution)" "" "%%" "" "document,vector" ""
754 \Format pdf9 pdf "PDF (docbook)" "" "%%" "" "document,vector,menu=export" ""'''])
756 checkViewer('a DVI previewer', ['xdvi', 'kdvi', 'okular',
758 'yap', 'dviout -Set=!m'],
759 rc_entry = [r'''\Format dvi dvi DVI D "%%" "" "document,vector,menu=export" "application/x-dvi"
760 \Format dvi3 dvi "DVI (LuaTeX)" V "%%" "" "document,vector,menu=export" ""'''])
762 # Windows only: DraftDVI
763 addToRC(r'\Format dvi2 dvi DraftDVI "" "" "" "vector" ""')
765 checkViewer('an HTML previewer', ['firefox', 'mozilla file://$$p$$i', 'netscape'],
766 rc_entry = [r'\Format html "html, htm" HTML H "%%" "" "document,menu=export" "text/html"'])
768 checkViewerEditor('Noteedit', ['noteedit'],
769 rc_entry = [r'\Format noteedit not Noteedit "" "%%" "%%" "vector" ""'])
771 checkViewerEditor('an OpenDocument viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
772 rc_entry = [r'''\Format odt odt "OpenDocument (tex4ht)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
773 \Format odt2 odt "OpenDocument (eLyXer)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
774 \Format odt3 odt "OpenDocument (Pandoc)" "" "%%" "%%" "document,vector,menu=export" "application/vnd.oasis.opendocument.text"
775 \Format sxw sxw "OpenOffice.Org (sxw)" "" "" "" "document,vector" "application/vnd.sun.xml.writer"'''])
777 checkViewerEditor('a Rich Text and Word viewer', ['libreoffice', 'lwriter', 'lowriter', 'oowriter', 'swriter', 'abiword'],
778 rc_entry = [r'''\Format rtf rtf "Rich Text Format" "" "%%" "%%" "document,vector,menu=export" "application/rtf"
779 \Format word doc "MS Word" W "%%" "%%" "document,vector,menu=export" "application/msword"
780 \Format word2 docx "MS Word Office Open XML" O "%%" "%%" "document,vector,menu=export" "application/vnd.openxmlformats-officedocument.wordprocessingml.document"'''])
782 # entries that do not need checkProg
783 addToRC(r'''\Format csv csv "Table (CSV)" "" "" "" "document" "text/csv"
784 \Format fax "" Fax "" "" "" "document" ""
785 \Format lyx lyx LyX "" "" "" "" "application/x-lyx"
786 \Format lyx13x 13.lyx "LyX 1.3.x" "" "" "" "document" ""
787 \Format lyx14x 14.lyx "LyX 1.4.x" "" "" "" "document" ""
788 \Format lyx15x 15.lyx "LyX 1.5.x" "" "" "" "document" ""
789 \Format lyx16x 16.lyx "LyX 1.6.x" "" "" "" "document" ""
790 \Format lyx20x 20.lyx "LyX 2.0.x" "" "" "" "document" ""
791 \Format lyx21x 21.lyx "LyX 2.1.x" "" "" "" "document" ""
792 \Format lyx22x 22.lyx "LyX 2.2.x" "" "" "" "document" ""
793 \Format lyx23x 23.lyx "LyX 2.3.x" "" "" "" "document,menu=export" ""
794 \Format clyx cjklyx "CJK LyX 1.4.x (big5)" "" "" "" "document" ""
795 \Format jlyx cjklyx "CJK LyX 1.4.x (euc-jp)" "" "" "" "document" ""
796 \Format klyx cjklyx "CJK LyX 1.4.x (euc-kr)" "" "" "" "document" ""
797 \Format lyxpreview lyxpreview "LyX Preview" "" "" "" "" ""
798 \Format pdftex "pdftex_t, pdf_tex" PDFTEX "" "" "" "" ""
799 \Format program "" Program "" "" "" "" ""
800 \Format pstex "pstex_t, ps_tex" PSTEX "" "" "" "" ""
801 \Format wmf wmf "Windows Metafile" "" "" "" "vector" "image/x-wmf"
802 \Format emf emf "Enhanced Metafile" "" "" "" "vector" "image/x-emf"
803 \Format wordhtml "html, htm" "HTML (MS Word)" "" "" "" "document" ""
807 def checkConverterEntries():
808 ''' Check all converters (\converter entries) '''
809 checkProg('the pdflatex program', ['pdflatex $$i'],
810 rc_entry = [ r'\converter pdflatex pdf2 "%%" "latex=pdflatex,hyperref-driver=pdftex"' ])
812 checkProg('XeTeX', ['xelatex $$i'],
813 rc_entry = [ r'\converter xetex pdf4 "%%" "latex=xelatex,hyperref-driver=xetex"' ])
817 # Look for tex2lyx in this order (see bugs #3308 and #6986):
818 # 1) If we're building LyX with autotools then tex2lyx is found
819 # in the subdirectory tex2lyx with respect to the binary dir.
820 # 2) If we're building LyX with cmake then tex2lyx is found
822 # 3) If LyX was configured with a version suffix then tex2lyx
823 # will also have this version suffix.
824 # 4) Otherwise always use tex2lyx.
825 in_binary_subdir = os.path.join(lyx_binary_dir, 'tex2lyx', 'tex2lyx')
826 in_binary_subdir = os.path.abspath(in_binary_subdir).replace('\\', '/')
828 in_binary_dir = os.path.join(lyx_binary_dir, 'tex2lyx')
829 in_binary_dir = os.path.abspath(in_binary_dir).replace('\\', '/')
831 path, t2l = checkProg('a LaTeX/Noweb -> LyX converter', [quoteIfSpace(in_binary_subdir), quoteIfSpace(in_binary_subdir + version_suffix), quoteIfSpace(in_binary_dir), quoteIfSpace(in_binary_dir + version_suffix), 'tex2lyx' + version_suffix, 'tex2lyx'],
832 rc_entry = [r'''\converter latex lyx "%% -f $$i $$o" ""
833 \converter latexclipboard lyx "%% -fixedenc utf8 -f $$i $$o" ""
834 \converter literate lyx "%% -n -m noweb -f $$i $$o" ""
835 \converter sweave lyx "%% -n -m sweave -f $$i $$o" ""
836 \converter knitr lyx "%% -n -m knitr -f $$i $$o" ""'''], not_found = 'tex2lyx')
838 logger.warning("Failed to find tex2lyx on your system.")
841 checkProg('a Noweb -> LaTeX converter', ['noweave -delay -index $$i > $$o'],
842 rc_entry = [r'''\converter literate latex "%%" ""
843 \converter literate pdflatex "%%" ""
844 \converter literate xetex "%%" ""
845 \converter literate luatex "%%" ""
846 \converter literate dviluatex "%%" ""'''])
848 checkProg('a Sweave -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e $$r'],
849 rc_entry = [r'''\converter sweave latex "%%" "needauth"
850 \converter sweave pdflatex "%%" "needauth"
851 \converter sweave-ja platex "%%" "needauth"
852 \converter sweave xetex "%%" "needauth"
853 \converter sweave luatex "%%" "needauth"
854 \converter sweave dviluatex "%%" "needauth"'''])
856 checkProg('a knitr -> LaTeX converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r'],
857 rc_entry = [r'''\converter knitr latex "%%" "needauth"
858 \converter knitr pdflatex "%%" "needauth"
859 \converter knitr-ja platex "%%" "needauth"
860 \converter knitr xetex "%%" "needauth"
861 \converter knitr luatex "%%" "needauth"
862 \converter knitr dviluatex "%%" "needauth"'''])
864 checkProg('a Sweave -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxstangle.R $$i $$e $$r'],
865 rc_entry = [ r'\converter sweave r "%%" ""',
866 r'\converter sweave-ja r "%%" ""' ])
868 checkProg('a knitr -> R/S code converter', ['Rscript --verbose --no-save --no-restore $$s/scripts/lyxknitr.R $$p$$i $$p$$o $$e $$r tangle'],
869 rc_entry = [ r'\converter knitr r "%%" ""',
870 r'\converter knitr-ja r "%%" ""' ])
872 checkProg('an HTML -> LaTeX converter', ['html2latex $$i', 'gnuhtml2latex',
873 'htmltolatex -input $$i -output $$o', 'htmltolatex.jar -input $$i -output $$o'],
874 rc_entry = [ r'\converter html latex "%%" ""',
875 r'\converter html latex "python -tt $$s/scripts/html2latexwrapper.py %% $$i $$o" ""',
876 r'\converter html latex "%%" ""',
877 r'\converter html latex "%%" ""', '' ])
879 checkProg('an MS Word -> LaTeX converter', ['wvCleanLatex $$i $$o'],
880 rc_entry = [ r'\converter word latex "%%" ""' ])
882 # eLyXer: search as an executable (elyxer.py, elyxer)
883 path, elyxer = checkProg('a LyX -> HTML converter',
884 ['elyxer.py --nofooter --directory $$r $$i $$o', 'elyxer --nofooter --directory $$r $$i $$o'],
885 rc_entry = [ r'\converter lyx html "%%" ""' ])
886 path, elyxer = checkProg('a LyX -> HTML (MS Word) converter',
887 ['elyxer.py --nofooter --html --directory $$r $$i $$o', 'elyxer --nofooter --html --directory $$r $$i $$o'],
888 rc_entry = [ r'\converter lyx wordhtml "%%" ""' ])
889 path, elyxer = checkProg('a LyX -> OpenDocument (eLyXer) converter',
890 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
891 rc_entry = [ r'\converter lyx odt2 "%%" ""' ])
892 path, elyxer = checkProg('a LyX -> Word converter',
893 ['elyxer.py --html --nofooter --unicode --directory $$r $$i $$o', 'elyxer --html --nofooter --unicode --directory $$r $$i $$o'],
894 rc_entry = [ r'\converter lyx word "%%" ""' ])
895 if elyxer.find('elyxer') >= 0:
896 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
897 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,jpg,jpeg,css $$i $$o"''')
899 # search for HTML converters other than eLyXer
900 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
901 path, htmlconv = checkProg('a LaTeX -> HTML converter', ['htlatex $$i', 'htlatex.sh $$i',
902 '/usr/share/tex4ht/htlatex $$i', 'tth -t -e2 -L$$b < $$i > $$o',
903 'latex2html -no_subdir -split 0 -show_section_numbers $$i', 'hevea -s $$i'],
904 rc_entry = [ r'\converter latex html "%%" "needaux"' ])
905 if htmlconv.find('htlatex') >= 0 or htmlconv == 'latex2html':
906 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
908 addToRC(r'''\copier html "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
909 path, htmlconv = checkProg('a LaTeX -> HTML (MS Word) converter', ["htlatex $$i 'html,word' 'symbol/!' '-cvalidate'",
910 "htlatex.sh $$i 'html,word' 'symbol/!' '-cvalidate'",
911 "/usr/share/tex4ht/htlatex $$i 'html,word' 'symbol/!' '-cvalidate'"],
912 rc_entry = [ r'\converter latex wordhtml "%%" "needaux"' ])
913 if htmlconv.find('htlatex') >= 0:
914 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py -e html,png,css $$i $$o"''')
916 addToRC(r'''\copier wordhtml "python -tt $$s/scripts/ext_copy.py $$i $$o"''')
919 # Check if LyXBlogger is installed
920 lyxblogger_found = checkModule('lyxblogger')
922 addToRC(r'\Format blog blog "LyXBlogger" "" "" "" "document" ""')
923 addToRC(r'\converter xhtml blog "python -m lyxblogger $$i" ""')
926 checkProg('an OpenOffice.org -> LaTeX converter', ['w2l -clean $$i'],
927 rc_entry = [ r'\converter sxw latex "%%" ""' ])
929 checkProg('an OpenDocument -> LaTeX converter', ['w2l -clean $$i'],
930 rc_entry = [ r'\converter odt latex "%%" ""' ])
932 checkProg('an Open Document (Pandoc) -> LaTeX converter', ['pandoc -s -f odt -o $$o -t latex $$i'],
933 rc_entry = [ r'\converter odt3 latex "%%" ""' ])
935 checkProg('DocBook converter -> PDF (docbook)', ['pandoc -f docbook -t latex --latex-engine=lualatex --toc -o $$o $$i'],
936 rc_entry = [ r'\converter docbook5 pdf9 "%%" ""' ])
938 checkProg('a MS Word Office Open XML converter -> LaTeX', ['pandoc -s -f docx -o $$o -t latex $$i'],
939 rc_entry = [ r'\converter word2 latex "%%" ""' ])
940 # Only define a converter to pdf6, otherwise the odt format could be
941 # used as an intermediate step for export to pdf, which is not wanted.
942 checkProg('an OpenDocument -> PDF converter', ['unoconv -f pdf --stdout $$i > $$o'],
943 rc_entry = [ r'\converter odt pdf6 "%%" ""' ])
944 # According to http://www.tug.org/applications/tex4ht/mn-commands.html
945 # the command mk4ht oolatex $$i has to be used as default,
946 # but as this would require to have Perl installed, in MiKTeX oolatex is
947 # directly available as application.
948 # On SuSE the scripts have a .sh suffix, and on debian they are in /usr/share/tex4ht/
949 # Both SuSE and debian have oolatex
950 checkProg('a LaTeX -> Open Document (tex4ht) converter', [
951 'oolatex $$i', 'mk4ht oolatex $$i', 'oolatex.sh $$i', '/usr/share/tex4ht/oolatex $$i',
952 'htlatex $$i \'xhtml,ooffice\' \'ooffice/! -cmozhtf\' \'-coo\' \'-cvalidate\''],
953 rc_entry = [ r'\converter latex odt "%%" "needaux"' ])
954 # On windows it is called latex2rt.exe
955 checkProg('a LaTeX -> RTF converter', ['latex2rtf -p -S -o $$o $$i', 'latex2rt -p -S -o $$o $$i'],
956 rc_entry = [ r'\converter latex rtf "%%" "needaux"' ])
958 checkProg('a LaTeX -> Open Document (Pandoc) converter', ['pandoc -s -f latex -o $$o -t odt $$i'],
959 rc_entry = [ r'\converter latex odt3 "%%" ""' ])
961 checkProg('a LaTeX -> MS Word Office Open XML converter', ['pandoc -s -f latex -o $$o -t docx $$i'],
962 rc_entry = [ r'\converter latex word2 "%%" ""' ])
964 checkProg('a RTF -> HTML converter', ['unrtf --html $$i > $$o'],
965 rc_entry = [ r'\converter rtf html "%%" ""' ])
966 # Do not define a converter to pdf6, ps is a pure export format
967 checkProg('a PS to PDF converter', ['ps2pdf $$i $$o'],
968 rc_entry = [ r'\converter ps pdf "%%" "hyperref-driver=dvips"' ])
970 checkProg('a PS to TXT converter', ['pstotext $$i > $$o'],
971 rc_entry = [ r'\converter ps text2 "%%" ""' ])
973 checkProg('a PS to TXT converter', ['ps2ascii $$i $$o'],
974 rc_entry = [ r'\converter ps text3 "%%" ""' ])
975 # Need to call ps2eps in a pipe, otherwise it would name the output file
976 # depending on the extension of the input file. We do not know the input
977 # file extension in general, so the resultfile= flag would not help.
978 # Since ps2eps crops the image, we do not use it to convert from ps->eps.
979 # This would create additional paths in the converter graph with unwanted
980 # side effects (e.g. ps->pdf via ps2pdf would create a different result
981 # than ps->eps->pdf via ps2eps and epstopdf).
982 checkProg('a PS to EPS converter', ['ps2eps -- < $$i > $$o'],
983 rc_entry = [ r'\converter eps2 eps "%%" ""' ])
985 checkProg('a PDF to PS converter', ['pdftops $$i $$o', 'pdf2ps $$i $$o'],
986 rc_entry = [ r'\converter pdf ps "%%" ""' ])
987 # Only define a converter from pdf6 for graphics
988 checkProg('a PDF to EPS converter', ['pdftops -eps -f 1 -l 1 $$i $$o'],
989 rc_entry = [ r'\converter pdf6 eps "%%" ""' ])
990 # Define a converter from pdf6 to png for Macs where pdftops is missing.
991 # The converter utility sips allows to force the dimensions of the resulting
992 # png image. The value of 800 pixel for the width is arbitrary and not
993 # related to the current screen resolution or width.
994 # There is no converter parameter for this information.
995 checkProg('a PDF to PNG converter',
996 ['sips --resampleWidth 800 --setProperty format png $$i --out $$o'],
997 rc_entry = [ r'\converter pdf6 png "%%" ""' ])
998 # Create one converter for a PDF produced using TeX fonts and one for a
999 # PDF produced using non-TeX fonts. This does not produce non-unique
1000 # conversion paths, since a given document either uses TeX fonts or not.
1001 checkProg('a PDF cropping tool', ['pdfcrop $$i $$o'],
1002 rc_entry = [ r'''\converter pdf2 pdf7 "%%" ""
1003 \converter pdf4 pdf7 "%%" ""''' ])
1004 # Create one converter for a PDF produced using TeX fonts and one for a
1005 # PDF produced using non-TeX fonts. This does not produce non-unique
1006 # conversion paths, since a given document either uses TeX fonts or not.
1007 checkProg('Ghostscript', ["gswin32c", "gswin64c", "gs"],
1008 rc_entry = [ r'''\converter pdf2 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""
1009 \converter pdf4 pdf8 "python -tt $$s/scripts/convert_pdf.py $$i $$o ebook" ""''' ])
1011 checkProg('a Beamer info extractor', ['makebeamerinfo -p $$i'],
1012 rc_entry = [ r'\converter pdf2 beamer.info "%%" ""' ])
1014 checkProg('a DVI to TXT converter', ['catdvi $$i > $$o'],
1015 rc_entry = [ r'\converter dvi text4 "%%" ""' ])
1017 checkProg('a DVI to PS converter', ['dvips -o $$o $$i'],
1018 rc_entry = [ r'\converter dvi ps "%%" "hyperref-driver=dvips"' ])
1020 checkProg('a DVI to cropped EPS converter', ['dvips -E -o $$o $$i'],
1021 rc_entry = [ r'\converter dvi eps3 "%%" ""' ])
1023 checkProg('a DVI to PDF converter', ['dvipdfmx', 'dvipdfm'],
1024 rc_entry = [ r'\converter dvi pdf3 "%% -o $$o $$i" "hyperref-driver=%%"' ])
1026 checkProg('a fax program', ['kdeprintfax $$i', 'ksendfax $$i', 'hylapex $$i'],
1027 rc_entry = [ r'\converter ps fax "%%" ""'])
1029 path, fig2dev = checkProg('a FIG -> Image converter', ['fig2dev'])
1030 if fig2dev == "fig2dev":
1031 addToRC(r'''\converter fig eps "fig2dev -L eps $$i $$o" ""
1032 \converter fig ppm "fig2dev -L ppm $$i $$o" ""
1033 \converter fig svg "fig2dev -L svg $$i $$o" ""
1034 \converter fig png "fig2dev -L png $$i $$o" ""
1035 \converter fig pdftex "python -tt $$s/scripts/fig2pdftex.py $$i $$o" ""
1036 \converter fig pstex "python -tt $$s/scripts/fig2pstex.py $$i $$o" ""''')
1039 checkProg('a SVG -> PDFTeX converter', [inkscape_cl],
1040 rc_entry = [ r'\converter svg pdftex "python -tt $$s/scripts/svg2pdftex.py %% $$p$$i $$p$$o" ""'],
1041 path = [inkscape_path])
1043 checkProg('a SVG -> PSTeX converter', [inkscape_cl],
1044 rc_entry = [ r'\converter svg pstex "python -tt $$s/scripts/svg2pstex.py %% $$p$$i $$p$$o" ""'],
1045 path = [inkscape_path])
1047 checkProg('a SVG -> PDFTeX converter', [inkscape_cl],
1048 rc_entry = [ r'\converter svg pdftex "python -tt $$s/scripts/svg2pdftex.py --unstable %% $$p$$i $$p$$o" ""'],
1049 path = [inkscape_path])
1051 checkProg('a SVG -> PSTeX converter', [inkscape_cl],
1052 rc_entry = [ r'\converter svg pstex "python -tt $$s/scripts/svg2pstex.py --unstable %% $$p$$i $$p$$o" ""'],
1053 path = [inkscape_path])
1055 checkProg('a TIFF -> PS converter', ['tiff2ps $$i > $$o'],
1056 rc_entry = [ r'\converter tiff eps "%%" ""'])
1058 checkProg('a TGIF -> EPS/PPM converter', ['tgif'],
1060 r'''\converter tgif eps "tgif -print -color -eps -stdout $$i > $$o" ""
1061 \converter tgif png "tgif -print -color -png -o $$d $$i" ""
1062 \converter tgif pdf6 "tgif -print -color -pdf -stdout $$i > $$o" ""'''])
1064 # inkscape 1.0 has changed cl options
1066 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1067 rc_entry = [ r'\converter wmf eps "%%" ""'])
1069 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1070 rc_entry = [ r'\converter emf eps "%%" ""'])
1072 checkProg('a WMF -> PDF converter', [inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1073 rc_entry = [ r'\converter wmf pdf6 "%%" ""'])
1075 checkProg('an EMF -> PDF converter', [inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1076 rc_entry = [ r'\converter emf pdf6 "%%" ""'])
1078 checkProg('a WMF -> EPS converter', ['metafile2eps $$i $$o', 'wmf2eps -o $$o $$i', inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1079 rc_entry = [ r'\converter wmf eps "%%" ""'])
1081 checkProg('an EMF -> EPS converter', ['metafile2eps $$i $$o', inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1082 rc_entry = [ r'\converter emf eps "%%" ""'])
1084 checkProg('a WMF -> PDF converter', [inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1085 rc_entry = [ r'\converter wmf pdf6 "%%" ""'])
1087 checkProg('an EMF -> PDF converter', [inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1088 rc_entry = [ r'\converter emf pdf6 "%%" ""'])
1089 # Only define a converter to pdf6 for graphics
1090 checkProg('an EPS -> PDF converter', ['epstopdf'],
1091 rc_entry = [ r'\converter eps pdf6 "epstopdf --outfile=$$o $$i" ""'])
1093 checkProg('an EPS -> PNG converter', ['magick $$i $$o', 'convert $$i $$o'],
1094 rc_entry = [ r'\converter eps png "%%" ""'])
1096 # no agr -> pdf6 converter, since the pdf library used by gracebat is not
1097 # free software and therefore not compiled in in many installations.
1098 # Fortunately, this is not a big problem, because we will use epstopdf to
1099 # convert from agr to pdf6 via eps without loss of quality.
1100 checkProg('a Grace -> Image converter', ['gracebat'],
1102 r'''\converter agr eps "gracebat -hardcopy -printfile $$o -hdevice EPS $$i 2>/dev/null" ""
1103 \converter agr png "gracebat -hardcopy -printfile $$o -hdevice PNG $$i 2>/dev/null" ""
1104 \converter agr jpg "gracebat -hardcopy -printfile $$o -hdevice JPEG $$i 2>/dev/null" ""
1105 \converter agr ppm "gracebat -hardcopy -printfile $$o -hdevice PNM $$i 2>/dev/null" ""'''])
1107 checkProg('a Dot -> Image converter', ['dot'],
1109 r'''\converter dot eps "dot -Teps $$i -o $$o" ""
1110 \converter dot png "dot -Tpng $$i -o $$o" ""'''])
1112 path, dia = checkProg('a Dia -> Image converter', ['dia'])
1114 addToRC(r'''\converter dia png "dia -e $$o -t png $$i" ""
1115 \converter dia eps "dia -e $$o -t eps $$i" ""
1116 \converter dia svg "dia -e $$o -t svg $$i" ""''')
1119 # Actually, this produces EPS, but with a wrong bounding box (usually A4 or letter).
1120 # The eps2->eps converter then fixes the bounding box by cropping.
1121 # Although unoconv can convert to png and pdf as well, do not define
1122 # odg->png and odg->pdf converters, since the bb would be too large as well.
1123 checkProg('an OpenDocument -> EPS converter', ['libreoffice --headless --nologo --convert-to eps $$i', 'unoconv -f eps --stdout $$i > $$o'],
1124 rc_entry = [ r'\converter odg eps2 "%%" ""'])
1126 checkProg('a SVG (compressed) -> SVG converter', ['gunzip -c $$i > $$o'],
1127 rc_entry = [ r'\converter svgz svg "%%" ""'])
1129 checkProg('a SVG -> SVG (compressed) converter', ['gzip -c $$i > $$o'],
1130 rc_entry = [ r'\converter svg svgz "%%" ""'])
1131 # Only define a converter to pdf6 for graphics
1132 # Prefer rsvg-convert over inkscape since it is faster (see http://www.lyx.org/trac/ticket/9891)
1133 # inkscape 1.0 has changed cl options
1135 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1136 rc_entry = [ r'''\converter svg pdf6 "%%" ""
1137 \converter svgz pdf6 "%%" ""'''],
1138 path = ['', inkscape_path])
1140 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_cl + ' $$i --export-area-drawing --export-filename=$$o'],
1141 rc_entry = [ r'''\converter svg eps "%%" ""
1142 \converter svgz eps "%%" ""'''],
1143 path = ['', inkscape_path])
1145 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_cl + ' $$i --export-filename=$$o'],
1146 rc_entry = [ r'''\converter svg png "%%" "",
1147 \converter svgz png "%%" ""'''],
1148 path = ['', inkscape_path])
1150 checkProg('a SVG -> PDF converter', ['rsvg-convert -f pdf -o $$o $$i', inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-pdf=$$o'],
1151 rc_entry = [ r'''\converter svg pdf6 "%%" ""
1152 \converter svgz pdf6 "%%" ""'''],
1153 path = ['', inkscape_path])
1155 checkProg('a SVG -> EPS converter', ['rsvg-convert -f ps -o $$o $$i', inkscape_cl + ' --file=$$i --export-area-drawing --without-gui --export-eps=$$o'],
1156 rc_entry = [ r'''\converter svg eps "%%" ""
1157 \converter svgz eps "%%" ""'''],
1158 path = ['', inkscape_path])
1160 checkProg('a SVG -> PNG converter', ['rsvg-convert -f png -o $$o $$i', inkscape_cl + ' --without-gui --file=$$i --export-png=$$o'],
1161 rc_entry = [ r'''\converter svg png "%%" "",
1162 \converter svgz png "%%" ""'''],
1163 path = ['', inkscape_path])
1165 checkProg('Gnuplot', ['gnuplot'],
1166 rc_entry = [ r'''\Format gnuplot "gp, gnuplot" "Gnuplot" "" "" "" "vector" "text/plain"
1167 \converter gnuplot pdf6 "python -tt $$s/scripts/gnuplot2pdf.py $$i $$o" "needauth"''' ])
1169 # gnumeric/xls/ods to tex
1170 checkProg('a spreadsheet -> latex converter', ['ssconvert'],
1171 rc_entry = [ r'''\converter gnumeric latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1172 \converter oocalc latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1173 \converter excel latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1174 \converter excel2 latex "ssconvert --export-type=Gnumeric_html:latex $$i $$o" ""
1175 \converter gnumeric html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1176 \converter oocalc html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1177 \converter excel html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1178 \converter excel2 html_table "ssconvert --export-type=Gnumeric_html:html40frag $$i $$o" ""
1179 \converter gnumeric xhtml_table "python $$s/scripts/spreadsheet_to_docbook.py $$i $$o" ""
1180 \converter oocalc xhtml_table "python $$s/scripts/spreadsheet_to_docbook.py $$i $$o" ""
1181 \converter excel xhtml_table "python $$s/scripts/spreadsheet_to_docbook.py $$i $$o" ""
1182 \converter excel2 xhtml_table "python $$s/scripts/spreadsheet_to_docbook.py $$i $$o" ""
1185 path, lilypond = checkProg('a LilyPond -> EPS/PDF/PNG converter', ['lilypond'])
1187 version_string = cmdOutput("lilypond --version")
1188 match = re.match('GNU LilyPond (\S+)', version_string)
1190 version_number = match.groups()[0]
1191 version = version_number.split('.')
1192 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 11):
1193 addToRC(r'''\converter lilypond eps "lilypond -dbackend=eps -dsafe --ps $$i" ""
1194 \converter lilypond png "lilypond -dbackend=eps -dsafe --png $$i" ""''')
1195 addToRC(r'\converter lilypond pdf6 "lilypond -dbackend=eps -dsafe --pdf $$i" ""')
1196 logger.info('+ found LilyPond version %s.' % version_number)
1197 elif int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 6):
1198 addToRC(r'''\converter lilypond eps "lilypond -b eps --ps --safe $$i" ""
1199 \converter lilypond png "lilypond -b eps --png $$i" ""''')
1200 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 9):
1201 addToRC(r'\converter lilypond pdf6 "lilypond -b eps --pdf --safe $$i" ""')
1202 logger.info('+ found LilyPond version %s.' % version_number)
1204 logger.info('+ found LilyPond, but version %s is too old.' % version_number)
1206 logger.info('+ found LilyPond, but could not extract version number.')
1208 path, lilypond_book = checkProg('a LilyPond book (LaTeX) -> LaTeX converter', ['lilypond-book'])
1210 version_string = cmdOutput("lilypond-book --version")
1211 match = re.match('(\S+)$', version_string)
1213 version_number = match.groups()[0]
1214 version = version_number.split('.')
1215 if int(version[0]) > 2 or (len(version) > 1 and int(version[0]) == 2 and int(version[1]) >= 13):
1216 # Note: The --lily-output-dir flag is required because lilypond-book
1217 # does not process input again unless the input has changed,
1218 # even if the output format being requested is different. So
1219 # once a .eps file exists, lilypond-book won't create a .pdf
1220 # even when requested with --pdf. This is a problem if a user
1221 # clicks View PDF after having done a View DVI. To circumvent
1222 # this, use different output folders for eps and pdf outputs.
1223 addToRC(r'\converter lilypond-book latex "lilypond-book --safe --lily-output-dir=ly-eps $$i" ""')
1224 addToRC(r'\converter lilypond-book pdflatex "lilypond-book --safe --pdf --latex-program=pdflatex --lily-output-dir=ly-pdf $$i" ""')
1225 addToRC(r'\converter lilypond-book-ja platex "lilypond-book --safe --pdf --latex-program=platex --lily-output-dir=ly-pdf $$i" ""')
1226 addToRC(r'\converter lilypond-book xetex "lilypond-book --safe --pdf --latex-program=xelatex --lily-output-dir=ly-pdf $$i" ""')
1227 addToRC(r'\converter lilypond-book luatex "lilypond-book --safe --pdf --latex-program=lualatex --lily-output-dir=ly-pdf $$i" ""')
1228 addToRC(r'\converter lilypond-book dviluatex "lilypond-book --safe --latex-program=dvilualatex --lily-output-dir=ly-eps $$i" ""')
1229 logger.info('+ found LilyPond-book version %s.' % version_number)
1231 logger.info('+ found LilyPond-book, but version %s is too old.' % version_number)
1233 logger.info('+ found LilyPond-book, but could not extract version number.')
1235 checkProg('a Noteedit -> LilyPond converter', ['noteedit --export-lilypond $$i'],
1236 rc_entry = [ r'\converter noteedit lilypond "%%" ""' ])
1238 # Currently, lyxpak outputs a gzip compressed tar archive on *nix
1239 # and a zip archive on Windows.
1240 # So, we configure the appropriate version according to the platform.
1241 cmd = r'\converter lyx %s "python -tt $$s/scripts/lyxpak.py $$r/$$f" ""'
1243 addToRC(r'\Format lyxzip zip "LyX Archive (zip)" "" "" "" "document,menu=export" ""')
1244 addToRC(cmd % "lyxzip")
1246 addToRC(r'\Format lyxgz gz "LyX Archive (tar.gz)" "" "" "" "document,menu=export" ""')
1247 addToRC(cmd % "lyxgz")
1250 # FIXME: no rc_entry? comment it out
1251 # checkProg('Image converter', ['convert $$i $$o'])
1253 # Entries that do not need checkProg
1255 \converter csv lyx "python -tt $$s/scripts/csv2lyx.py $$i $$o" ""
1256 \converter fen asciichess "python -tt $$s/scripts/fen2ascii.py $$i $$o" ""
1257 \converter lyx lyx13x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.3 -o $$o $$i" ""
1258 \converter lyx lyx14x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o $$i" ""
1259 \converter lyx lyx15x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.5 -o $$o $$i" ""
1260 \converter lyx lyx16x "python -tt $$s/lyx2lyx/lyx2lyx -V 1.6 -o $$o $$i" ""
1261 \converter lyx lyx20x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.0 -o $$o $$i" ""
1262 \converter lyx lyx21x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.1 -o $$o $$i" ""
1263 \converter lyx lyx22x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.2 -o $$o $$i" ""
1264 \converter lyx lyx23x "python -tt $$s/lyx2lyx/lyx2lyx -V 2.3 -o $$o $$i" ""
1265 \converter lyx clyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c big5 $$i" ""
1266 \converter lyx jlyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_jp $$i" ""
1267 \converter lyx klyx "python -tt $$s/lyx2lyx/lyx2lyx -V 1.4 -o $$o -c euc_kr $$i" ""
1268 \converter clyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c big5 -o $$o $$i" ""
1269 \converter jlyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_jp -o $$o $$i" ""
1270 \converter klyx lyx "python -tt $$s/lyx2lyx/lyx2lyx -c euc_kr -o $$o $$i" ""
1271 \converter lyxpreview png "python -tt $$s/scripts/lyxpreview2bitmap.py --png" ""
1272 \converter lyxpreview ppm "python -tt $$s/scripts/lyxpreview2bitmap.py --ppm" ""
1273 \converter docbook docbook5 "cp $$i $$o" "xml"
1277 def checkOtherEntries():
1278 ''' entries other than Format and Converter '''
1279 checkProg('ChkTeX', ['chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38'],
1280 rc_entry = [ r'\chktex_command "%%"' ])
1281 checkProgAlternatives('BibTeX or alternative programs',
1282 ['bibtex', 'bibtex8', 'biber'],
1283 rc_entry = [ r'\bibtex_command "automatic"' ],
1284 alt_rc_entry = [ r'\bibtex_alternatives "%%"' ])
1285 checkProgAlternatives('a specific Japanese BibTeX variant',
1286 ['pbibtex', 'upbibtex', 'jbibtex', 'bibtex', 'biber'],
1287 rc_entry = [ r'\jbibtex_command "automatic"' ],
1288 alt_rc_entry = [ r'\jbibtex_alternatives "%%"' ])
1289 checkProgAlternatives('available index processors',
1290 ['texindy $$x -t $$b.ilg', 'xindex -l $$lcode', 'makeindex -c -q', 'xindy -M texindy $$x -t $$b.ilg'],
1291 rc_entry = [ r'\index_command "%%"' ],
1292 alt_rc_entry = [ r'\index_alternatives "%%"' ])
1293 checkProg('an index processor appropriate to Japanese',
1294 ['mendex -c -q', 'jmakeindex -c -q', 'makeindex -c -q'],
1295 rc_entry = [ r'\jindex_command "%%"' ])
1296 checkProg('the splitindex processor', ['splitindex.pl', 'splitindex',
1297 'splitindex.class'], rc_entry = [ r'\splitindex_command "%%"' ])
1298 checkProg('a nomenclature processor', ['makeindex'],
1299 rc_entry = [ r'\nomencl_command "makeindex -s nomencl.ist"' ])
1300 checkProg('a python-pygments driver command', ['pygmentize'],
1301 rc_entry = [ r'\pygmentize_command "%%"' ])
1302 ## FIXME: OCTAVE is not used anywhere
1303 # path, OCTAVE = checkProg('Octave', ['octave'])
1304 ## FIXME: MAPLE is not used anywhere
1305 # path, MAPLE = checkProg('Maple', ['maple'])
1306 # Add the rest of the entries (no checkProg is required)
1307 addToRC(r'''\citation_search_view "python -tt $$s/scripts/lyxpaperview.py"''')
1308 addToRC(r'''\copier fig "python -tt $$s/scripts/fig_copy.py $$i $$o"
1309 \copier pstex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1310 \copier pdftex "python -tt $$s/scripts/tex_copy.py $$i $$o $$l"
1311 \copier program "python -tt $$s/scripts/ext_copy.py $$i $$o"
1314 def _checkForClassExtension(x):
1315 '''if the extension for a latex class is not
1316 provided, add .cls to the classname'''
1318 return x.strip() + '.cls'
1322 def processLayoutFile(file):
1323 """ process layout file and get a line of result
1325 Declare lines look like this:
1327 \DeclareLaTeXClass[<requirements>]{<description>}
1329 Optionally, a \DeclareCategory line follows:
1331 \DeclareCategory{<category>}
1333 So for example (article.layout, scrbook.layout, svjog.layout)
1335 \DeclareLaTeXClass{article}
1336 \DeclareCategory{Articles}
1338 \DeclareLaTeXClass[scrbook]{book (koma-script)}
1339 \DeclareCategory{Books}
1341 \DeclareLaTeXClass[svjour,svjog.clo]{article (Springer - svjour/jog)}
1343 we'd expect this output:
1345 "article" "article" "article" "false" "article.cls" "Articles"
1346 "scrbook" "scrbook" "book (koma-script)" "false" "scrbook.cls" "Books"
1347 "svjog" "svjour" "article (Springer - svjour/jog)" "false" "svjour.cls,svjog.clo" ""
1349 classname = file.split(os.sep)[-1].split('.')[0]
1350 # return ('[a,b]', 'a', ',b,c', 'article') for \DeclareLaTeXClass[a,b,c]{article}
1351 p = re.compile('\s*#\s*\\\\DeclareLaTeXClass\s*(\[([^,]*)(,.*)*])*\s*{(.*)}\s*$')
1352 q = re.compile('\s*#\s*\\\\DeclareCategory{(.*)}\s*$')
1353 classdeclaration = ""
1354 categorydeclaration = '""'
1355 for line in open(file, 'r', encoding='utf8').readlines():
1357 qres = q.match(line)
1359 (optAll, opt, opt1, desc) = res.groups()
1362 prereq = _checkForClassExtension(classname)
1364 prereq_list = optAll[1:-1].split(',')
1365 prereq_list = list(map(_checkForClassExtension, prereq_list))
1366 prereq = ','.join(prereq_list)
1367 classdeclaration = ('"%s" "%s" "%s" "%s" "%s"'
1368 % (classname, opt, desc, 'false', prereq))
1369 if categorydeclaration != '""':
1370 return classdeclaration + " " + categorydeclaration
1371 if qres is not None:
1372 categorydeclaration = '"%s"' % (qres.groups()[0])
1373 if classdeclaration:
1374 return classdeclaration + " " + categorydeclaration
1375 if classdeclaration:
1376 return classdeclaration + " " + categorydeclaration
1377 logger.warning("Layout file " + file + " has no \\DeclareLaTeXClass line. ")
1381 def checkLatexConfig(check_config):
1382 ''' Explore the LaTeX configuration
1383 Return None (will be passed to sys.exit()) for success.
1385 msg = 'checking LaTeX configuration... '
1386 # if --without-latex-config is forced, or if there is no previous
1387 # version of textclass.lst, re-generate a default file.
1388 if not os.path.isfile('textclass.lst') or not check_config:
1389 # remove the files only if we want to regenerate
1390 removeFiles(['textclass.lst', 'packages.lst'])
1392 # Then, generate a default textclass.lst. In case configure.py
1393 # fails, we still have something to start lyx.
1394 logger.info(msg + ' default values')
1395 logger.info('+checking list of textclasses... ')
1396 tx = open('textclass.lst', 'w', encoding='utf8')
1398 # This file declares layouts and their associated definition files
1399 # (include dir. relative to the place where this file is).
1400 # It contains only default values, since chkconfig.ltx could not be run
1401 # for some reason. Run ./configure.py if you need to update it after a
1402 # configuration change.
1404 # build the list of available layout files and convert it to commands
1407 for file in (glob.glob(os.path.join('layouts', '*.layout'))
1408 + glob.glob(os.path.join(srcdir, 'layouts', '*.layout'))):
1410 if not os.path.isfile(file):
1412 # get stuff between /xxxx.layout .
1413 classname = file.split(os.sep)[-1].split('.')[0]
1415 cleanclass = classname.replace(' ', '_').replace('-', '_')
1416 # make sure the same class is not considered twice
1417 if foundClasses.count(cleanclass) == 0: # not found before
1418 foundClasses.append(cleanclass)
1419 retval = processLayoutFile(file)
1421 tx.write(retval + os.linesep)
1423 logger.info('\tdone')
1424 if not os.path.isfile('packages.lst') or not check_config:
1425 logger.info('+generating default list of packages... ')
1426 removeFiles(['packages.lst'])
1427 tx = open('packages.lst', 'w', encoding='utf8')
1429 logger.info('\tdone')
1430 if not check_config:
1432 # the following will generate textclass.lst.tmp, and packages.lst.tmp
1433 logger.info(msg + '\tauto')
1434 removeFiles(['chkconfig.classes', 'chkconfig.vars', 'chklayouts.tex',
1435 'wrap_chkconfig.ltx'])
1437 if not os.path.isfile( 'chkconfig.ltx' ):
1438 shutil.copyfile( os.path.join(srcdir, 'chkconfig.ltx'), 'chkconfig.ltx' )
1440 writeToFile('wrap_chkconfig.ltx', '\\def\\hasdocbook{yes}\n\\input{chkconfig.ltx}\n')
1441 # Construct the list of classes to test for.
1442 # build the list of available layout files and convert it to commands
1444 declare = re.compile('\\s*#\\s*\\\\DeclareLaTeXClass\\s*(\[([^,]*)(,.*)*\])*\\s*{(.*)}\\s*$')
1445 category = re.compile('\\s*#\\s*\\\\DeclareCategory{(.*)}\\s*$')
1446 empty = re.compile('\\s*$')
1447 testclasses = list()
1448 for file in (glob.glob( os.path.join('layouts', '*.layout') )
1449 + glob.glob( os.path.join(srcdir, 'layouts', '*.layout' ) ) ):
1450 nodeclaration = False
1451 if not os.path.isfile(file):
1453 classname = file.split(os.sep)[-1].split('.')[0]
1457 for line in open(file, 'r', encoding='utf8').readlines():
1458 if not empty.match(line) and line[0] != '#'[0]:
1460 logger.warning("Failed to find valid \Declare line "
1461 "for layout file `%s'.\n\t=> Skipping this file!" % file)
1462 nodeclaration = True
1463 # A class, but no category declaration. Just break.
1465 if declare.match(line) is not None:
1466 decline = "\\TestDocClass{%s}{%s}" % (classname, line[1:].strip())
1467 testclasses.append(decline)
1468 elif category.match(line) is not None:
1469 catline = ("\\DeclareCategory{%s}{%s}"
1470 % (classname, category.match(line).groups()[0]))
1471 testclasses.append(catline)
1472 if catline == "" or decline == "":
1477 except UnicodeDecodeError:
1478 logger.warning("**************************************************\n"
1479 "Layout file '%s'\n"
1480 "cannot be decoded in utf-8.\n"
1481 "Please check if the file has the correct encoding.\n"
1482 "Skipping this file!\n"
1483 "**************************************************" % file)
1486 cl = open('chklayouts.tex', 'w', encoding='utf8')
1487 for line in testclasses:
1488 cl.write(line + '\n')
1491 # we have chklayouts.tex, then process it
1492 latex_out = cmdOutput(LATEX + ' wrap_chkconfig.ltx', True)
1494 line = latex_out.readline()
1497 if line.startswith('+'):
1498 logger.info(line.strip())
1499 # if the command succeeds, None will be returned
1500 ret = latex_out.close()
1502 # remove the copied file
1504 removeFiles( [ 'chkconfig.ltx' ] )
1506 # values in chkconfig were only used to set
1507 # \font_encoding, which is obsolete
1509 # for line in open('chkconfig.vars').readlines():
1510 # key, val = re.sub('-', '_', line).split('=')
1512 # values[key] = val.strip("'")
1513 # if configure successed, move textclass.lst.tmp to textclass.lst
1514 # and packages.lst.tmp to packages.lst
1515 if (os.path.isfile('textclass.lst.tmp')
1516 and len(open('textclass.lst.tmp', encoding='utf8').read()) > 0
1517 and os.path.isfile('packages.lst.tmp')
1518 and len(open('packages.lst.tmp', encoding='utf8').read()) > 0):
1519 shutil.move('textclass.lst.tmp', 'textclass.lst')
1520 shutil.move('packages.lst.tmp', 'packages.lst')
1524 def checkModulesConfig():
1525 removeFiles(['lyxmodules.lst', 'chkmodules.tex'])
1527 logger.info('+checking list of modules... ')
1528 tx = open('lyxmodules.lst', 'w', encoding='utf8')
1529 tx.write('''## This file declares modules and their associated definition files.
1530 ## It has been automatically generated by configure
1531 ## Use "Options/Reconfigure" if you need to update it after a
1532 ## configuration change.
1533 ## "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category" "Local"
1536 # build the list of available modules
1538 # note that this searches the local directory first, then the
1539 # system directory. that way, we pick up the user's version first.
1540 for file in (glob.glob( os.path.join('layouts', '*.module') )
1541 + glob.glob( os.path.join(srcdir, 'layouts', '*.module' ) ) ):
1544 if not os.path.isfile(file):
1547 filename = file.split(os.sep)[-1]
1548 filename = filename[:-7]
1549 if seen.count(filename):
1552 seen.append(filename)
1554 retval = processModuleFile(file, filename)
1557 except UnicodeDecodeError:
1558 logger.warning("**************************************************\n"
1559 "Module file '%s'\n"
1560 "cannot be decoded in utf-8.\n"
1561 "Please check if the file has the correct encoding.\n"
1562 "Skipping this file!\n"
1563 "**************************************************" % filename)
1565 logger.info('\tdone')
1568 def processModuleFile(file, filename):
1569 ''' process module file and get a line of result
1571 The top of a module file should look like this:
1572 #\DeclareLyXModule[LaTeX Packages]{ModuleName}
1574 #...body of description...
1576 #Requires: [list of required modules]
1577 #Excludes: [list of excluded modules]
1578 #Category: [category name]
1579 The last three lines are optional (though do give a category).
1581 "ModuleName" "filename" "Description" "Packages" "Requires" "Excludes" "Category"
1583 remods = re.compile('\s*#\s*\\\\DeclareLyXModule\s*(?:\[([^]]*?)\])?{(.*)}')
1584 rereqs = re.compile('\s*#+\s*Requires: (.*)')
1585 reexcs = re.compile('\s*#+\s*Excludes: (.*)')
1586 recaty = re.compile('\\s*#\\s*\\\\DeclareCategory{(.*)}\\s*$')
1587 redbeg = re.compile('\s*#+\s*DescriptionBegin\s*$')
1588 redend = re.compile('\s*#+\s*DescriptionEnd\s*$')
1590 modname = desc = pkgs = req = excl = catgy = ""
1591 readingDescription = False
1594 for line in open(file, 'r', encoding='utf8').readlines():
1595 if readingDescription:
1596 res = redend.match(line)
1598 readingDescription = False
1599 desc = " ".join(descLines)
1601 desc = desc.replace('"', '\\"')
1603 descLines.append(line[1:].strip())
1605 res = redbeg.match(line)
1607 readingDescription = True
1609 res = remods.match(line)
1611 (pkgs, modname) = res.groups()
1615 tmp = [s.strip() for s in pkgs.split(",")]
1616 pkgs = ",".join(tmp)
1618 res = rereqs.match(line)
1621 tmp = [s.strip() for s in req.split("|")]
1624 res = reexcs.match(line)
1627 tmp = [s.strip() for s in excl.split("|")]
1628 excl = "|".join(tmp)
1630 res = recaty.match(line)
1632 catgy = res.group(1)
1636 logger.warning("Module file without \DeclareLyXModule line. ")
1640 # this module has some latex dependencies:
1641 # append the dependencies to chkmodules.tex,
1642 # which is \input'ed by chkconfig.ltx
1643 testpackages = list()
1644 for pkg in pkgs.split(","):
1646 # this is a converter dependency: skip
1648 if pkg.endswith(".sty"):
1650 testpackages.append("\\TestPackage{%s}" % pkg)
1651 cm = open('chkmodules.tex', 'a', encoding='utf8')
1652 for line in testpackages:
1653 cm.write(line + '\n')
1657 if (file.startswith(srcdir)):
1659 return ('"%s" "%s" "%s" "%s" "%s" "%s" "%s" "%s"\n'
1660 % (modname, filename, desc, pkgs, req, excl, catgy, local))
1663 def checkCiteEnginesConfig():
1664 removeFiles(['lyxciteengines.lst', 'chkciteengines.tex'])
1666 logger.info('+checking list of cite engines... ')
1667 tx = open('lyxciteengines.lst', 'w', encoding='utf8')
1668 tx.write('''## This file declares cite engines and their associated definition files.
1669 ## It has been automatically generated by configure
1670 ## Use "Options/Reconfigure" if you need to update it after a
1671 ## configuration change.
1672 ## "CiteEngineName" "filename" "CiteEngineType" "CiteFramework" "DefaultBiblio" "Description" "Packages"
1675 # build the list of available modules
1677 # note that this searches the local directory first, then the
1678 # system directory. that way, we pick up the user's version first.
1679 for file in glob.glob( os.path.join('citeengines', '*.citeengine') ) + \
1680 glob.glob( os.path.join(srcdir, 'citeengines', '*.citeengine' ) ) :
1683 if not os.path.isfile(file):
1686 filename = file.split(os.sep)[-1]
1687 filename = filename[:-11]
1688 if seen.count(filename):
1691 seen.append(filename)
1692 retval = processCiteEngineFile(file, filename)
1696 logger.info('\tdone')
1699 def processCiteEngineFile(file, filename):
1700 ''' process cite engines file and get a line of result
1702 The top of a cite engine file should look like this:
1703 #\DeclareLyXCiteEngine[LaTeX Packages]{CiteEngineName}
1705 #...body of description...
1708 "CiteEngineName" "filename" "CiteEngineType" "CiteFramework" "DefaultBiblio" "Description" "Packages"
1710 remods = re.compile('\s*#\s*\\\\DeclareLyXCiteEngine\s*(?:\[([^]]*?)\])?{(.*)}')
1711 redbeg = re.compile('\s*#+\s*DescriptionBegin\s*$')
1712 redend = re.compile('\s*#+\s*DescriptionEnd\s*$')
1713 recet = re.compile('\s*CiteEngineType\s*(.*)')
1714 redb = re.compile('\s*DefaultBiblio\s*(.*)')
1715 resfm = re.compile('\s*CiteFramework\s*(.*)')
1717 modname = desc = pkgs = cet = db = cfm = ""
1718 readingDescription = False
1721 for line in open(file, 'r', encoding='utf8').readlines():
1722 if readingDescription:
1723 res = redend.match(line)
1725 readingDescription = False
1726 desc = " ".join(descLines)
1728 desc = desc.replace('"', '\\"')
1730 descLines.append(line[1:].strip())
1732 res = redbeg.match(line)
1734 readingDescription = True
1736 res = remods.match(line)
1738 (pkgs, modname) = res.groups()
1742 tmp = [s.strip() for s in pkgs.split(",")]
1743 pkgs = ",".join(tmp)
1745 res = recet.match(line)
1749 res = redb.match(line)
1753 res = resfm.match(line)
1759 logger.warning("Cite Engine File file without \DeclareLyXCiteEngine line. ")
1763 # this cite engine has some latex dependencies:
1764 # append the dependencies to chkciteengines.tex,
1765 # which is \input'ed by chkconfig.ltx
1766 testpackages = list()
1767 for pkg in pkgs.split(","):
1769 # this is a converter dependency: skip
1771 if pkg.endswith(".sty"):
1773 testpackages.append("\\TestPackage{%s}" % pkg)
1774 cm = open('chkciteengines.tex', 'a', encoding='utf8')
1775 for line in testpackages:
1776 cm.write(line + '\n')
1779 return ('"%s" "%s" "%s" "%s" "%s" "%s" "%s"\n'
1780 % (modname, filename, cet, cfm, db, desc, pkgs))
1783 def checkXTemplates():
1784 removeFiles(['xtemplates.lst'])
1786 logger.info('+checking list of external templates... ')
1787 tx = open('xtemplates.lst', 'w', encoding='utf8')
1788 tx.write('''## This file lists external templates.
1789 ## It has been automatically generated by configure
1790 ## Use "Options/Reconfigure" if you need to update it after a
1791 ## configuration change.
1794 # build the list of available templates
1796 # note that this searches the local directory first, then the
1797 # system directory. that way, we pick up the user's version first.
1798 for file in glob.glob( os.path.join('xtemplates', '*.xtemplate') ) + \
1799 glob.glob( os.path.join(srcdir, 'xtemplates', '*.xtemplate' ) ) :
1802 if not os.path.isfile(file):
1805 filename = file.split(os.sep)[-1]
1806 if seen.count(filename):
1809 seen.append(filename)
1811 tx.write(filename + "\n")
1813 logger.info('\tdone')
1816 def checkTeXAllowSpaces():
1817 ''' Let's check whether spaces are allowed in TeX file names '''
1818 tex_allows_spaces = 'false'
1819 if lyx_check_config:
1820 msg = "Checking whether TeX allows spaces in file names... "
1821 writeToFile('a b.tex', r'\message{working^^J}' )
1823 if os.name == 'nt' or sys.platform == 'cygwin':
1824 latex_out = cmdOutput(LATEX + r""" "\nonstopmode\input{\"a b\"}\makeatletter\@@end" """)
1826 latex_out = cmdOutput(LATEX + r""" '\nonstopmode\input{"a b"}\makeatletter\@@end' """)
1829 if 'working' in latex_out:
1830 logger.info(msg + 'yes')
1831 tex_allows_spaces = 'true'
1833 logger.info(msg + 'no')
1834 tex_allows_spaces = 'false'
1835 addToRC(r'\tex_allows_spaces ' + tex_allows_spaces)
1836 removeFiles( [ 'a b.tex', 'a b.log', 'texput.log' ])
1839 def rescanTeXFiles():
1840 ''' Run kpsewhich to update information about TeX files '''
1841 logger.info("+Indexing TeX files... ")
1842 tfscript = os.path.join(srcdir, 'scripts', 'TeXFiles.py')
1843 if not os.path.isfile(tfscript):
1844 logger.error("configure: error: cannot find TeXFiles.py script")
1846 interpreter = sys.executable
1847 if interpreter == '':
1848 interpreter = "python"
1849 tfp = cmdOutput('"%s" -tt "%s"' % (interpreter, tfscript))
1851 logger.info("\tdone")
1854 def removeTempFiles():
1856 if not lyx_keep_temps:
1857 removeFiles(['chkconfig.vars', 'chklatex.ltx', 'chklatex.log',
1858 'chklayouts.tex', 'chkmodules.tex', 'chkciteengines.tex',
1859 'missfont.log', 'wrap_chkconfig.ltx', 'wrap_chkconfig.log'])
1862 if __name__ == '__main__':
1863 lyx_check_config = True
1864 lyx_kpsewhich = True
1865 outfile = 'lyxrc.defaults'
1866 lyxrc_fileformat = 34
1868 lyx_keep_temps = False
1871 logger.info("+Running LyX configure with Python %s.%s.%s", sys.version_info[0], sys.version_info[1], sys.version_info[2])
1872 ## Parse the command line
1873 for op in sys.argv[1:]: # default shell/for list is $*, the options
1874 if op in [ '-help', '--help', '-h' ]:
1875 print('''Usage: configure [options]
1877 --help show this help lines
1878 --keep-temps keep temporary files (for debug. purposes)
1879 --without-kpsewhich do not update TeX files information via kpsewhich
1880 --without-latex-config do not run LaTeX to determine configuration
1881 --with-version-suffix=suffix suffix of binary installed files
1882 --binary-dir=directory directory of binary installed files
1885 elif op == '--without-kpsewhich':
1886 lyx_kpsewhich = False
1887 elif op == '--without-latex-config':
1888 lyx_check_config = False
1889 elif op == '--keep-temps':
1890 lyx_keep_temps = True
1891 elif op[0:22] == '--with-version-suffix=': # never mind if op is not long enough
1892 version_suffix = op[22:]
1893 elif op[0:13] == '--binary-dir=':
1894 lyx_binary_dir = op[13:]
1896 print("Unknown option %s" % op)
1899 # check if we run from the right directory
1900 srcdir = os.path.dirname(sys.argv[0])
1903 if not os.path.isfile( os.path.join(srcdir, 'chkconfig.ltx') ):
1904 logger.error("configure: error: cannot find chkconfig.ltx script")
1907 if sys.platform == 'darwin' and len(version_suffix) > 0:
1910 dtl_tools = checkDTLtools()
1911 ## Write the first part of outfile
1912 writeToFile(outfile, '''# This file has been automatically generated by LyX' lib/configure.py
1913 # script. It contains default settings that have been determined by
1914 # examining your system. PLEASE DO NOT MODIFY ANYTHING HERE! If you
1915 # want to customize LyX, use LyX' Preferences dialog or modify directly
1916 # the "preferences" file instead. Any setting in that file will
1917 # override the values given here.
1921 ''' % lyxrc_fileformat)
1923 LATEX = checkLatex(dtl_tools)
1924 # check java and perl before any checkProg that may require them
1925 java = checkProg('a java interpreter', ['java'])[1]
1926 perl = checkProg('a perl interpreter', ['perl'])[1]
1927 (inkscape_path, inkscape_gui) = os.path.split(checkInkscape())
1928 # On Windows, we need to call the "inkscape.com" wrapper
1929 # for command line purposes. Other OSes do not differentiate.
1930 inkscape_cl = inkscape_gui
1932 inkscape_cl = inkscape_gui.replace('.exe', '.com')
1933 inkscape_stable = checkInkscapeStable()
1934 checkFormatEntries(dtl_tools)
1935 checkConverterEntries()
1936 checkTeXAllowSpaces()
1937 windows_style_tex_paths = checkTeXPaths()
1938 if windows_style_tex_paths:
1939 addToRC(r'\tex_expects_windows_paths %s' % windows_style_tex_paths)
1943 checkModulesConfig()
1944 checkCiteEnginesConfig()
1946 # --without-latex-config can disable lyx_check_config
1947 ret = checkLatexConfig(lyx_check_config and LATEX)
1949 # The return error code can be 256. Because most systems expect an error code
1950 # in the range 0-127, 256 can be interpretted as 'success'. Because we expect
1951 # a None for success, 'ret is not None' is used to exit.
1952 sys.exit(ret is not None)