]> git.lyx.org Git - lyx.git/blobdiff - src/insets/ExternalSupport.cpp
Fix bug #12795
[lyx.git] / src / insets / ExternalSupport.cpp
index b3f6a98015bc4747b28a492109412063d87af55b..33c14d38be935a6a0b957346bd8e320faaf49e24 100644 (file)
@@ -22,6 +22,7 @@
 #include "Exporter.h"
 #include "Format.h"
 #include "Mover.h"
+#include "texstream.h"
 
 #include "frontends/alert.h"
 
@@ -29,8 +30,6 @@
 #include "support/filetools.h"
 #include "support/gettext.h"
 #include "support/lstrings.h"
-#include "support/lyxalgo.h"
-#include "support/lyxlib.h"
 #include "support/os.h"
 #include "support/Package.h"
 
@@ -51,8 +50,8 @@ Template const * getTemplatePtr(InsetExternalParams const & params)
 
 void editExternal(InsetExternalParams const & params, Buffer const & buffer)
 {
-       formats.edit(buffer, params.filename,
-                    formats.getFormatFromFile(params.filename));
+       theFormats().edit(buffer, params.filename,
+               theFormats().getFormatFromFile(params.filename));
 }
 
 
@@ -62,8 +61,8 @@ string const subst_path(string const & input,
                        string const & placeholder,
                        string const & path,
                        bool use_latex_path,
-                       support::latex_path_extension ext = support::PROTECT_EXTENSION,
-                       support::latex_path_dots dots = support::LEAVE_DOTS)
+                       latex_path_extension ext = PROTECT_EXTENSION,
+                       latex_path_dots dots = LEAVE_DOTS)
 {
        if (input.find(placeholder) == string::npos)
                return input;
@@ -71,11 +70,11 @@ string const subst_path(string const & input,
        // path will be compared with another one in internal style later
        // in Converters::move.
        string const path2 = use_latex_path ?
-               support::latex_path(path, ext, dots) : path;
-       return support::subst(input, placeholder, path2);
+               latex_path(path, ext, dots) : path;
+       return subst(input, placeholder, path2);
 }
 
-} // namespace anon
+} // namespace
 
 
 string const doSubstitution(InsetExternalParams const & params,
@@ -84,71 +83,85 @@ string const doSubstitution(InsetExternalParams const & params,
                            bool external_in_tmpdir,
                            Substitute what)
 {
+       string result = s;
+       if (what != PATHS && contains(result, "$$pngOrjpg")) {
+               // This is for raster images and pdflatex:
+               // Since pdflatex supports both jpg and png, we choose the best format:
+               // jpg if the original file is jpg to retain the compression, else png.
+               string format = theFormats().getFormatFromFile(params.filename);
+               if (format == "jpg")
+                       result = subst(result, "$$pngOrjpg", "jpg");
+               else
+                       result = subst(result, "$$pngOrjpg", "png");
+       }
+
+       if (what == FORMATS)
+               return result;
+
        Buffer const * masterBuffer = buffer.masterBuffer();
        string const parentpath = external_in_tmpdir ?
                masterBuffer->temppath() :
                buffer.filePath();
        string const filename = external_in_tmpdir ?
-               params.filename.mangledFilename() :
-               params.filename.outputFilename(parentpath);
-       string const basename = support::changeExtension(
-                       support::onlyFilename(filename), string());
-       string const absname = support::makeAbsPath(filename, parentpath).absFilename();
+               params.filename.mangledFileName() :
+               params.filename.outputFileName(parentpath);
+       string const basename = changeExtension(
+                       onlyFileName(filename), string());
+       string const absname = makeAbsPath(filename, parentpath).absFileName();
 
-       string result = s;
        if (what != ALL_BUT_PATHS) {
-               string const filepath = support::onlyPath(filename);
-               string const abspath = support::onlyPath(absname);
+               string const filepath = onlyPath(filename);
+               string const abspath = onlyPath(absname);
                string const masterpath = external_in_tmpdir ?
                        masterBuffer->temppath() :
                        masterBuffer->filePath();
                // FIXME UNICODE
-               string relToMasterPath = support::onlyPath(
-                               to_utf8(support::makeRelPath(from_utf8(absname),
+               string relToMasterPath = onlyPath(
+                               to_utf8(makeRelPath(from_utf8(absname),
                                                             from_utf8(masterpath))));
                if (relToMasterPath == "./")
                        relToMasterPath.clear();
                // FIXME UNICODE
-               string relToParentPath = support::onlyPath(
-                               to_utf8(support::makeRelPath(from_utf8(absname),
+               string relToParentPath = onlyPath(
+                               to_utf8(makeRelPath(from_utf8(absname),
                                                             from_utf8(parentpath))));
                if (relToParentPath == "./")
                        relToParentPath.clear();
 
                result = subst_path(result, "$$FPath", filepath,
                                    use_latex_path,
-                                   support::PROTECT_EXTENSION,
-                                   support::ESCAPE_DOTS);
+                                   PROTECT_EXTENSION,
+                                   ESCAPE_DOTS);
                result = subst_path(result, "$$AbsPath", abspath,
                                    use_latex_path,
-                                   support::PROTECT_EXTENSION,
-                                   support::ESCAPE_DOTS);
+                                   PROTECT_EXTENSION,
+                                   ESCAPE_DOTS);
                result = subst_path(result, "$$RelPathMaster",
                                    relToMasterPath, use_latex_path,
-                                   support::PROTECT_EXTENSION,
-                                   support::ESCAPE_DOTS);
+                                   PROTECT_EXTENSION,
+                                   ESCAPE_DOTS);
                result = subst_path(result, "$$RelPathParent",
                                    relToParentPath, use_latex_path,
-                                   support::PROTECT_EXTENSION,
-                                   support::ESCAPE_DOTS);
-               if (support::absolutePath(filename)) {
+                                   PROTECT_EXTENSION,
+                                   ESCAPE_DOTS);
+               if (FileName::isAbsolute(filename)) {
                        result = subst_path(result, "$$AbsOrRelPathMaster",
                                            abspath, use_latex_path,
-                                           support::PROTECT_EXTENSION,
-                                           support::ESCAPE_DOTS);
+                                           PROTECT_EXTENSION,
+                                           ESCAPE_DOTS);
                        result = subst_path(result, "$$AbsOrRelPathParent",
                                            abspath, use_latex_path,
-                                           support::PROTECT_EXTENSION,
-                                           support::ESCAPE_DOTS);
+                                           PROTECT_EXTENSION,
+                                           ESCAPE_DOTS);
                } else {
                        result = subst_path(result, "$$AbsOrRelPathMaster",
                                            relToMasterPath, use_latex_path,
-                                           support::PROTECT_EXTENSION,
-                                           support::ESCAPE_DOTS);
+                                           PROTECT_EXTENSION,
+                                           ESCAPE_DOTS);
                        result = subst_path(result, "$$AbsOrRelPathParent",
                                            relToParentPath, use_latex_path,
-                                           support::PROTECT_EXTENSION,
-                                           support::ESCAPE_DOTS);
+                                           PROTECT_EXTENSION,
+                                           ESCAPE_DOTS);
                }
        }
 
@@ -156,17 +169,17 @@ string const doSubstitution(InsetExternalParams const & params,
                return result;
 
        result = subst_path(result, "$$FName", filename, use_latex_path,
-                           support::EXCLUDE_EXTENSION);
+                           EXCLUDE_EXTENSION);
        result = subst_path(result, "$$Basename", basename, use_latex_path,
-                           support::PROTECT_EXTENSION, support::ESCAPE_DOTS);
+                           PROTECT_EXTENSION, ESCAPE_DOTS);
        result = subst_path(result, "$$Extension",
-                       '.' + support::getExtension(filename), use_latex_path);
-       result = subst_path(result, "$$Tempname", params.tempname().absFilename(), use_latex_path);
+                       '.' + getExtension(filename), use_latex_path);
+       result = subst_path(result, "$$Tempname", params.tempname().absFileName(), use_latex_path);
        result = subst_path(result, "$$Sysdir",
-                               support::package().system_support().absFilename(), use_latex_path);
+                               package().system_support().absFileName(), use_latex_path);
 
        // Handle the $$Contents(filename) syntax
-       if (support::contains(result, "$$Contents(\"")) {
+       if (contains(result, "$$Contents(\"")) {
                // Since use_latex_path may be true we must extract the file
                // name from s instead of result and do the substitutions
                // again, this time with use_latex_path false.
@@ -179,14 +192,14 @@ string const doSubstitution(InsetExternalParams const & params,
                string contents;
 
                FileName const absfile(
-                       support::makeAbsPath(file, masterBuffer->temppath()));
+                       makeAbsPath(file, masterBuffer->temppath()));
                if (absfile.isReadableFile())
                        // FIXME UNICODE
                        contents = to_utf8(absfile.fileContents("UTF-8"));
 
                size_t const pos = result.find("$$Contents(\"");
                size_t const end = result.find("\")", pos);
-               result.replace(pos, end + 2, contents);
+               result.replace(pos, end + 2- pos, contents);
        }
 
        return result;
@@ -199,7 +212,7 @@ namespace {
     If \p external_in_tmpdir == true, then the generated file is
     placed in the buffer's temporary directory.
 */
-void updateExternal(InsetExternalParams const & params,
+RetVal updateExternal(InsetExternalParams const & params,
                    string const & format,
                    Buffer const & buffer,
                    ExportData & exportdata,
@@ -208,37 +221,38 @@ void updateExternal(InsetExternalParams const & params,
 {
        Template const * const et_ptr = getTemplatePtr(params);
        if (!et_ptr)
-               return; // FAILURE
+               return FAILURE;
        Template const & et = *et_ptr;
 
        if (!et.automaticProduction)
-               return; // NOT_NEEDED
+               return NOT_NEEDED;
 
        Template::Formats::const_iterator cit = et.formats.find(format);
        if (cit == et.formats.end())
-               return; // FAILURE
+               return FAILURE;
 
        Template::Format const & outputFormat = cit->second;
        if (outputFormat.updateResult.empty())
-               return; // NOT_NEEDED
+               return NOT_NEEDED;
 
        string from_format = et.inputFormat;
        if (from_format.empty())
-               return; // NOT_NEEDED
+               return NOT_NEEDED;
 
        if (from_format == "*") {
                if (params.filename.empty())
-                       return; // NOT_NEEDED
+                       return NOT_NEEDED;
 
                // Try and ascertain the file format from its contents.
-               from_format = formats.getFormatFromFile(params.filename);
+               from_format = theFormats().getFormatFromFile(params.filename);
                if (from_format.empty())
-                       return; // FAILURE
+                       return FAILURE;
        }
 
-       string const to_format = outputFormat.updateFormat;
+       string const to_format = doSubstitution(params, buffer,
+               outputFormat.updateFormat, false, external_in_tmpdir, FORMATS);
        if (to_format.empty())
-               return; // NOT_NEEDED
+               return NOT_NEEDED;
 
        // The master buffer. This is useful when there are multiple levels
        // of include files
@@ -246,10 +260,11 @@ void updateExternal(InsetExternalParams const & params,
 
        // We copy the source file to the temp dir and do the conversion
        // there if necessary
+       bool const isDir = params.filename.isDirectory();
        FileName const temp_file(
-               support::makeAbsPath(params.filename.mangledFilename(),
+               makeAbsPath(params.filename.mangledFileName(),
                                     masterBuffer->temppath()));
-       if (!params.filename.empty() && !params.filename.isDirectory()) {
+       if (!params.filename.empty() && !isDir) {
                unsigned long const from_checksum = params.filename.checksum();
                unsigned long const temp_checksum = temp_file.checksum();
 
@@ -258,7 +273,7 @@ void updateExternal(InsetExternalParams const & params,
                        if (!mover.copy(params.filename, temp_file)) {
                                LYXERR(Debug::EXTERNAL, "external::updateExternal. "
                                        << "Unable to copy " << params.filename << " to " << temp_file);
-                               return; // FAILURE
+                               return FAILURE;
                        }
                }
        }
@@ -268,7 +283,7 @@ void updateExternal(InsetExternalParams const & params,
                                              outputFormat.updateResult,
                                              false, true);
        FileName const abs_to_file(
-               support::makeAbsPath(to_file, masterBuffer->temppath()));
+               makeAbsPath(to_file, masterBuffer->temppath()));
 
        if (!dryrun) {
                // Record the referenced files for the exporter.
@@ -280,7 +295,7 @@ void updateExternal(InsetExternalParams const & params,
                        vector<string>::const_iterator fit  = rit->second.begin();
                        vector<string>::const_iterator fend = rit->second.end();
                        for (; fit != fend; ++fit) {
-                               FileName const source(support::makeAbsPath(
+                               FileName const source(makeAbsPath(
                                                doSubstitution(params, buffer, *fit,
                                                               false, true),
                                                masterBuffer->temppath()));
@@ -288,7 +303,7 @@ void updateExternal(InsetExternalParams const & params,
                                // temp path, but the filename may be the mangled
                                // or the real name. Therefore we substitute the
                                // paths and names separately.
-                               string file = support::subst(*fit, "$$FName",
+                               string file = subst(*fit, "$$FName",
                                                "$$FPath$$Basename$$Extension");
                                file = doSubstitution(params, buffer, file, false, false,
                                                      PATHS);
@@ -297,29 +312,37 @@ void updateExternal(InsetExternalParams const & params,
                                                      ALL_BUT_PATHS);
                                // if file is a relative name, it is interpreted
                                // relative to the master document.
-                               exportdata.addExternalFile(rit->first, source, file);
+                               if (makeAbsPath(file, masterBuffer->filePath()) !=
+                                       params.filename.absFileName())
+                                               exportdata.addExternalFile(rit->first, source, file);
                        }
                }
        }
 
        // Do we need to perform the conversion?
        // Yes if to_file does not exist or if from_file is newer than to_file
-       if (support::compare_timestamps(temp_file, abs_to_file) < 0)
-               return; // SUCCESS
+       // or if from_file is a directory (bug 9925)
+       if (!isDir && compare_timestamps(temp_file, abs_to_file) < 0)
+               return SUCCESS;
 
        // FIXME (Abdel 12/08/06): Is there a need to show these errors?
        ErrorList el;
-       bool const success =
+       Converters::RetVal const success =
                theConverters().convert(&buffer, temp_file, abs_to_file,
                                   params.filename, from_format, to_format, el,
                                   Converters::try_default | Converters::try_cache);
-
-       if (!success) {
+       switch (success) {
+       case Converters::SUCCESS:
+               return SUCCESS;
+       case Converters::FAILURE:
                LYXERR(Debug::EXTERNAL, "external::updateExternal. "
                        << "Unable to convert from " << from_format << " to " << to_format);
+                       return FAILURE;
+       case Converters::KILLED:
+               return KILLED;
        }
-
-       // return success
+       // squash warning
+       return SUCCESS;
 }
 
 
@@ -329,51 +352,64 @@ string const substituteCommands(InsetExternalParams const & params,
 string const substituteOptions(InsetExternalParams const & params,
                               string const & input, string const & format);
 
-} // namespace anon
+} // namespace
 
 
-int writeExternal(InsetExternalParams const & params,
-                 string const & format,
-                 Buffer const & buffer, odocstream & os,
-                 ExportData & exportdata,
-                 bool external_in_tmpdir,
-                 bool dryrun)
+RetVal writeExternal(InsetExternalParams const & params,
+                  string const & format,
+                  Buffer const & buffer, otexstream & os,
+                  ExportData & exportdata,
+                  bool external_in_tmpdir,
+                  bool dryrun)
 {
        Template const * const et_ptr = getTemplatePtr(params);
        if (!et_ptr)
-               return 0;
+               return FAILURE;
        Template const & et = *et_ptr;
 
        Template::Formats::const_iterator cit = et.formats.find(format);
        if (cit == et.formats.end()) {
                LYXERR(Debug::EXTERNAL, "External template format '" << format
                        << "' not specified in template " << params.templatename());
-               return 0;
+               return FAILURE;
        }
 
-       if (!dryrun || support::contains(cit->second.product, "$$Contents"))
-               updateExternal(params, format, buffer, exportdata,
-                              external_in_tmpdir, dryrun);
+       if (!dryrun || contains(cit->second.product, "$$Contents")) {
+               RetVal const success = 
+                       updateExternal(params, format, buffer, exportdata, 
+                               external_in_tmpdir, dryrun);
+               if (success == FAILURE || success == KILLED)
+                       return success;
+       }
 
        bool const use_latex_path = format == "LaTeX";
        string str = doSubstitution(params, buffer, cit->second.product,
                                    use_latex_path, external_in_tmpdir);
 
-       string const absname = support::makeAbsPath(
-               params.filename.outputFilename(buffer.filePath()), buffer.filePath()).absFilename();
+       string const absname = makeAbsPath(
+               params.filename.outputFileName(buffer.filePath()), buffer.filePath()).absFileName();
 
-       if (!external_in_tmpdir && !isValidLaTeXFilename(absname)) {
-               lyx::frontend::Alert::warning(_("Invalid filename"),
-                                             _("The following filename is likely to cause trouble "
-                                               "when running the exported file through LaTeX: ") +
-                                             from_utf8(absname));
+       if (!dryrun && !external_in_tmpdir) {
+               if (!isValidLaTeXFileName(absname)) {
+                       lyx::frontend::Alert::warning(_("Invalid filename"),
+                                _("The following filename will cause troubles "
+                                "when running the exported file through LaTeX: ") +
+                             from_utf8(absname));
+               }
+               if (!isValidDVIFileName(absname)) {
+                       lyx::frontend::Alert::warning(_("Problematic filename for DVI"),
+                                _("The following filename can cause troubles "
+                                "when running the exported file through LaTeX "
+                                "and opening the resulting DVI: ") +
+                              from_utf8(absname), true);
+               }
        }
 
        str = substituteCommands(params, str, format);
        str = substituteOptions(params, str, format);
        // FIXME UNICODE
        os << from_utf8(str);
-       return int(std::count(str.begin(), str.end(),'\n'));
+       return SUCCESS;
 }
 
 namespace {
@@ -394,7 +430,7 @@ string const substituteIt<TransformCommand>(string const & input,
                                            Template::Format const & format,
                                            InsetExternalParams const & params)
 {
-       typedef std::map<TransformID, TransformStore> Transformers;
+       typedef map<TransformID, TransformStore> Transformers;
        Transformers::const_iterator it = format.command_transformers.find(id);
        if (it == format.command_transformers.end())
                return input;
@@ -407,12 +443,12 @@ string const substituteIt<TransformCommand>(string const & input,
        else if (id == Resize)
                ptr = store.getCommandTransformer(params.resizedata);
 
-       if (!ptr.get())
+       if (!ptr)
                return input;
 
        string result =
-               support::subst(input, ptr->front_placeholder(), ptr->front());
-       return support::subst(result, ptr->back_placeholder(),  ptr->back());
+               subst(input, ptr->front_placeholder(), ptr->front());
+       return subst(result, ptr->back_placeholder(),  ptr->back());
 }
 
 
@@ -423,7 +459,7 @@ string const substituteIt<TransformOption>(string const & input,
                                           Template::Format const & format,
                                           InsetExternalParams const & params)
 {
-       typedef std::map<TransformID, TransformStore> Transformers;
+       typedef map<TransformID, TransformStore> Transformers;
        Transformers::const_iterator it = format.option_transformers.find(id);
        if (it == format.option_transformers.end())
                return input;
@@ -444,12 +480,14 @@ string const substituteIt<TransformOption>(string const & input,
        case Resize:
                ptr = store.getOptionTransformer(params.resizedata);
                break;
+       case None:
+               break;
        }
 
-       if (!ptr.get())
+       if (!ptr)
                return input;
 
-       return support::subst(input, ptr->placeholder(), ptr->option());
+       return subst(input, ptr->placeholder(), ptr->option());
 }
 
 
@@ -519,13 +557,13 @@ string const substituteOptions(InsetExternalParams const & params,
        for (; it != end; ++it) {
                string const opt = substituteOption(params, it->option, format);
                string const placeholder = "$$" + it->name;
-               output = support::subst(output, placeholder, opt);
+               output = subst(output, placeholder, opt);
        }
 
        return output;
 }
 
-} // namespace anon
+} // namespace
 
 } // namespace external