3 # file lyxpreview_tools.py
4 # This file is part of LyX, the document processor.
5 # Licence details can be found in the file COPYING.
8 # Full author contact details are available in file CREDITS
10 # and with much help testing the code under Windows from
11 # Paul A. Rubin, rubin@msu.edu.
13 # A repository of the following functions, used by the lyxpreview2xyz scripts.
14 # copyfileobj, error, find_exe, find_exe_or_terminate, make_texcolor, mkstemp,
15 # run_command, warning
17 import os, re, string, sys, tempfile
32 sys.stderr.write("Consider installing the PyWin extension modules " \
33 "if you're irritated by windows appearing briefly.\n")
38 sys.stderr.write(message + '\n')
42 sys.stderr.write(message + '\n')
46 def make_texcolor(hexcolor, graphics):
47 # Test that the input string contains 6 hexadecimal chars.
48 hexcolor_re = re.compile("^[0-9a-fA-F]{6}$")
49 if not hexcolor_re.match(hexcolor):
50 error("Cannot convert color '%s'" % hexcolor)
52 red = float(string.atoi(hexcolor[0:2], 16)) / 255.0
53 green = float(string.atoi(hexcolor[2:4], 16)) / 255.0
54 blue = float(string.atoi(hexcolor[4:6], 16)) / 255.0
57 return "%f,%f,%f" % (red, green, blue)
59 return "rgb %f %f %f" % (red, green, blue)
62 def find_exe(candidates, path):
64 if "PATHEXT" in os.environ:
65 extlist = extlist + os.environ["PATHEXT"].split(os.pathsep)
67 for prog in candidates:
68 for directory in path:
70 full_path = os.path.join(directory, prog + ext)
71 if os.access(full_path, os.X_OK):
72 # The thing is in the PATH already (or we wouldn't
73 # have found it). Return just the basename to avoid
74 # problems when the path to the executable contains
76 return os.path.basename(full_path)
81 def find_exe_or_terminate(candidates, path):
82 exe = find_exe(candidates, path)
84 error("Unable to find executable from '%s'" % string.join(candidates))
89 def run_command_popen(cmd):
90 handle = os.popen(cmd, 'r')
91 cmd_stdout = handle.read()
92 cmd_status = handle.close()
94 return cmd_status, cmd_stdout
97 def run_command_win32(cmd):
98 sa = win32security.SECURITY_ATTRIBUTES()
99 sa.bInheritHandle = True
100 stdout_r, stdout_w = win32pipe.CreatePipe(sa, 0)
102 si = win32process.STARTUPINFO()
103 si.dwFlags = (win32process.STARTF_USESTDHANDLES
104 | win32process.STARTF_USESHOWWINDOW)
105 si.wShowWindow = win32con.SW_HIDE
106 si.hStdOutput = stdout_w
108 process, thread, pid, tid = \
109 win32process.CreateProcess(None, cmd, None, None, True,
114 # Must close the write handle in this process, or ReadFile will hang.
117 # Read the pipe until we get an error (including ERROR_BROKEN_PIPE,
118 # which is okay because it happens when child process ends).
123 hr, buffer = win32file.ReadFile(stdout_r, 4096)
124 if hr != winerror.ERROR_IO_PENDING:
127 except pywintypes.error, e:
128 if e.args[0] != winerror.ERROR_BROKEN_PIPE:
135 # Everything is okay --- the called process has closed the pipe.
136 # For safety, check that the process ended, then pick up its exit code.
137 win32event.WaitForSingleObject(process, win32event.INFINITE)
138 if win32process.GetExitCodeProcess(process):
144 def run_command(cmd):
145 if use_win32_modules:
146 return run_command_win32(cmd)
148 return run_command_popen(cmd)
151 def get_version_info():
152 version_re = re.compile("([0-9])\.([0-9])")
154 match = version_re.match(sys.version)
156 error("Unable to extract version info from 'sys.version'")
158 return string.atoi(match.group(1)), string.atoi(match.group(2))
161 def copyfileobj(fsrc, fdst, rewind=0, length=16*1024):
162 """copy data from file-like object fsrc to file-like object fdst"""
168 buf = fsrc.read(length)
175 """clone of tempfile.TemporaryFile to use with python < 2.0."""
176 # Cache the unlinker so we don't get spurious errors at shutdown
177 # when the module-level "os" is None'd out. Note that this must
178 # be referenced as self.unlink, because the name TempFile
179 # may also get None'd out before __del__ is called.
183 self.filename = tempfile.mktemp()
184 self.file = open(self.filename,"w+b")
185 self.close_called = 0
188 if not self.close_called:
189 self.close_called = 1
191 self.unlink(self.filename)
196 def read(self, size = -1):
197 return self.file.read(size)
199 def write(self, line):
200 return self.file.write(line)
202 def seek(self, offset):
203 return self.file.seek(offset)
206 return self.file.flush()
210 """create a secure temporary file and return its object-like file"""
211 major, minor = get_version_info()
213 if major >= 2 and minor >= 0:
214 return tempfile.TemporaryFile()
218 def write_metrics_info(metrics_info, metrics_file):
219 metrics = open(metrics_file, 'w')
220 for metric in metrics_info:
221 metrics.write("Snippet %s %f\n" % metric)
224 # Reads a .tex files and create an identical file but only with
225 # pages whose index is in pages_to_keep
226 def filter_pages(source_path, destination_path, pages_to_keep):
227 source_file = open(source_path, "r")
228 destination_file = open(destination_path, "w")
232 for line in source_file:
233 # We found a new page
234 if line.startswith("\\begin{preview}"):
236 # If the page index isn't in pages_to_keep we don't copy it
237 skip_page = page_index not in pages_to_keep
240 destination_file.write(line)
242 # End of a page, we reset the skip_page bool
243 if line.startswith("\\end{preview}"):
246 destination_file.close()
249 # Joins two metrics list, that is a list of tuple (page_index, metric)
250 # new_page_indexes contains the original page number of the pages in new_metrics
251 # e.g. new_page_indexes[3] == 14 means that the 4th item in new_metrics is the 15th in the original counting
252 # original_bitmap and destination_bitmap are file name models used to rename the new files
253 # e.g. image_new%d.png and image_%d.png
254 def join_metrics_and_rename(original_metrics, new_metrics, new_page_indexes, original_bitmap, destination_bitmap):
256 for (index, metric) in new_metrics:
257 # If the file exists we rename it
258 if os.path.isfile(original_bitmap % (index)):
259 os.rename(original_bitmap % (index), destination_bitmap % new_page_indexes[index-1])
261 # Extract the original page index
262 index = new_page_indexes[index-1]
263 # Goes through the array until the end is reached or the correct index is found
264 while legacy_index < len(original_metrics) and original_metrics[legacy_index][0] < index:
267 # Add or update the metric for this page
268 if legacy_index < len(original_metrics) and original_metrics[legacy_index][0] == index:
269 original_metrics[legacy_index] = (index, metric)
271 original_metrics.insert(legacy_index, (index, metric))