3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Alfredo Braunstein
8 * \author Lars Gullik Bjønnes
9 * \author Jean Marc Lasgouttes
10 * \author Angus Leeming
12 * \author André Pönitz
14 * Full author contact details are available in file CREDITS.
22 #include "buffer_funcs.h"
23 #include "bufferparams.h"
24 #include "converter.h"
29 #include "output_plaintext.h"
30 #include "outputparams.h"
31 #include "frontends/Alert.h"
33 #include "support/filetools.h"
34 #include "support/lyxlib.h"
35 #include "support/package.h"
37 #include <boost/filesystem/operations.hpp>
42 using support::addName;
43 using support::bformat;
44 using support::changeExtension;
45 using support::contains;
46 using support::makeAbsPath;
47 using support::makeDisplayPath;
48 using support::onlyFilename;
49 using support::onlyPath;
50 using support::package;
51 using support::prefixIs;
57 namespace Alert = frontend::Alert;
58 namespace fs = boost::filesystem;
62 vector<string> const Backends(Buffer const & buffer)
65 if (buffer.params().getLyXTextClass().isTeXClassAvailable()) {
66 v.push_back(bufferFormat(buffer));
67 // FIXME: Don't hardcode format names here, but use a flag
68 if (v.back() == "latex")
69 v.push_back("pdflatex");
77 /// ask the user what to do if a file already exists
78 int checkOverwrite(string const & filename)
80 if (fs::exists(filename)) {
81 docstring text = bformat(_("The file %1$s already exists.\n\n"
82 "Do you want to over-write that file?"),
83 makeDisplayPath(filename));
84 return Alert::prompt(_("Over-write file?"),
86 _("&Over-write"), _("Over-write &all"),
100 /** copy file \p sourceFile to \p destFile. If \p force is false, the user
101 * will be asked before existing files are overwritten.
103 * - SUCCESS if this file got copied
104 * - FORCE if subsequent calls should not ask for confirmation before
105 * overwriting files anymore.
106 * - CANCEL if the export should be cancelled
108 CopyStatus copyFile(string const & format,
109 string const & sourceFile, string const & destFile,
110 string const & latexFile, bool force)
112 CopyStatus ret = force ? FORCE : SUCCESS;
114 // Only copy files that are in our tmp dir, all other files would
115 // overwrite themselves. This check could be changed to
116 // boost::filesystem::equivalent(sourceFile, destFile) if export to
117 // other directories than the document directory is desired.
118 if (!prefixIs(onlyPath(sourceFile), package().temp_dir()))
122 switch(checkOverwrite(destFile)) {
134 Mover const & mover = movers(format);
135 if (!mover.copy(sourceFile, destFile, latexFile))
136 Alert::error(_("Couldn't copy file"),
137 bformat(_("Copying %1$s to %2$s failed."),
138 makeDisplayPath(sourceFile),
139 makeDisplayPath(destFile)));
147 bool Exporter::Export(Buffer * buffer, string const & format,
148 bool put_in_tempdir, string & result_file)
150 string backend_format;
151 OutputParams runparams;
152 runparams.flavor = OutputParams::LATEX;
153 runparams.linelen = lyxrc.ascii_linelen;
154 vector<string> backends = Backends(*buffer);
155 // FIXME: Without this test export to lyx13 would be through
156 // latex -> lyx -> lyx13, because the first backend below with a
157 // working conversion path is used. We should replace this test and
158 // the explicit loop below with a method
159 // getShortestPath(vector<string> const & from, string const & to)
160 // which returns the shortest path from one of the formats in 'from'
162 if (format == "lyx13x" && !converters.getPath("lyx", format).empty())
163 backend_format = "lyx";
164 else if (find(backends.begin(), backends.end(), format) == backends.end()) {
165 for (vector<string>::const_iterator it = backends.begin();
166 it != backends.end(); ++it) {
167 Graph::EdgePath p = converters.getPath(*it, format);
169 runparams.flavor = converters.getFlavor(p);
170 backend_format = *it;
174 if (backend_format.empty()) {
175 Alert::error(_("Couldn't export file"),
176 bformat(_("No information for exporting the format %1$s."),
177 formats.prettyName(format)));
181 backend_format = format;
182 // FIXME: Don't hardcode format names here, but use a flag
183 if (backend_format == "pdflatex")
184 runparams.flavor = OutputParams::PDFLATEX;
187 string filename = buffer->getLatexName(false);
188 filename = addName(buffer->temppath(), filename);
189 filename = changeExtension(filename,
190 formats.extension(backend_format));
193 if (backend_format == "text")
194 writeFileAscii(*buffer, filename, runparams);
196 else if (backend_format == "lyx")
197 buffer->writeFile(filename);
199 else if (buffer->isDocBook()) {
200 runparams.nice = !put_in_tempdir;
201 buffer->makeDocBookFile(filename, runparams);
204 else if (backend_format == format) {
205 runparams.nice = true;
206 buffer->makeLaTeXFile(filename, string(), runparams);
207 } else if (!lyxrc.tex_allows_spaces
208 && contains(buffer->filePath(), ' ')) {
209 Alert::error(_("File name error"),
210 _("The directory path to the document cannot contain spaces."));
213 runparams.nice = false;
214 buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
217 string const error_type = (format == "program")? "Build" : bufferFormat(*buffer);
218 bool const success = converters.convert(buffer, filename, filename,
219 backend_format, format, result_file,
220 buffer->errorList(error_type));
221 // Emit the signal to show the error list.
222 buffer->errors(error_type);
226 if (!put_in_tempdir) {
227 string const tmp_result_file = result_file;
228 result_file = changeExtension(buffer->fileName(),
229 formats.extension(format));
230 // We need to copy referenced files (e. g. included graphics
231 // if format == "dvi") to the result dir.
232 vector<ExportedFile> const files =
233 runparams.exportdata->externalFiles(format);
234 string const dest = onlyPath(result_file);
235 CopyStatus status = SUCCESS;
236 for (vector<ExportedFile>::const_iterator it = files.begin();
237 it != files.end() && status != CANCEL; ++it) {
239 formats.getFormatFromFile(it->sourceName);
240 status = copyFile(fmt, it->sourceName,
241 makeAbsPath(it->exportName, dest),
242 it->exportName, status == FORCE);
244 if (status == CANCEL) {
245 buffer->message(_("Document export cancelled."));
246 } else if (fs::exists(tmp_result_file)) {
247 // Finally copy the main file
248 status = copyFile(format, tmp_result_file,
249 result_file, result_file,
251 buffer->message(bformat(_("Document exported as %1$s "
253 formats.prettyName(format),
254 makeDisplayPath(result_file)));
256 // This must be a dummy converter like fax (bug 1888)
257 buffer->message(bformat(_("Document exported as %1$s"),
258 formats.prettyName(format)));
266 bool Exporter::Export(Buffer * buffer, string const & format,
270 return Export(buffer, format, put_in_tempdir, result_file);
274 bool Exporter::preview(Buffer * buffer, string const & format)
277 if (!Export(buffer, format, true, result_file))
279 return formats.view(*buffer, result_file, format);
283 bool Exporter::isExportable(Buffer const & buffer, string const & format)
285 vector<string> backends = Backends(buffer);
286 for (vector<string>::const_iterator it = backends.begin();
287 it != backends.end(); ++it)
288 if (converters.isReachable(*it, format))
294 vector<Format const *> const
295 Exporter::getExportableFormats(Buffer const & buffer, bool only_viewable)
297 vector<string> backends = Backends(buffer);
298 vector<Format const *> result =
299 converters.getReachable(backends[0], only_viewable, true);
300 for (vector<string>::const_iterator it = backends.begin() + 1;
301 it != backends.end(); ++it) {
302 vector<Format const *> r =
303 converters.getReachable(*it, only_viewable, false);
304 result.insert(result.end(), r.begin(), r.end());
310 ExportedFile::ExportedFile(string const & s, string const & e) :
311 sourceName(s), exportName(e) {}
314 bool operator==(ExportedFile const & f1, ExportedFile const & f2)
316 return f1.sourceName == f2.sourceName &&
317 f1.exportName == f2.exportName;
322 void ExportData::addExternalFile(string const & format,
323 string const & sourceName,
324 string const & exportName)
326 BOOST_ASSERT(support::absolutePath(sourceName));
328 // Make sure that we have every file only once, otherwise copyFile()
329 // would ask several times if it should overwrite a file.
330 vector<ExportedFile> & files = externalfiles[format];
331 ExportedFile file(sourceName, exportName);
332 if (find(files.begin(), files.end(), file) == files.end())
333 files.push_back(file);
337 void ExportData::addExternalFile(string const & format,
338 string const & sourceName)
340 addExternalFile(format, sourceName, onlyFilename(sourceName));
344 vector<ExportedFile> const
345 ExportData::externalFiles(string const & format) const
347 FileMap::const_iterator cit = externalfiles.find(format);
348 if (cit != externalfiles.end())
350 return vector<ExportedFile>();