]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.C
remove !NEW_INSETS cruft
[lyx.git] / src / support / filetools.C
index 287a7e5860feac6f67e59f036beadfb6197866d3..d284417e243acb55f47bf4af750bbbc69d922679 100644 (file)
@@ -57,6 +57,7 @@ using std::make_pair;
 using std::pair;
 using std::endl;
 using std::ifstream;
+using std::vector;
 
 extern string system_lyxdir;
 extern string build_lyxdir;
@@ -66,7 +67,13 @@ extern string system_tempdir;
 
 bool IsLyXFilename(string const & filename)
 {
-       return contains(filename, ".lyx");
+       return suffixIs(filename, ".lyx");
+}
+
+
+bool IsSGMLFilename(string const & filename)
+{
+       return suffixIs(filename, ".sgml");
 }
 
 
@@ -74,14 +81,14 @@ bool IsLyXFilename(string const & filename)
 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:;<=>?[]`|");
        
@@ -98,44 +105,13 @@ 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 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));
-
-       // find a uniq postfix for the filename...
-       // using the pid, and...
-       tmpfl += tostr(getpid());
-       // a short string...
-       string ret;
-       FileInfo fnfo;
-       for (int a = 'a'; a <= 'z'; ++a)
-               for (int b = 'a'; b <= 'z'; ++b)
-                       for (int c = 'a'; c <= 'z'; ++c) {
-                               // if this is not enough I have no idea what
-                               // to do.
-                               ret = tmpfl + char(a) + char(b) + char(c);
-                               // check if the file exist
-                               if (!fnfo.newFile(ret).exist())
-                                       return ret;
-                       }
-       lyxerr << "Not able to find a uniq tmpfile name." << endl;
-       return string();
-}
-
-
 // Is a file readable ?
 bool IsFileReadable (string const & path)
 {
@@ -167,8 +143,10 @@ int IsFileWriteable (string const & path)
 //      -1: error- couldn't find out
 int IsDirWriteable (string const & path)
 {
-        string tmpfl(TmpFileName(path));
-
+        string const tmpfl(lyx::tempName(path, "lyxwritetest"));
+       // We must unlink the tmpfl.
+       lyx::unlink(tmpfl);
+       
        if (tmpfl.empty()) {
                WriteFSAlert(_("LyX Internal Error!"), 
                             _("Could not test if directory is writeable"));
@@ -220,6 +198,48 @@ string const FileOpenSearch (string const & path, string const & name,
 }
 
 
+/// Returns a vector of all files in directory dir having extension ext.
+vector<string> const DirList(string const & dir, string const & ext)
+{
+       // This is a non-error checking C/system implementation
+       string extension(ext);
+       if (!extension.empty() && extension[0] != '.')
+               extension.insert(0, ".");
+       vector<string> dirlist;
+       DIR * dirp = ::opendir(dir.c_str());
+       dirent * dire;
+       while ((dire = ::readdir(dirp))) {
+               string const fil = dire->d_name;
+               if (suffixIs(fil, extension)) {
+                       dirlist.push_back(fil);
+               }
+       }
+       ::closedir(dirp);
+       return dirlist;
+       /* I would have prefered to take a vector<string>& as parameter so
+          that we could avoid the copy of the vector when returning.
+          Then we would use:
+          dirlist.swap(argvec);
+          to avoid the copy. (Lgb)
+       */
+       /* A C++ implementaion will look like this:
+          string extension(ext);
+          if (extension[0] != '.') extension.insert(0, ".");
+          vector<string> dirlist;
+          directory_iterator dit("dir");
+          while (dit != directory_iterator()) {
+                  string fil = (*dit).filename;
+                  if (prefixIs(fil, extension)) {
+                          dirlist.push_back(fil);
+                  }
+                  ++dit;
+          }
+          dirlist.swap(argvec);
+          return;
+       */
+}
+
+
 // Returns the real name of file name in directory path, with optional
 // extension ext.  
 string const FileSearch(string const & path, string const & name, 
@@ -227,7 +247,7 @@ string const FileSearch(string const & path, string const & name,
 {
        // 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.
@@ -272,13 +292,13 @@ 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
@@ -291,7 +311,7 @@ string const GetEnv(string const & envname)
 {
         // f.ex. what about error checking?
         char const * const ch = getenv(envname.c_str());
-        string envstr = !ch ? "" : ch;
+        string const envstr = !ch ? "" : ch;
         return envstr;
 }
 
@@ -299,9 +319,9 @@ string const GetEnv(string const & envname)
 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, ';');
 }
@@ -324,7 +344,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
@@ -337,11 +357,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;
@@ -354,7 +374,8 @@ bool PutEnvPath(string const & envstr)
 }
 
 
-static
+namespace {
+
 int DeleteAllFilesInDir (string const & path)
 {
        // I have decided that we will be using parts from the boost
@@ -372,12 +393,12 @@ int DeleteAllFilesInDir (string const & path)
        //         if (filename == "." || filename == "..")
        //                 continue;
        //         string unlinkpath(AddName(path, filename));
-       //         if (remove(unlinkpath.c_str()))
+       //         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;
@@ -385,17 +406,17 @@ int DeleteAllFilesInDir (string const & path)
        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;
 
                bool deleted = true;
                if (FileInfo(unlinkpath).isDir())
                        deleted = (DeleteAllFilesInDir(unlinkpath) == 0);
-               deleted &= (remove(unlinkpath.c_str()) == 0);
+               deleted &= (lyx::unlink(unlinkpath) == 0);
                if (!deleted) {
                        WriteFSAlert (_("Error! Could not remove file:"), 
                                      unlinkpath);
@@ -407,12 +428,20 @@ int DeleteAllFilesInDir (string const & path)
 }
 
 
-static
-string const CreateTmpDir (string const & tempdir, string const & mask)
+string const CreateTmpDir(string const & tempdir, string const & mask)
 {
-       string tmpfl(TmpFileName(tempdir, mask));
+       lyxerr[Debug::FILES]
+               << "CreateTmpDir: tempdir=`" << tempdir << "'\n"
+               << "CreateTmpDir:    mask=`" << mask << "'" << endl;
        
-       if ((tmpfl.empty()) || lyx::mkdir (tmpfl.c_str(), 0777)) {
+       string const tmpfl(lyx::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
+       // safe because of the gap between unlink and mkdir. (Lgb)
+       lyx::unlink(tmpfl.c_str());
+       
+       if (tmpfl.empty() || lyx::mkdir(tmpfl, 0700)) {
                WriteFSAlert(_("Error! Couldn't create temporary directory:"),
                             tempdir);
                return string();
@@ -421,42 +450,43 @@ string const 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;
        }
        return 0; 
-} 
+}
 
+} // namespace anon
 
-string const CreateBufferTmpDir (string const & pathfor)
+
+string const CreateBufferTmpDir(string const & pathfor)
 {
-       return CreateTmpDir(pathfor, "lyx_bufrtmp");
+       return CreateTmpDir(pathfor, "lyx_tmpbuf");
 }
 
 
-int DestroyBufferTmpDir (string const & tmpdir)
+int DestroyBufferTmpDir(string const & tmpdir)
 {
        return DestroyTmpDir(tmpdir, true);
 }
 
 
-string const 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_tmpdir"));
                         return t;
                } else
                         return deflt;
@@ -464,13 +494,13 @@ string const CreateLyXTmpDir (string const & deflt)
 #ifdef __EMX__
                Path p(user_lyxdir);
 #endif
-               string t(CreateTmpDir ("/tmp", "lyx_tmp"));
+               string const t(CreateTmpDir("/tmp", "lyx_tmpdir"));
                return t;
        }
 }
 
 
-int DestroyLyXTmpDir (string const & tmpdir)
+int DestroyLyXTmpDir(string const & tmpdir)
 {
        return DestroyTmpDir (tmpdir, false); // Why false?
 }
@@ -487,7 +517,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;
        }
@@ -495,28 +525,6 @@ bool createDirectory(string const & path, int permission)
 }
 
 
-// Returns current working directory
-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)) {
-               // Buffer too small, double the buffersize and try again
-               delete[] tbuf;
-               n = 2 * n;
-               tbuf = new char[n];
-       }
-
-       string result;
-       if (err) result = tbuf;
-       delete[] tbuf;
-       return result;
-}
-
-
 // Strip filename from path name
 string const OnlyPath(string const & Filename)
 {
@@ -539,7 +547,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
        // checks for already absolute path
        if (AbsolutePath(RelPath))
 #ifdef __EMX__
-               if(RelPath[0]!= '/' && RelPath[0]!= '\\')
+               if (RelPath[0]!= '/' && RelPath[0]!= '\\')
 #endif
                return RelPath;
 
@@ -558,7 +566,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
                delete[] with_drive;
 #endif
        } else
-               TempBase = GetCWD();
+               TempBase = lyx::getcwd(); //GetCWD();
 #ifdef __EMX__
        if (AbsolutePath(TempRel))
                return TempBase.substr(0, 2) + TempRel;
@@ -579,7 +587,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
                if (Temp == ".") continue;
                if (Temp == "..") {
                        // Remove one level of TempBase
-                       int i = TempBase.length() - 2;
+                       string::difference_type i = TempBase.length() - 2;
 #ifndef __EMX__
                        if (i < 0) i = 0;
                        while (i > 0 && TempBase[i] != '/') --i;
@@ -611,7 +619,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
 string const AddName(string const & path, string const & fname)
 {
        // Get basename
-       string basename(OnlyFilename(fname));
+       string const basename(OnlyFilename(fname));
 
        string buf;
 
@@ -661,13 +669,13 @@ string const ExpandPath(string const & path)
                return RTemp;
 
        string Temp;
-       string copy(RTemp);
+       string const copy(RTemp);
 
        // Split by next /
        RTemp = split(RTemp, Temp, '/');
 
        if (Temp == ".") {
-               return GetCWD() + '/' + RTemp;
+               return lyx::getcwd() /*GetCWD()*/ + '/' + RTemp;
        } else if (Temp == "~") {
                return GetEnvPath("HOME") + '/' + RTemp;
        } else if (Temp == "..") {
@@ -701,7 +709,7 @@ string const NormalizePath(string const & path)
                        TempBase = "./";
                } else if (Temp == "..") {
                        // Remove one level of TempBase
-                       int i = TempBase.length() - 2;
+                       string::difference_type i = TempBase.length() - 2;
                        while (i > 0 && TempBase[i] != '/')
                                --i;
                        if (i >= 0 && TempBase[i] == '/')
@@ -848,22 +856,22 @@ string const MakeRelPath(string const & abspath0, string const & basepath0)
 // different, then the absolute path will be used as relative path.
 {
        // This is a hack. It should probaly be done in another way. Lgb.
-       string abspath = CleanupPath(abspath0);
-       string basepath = CleanupPath(basepath0);
+       string const abspath = CleanupPath(abspath0);
+       string const basepath = CleanupPath(basepath0);
        if (abspath.empty())
                return "<unknown_path>";
 
-       int const abslen = abspath.length();
-       int const baselen = basepath.length();
+       string::size_type const abslen = abspath.length();
+       string::size_type const baselen = basepath.length();
        
        // Find first different character
-       int i = 0;
+       string::size_type i = 0;
        while (i < abslen && i < baselen && abspath[i] == basepath[i]) ++i;
 
        // Go back to last /
        if (i < abslen && i < baselen
-           || (i<abslen && abspath[i] != '/' && i == baselen)
-           || (i<baselen && basepath[i] != '/' && i == abslen))
+           || (i < abslen && abspath[i] != '/' && i == baselen)
+           || (i < baselen && basepath[i] != '/' && i == abslen))
        {
                if (i) --i;     // here was the last match
                while (i && abspath[i] != '/') --i;
@@ -877,7 +885,7 @@ string const MakeRelPath(string const & abspath0, string const & basepath0)
        // Count how many dirs there are in basepath above match
        // and append as many '..''s into relpath
        string buf;
-       int j = i;
+       string::size_type j = i;
        while (j < baselen) {
                if (basepath[j] == '/') {
                        if (j + 1 == baselen) break;
@@ -904,7 +912,7 @@ string const MakeRelPath(string const & abspath0, string const & basepath0)
 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);
@@ -912,14 +920,9 @@ string const AddPath(string const & path, string const & path_2)
                        buf += '/';
        }
 
-       if (!path2.empty()){
-               int p2start = path2.find_first_not_of('/');
-
-               int p2end = path2.find_last_not_of('/');
+       if (!path2.empty())
+               buf += frontStrip(strip(path2, '/'), '/') + '/';
 
-               string tmp = path2.substr(p2start, p2end - p2start + 1);
-               buf += tmp + '/';
-       }
        return buf;
 }
 
@@ -932,7 +935,7 @@ string const AddPath(string const & path, string const & path_2)
 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;
@@ -940,7 +943,7 @@ 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;
 
@@ -951,8 +954,8 @@ 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 last_slash = name.rfind('/');
-       string::size_type last_dot = name.rfind('.');
+       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,
@@ -966,13 +969,13 @@ string const GetExtension(string const & name)
 string const
 MakeDisplayPath (string const & path, unsigned int threshold)
 {
-       int const l1 = path.length();
+       string::size_type const l1 = path.length();
 
        // First, we try a relative path compared to home
        string const home(GetEnvPath("HOME"));
        string relhome = MakeRelPath(path, home);
 
-       unsigned int l2 = relhome.length();
+       string::size_type l2 = relhome.length();
 
        string prefix;
 
@@ -1001,10 +1004,10 @@ MakeDisplayPath (string const & path, unsigned int threshold)
                        // Yes, filename in itself is too long.
                        // Pick the start and the end of the filename.
                        relhome = OnlyFilename(path);
-                       string head = relhome.substr(0, threshold/2 - 3);
+                       string const head = relhome.substr(0, threshold/2 - 3);
 
                        l2 = relhome.length();
-                       string tail =
+                       string const tail =
                                relhome.substr(l2 - threshold/2 - 2, l2 - 1);
                        relhome = head + "..." + tail;
                }
@@ -1017,17 +1020,20 @@ 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;
+       LinkBuffer[nRead] = '\0'; // terminator
        Link = LinkBuffer;
        return true;
 }
 
 
+namespace {
+
 typedef pair<int, string> cmdret;
-static
+
 cmdret const do_popen(string const & cmd)
 {
        // One question is if we should use popen or
@@ -1035,17 +1041,19 @@ cmdret const do_popen(string const & cmd)
        // 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) {
                ret += static_cast<char>(c);
                c = fgetc(inf);
        }
-       int pret = pclose(inf);
+       int const pret = pclose(inf);
        return make_pair(pret, ret);
 }
 
+} // namespace anon
+
 
 string const
 findtexfile(string const & fil, string const & /*format*/)
@@ -1101,9 +1109,9 @@ void removeAutosaveFile(string const & filename)
        a += '#';
        a += OnlyFilename(filename);
        a += '#';
-       FileInfo fileinfo(a);
+       FileInfo const fileinfo(a);
        if (fileinfo.exist()) {
-               if (::remove(a.c_str()) != 0) {
+               if (lyx::unlink(a) != 0) {
                        WriteFSAlert(_("Could not delete auto-save file!"), a);
                }
        }