]> git.lyx.org Git - lyx.git/blobdiff - src/exporter.C
* filetools.[Ch]: Make functions that start with a capital
[lyx.git] / src / exporter.C
index 6ca03d33350d0ea672b0f886296d56fdd4121c4d..076e09a09b163d5b93fdb5c0344b55171da7c7f4 100644 (file)
 
 #include "buffer.h"
 #include "buffer_funcs.h"
+#include "bufferparams.h"
 #include "converter.h"
 #include "format.h"
 #include "gettext.h"
-#include "latexrunparams.h"
 #include "lyxrc.h"
-
+#include "mover.h"
+#include "output_plaintext.h"
+#include "outputparams.h"
 #include "frontends/Alert.h"
 
 #include "support/filetools.h"
+#include "support/lyxlib.h"
+#include "support/package.h"
 
-using namespace lyx::support;
+#include <boost/filesystem/operations.hpp>
+
+using lyx::support::addName;
+using lyx::support::bformat;
+using lyx::support::changeExtension;
+using lyx::support::contains;
+using lyx::support::makeAbsPath;
+using lyx::support::makeDisplayPath;
+using lyx::support::onlyFilename;
+using lyx::support::onlyPath;
+using lyx::support::package;
+using lyx::support::prefixIs;
 
-using std::vector;
 using std::find;
+using std::string;
+using std::vector;
 
+namespace fs = boost::filesystem;
 
 namespace {
 
 vector<string> const Backends(Buffer const & buffer)
 {
        vector<string> v;
-       if (buffer.params.getLyXTextClass().isTeXClassAvailable())
+       if (buffer.params().getLyXTextClass().isTeXClassAvailable()) {
                v.push_back(BufferFormat(buffer));
+               // FIXME: Don't hardcode format names here, but use a flag
+               if (v.back() == "latex")
+                       v.push_back("pdflatex");
+       }
        v.push_back("text");
+       v.push_back("lyx");
        return v;
 }
 
+
+/// ask the user what to do if a file already exists
+int checkOverwrite(string const & filename)
+{
+       if (fs::exists(filename)) {
+               string text = bformat(_("The file %1$s already exists.\n\n"
+                                       "Do you want to over-write that file?"),
+                                     makeDisplayPath(filename));
+               return Alert::prompt(_("Over-write file?"),
+                                    text, 0, 2,
+                                    _("&Over-write"), _("Over-write &all"),
+                                    _("&Cancel export"));
+       }
+       return 0;
+}
+
+
+enum CopyStatus {
+       SUCCESS,
+       FORCE,
+       CANCEL
+};
+
+
+/** copy file \p sourceFile to \p destFile. If \p force is false, the user
+ *  will be asked before existing files are overwritten.
+ *  \return
+ *  - SUCCESS if this file got copied
+ *  - FORCE   if subsequent calls should not ask for confirmation before
+ *            overwriting files anymore.
+ *  - CANCEL  if the export should be cancelled
+ */
+CopyStatus copyFile(string const & format,
+                   string const & sourceFile, string const & destFile,
+                   string const & latexFile, bool force)
+{
+       CopyStatus ret = force ? FORCE : SUCCESS;
+
+       // Only copy files that are in our tmp dir, all other files would
+       // overwrite themselves. This check could be changed to
+       // boost::filesystem::equivalent(sourceFile, destFile) if export to
+       // other directories than the document directory is desired.
+       if (!prefixIs(onlyPath(sourceFile), package().temp_dir()))
+               return ret;
+
+       if (!force) {
+               switch(checkOverwrite(destFile)) {
+               case 0:
+                       ret = SUCCESS;
+                       break;
+               case 1:
+                       ret = FORCE;
+                       break;
+               default:
+                       return CANCEL;
+               }
+       }
+
+       Mover const & mover = movers(format);
+       if (!mover.copy(sourceFile, destFile, latexFile))
+               Alert::error(_("Couldn't copy file"),
+                            bformat(_("Copying %1$s to %2$s failed."),
+                                    makeDisplayPath(sourceFile),
+                                    makeDisplayPath(destFile)));
+
+       return ret;
+}
+
 } //namespace anon
 
 
@@ -54,17 +144,25 @@ bool Exporter::Export(Buffer * buffer, string const & format,
                      bool put_in_tempdir, string & result_file)
 {
        string backend_format;
-       LatexRunParams runparams;
-       runparams.flavor = LatexRunParams::LATEX;
+       OutputParams runparams;
+       runparams.flavor = OutputParams::LATEX;
+       runparams.linelen = lyxrc.ascii_linelen;
        vector<string> backends = Backends(*buffer);
-       if (find(backends.begin(), backends.end(), format) == backends.end()) {
+       // FIXME: Without this test export to lyx13 would be through
+       // latex -> lyx -> lyx13, because the first backend below with a
+       // working conversion path is used. We should replace this test and
+       // the explicit loop below with a method
+       // getShortestPath(vector<string> const & from, string const & to)
+       // which returns the shortest path from one of the formats in 'from'
+       // to 'to'.
+       if (format == "lyx13x" && !converters.getPath("lyx", format).empty())
+               backend_format = "lyx";
+       else if (find(backends.begin(), backends.end(), format) == backends.end()) {
                for (vector<string>::const_iterator it = backends.begin();
                     it != backends.end(); ++it) {
-                       Graph::EdgePath p =
-                               converters.getPath(*it, format);
+                       Graph::EdgePath p = converters.getPath(*it, format);
                        if (!p.empty()) {
-                               if (converters.usePdflatex(p))
-                                       runparams.flavor = LatexRunParams::PDFLATEX;
+                               runparams.flavor = converters.getFlavor(p);
                                backend_format = *it;
                                break;
                        }
@@ -75,29 +173,40 @@ bool Exporter::Export(Buffer * buffer, string const & format,
                                   formats.prettyName(format)));
                        return false;
                }
-       } else
+       } else {
                backend_format = format;
+               // FIXME: Don't hardcode format names here, but use a flag
+               if (backend_format == "pdflatex")
+                       runparams.flavor = OutputParams::PDFLATEX;
+       }
 
        string filename = buffer->getLatexName(false);
-       if (!buffer->tmppath.empty())
-               filename = AddName(buffer->tmppath, filename);
-       filename = ChangeExtension(filename,
+       filename = addName(buffer->temppath(), filename);
+       filename = changeExtension(filename,
                                   formats.extension(backend_format));
 
        // Ascii backend
        if (backend_format == "text")
-               buffer->writeFileAscii(filename, lyxrc.ascii_linelen);
+               writeFileAscii(*buffer, filename, runparams);
+       // no backend
+       else if (backend_format == "lyx")
+               buffer->writeFile(filename);
        // Linuxdoc backend
-       else if (buffer->isLinuxDoc())
-               buffer->makeLinuxDocFile(filename, !put_in_tempdir);
+       else if (buffer->isLinuxDoc()) {
+               runparams.nice = !put_in_tempdir;
+               buffer->makeLinuxDocFile(filename, runparams);
+       }
        // Docbook backend
-       else if (buffer->isDocBook())
-               buffer->makeDocBookFile(filename, !put_in_tempdir);
+       else if (buffer->isDocBook()) {
+               runparams.nice = !put_in_tempdir;
+               buffer->makeDocBookFile(filename, runparams);
+       }
        // LaTeX backend
        else if (backend_format == format) {
                runparams.nice = true;
                buffer->makeLaTeXFile(filename, string(), runparams);
-       } else if (contains(buffer->filePath(), ' ')) {
+       } else if (!lyxrc.tex_allows_spaces
+                  && contains(buffer->filePath(), ' ')) {
                Alert::error(_("File name error"),
                           _("The directory path to the document cannot contain spaces."));
                return false;
@@ -106,18 +215,46 @@ bool Exporter::Export(Buffer * buffer, string const & format,
                buffer->makeLaTeXFile(filename, buffer->filePath(), runparams);
        }
 
-       string outfile_base = (put_in_tempdir)
-               ? filename : buffer->getLatexName(false);
-
-       if (!converters.convert(buffer, filename, outfile_base,
+       if (!converters.convert(buffer, filename, filename,
                                backend_format, format, result_file))
                return false;
 
-       if (!put_in_tempdir)
-               buffer->message(_("Document exported as ")
-                                     + formats.prettyName(format)
-                                     + _(" to file `")
-                                     + MakeDisplayPath(result_file) +'\'');
+       if (!put_in_tempdir) {
+               string const tmp_result_file = result_file;
+               result_file = changeExtension(buffer->fileName(),
+                                             formats.extension(format));
+               // We need to copy referenced files (e. g. included graphics
+               // if format == "dvi") to the result dir.
+               vector<ExportedFile> const files =
+                       runparams.exportdata->externalFiles(format);
+               string const dest = onlyPath(result_file);
+               CopyStatus status = SUCCESS;
+               for (vector<ExportedFile>::const_iterator it = files.begin();
+                               it != files.end() && status != CANCEL; ++it) {
+                       string const fmt =
+                               formats.getFormatFromFile(it->sourceName);
+                       status = copyFile(fmt, it->sourceName,
+                                         makeAbsPath(it->exportName, dest),
+                                         it->exportName, status == FORCE);
+               }
+               if (status == CANCEL) {
+                       buffer->message(_("Document export cancelled."));
+               } else if (fs::exists(tmp_result_file)) {
+                       // Finally copy the main file
+                       status = copyFile(format, tmp_result_file,
+                                         result_file, result_file,
+                                         status == FORCE);
+                       buffer->message(bformat(_("Document exported as %1$s "
+                                                 "to file `%2$s'"),
+                                               formats.prettyName(format),
+                                               makeDisplayPath(result_file)));
+               } else {
+                       // This must be a dummy converter like fax (bug 1888)
+                       buffer->message(bformat(_("Document exported as %1$s"),
+                                               formats.prettyName(format)));
+               }
+       }
+
        return true;
 }
 
@@ -164,3 +301,47 @@ Exporter::GetExportableFormats(Buffer const & buffer, bool only_viewable)
        }
        return result;
 }
+
+
+ExportedFile::ExportedFile(string const & s, string const & e) :
+       sourceName(s), exportName(e) {}
+
+
+bool operator==(ExportedFile const & f1, ExportedFile const & f2)
+{
+       return f1.sourceName == f2.sourceName &&
+              f1.exportName == f2.exportName;
+
+}
+
+
+void ExportData::addExternalFile(string const & format,
+                                string const & sourceName,
+                                string const & exportName)
+{
+       BOOST_ASSERT(lyx::support::absolutePath(sourceName));
+
+       // Make sure that we have every file only once, otherwise copyFile()
+       // would ask several times if it should overwrite a file.
+       vector<ExportedFile> & files = externalfiles[format];
+       ExportedFile file(sourceName, exportName);
+       if (find(files.begin(), files.end(), file) == files.end())
+               files.push_back(file);
+}
+
+
+void ExportData::addExternalFile(string const & format,
+                                string const & sourceName)
+{
+       addExternalFile(format, sourceName, onlyFilename(sourceName));
+}
+
+
+vector<ExportedFile> const
+ExportData::externalFiles(string const & format) const
+{
+       FileMap::const_iterator cit = externalfiles.find(format);
+       if (cit != externalfiles.end())
+               return cit->second;
+       return vector<ExportedFile>();
+}