]> git.lyx.org Git - lyx.git/blobdiff - src/insets/ExternalSupport.C
* In the process of fixing the math background color bug, this commit transfer backgr...
[lyx.git] / src / insets / ExternalSupport.C
index 7018d37db4e66076ca2dd65ff6e27f89154bed3f..1f7669b7045a1fed3984387c3598f52962a519d3 100644 (file)
 #include "support/lyxlib.h"
 #include "support/os.h"
 #include "support/package.h"
-#include "support/path.h"
 
-#include "support/std_ostream.h"
-
-namespace support = lyx::support;
+#include <boost/filesystem/operations.hpp>
 
 using std::endl;
-
-using std::ostream;
 using std::string;
 using std::vector;
 
+using boost::filesystem::is_directory;
+
 
 namespace lyx {
+
+using support::FileName;
+
 namespace external {
 
 Template const * getTemplatePtr(InsetExternalParams const & params)
@@ -55,9 +55,8 @@ Template const * getTemplatePtr(InsetExternalParams const & params)
 
 void editExternal(InsetExternalParams const & params, Buffer const & buffer)
 {
-       string const file_with_path = params.filename.absFilename();
-       formats.edit(buffer, file_with_path,
-                    formats.getFormatFromFile(file_with_path));
+       formats.edit(buffer, params.filename,
+                    formats.getFormatFromFile(params.filename));
 }
 
 
@@ -72,9 +71,11 @@ string const subst_path(string const & input,
 {
        if (input.find(placeholder) == string::npos)
                return input;
+       // Don't use external_path here when use_latex_path is false, as the
+       // 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) :
-               support::os::external_path(path);
+               support::latex_path(path, ext, dots) : path;
        return support::subst(input, placeholder, path2);
 }
 
@@ -96,7 +97,7 @@ string const doSubstitution(InsetExternalParams const & params,
                params.filename.outputFilename(parentpath);
        string const basename = support::changeExtension(
                        support::onlyFilename(filename), string());
-       string const absname = support::makeAbsPath(filename, parentpath);
+       string const absname = support::makeAbsPath(filename, parentpath).absFilename();
 
        string result = s;
        if (what != ALL_BUT_PATHS) {
@@ -105,12 +106,16 @@ string const doSubstitution(InsetExternalParams const & params,
                string const masterpath = external_in_tmpdir ?
                        m_buffer->temppath() :
                        m_buffer->filePath();
+               // FIXME UNICODE
                string relToMasterPath = support::onlyPath(
-                               support::makeRelPath(absname, masterpath));
+                               to_utf8(support::makeRelPath(from_utf8(absname),
+                                                            from_utf8(masterpath))));
                if (relToMasterPath == "./")
                        relToMasterPath.clear();
+               // FIXME UNICODE
                string relToParentPath = support::onlyPath(
-                               support::makeRelPath(absname, parentpath));
+                               to_utf8(support::makeRelPath(from_utf8(absname),
+                                                            from_utf8(parentpath))));
                if (relToParentPath == "./")
                        relToParentPath.clear();
 
@@ -160,28 +165,31 @@ string const doSubstitution(InsetExternalParams const & params,
                            support::PROTECT_EXTENSION, support::ESCAPE_DOTS);
        result = subst_path(result, "$$Extension",
                        '.' + support::getExtension(filename), use_latex_path);
-       result = subst_path(result, "$$Tempname", params.tempname(), use_latex_path);
+       result = subst_path(result, "$$Tempname", params.tempname().absFilename(), use_latex_path);
        result = subst_path(result, "$$Sysdir",
-                               support::package().system_support(), use_latex_path);
+                               support::package().system_support().absFilename(), use_latex_path);
 
        // Handle the $$Contents(filename) syntax
        if (support::contains(result, "$$Contents(\"")) {
-
-               string::size_type const pos = result.find("$$Contents(\"");
-               string::size_type const end = result.find("\")", pos);
-               string const file = result.substr(pos + 12, end - (pos + 12));
+               // 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.
+               string::size_type const spos = s.find("$$Contents(\"");
+               string::size_type const send = s.find("\")", spos);
+               string const file_template = s.substr(spos + 12, send - (spos + 12));
+               string const file = doSubstitution(params, buffer,
+                                                  file_template, false,
+                                                  external_in_tmpdir, what);
                string contents;
 
-               string const filepath = support::isFileReadable(file) ?
-                       buffer.filePath() : m_buffer->temppath();
-               support::Path p(filepath);
-
-               if (support::isFileReadable(file))
-                       contents = support::getFileContents(file);
+               FileName const absfile(
+                       support::makeAbsPath(file, m_buffer->temppath()));
+               if (support::isFileReadable(absfile))
+                       contents = support::getFileContents(absfile);
 
-               result = support::subst(result,
-                                       ("$$Contents(\"" + file + "\")").c_str(),
-                                       contents);
+               string::size_type const pos = result.find("$$Contents(\"");
+               string::size_type const end = result.find("\")", pos);
+               result.replace(pos, end + 2, contents);
        }
 
        return result;
@@ -198,7 +206,8 @@ void updateExternal(InsetExternalParams const & params,
                    string const & format,
                    Buffer const & buffer,
                    ExportData & exportdata,
-                   bool external_in_tmpdir)
+                    bool external_in_tmpdir,
+                    bool dryrun)
 {
        Template const * const et_ptr = getTemplatePtr(params);
        if (!et_ptr)
@@ -220,14 +229,12 @@ void updateExternal(InsetExternalParams const & params,
        if (from_format.empty())
                return; // NOT_NEEDED
 
-       string abs_from_file = params.filename.absFilename();
-
        if (from_format == "*") {
-               if (abs_from_file.empty())
+               if (params.filename.empty())
                        return; // NOT_NEEDED
 
                // Try and ascertain the file format from its contents.
-               from_format = formats.getFormatFromFile(abs_from_file);
+               from_format = formats.getFormatFromFile(params.filename);
                if (from_format.empty())
                        return; // FAILURE
 
@@ -237,34 +244,26 @@ void updateExternal(InsetExternalParams const & params,
        if (to_format.empty())
                return; // NOT_NEEDED
 
-       if (!converters.isReachable(from_format, to_format)) {
-               lyxerr[Debug::EXTERNAL]
-                       << "external::updateExternal. "
-                       << "Unable to convert from "
-                       << from_format << " to " << to_format << endl;
-               return; // FAILURE
-       }
-
        // The master buffer. This is useful when there are multiple levels
        // of include files
        Buffer const * m_buffer = buffer.getMasterBuffer();
 
        // We copy the source file to the temp dir and do the conversion
        // there if necessary
-       string const temp_file =
+       FileName const temp_file(
                support::makeAbsPath(params.filename.mangledFilename(),
-                                    m_buffer->temppath());
-       if (!abs_from_file.empty()) {
-               unsigned long const from_checksum = support::sum(abs_from_file);
+                                    m_buffer->temppath()));
+       if (!params.filename.empty() && !is_directory(params.filename.toFilesystemEncoding())) {
+               unsigned long const from_checksum = support::sum(params.filename);
                unsigned long const temp_checksum = support::sum(temp_file);
 
                if (from_checksum != temp_checksum) {
-                       Mover const & mover = movers(from_format);
-                       if (!mover.copy(abs_from_file, temp_file)) {
-                               lyxerr[Debug::EXTERNAL]
+                       Mover const & mover = getMover(from_format);
+                       if (!mover.copy(params.filename, temp_file)) {
+                               LYXERR(Debug::EXTERNAL)
                                        << "external::updateExternal. "
                                        << "Unable to copy "
-                                       << abs_from_file << " to " << temp_file << endl;
+                                       << params.filename << " to " << temp_file << endl;
                                return; // FAILURE
                        }
                }
@@ -274,36 +273,38 @@ void updateExternal(InsetExternalParams const & params,
        string const to_file = doSubstitution(params, buffer,
                                              outputFormat.updateResult,
                                              false, true);
-       string const abs_to_file =
-               support::makeAbsPath(to_file, m_buffer->temppath());
-
-       // Record the referenced files for the exporter.
-       // The exporter will copy them to the export dir.
-       typedef Template::Format::FileMap FileMap;
-       FileMap::const_iterator rit  = outputFormat.referencedFiles.begin();
-       FileMap::const_iterator rend = outputFormat.referencedFiles.end();
-       for (; rit != rend; ++rit) {
-               vector<string>::const_iterator fit  = rit->second.begin();
-               vector<string>::const_iterator fend = rit->second.end();
-               for (; fit != fend; ++fit) {
-                       string const source = support::makeAbsPath(
-                                       doSubstitution(params, buffer, *fit,
-                                                      false, true),
-                                       m_buffer->temppath());
-                       // The path of the referenced file is never the
-                       // 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",
-                                       "$$FPath$$Basename$$Extension");
-                       file = doSubstitution(params, buffer, file, false, false,
-                                             PATHS);
-                       file = doSubstitution(params, buffer, file,
-                                             false, external_in_tmpdir,
-                                             ALL_BUT_PATHS);
-                       // if file is a relative name, it is interpreted
-                       // relative to the master document.
-                       exportdata.addExternalFile(rit->first, source, file);
+       FileName const abs_to_file(
+               support::makeAbsPath(to_file, m_buffer->temppath()));
+
+       if (!dryrun) {
+               // Record the referenced files for the exporter.
+               // The exporter will copy them to the export dir.
+               typedef Template::Format::FileMap FileMap;
+               FileMap::const_iterator rit  = outputFormat.referencedFiles.begin();
+               FileMap::const_iterator rend = outputFormat.referencedFiles.end();
+               for (; rit != rend; ++rit) {
+                       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(
+                                               doSubstitution(params, buffer, *fit,
+                                                              false, true),
+                                               m_buffer->temppath()));
+                               // The path of the referenced file is never the
+                               // 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",
+                                               "$$FPath$$Basename$$Extension");
+                               file = doSubstitution(params, buffer, file, false, false,
+                                                     PATHS);
+                               file = doSubstitution(params, buffer, file,
+                                                     false, external_in_tmpdir,
+                                                     ALL_BUT_PATHS);
+                               // if file is a relative name, it is interpreted
+                               // relative to the master document.
+                               exportdata.addExternalFile(rit->first, source, file);
+                       }
                }
        }
 
@@ -311,14 +312,20 @@ void updateExternal(InsetExternalParams const & params,
        // 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
-       string const to_file_base =
-               support::changeExtension(to_file, string());
 
        // FIXME (Abdel 12/08/06): Is there a need to show these errors?
        ErrorList el;
-       /* bool const success = */
-               converters.convert(&buffer, temp_file, to_file_base,
-                                  from_format, to_format, el, true);
+       bool 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)
+               LYXERR(Debug::EXTERNAL)
+                       << "external::updateExternal. "
+                       << "Unable to convert from "
+                       << from_format << " to " << to_format << endl;
+
        // return success
 }
 
@@ -334,10 +341,10 @@ string const substituteOptions(InsetExternalParams const & params,
 
 int writeExternal(InsetExternalParams const & params,
                  string const & format,
-                 Buffer const & buffer, ostream & os,
+                 Buffer const & buffer, odocstream & os,
                  ExportData & exportdata,
                  bool external_in_tmpdir,
-                 bool external_in_comment)
+                 bool dryrun)
 {
        Template const * const et_ptr = getTemplatePtr(params);
        if (!et_ptr)
@@ -346,23 +353,24 @@ int writeExternal(InsetExternalParams const & params,
 
        Template::Formats::const_iterator cit = et.formats.find(format);
        if (cit == et.formats.end()) {
-               lyxerr[Debug::EXTERNAL]
+               LYXERR(Debug::EXTERNAL)
                        << "External template format '" << format
                        << "' not specified in template "
                        << params.templatename() << endl;
                return 0;
        }
 
-       if (!external_in_comment)
+       if (!dryrun || support::contains(cit->second.product, "$$Contents"))
                updateExternal(params, format, buffer, exportdata,
-                              external_in_tmpdir);
+                              external_in_tmpdir, dryrun);
 
        bool const use_latex_path = format == "LaTeX";
        string str = doSubstitution(params, buffer, cit->second.product,
                                    use_latex_path, external_in_tmpdir);
        str = substituteCommands(params, str, format);
        str = substituteOptions(params, str, format);
-       os << str;
+       // FIXME UNICODE
+       os << from_utf8(str);
        return int(lyx::count(str.begin(), str.end(),'\n'));
 }
 
@@ -513,9 +521,10 @@ string const substituteOptions(InsetExternalParams const & params,
        }
 
        return output;
- }
+}
 
 } // namespace anon
 
 } // namespace external
+
 } // namespace lyx