]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.C
fix compiler warnings about unused parameter
[lyx.git] / src / support / filetools.C
index ca5584211ef376414d70ad8440663f57f062a7af..7a8448df49dda1c3233fc3685ea566999977ab1a 100644 (file)
@@ -133,28 +133,43 @@ string const makeLatexName(string const & file)
 }
 
 
-string const quoteName(string const & name)
+string const quoteName(string const & name, quote_style style)
 {
-       return (os::shell() == os::UNIX) ?
-               '\'' + name + '\'':
-               '"' + name + '"';
+       switch(style) {
+       case quote_shell:
+               // This does not work for filenames containing " (windows)
+               // or ' (all other OSes). This can't be changed easily, since
+               // we would need to adapt the command line parser in
+               // Forkedcall::generateChild. Therefore we don't pass user
+               // filenames to child processes if possible. We store them in
+               // a python script instead, where we don't have these
+               // limitations.
+               return (os::shell() == os::UNIX) ?
+                       '\'' + name + '\'':
+                       '"' + name + '"';
+       case quote_python:
+               return "\"" + subst(subst(name, "\\", "\\\\"), "\"", "\\\"")
+                    + "\"";
+       }
+       // shut up stupid compiler
+       return string();
 }
 
 
-// Is a file readable ?
-bool isFileReadable(string const & path)
+bool isFileReadable(FileName const & filename)
 {
+       std::string const path = filename.toFilesystemEncoding();
        return fs::exists(path) && !fs::is_directory(path) && fs::is_readable(path);
 }
 
 
 //returns true: dir writeable
 //       false: not writeable
-bool isDirWriteable(string const & path)
+bool isDirWriteable(FileName const & path)
 {
        lyxerr[Debug::FILES] << "isDirWriteable: " << path << endl;
 
-       string const tmpfl = tempName(path, "lyxwritetest");
+       FileName const tmpfl(tempName(path, "lyxwritetest"));
 
        if (tmpfl.empty())
                return false;
@@ -164,15 +179,16 @@ bool isDirWriteable(string const & path)
 }
 
 
+#if 0
 // Uses a string of paths separated by ";"s to find a file to open.
 // Can't cope with pathnames with a ';' in them. Returns full path to file.
 // If path entry begins with $$LyX/, use system_lyxdir
 // If path entry begins with $$User/, use user_lyxdir
 // Example: "$$User/doc;$$LyX/doc"
-string const fileOpenSearch(string const & path, string const & name,
+FileName const fileOpenSearch(string const & path, string const & name,
                             string const & ext)
 {
-       string real_file;
+       FileName real_file;
        string path_element;
        bool notfound = true;
        string tmppath = split(path, path_element, ';');
@@ -198,15 +214,17 @@ string const fileOpenSearch(string const & path, string const & name,
        }
        return real_file;
 }
+#endif
 
 
 /// Returns a vector of all files in directory dir having extension ext.
-vector<string> const dirList(string const & dir, string const & ext)
+vector<FileName> const dirList(FileName const & dir, string const & ext)
 {
        // EXCEPTIONS FIXME. Rewrite needed when we turn on exceptions. (Lgb)
-       vector<string> dirlist;
+       vector<FileName> dirlist;
 
-       if (!(fs::exists(dir) && fs::is_directory(dir))) {
+       string const encoded_dir = dir.toFilesystemEncoding();
+       if (!(fs::exists(encoded_dir) && fs::is_directory(encoded_dir))) {
                lyxerr[Debug::FILES]
                        << "Directory \"" << dir
                        << "\" does not exist to DirList." << endl;
@@ -218,13 +236,13 @@ vector<string> const dirList(string const & dir, string const & ext)
                extension += '.';
        extension += ext;
 
-       fs::directory_iterator dit(dir);
+       fs::directory_iterator dit(encoded_dir);
        fs::directory_iterator end;
        for (; dit != end; ++dit) {
                string const & fil = dit->leaf();
-               if (suffixIs(fil, extension)) {
-                       dirlist.push_back(fil);
-               }
+               if (suffixIs(fil, extension))
+                       dirlist.push_back(FileName::fromFilesystemEncoding(
+                                       encoded_dir + '/' + fil));
        }
        return dirlist;
 }
@@ -232,22 +250,26 @@ vector<string> const dirList(string const & dir, string const & ext)
 
 // Returns the real name of file name in directory path, with optional
 // extension ext.
-string const fileSearch(string const & path, string const & name,
-                       string const & ext)
+FileName const fileSearch(string const & path, string const & name,
+                          string const & ext, search_mode mode)
 {
        // if `name' is an absolute path, we ignore the setting of `path'
        // Expand Environmentvariables in 'name'
        string const tmpname = replaceEnvironmentPath(name);
-       string fullname = makeAbsPath(tmpname, path);
+       FileName fullname(makeAbsPath(tmpname, path));
        // search first without extension, then with it.
        if (isFileReadable(fullname))
                return fullname;
        if (ext.empty())
-               return string();
-       // Is it not more reasonable to use ChangeExtension()? (SMiyata)
-       fullname += '.';
-       fullname += ext;
-       return isFileReadable(fullname) ? fullname : string();
+               // We are done.
+               return mode == allow_unreadable ? fullname : FileName();
+       // Only add the extension if it is not already the extension of
+       // fullname.
+       if (getExtension(fullname.absFilename()) != ext)
+               fullname = FileName(addExtension(fullname.absFilename(), ext));
+       if (isFileReadable(fullname) || mode == allow_unreadable)
+               return fullname;
+       return FileName();
 }
 
 
@@ -255,10 +277,10 @@ string const fileSearch(string const & path, string const & name,
 //   1) user_lyxdir
 //   2) build_lyxdir (if not empty)
 //   3) system_lyxdir
-string const libFileSearch(string const & dir, string const & name,
+FileName const libFileSearch(string const & dir, string const & name,
                           string const & ext)
 {
-       string fullname = fileSearch(addPath(package().user_support(), dir),
+       FileName fullname = fileSearch(addPath(package().user_support(), dir),
                                     name, ext);
        if (!fullname.empty())
                return fullname;
@@ -273,7 +295,7 @@ string const libFileSearch(string const & dir, string const & name,
 }
 
 
-string const i18nLibFileSearch(string const & dir, string const & name,
+FileName const i18nLibFileSearch(string const & dir, string const & name,
                  string const & ext)
 {
        // the following comments are from intl/dcigettext.c. We try
@@ -301,7 +323,7 @@ string const i18nLibFileSearch(string const & dir, string const & name,
        string l;
        lang = split(lang, l, ':');
        while (!l.empty() && l != "C" && l != "POSIX") {
-               string const tmp = libFileSearch(dir,
+               FileName const tmp = libFileSearch(dir,
                                                 token(l, '_', 0) + '_' + name,
                                                 ext);
                if (!tmp.empty())
@@ -313,7 +335,7 @@ string const i18nLibFileSearch(string const & dir, string const & name,
 }
 
 
-string const libScriptSearch(string const & command_in)
+string const libScriptSearch(string const & command_in, quote_style style)
 {
        static string const token_scriptpath = "$$s/";
 
@@ -330,8 +352,8 @@ string const libScriptSearch(string const & command_in)
                (command.size() - start_script) : pos2 - start_script;
 
        // Does this script file exist?
-       string const script =
-               libFileSearch(".", command.substr(start_script, size_script));
+       string const script = 
+               libFileSearch(".", command.substr(start_script, size_script)).absFilename();
 
        if (script.empty()) {
                // Replace "$$s/" with ""
@@ -339,7 +361,7 @@ string const libScriptSearch(string const & command_in)
        } else {
                // Replace "$$s/foo/some_script" with "<path to>/some_script".
                string::size_type const size_replace = size_script + 4;
-               command.replace(pos1, size_replace, quoteName(script));
+               command.replace(pos1, size_replace, quoteName(script, style));
        }
 
        return command;
@@ -348,13 +370,13 @@ string const libScriptSearch(string const & command_in)
 
 namespace {
 
-string const createTmpDir(string const & tempdir, string const & mask)
+FileName const createTmpDir(FileName const & tempdir, string const & mask)
 {
        lyxerr[Debug::FILES]
                << "createTmpDir: tempdir=`" << tempdir << "'\n"
                << "createTmpDir:    mask=`" << mask << '\'' << endl;
 
-       string const tmpfl = tempName(tempdir, mask);
+       FileName const tmpfl(tempName(tempdir, mask));
        // lyx::tempName actually creates a file to make sure that it
        // stays unique. So we have to delete it before we can create
        // a dir with the same name. Note also that we are not thread
@@ -364,18 +386,23 @@ string const createTmpDir(string const & tempdir, string const & mask)
        if (tmpfl.empty() || mkdir(tmpfl, 0700)) {
                lyxerr << "LyX could not create the temporary directory '"
                       << tmpfl << "'" << endl;
-               return string();
+               return FileName();
        }
 
-       return makeAbsPath(tmpfl);
+       return tmpfl;
 }
 
 } // namespace anon
 
 
-bool destroyDir(string const & tmpdir)
+bool destroyDir(FileName const & tmpdir)
 {
-       return fs::remove_all(tmpdir) > 0;
+       try {
+               return fs::remove_all(tmpdir.toFilesystemEncoding()) > 0;
+       } catch (fs::filesystem_error const & fe){
+               lyxerr << "Could not delete " << tmpdir << ". (" << fe.what() << ")" << std::endl;
+               return false;
+       }
 }
 
 
@@ -389,7 +416,7 @@ string const createBufferTmpDir()
                package().temp_dir() + "/lyx_tmpbuf" +
                convert<string>(count++);
 
-       if (mkdir(tmpfl, 0777)) {
+       if (mkdir(FileName(tmpfl), 0777)) {
                lyxerr << "LyX could not create the temporary directory '"
                       << tmpfl << "'" << endl;
                return string();
@@ -398,9 +425,9 @@ string const createBufferTmpDir()
 }
 
 
-string const createLyXTmpDir(string const & deflt)
+FileName const createLyXTmpDir(FileName const & deflt)
 {
-       if (!deflt.empty() && deflt != "/tmp") {
+       if (!deflt.empty() && deflt.absFilename() != "/tmp") {
                if (mkdir(deflt, 0777)) {
                        if (isDirWriteable(deflt)) {
                                // deflt could not be created because it
@@ -409,12 +436,12 @@ string const createLyXTmpDir(string const & deflt)
                                return createTmpDir(deflt, "lyx_tmpdir");
                        } else {
                                // some other error occured.
-                               return createTmpDir("/tmp", "lyx_tmpdir");
+                               return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
                        }
                } else
                        return deflt;
        } else {
-               return createTmpDir("/tmp", "lyx_tmpdir");
+               return createTmpDir(FileName("/tmp"), "lyx_tmpdir");
        }
 }
 
@@ -423,7 +450,7 @@ bool createDirectory(string const & path, int permission)
 {
        string temp = rtrim(os::internal_path(path), "/");
        BOOST_ASSERT(!temp.empty());
-       return mkdir(temp, permission) == 0;
+       return mkdir(FileName(temp), permission) == 0;
 }
 
 
@@ -443,11 +470,11 @@ string const onlyPath(string const & filename)
 // Convert relative path into absolute path based on a basepath.
 // If relpath is absolute, just use that.
 // If basepath is empty, use CWD as base.
-string const makeAbsPath(string const & relPath, string const & basePath)
+FileName const makeAbsPath(string const & relPath, string const & basePath)
 {
        // checks for already absolute path
        if (os::is_absolute_path(relPath))
-               return relPath;
+               return FileName(relPath);
 
        // Copies given paths
        string tempRel = os::internal_path(relPath);
@@ -459,7 +486,7 @@ string const makeAbsPath(string const & relPath, string const & basePath)
        if (os::is_absolute_path(basePath))
                tempBase = basePath;
        else
-               tempBase = addPath(getcwd(), basePath);
+               tempBase = addPath(getcwd().absFilename(), basePath);
 
        // Handle /./ at the end of the path
        while (suffixIs(tempBase, "/./"))
@@ -497,7 +524,7 @@ string const makeAbsPath(string const & relPath, string const & basePath)
        }
 
        // returns absolute path
-       return os::internal_path(tempBase);
+       return FileName(os::internal_path(tempBase));
 }
 
 
@@ -557,13 +584,13 @@ string const expandPath(string const & path)
        rTemp = split(rTemp, temp, '/');
 
        if (temp == ".")
-               return getcwd() + '/' + rTemp;
+               return getcwd().absFilename() + '/' + rTemp;
 
        if (temp == "~")
                return package().home_dir() + '/' + rTemp;
 
        if (temp == "..")
-               return makeAbsPath(copy);
+               return makeAbsPath(copy).absFilename();
 
        // Don't know how to handle this
        return copy;
@@ -588,10 +615,11 @@ string const normalizePath(string const & path)
 }
 
 
-string const getFileContents(string const & fname)
+string const getFileContents(FileName const & fname)
 {
-       if (fs::exists(fname)) {
-               ifstream ifs(fname.c_str());
+       string const encodedname = fname.toFilesystemEncoding();
+       if (fs::exists(encodedname)) {
+               ifstream ifs(encodedname.c_str());
                ostringstream ofs;
                if (ifs && ofs) {
                        ofs << ifs.rdbuf();
@@ -700,11 +728,6 @@ string const addPath(string const & path, string const & path_2)
 }
 
 
-/*
- Change extension of oldname to extension.
- Strips path off if no_path == true.
- If no extension on oldname, just appends.
- */
 string const changeExtension(string const & oldname, string const & extension)
 {
        string::size_type const last_slash = oldname.rfind('/');
@@ -729,6 +752,14 @@ string const removeExtension(string const & name)
 }
 
 
+string const addExtension(string const & name, string const & extension)
+{
+       if (!extension.empty() && extension[0] != '.')
+               return name + '.' + extension;
+       return name + extension;
+}
+
+
 /// Return the extension of the file (not including the .)
 string const getExtension(string const & name)
 {
@@ -770,13 +801,13 @@ string const getExtension(string const & name)
 // ZIP PK...                   http://www.halyava.ru/document/ind_arch.htm
 // Z   \037\235                UNIX compress
 
-string const getFormatFromContents(string const & filename)
+string const getFormatFromContents(FileName const & filename)
 {
        // paranoia check
        if (filename.empty() || !isFileReadable(filename))
                return string();
 
-       ifstream ifs(filename.c_str());
+       ifstream ifs(filename.toFilesystemEncoding().c_str());
        if (!ifs)
                // Couldn't open file...
                return string();
@@ -923,7 +954,7 @@ string const getFormatFromContents(string const & filename)
 
 
 /// check for zipped file
-bool zippedFile(string const & name)
+bool zippedFile(FileName const & name)
 {
        string const type = getFormatFromContents(name);
        if (contains("gzip zip compress", type) && !type.empty())
@@ -941,12 +972,15 @@ string const unzippedFileName(string const & zipped_file)
 }
 
 
-string const unzipFile(string const & zipped_file, string const & unzipped_file)
+FileName const unzipFile(FileName const & zipped_file, string const & unzipped_file)
 {
-       string const tempfile = unzipped_file.empty() ?
-               unzippedFileName(zipped_file) : unzipped_file;
+       FileName const tempfile = FileName(unzipped_file.empty() ?
+               unzippedFileName(zipped_file.toFilesystemEncoding()) :
+               unzipped_file);
        // Run gunzip
-       string const command = "gunzip -c " + zipped_file + " > " + tempfile;
+       string const command = "gunzip -c " +
+               zipped_file.toFilesystemEncoding() + " > " +
+               tempfile.toFilesystemEncoding();
        Systemcall one;
        one.startscript(Systemcall::Wait, command);
        // test that command was executed successfully (anon)
@@ -965,7 +999,7 @@ docstring const makeDisplayPath(string const & path, unsigned int threshold)
                str = subst(str, home, "~");
 
        if (str.length() <= threshold)
-               return lyx::from_utf8(os::external_path(str));
+               return from_utf8(os::external_path(str));
 
        string const prefix = ".../";
        string temp;
@@ -986,7 +1020,7 @@ docstring const makeDisplayPath(string const & path, unsigned int threshold)
                str = head + "..." + tail;
        }
 
-       return lyx::from_utf8(os::external_path(prefix + str));
+       return from_utf8(os::external_path(prefix + str));
 }
 
 
@@ -1001,7 +1035,7 @@ bool readLink(string const & file, string & link, bool resolve)
                return false;
        linkbuffer[nRead] = '\0'; // terminator
        if (resolve)
-               link = makeAbsPath(linkbuffer, onlyPath(file));
+               link = makeAbsPath(linkbuffer, onlyPath(file)).absFilename();
        else
                link = linkbuffer;
        return true;
@@ -1059,7 +1093,7 @@ cmd_ret const runCommand(string const & cmd)
 }
 
 
-string const findtexfile(string const & fil, string const & /*format*/)
+FileName const findtexfile(string const & fil, string const & /*format*/)
 {
        /* There is no problem to extend this function too use other
           methods to look for files. It could be setup to look
@@ -1072,8 +1106,9 @@ string const findtexfile(string const & fil, string const & /*format*/)
 
        // If the file can be found directly, we just return a
        // absolute path version of it.
-       if (fs::exists(fil))
-               return makeAbsPath(fil);
+       FileName const absfile(makeAbsPath(fil));
+       if (fs::exists(absfile.toFilesystemEncoding()))
+               return absfile;
 
        // No we try to find it using kpsewhich.
        // It seems from the kpsewhich manual page that it is safe to use
@@ -1100,12 +1135,13 @@ string const findtexfile(string const & fil, string const & /*format*/)
        cmd_ret const c = runCommand(kpsecmd);
 
        lyxerr[Debug::LATEX] << "kpse status = " << c.first << '\n'
-                << "kpse result = `" << rtrim(c.second, "\n")
+                << "kpse result = `" << rtrim(c.second, "\n\r")
                 << '\'' << endl;
        if (c.first != -1)
-               return os::internal_path(rtrim(c.second, "\n\r"));
+               return FileName(os::internal_path(rtrim(to_utf8(from_filesystem8bit(c.second)),
+                                                       "\n\r")));
        else
-               return string();
+               return FileName();
 }
 
 
@@ -1115,12 +1151,13 @@ void removeAutosaveFile(string const & filename)
        a += '#';
        a += onlyFilename(filename);
        a += '#';
-       if (fs::exists(a))
-               unlink(a);
+       FileName const autosave(a);
+       if (fs::exists(autosave.toFilesystemEncoding()))
+               unlink(autosave);
 }
 
 
-void readBB_lyxerrMessage(string const & file, bool & zipped,
+void readBB_lyxerrMessage(FileName const & file, bool & zipped,
        string const & message)
 {
        lyxerr[Debug::GRAPHICS] << "[readBB_from_PSFile] "
@@ -1133,7 +1170,7 @@ void readBB_lyxerrMessage(string const & file, bool & zipped,
 }
 
 
-string const readBB_from_PSFile(string const & file)
+string const readBB_from_PSFile(FileName const & file)
 {
        // in a (e)ps-file it's an entry like %%BoundingBox:23 45 321 345
        // It seems that every command in the header has an own line,
@@ -1143,7 +1180,7 @@ string const readBB_from_PSFile(string const & file)
        // %%BoundingBox: (atend)
        // In this case we must check the end.
        bool zipped = zippedFile(file);
-       string const file_ = zipped ?  unzipFile(file) : file;
+       FileName const file_ = zipped ? unzipFile(file) : file;
        string const format = getFormatFromContents(file_);
 
        if (format != "eps" && format != "ps") {
@@ -1153,7 +1190,7 @@ string const readBB_from_PSFile(string const & file)
 
        static boost::regex bbox_re(
                "^%%BoundingBox:\\s*([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)\\s+([[:digit:]]+)");
-       std::ifstream is(file_.c_str());
+       std::ifstream is(file_.toFilesystemEncoding().c_str());
        while (is) {
                string s;
                getline(is,s);
@@ -1176,14 +1213,13 @@ string const readBB_from_PSFile(string const & file)
 }
 
 
-int compare_timestamps(string const & file1, string const & file2)
+int compare_timestamps(FileName const & filename1, FileName const & filename2)
 {
-       BOOST_ASSERT(absolutePath(file1));
-       BOOST_ASSERT(absolutePath(file2));
-
        // If the original is newer than the copy, then copy the original
        // to the new directory.
 
+       string const file1 = filename1.toFilesystemEncoding();
+       string const file2 = filename2.toFilesystemEncoding();
        int cmp = 0;
        if (fs::exists(file1) && fs::exists(file2)) {
                double const tmp = difftime(fs::last_write_time(file1),