]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.C
Fix small typos
[lyx.git] / src / support / filetools.C
index 33c6dd4d82c28ed541c9a6ac3a186862e0c840a9..8f19df47a52d3bd8a31d1d5e21f675e9072ad941 100644 (file)
 #include <utility>
 #include <fstream>
 
-#ifdef HAVE_SSTREAM
-#include <sstream>
-#else
-#include <strstream>
-#endif
+#include "Lsstream.h"
 
 #ifdef __GNUG__
 #pragma implementation "filetools.h"
@@ -75,17 +71,17 @@ bool IsLyXFilename(string const & filename)
 
 
 // Substitutes spaces with underscores in filename (and path)
-string MakeLatexName(string const & file)
+string const MakeLatexName(string const & file)
 {
        string name = OnlyFilename(file);
-       string path = OnlyPath(file);
+       string const path = OnlyPath(file);
        
        for (string::size_type i = 0; i < name.length(); ++i) {
                name[i] &= 0x7f; // set 8th bit to 0
        };
 
        // ok so we scan through the string twice, but who cares.
-       string keep("abcdefghijklmnopqrstuvwxyz"
+       string const keep("abcdefghijklmnopqrstuvwxyz"
                "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
                "@!\"'()*+,-./0123456789:;<=>?[]`|");
        
@@ -96,27 +92,28 @@ string MakeLatexName(string const & file)
        return AddName(path, name);
 }
 
+
 // Substitutes spaces with underscores in filename (and path)
-string QuoteName(string const & name)
+string const QuoteName(string const & name)
 {
        // CHECK Add proper emx support here!
 #ifndef __EMX__
-       return '\'' + name + '\'';
+       return "\'" + name + "\'";
 #else
        return name; 
 #endif
 }
 
 
-/// Returns an unique name to be used as a temporary file. 
-string TmpFileName(string const & dir, string const & mask)
+// Returns an unique name to be used as a temporary file. 
+string const TmpFileName(string const & dir, string const & mask)
 {// With all these temporary variables, it should be safe enough :-) (JMarc)
        string tmpdir;  
        if (dir.empty())
                tmpdir = system_tempdir;
        else
                tmpdir = dir;
-       string tmpfl = AddName(tmpdir, mask);
+       string tmpfl(AddName(tmpdir, mask));
 
        // find a uniq postfix for the filename...
        // using the pid, and...
@@ -170,7 +167,7 @@ int IsFileWriteable (string const & path)
 //      -1: error- couldn't find out
 int IsDirWriteable (string const & path)
 {
-        string tmpfl = TmpFileName(path);
+        string const tmpfl(TmpFileName(path));
 
        if (tmpfl.empty()) {
                WriteFSAlert(_("LyX Internal Error!"), 
@@ -189,8 +186,8 @@ int IsDirWriteable (string const & path)
 // If path entry begins with $$LyX/, use system_lyxdir
 // If path entry begins with $$User/, use user_lyxdir
 // Example: "$$User/doc;$$LyX/doc"
-string FileOpenSearch (string const & path, string const & name, 
-                      string const & ext)
+string const FileOpenSearch (string const & path, string const & name, 
+                            string const & ext)
 {
        string real_file, path_element;
        bool notfound = true;
@@ -225,12 +222,12 @@ string FileOpenSearch (string const & path, string const & name,
 
 // Returns the real name of file name in directory path, with optional
 // extension ext.  
-string FileSearch(string const & path, string const & name, 
-                 string const & ext)
+string const FileSearch(string const & path, string const & name, 
+                       string const & ext)
 {
        // if `name' is an absolute path, we ignore the setting of `path'
        // Expand Environmentvariables in 'name'
-       string tmpname = ReplaceEnvironmentPath(name);
+       string const tmpname = ReplaceEnvironmentPath(name);
        string fullname = MakeAbsPath(tmpname, path);
        
        // search first without extension, then with it.
@@ -253,8 +250,8 @@ string FileSearch(string const & path, string const & name,
 //   1) user_lyxdir
 //   2) build_lyxdir (if not empty)
 //   3) system_lyxdir
-string LibFileSearch(string const & dir, string const & name, 
-                    string const & ext)
+string const LibFileSearch(string const & dir, string const & name, 
+                          string const & ext)
 {
         string fullname = FileSearch(AddPath(user_lyxdir, dir),
                                     name, ext); 
@@ -271,16 +268,17 @@ string LibFileSearch(string const & dir, string const & name,
 }
 
 
-string i18nLibFileSearch(string const & dir, string const & name, 
-                        string const & ext)
+string const
+i18nLibFileSearch(string const & dir, string const & name, 
+                 string const & ext)
 {
-       string lang = token(string(GetEnv("LANG")), '_', 0);
+       string const lang = token(string(GetEnv("LANG")), '_', 0);
        
        if (lang.empty() || lang == "C")
                return LibFileSearch(dir, name, ext);
        else {
-               string tmp = LibFileSearch(dir, lang + '_' + name,
-                                          ext);
+               string const tmp = LibFileSearch(dir, lang + '_' + name,
+                                                ext);
                if (!tmp.empty())
                        return tmp;
                else
@@ -289,21 +287,21 @@ string i18nLibFileSearch(string const & dir, string const & name,
 }
 
 
-string GetEnv(string const & envname)
+string const GetEnv(string const & envname)
 {
         // f.ex. what about error checking?
-        char const * const ch = getenv(envname.c_str());
-        string envstr = !ch ? "" : ch;
+        char const * const ch = ::getenv(envname.c_str());
+        string const envstr = !ch ? "" : ch;
         return envstr;
 }
 
 
-string GetEnvPath(string const & name)
+string const GetEnvPath(string const & name)
 {
 #ifndef __EMX__
-        string pathlist = subst(GetEnv(name), ':', ';');
+        string const pathlist = subst(GetEnv(name), ':', ';');
 #else
-        string pathlist = subst(GetEnv(name), '\\', '/');
+        string const pathlist = subst(GetEnv(name), '\\', '/');
 #endif
         return strip(pathlist, ';');
 }
@@ -326,7 +324,7 @@ bool PutEnv(string const & envstr)
        char * leaker = new char[envstr.length() + 1];
        envstr.copy(leaker, envstr.length());
        leaker[envstr.length()] = '\0';
-       int retval = lyx::putenv(leaker);
+       int const retval = lyx::putenv(leaker);
 
        // If putenv does not make a copy of the char const * this
        // is very dangerous. OTOH if it does take a copy this is the
@@ -339,11 +337,11 @@ bool PutEnv(string const & envstr)
 #else
 #ifdef HAVE_SETENV 
         string varname;
-        string str = envstr.split(varname,'=');
-        int retval = setenv(varname.c_str(), str.c_str(), true);
+        string const str = envstr.split(varname,'=');
+        int const retval = ::setenv(varname.c_str(), str.c_str(), true);
 #else
        // No environment setting function. Can this happen?
-       int retval = 1; //return an error condition.
+       int const retval = 1; //return an error condition.
 #endif
 #endif
         return retval == 0;
@@ -363,49 +361,58 @@ int DeleteAllFilesInDir (string const & path)
        // library. Check out http://www.boost.org/
        // For directory access we will then use the directory_iterator.
        // Then the code will be something like:
-       // directory_iterator dit(path.c_str());
-       // if (<some way to detect failure>) {
+       // directory_iterator dit(path);
+       // directory_iterator dend;
+       // if (dit == dend) {
        //         WriteFSAlert(_("Error! Cannot open directory:"), path);
        //         return -1;
        // }
-       // for (; dit != <someend>; ++dit) {
-       //         if ((*dit) == 2." || (*dit) == "..")
+       // for (; dit != dend; ++dit) {
+       //         string filename(*dit);
+       //         if (filename == "." || filename == "..")
        //                 continue;
-       //         string unlinkpath = AddName(path, temp);
-       //         if (remove(unlinkpath.c_str()))
+       //         string unlinkpath(AddName(path, filename));
+       //         if (lyx::unlink(unlinkpath))
        //                 WriteFSAlert(_("Error! Could not remove file:"),
        //                              unlinkpath);
        // }
        // return 0;
-       DIR * dir = opendir(path.c_str());
+       DIR * dir = ::opendir(path.c_str());
        if (!dir) {
                WriteFSAlert (_("Error! Cannot open directory:"), path);
                return -1;
        }
        struct dirent * de;
+       int return_value = 0;
        while ((de = readdir(dir))) {
-               string temp = de->d_name;
+               string const temp = de->d_name;
                if (temp == "." || temp == "..") 
                        continue;
-               string unlinkpath = AddName (path, temp);
+               string const unlinkpath = AddName (path, temp);
 
                lyxerr.debug() << "Deleting file: " << unlinkpath << endl;
 
-               if (remove(unlinkpath.c_str()))
+               bool deleted = true;
+               if (FileInfo(unlinkpath).isDir())
+                       deleted = (DeleteAllFilesInDir(unlinkpath) == 0);
+               deleted &= (lyx::unlink(unlinkpath) == 0);
+               if (!deleted) {
                        WriteFSAlert (_("Error! Could not remove file:"), 
                                      unlinkpath);
+                       return_value = -1;
+               }
         }
        closedir(dir);
-       return 0;
+       return return_value;
 }
 
 
 static
-string CreateTmpDir (string const & tempdir, string const & mask)
+string const CreateTmpDir(string const & tempdir, string const & mask)
 {
-       string tmpfl = TmpFileName(tempdir, mask);
+       string const tmpfl(TmpFileName(tempdir, mask));
        
-       if ((tmpfl.empty()) || lyx::mkdir (tmpfl.c_str(), 0777)) {
+       if ((tmpfl.empty()) || lyx::mkdir(tmpfl, 0777)) {
                WriteFSAlert(_("Error! Couldn't create temporary directory:"),
                             tempdir);
                return string();
@@ -415,13 +422,13 @@ string CreateTmpDir (string const & tempdir, string const & mask)
 
 
 static
-int DestroyTmpDir (string const & tmpdir, bool Allfiles)
+int DestroyTmpDir(string const & tmpdir, bool Allfiles)
 {
 #ifdef __EMX__
        Path p(user_lyxdir);
 #endif
        if (Allfiles && DeleteAllFilesInDir(tmpdir)) return -1;
-       if (rmdir(tmpdir.c_str())) { 
+       if (lyx::rmdir(tmpdir)) { 
                WriteFSAlert(_("Error! Couldn't delete temporary directory:"), 
                             tmpdir);
                return -1;
@@ -430,26 +437,26 @@ int DestroyTmpDir (string const & tmpdir, bool Allfiles)
 } 
 
 
-string CreateBufferTmpDir (string const & pathfor)
+string const CreateBufferTmpDir(string const & pathfor)
 {
        return CreateTmpDir(pathfor, "lyx_bufrtmp");
 }
 
 
-int DestroyBufferTmpDir (string const & tmpdir)
+int DestroyBufferTmpDir(string const & tmpdir)
 {
        return DestroyTmpDir(tmpdir, true);
 }
 
 
-string CreateLyXTmpDir (string const & deflt)
+string const CreateLyXTmpDir(string const & deflt)
 {
        if ((!deflt.empty()) && (deflt  != "/tmp")) {
-               if (lyx::mkdir(deflt.c_str(), 0777)) {
+               if (lyx::mkdir(deflt, 0777)) {
 #ifdef __EMX__
                         Path p(user_lyxdir);
 #endif
-                       string t = CreateTmpDir (deflt.c_str(), "lyx_tmp");
+                       string const t(CreateTmpDir(deflt, "lyx_tmp"));
                         return t;
                } else
                         return deflt;
@@ -457,7 +464,7 @@ string CreateLyXTmpDir (string const & deflt)
 #ifdef __EMX__
                Path p(user_lyxdir);
 #endif
-               string t = CreateTmpDir ("/tmp", "lyx_tmp");
+               string const t(CreateTmpDir("/tmp", "lyx_tmp"));
                return t;
        }
 }
@@ -472,7 +479,7 @@ int DestroyLyXTmpDir (string const & tmpdir)
 // Creates directory. Returns true if succesfull
 bool createDirectory(string const & path, int permission)
 {
-       string temp = strip(CleanupPath(path), '/');
+       string temp(strip(CleanupPath(path), '/'));
 
        if (temp.empty()) {
                WriteAlert(_("Internal error!"),
@@ -480,7 +487,7 @@ bool createDirectory(string const & path, int permission)
                return false;
        }
 
-       if (lyx::mkdir(temp.c_str(), permission)) {
+       if (lyx::mkdir(temp, permission)) {
                WriteFSAlert (_("Error! Couldn't create directory:"), temp);
                return false;
        }
@@ -489,14 +496,14 @@ bool createDirectory(string const & path, int permission)
 
 
 // Returns current working directory
-string GetCWD ()
+string const GetCWD ()
 {
        int n = 256;    // Assume path is less than 256 chars
        char * err;
        char * tbuf = new char[n];
        
        // Safe. Hopefully all getcwds behave this way!
-       while (((err = lyx::getcwd (tbuf, n)) == 0) && (errno == ERANGE)) {
+       while (((err = lyx::getcwd(tbuf, n)) == 0) && (errno == ERANGE)) {
                // Buffer too small, double the buffersize and try again
                delete[] tbuf;
                n = 2 * n;
@@ -511,7 +518,7 @@ string GetCWD ()
 
 
 // Strip filename from path name
-string OnlyPath(string const & Filename)
+string const OnlyPath(string const & Filename)
 {
        // If empty filename, return empty
        if (Filename.empty()) return Filename;
@@ -527,7 +534,7 @@ string 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 MakeAbsPath(string const & RelPath, string const & BasePath)
+string const MakeAbsPath(string const & RelPath, string const & BasePath)
 {
        // checks for already absolute path
        if (AbsolutePath(RelPath))
@@ -537,7 +544,7 @@ string MakeAbsPath(string const & RelPath, string const & BasePath)
                return RelPath;
 
        // Copies given paths
-       string TempRel = CleanupPath(RelPath);
+       string TempRel(CleanupPath(RelPath));
 
        string TempBase;
 
@@ -562,7 +569,7 @@ string MakeAbsPath(string const & RelPath, string const & BasePath)
                TempBase.erase(TempBase.length() - 2);
 
        // processes relative path
-       string RTemp = TempRel;
+       string RTemp(TempRel);
        string Temp;
 
        while (!RTemp.empty()) {
@@ -601,10 +608,10 @@ string MakeAbsPath(string const & RelPath, string const & BasePath)
 // Correctly append filename to the pathname.
 // If pathname is '.', then don't use pathname.
 // Chops any path of filename.
-string AddName(string const & path, string const & fname)
+string const AddName(string const & path, string const & fname)
 {
        // Get basename
-       string basename = OnlyFilename(fname);
+       string const basename(OnlyFilename(fname));
 
        string buf;
 
@@ -619,7 +626,7 @@ string AddName(string const & path, string const & fname)
 
 
 // Strips path from filename
-string OnlyFilename(string const & fname)
+string const OnlyFilename(string const & fname)
 {
        if (fname.empty())
                return fname;
@@ -646,18 +653,18 @@ bool AbsolutePath(string const & path)
 
 // Create absolute path. If impossible, don't do anything
 // Supports ./ and ~/. Later we can add support for ~logname/. (Asger)
-string ExpandPath(string const & path)
+string const ExpandPath(string const & path)
 {
        // checks for already absolute path
-       string RTemp = ReplaceEnvironmentPath(path);
+       string RTemp(ReplaceEnvironmentPath(path));
        if (AbsolutePath(RTemp))
                return RTemp;
 
        string Temp;
-       string copy(RTemp);
+       string const copy(RTemp);
 
        // Split by next /
-       RTemp= split(RTemp, Temp, '/');
+       RTemp = split(RTemp, Temp, '/');
 
        if (Temp == ".") {
                return GetCWD() + '/' + RTemp;
@@ -674,7 +681,7 @@ string ExpandPath(string const & path)
 // Normalize a path
 // Constracts path/../path
 // Can't handle "../../" or "/../" (Asger)
-string NormalizePath(string const & path)
+string const NormalizePath(string const & path)
 {
        string TempBase;
        string RTemp;
@@ -710,7 +717,8 @@ string NormalizePath(string const & path)
        return TempBase;        
 }
 
-string CleanupPath(string const & path) 
+
+string const CleanupPath(string const & path) 
 {
 #ifdef __EMX__   /* SMiyata: This should fix searchpath bug. */
        string temppath = subst(path, '\\', '/');
@@ -721,28 +729,17 @@ string CleanupPath(string const & path)
 #endif
 }
 
-string GetFileContents(string const & fname) {
+
+string const GetFileContents(string const & fname)
+{
        FileInfo finfo(fname);
        if (finfo.exist()) {
                ifstream ifs(fname.c_str());
-#ifdef HAVE_SSTREAM
                std::ostringstream ofs;
-#else
-#warning The rumour goes that this might leak, but who really cares?
-               ostrstream ofs;
-#endif
                if (ifs && ofs) {
                        ofs << ifs.rdbuf();
                        ifs.close();
-#ifdef HAVE_SSTREAM
-                       return ofs.str();
-#else
-                       ofs << '\0';
-                       char const * tmp = ofs.str();
-                       string ret(tmp);
-                       delete[] tmp;
-                       return ret;
-#endif
+                       return ofs.str().c_str();
                }
        }
        lyxerr << "LyX was not able to read file '" << fname << "'" << endl;
@@ -757,7 +754,7 @@ string GetFileContents(string const & fname) {
 //  variable :=  '$' '{' [A-Za-z_]{[A-Za-z_0-9]*} '}'
 //
 
-string ReplaceEnvironmentPath(string const & path)
+string const ReplaceEnvironmentPath(string const & path)
 {
 // 
 // CompareChar: Environmentvariables starts with this character
@@ -828,7 +825,7 @@ string ReplaceEnvironmentPath(string const & path)
                        continue;
                }
             
-               string env = GetEnv(res1_contents+1);
+               string env(GetEnv(res1_contents + 1));
                if (!env.empty()) {
                        // Congratulations. Environmentvariable found
                        result1 += env;
@@ -844,7 +841,7 @@ string ReplaceEnvironmentPath(string const & path)
 
 
 // Make relative path out of two absolute paths
-string MakeRelPath(string const & abspath0, string const & basepath0)
+string const MakeRelPath(string const & abspath0, string const & basepath0)
 // Makes relative path out of absolute path. If it is deeper than basepath,
 // it's easy. If basepath and abspath share something (they are all deeper
 // than some directory), it'll be rendered using ..'s. If they are completely
@@ -856,8 +853,8 @@ string MakeRelPath(string const & abspath0, string const & basepath0)
        if (abspath.empty())
                return "<unknown_path>";
 
-       const int abslen = abspath.length();
-       const int baselen = basepath.length();
+       int const abslen = abspath.length();
+       int const baselen = basepath.length();
        
        // Find first different character
        int i = 0;
@@ -904,10 +901,10 @@ string MakeRelPath(string const & abspath0, string const & basepath0)
 
 
 // Append sub-directory(ies) to a path in an intelligent way
-string AddPath(string const & path, string const & path_2)
+string const AddPath(string const & path, string const & path_2)
 {
        string buf;
-       string path2 = CleanupPath(path_2);
+       string const path2 = CleanupPath(path_2);
 
        if (!path.empty() && path != "." && path != "./") {
                buf = CleanupPath(path);
@@ -932,9 +929,10 @@ string AddPath(string const & path, string const & path_2)
  Strips path off if no_path == true.
  If no extension on oldname, just appends.
  */
-string ChangeExtension(string const & oldname, string const & extension)
+string const
+ChangeExtension(string const & oldname, string const & extension)
 {
-       string::size_type last_slash = oldname.rfind('/');
+       string::size_type const last_slash = oldname.rfind('/');
        string::size_type last_dot = oldname.rfind('.');
        if (last_dot < last_slash && last_slash != string::npos)
                last_dot = string::npos;
@@ -942,7 +940,7 @@ string ChangeExtension(string const & oldname, string const & extension)
        string ext;
        // Make sure the extension starts with a dot
        if (!extension.empty() && extension[0] != '.')
-               ext= '.' + extension;
+               ext= "." + extension;
        else
                ext = extension;
 
@@ -950,13 +948,28 @@ string ChangeExtension(string const & oldname, string const & extension)
 }
 
 
+/// Return the extension of the file (not including the .)
+string const GetExtension(string const & name)
+{
+       string::size_type const last_slash = name.rfind('/');
+       string::size_type const last_dot = name.rfind('.');
+       if (last_dot != string::npos &&
+           (last_slash == string::npos || last_dot > last_slash))
+               return name.substr(last_dot + 1,
+                                  name.length() - (last_dot + 1));
+       else
+               return string();
+}
+
+
 // Creates a nice compact path for displaying
-string MakeDisplayPath (string const & path, unsigned int threshold)
+string const
+MakeDisplayPath (string const & path, unsigned int threshold)
 {
-       const int l1 = path.length();
+       int const l1 = path.length();
 
        // First, we try a relative path compared to home
-       string home = GetEnvPath("HOME");
+       string const home(GetEnvPath("HOME"));
        string relhome = MakeRelPath(path, home);
 
        unsigned int l2 = relhome.length();
@@ -1004,7 +1017,8 @@ bool LyXReadLink(string const & File, string & Link)
 {
        char LinkBuffer[512];
        // Should be PATH_MAX but that needs autconf support
-       int nRead = readlink(File.c_str(), LinkBuffer, sizeof(LinkBuffer)-1);
+       int const nRead = ::readlink(File.c_str(),
+                                    LinkBuffer, sizeof(LinkBuffer) - 1);
        if (nRead <= 0)
                return false;
        LinkBuffer[nRead] = 0;
@@ -1015,14 +1029,14 @@ bool LyXReadLink(string const & File, string & Link)
 
 typedef pair<int, string> cmdret;
 static
-cmdret do_popen(string const & cmd)
+cmdret const do_popen(string const & cmd)
 {
        // One question is if we should use popen or
        // create our own popen based on fork, exec, pipe
        // of course the best would be to have a
        // pstream (process stream), with the
        // variants ipstream, opstream
-       FILE * inf = popen(cmd.c_str(), "r");
+       FILE * inf = ::popen(cmd.c_str(), "r");
        string ret;
        int c = fgetc(inf);
        while (c != EOF) {
@@ -1034,7 +1048,8 @@ cmdret do_popen(string const & cmd)
 }
 
 
-string findtexfile(string const & fil, string const & /*format*/)
+string 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
@@ -1070,12 +1085,27 @@ string findtexfile(string const & fil, string const & /*format*/)
        // tfm - TFMFONTS, TEXFONTS
        // This means that to use kpsewhich in the best possible way we
        // should help it by setting additional path in the approp. envir.var.
-        string kpsecmd = "kpsewhich " + fil;
+        string const kpsecmd = "kpsewhich " + fil;
 
-        cmdret c = do_popen(kpsecmd);
+        cmdret const c = do_popen(kpsecmd);
        
         lyxerr[Debug::LATEX] << "kpse status = " << c.first << "\n"
                             << "kpse result = `" << strip(c.second, '\n') 
                             << "'" << endl;
         return c.first != -1 ? strip(c.second, '\n') : string();
 }
+
+
+void removeAutosaveFile(string const & filename)
+{
+       string a = OnlyPath(filename);
+       a += '#';
+       a += OnlyFilename(filename);
+       a += '#';
+       FileInfo fileinfo(a);
+       if (fileinfo.exist()) {
+               if (lyx::unlink(a) != 0) {
+                       WriteFSAlert(_("Could not delete auto-save file!"), a);
+               }
+       }
+}