]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.C
various changes
[lyx.git] / src / support / filetools.C
index 5d084b314135850f8fc6f3d2d5d53ea3443214ad..10335730aac05a05de296288debc686638ebdd97 100644 (file)
@@ -32,9 +32,9 @@
 #include "lyx_gui_misc.h"
 #include "FileInfo.h"
 #include "support/path.h"        // I know it's OS/2 specific (SMiyata)
-#include "support/syscall.h"
 #include "gettext.h"
 #include "lyxlib.h"
+#include "os.h"
 
 // Which part of this is still necessary? (JMarc).
 #if HAVE_DIRENT_H
@@ -60,13 +60,6 @@ using std::endl;
 using std::ifstream;
 using std::vector;
 
-#if 0
-using std::getenv;
-using std::isalpha;
-using std::isalnum;
-using std::popen;
-#endif
-
 extern string system_lyxdir;
 extern string build_lyxdir;
 extern string user_lyxdir;
@@ -75,7 +68,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");
 }
 
 
@@ -105,48 +104,12 @@ string const MakeLatexName(string const & file)
 // Substitutes spaces with underscores in filename (and path)
 string const QuoteName(string const & name)
 {
-       // CHECK Add proper emx support here!
-#ifndef __EMX__
-       return "\'" + name + "\'";
-#else
-       return name; 
-#endif
+       return (os::shell() == os::UNIX) ?
+               "\'" + name + "\'":
+               "\"" + name + "\"";
 }
 
 
-#if 0
-// 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();
-}
-#endif
-
-
 // Is a file readable ?
 bool IsFileReadable (string const & path)
 {
@@ -178,8 +141,10 @@ int IsFileWriteable (string const & path)
 //      -1: error- couldn't find out
 int IsDirWriteable (string const & path)
 {
-        string const tmpfl(lyx::tempName(path)); //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"));
@@ -205,7 +170,7 @@ string const FileOpenSearch (string const & path, string const & name,
        string tmppath = split(path, path_element, ';');
        
        while (notfound && !path_element.empty()) {
-               path_element = CleanupPath(path_element);
+               path_element = os::slashify_path(path_element);
                if (!suffixIs(path_element, '/'))
                        path_element+= '/';
                path_element = subst(path_element, "$$LyX", system_lyxdir);
@@ -232,67 +197,44 @@ 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)
+vector<string> const DirList(string const & dir, string const & ext)
 {
-       // What what what????
-       // where you tinking when you implemented this?
-#if 0
-       string lsCommand = "ls " + dir;
-       if (!ext.empty()) {
-               string::size_type sz = lsCommand.size();
-               if (lsCommand[sz - 1] != '/')
-                       lsCommand += '/';
-               lsCommand += '*';
-               if (ext[0] != '.')
-                       lsCommand += '.';
-               lsCommand += ext;
-       }
-       string tmpfile = system_tempdir + "/dirlist";
-       lsCommand += " > " + tmpfile;
-
-       Systemcalls(Systemcalls::System, lsCommand);
-
-       string contents = GetFileContents(tmpfile);
-       string rmCommand = "rm " + tmpfile;
-       Systemcalls(Systemcalls::System, rmCommand);
-
-       string tmp = strip(contents);
-       vector<string> dirlist;
-
-       while (!tmp.empty()) {
-               string file;
-               tmp = frontStrip(split(tmp, file, '\n'));
-               dirlist.push_back( file );
-       }
-       return dirlist;
-#else
        // This is a non-error checking C/system implementation
-       // of the above.
        string extension(ext);
-       if (extension[0] != '.') extension.insert(0u, 1u, '.');
+       if (!extension.empty() && extension[0] != '.')
+               extension.insert(0, ".");
        vector<string> dirlist;
        DIR * dirp = ::opendir(dir.c_str());
        dirent * dire;
        while ((dire = ::readdir(dirp))) {
-               string fil = dire->d_name;
-               if (prefixIs(fil, extension)) {
+               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:
-          if (ext[0] != '.') ext.insert(0u, 1u, '.');
+          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, ext)) {
+                  if (prefixIs(fil, extension)) {
                           dirlist.push_back(fil);
                   }
                   ++dit;
           }
+          dirlist.swap(argvec);
+          return;
        */
-#endif
 }
 
 
@@ -305,7 +247,6 @@ string const FileSearch(string const & path, string const & name,
        // Expand Environmentvariables in 'name'
        string const tmpname = ReplaceEnvironmentPath(name);
        string fullname = MakeAbsPath(tmpname, path);
-       
        // search first without extension, then with it.
        if (IsFileReadable(fullname))
                return fullname;
@@ -377,7 +318,7 @@ string const GetEnvPath(string const & name)
 #ifndef __EMX__
         string const pathlist = subst(GetEnv(name), ':', ';');
 #else
-        string const pathlist = subst(GetEnv(name), '\\', '/');
+        string const pathlist = os::slashify_path(GetEnv(name));
 #endif
         return strip(pathlist, ';');
 }
@@ -430,7 +371,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
@@ -483,12 +425,11 @@ int DeleteAllFilesInDir (string const & path)
 }
 
 
-static
 string const CreateTmpDir(string const & tempdir, string const & mask)
 {
-#warning Possibly buggy (Lgb)
-       lyxerr << "CreateTmpDir: tempdir=`" << tempdir << "'" << endl;
-       lyxerr << "CreateTmpDir:    mask=`" << mask << "'" << endl;
+       lyxerr[Debug::FILES]
+               << "CreateTmpDir: tempdir=`" << tempdir << "'\n"
+               << "CreateTmpDir:    mask=`" << mask << "'" << endl;
        
        string const tmpfl(lyx::tempName(tempdir, mask));
        // lyx::tempName actually creates a file to make sure that it
@@ -497,7 +438,7 @@ string const CreateTmpDir(string const & tempdir, string const & mask)
        // safe because of the gap between unlink and mkdir. (Lgb)
        lyx::unlink(tmpfl.c_str());
        
-       if (tmpfl.empty() || lyx::mkdir(tmpfl, 0777)) {
+       if (tmpfl.empty() || lyx::mkdir(tmpfl, 0700)) {
                WriteFSAlert(_("Error! Couldn't create temporary directory:"),
                             tempdir);
                return string();
@@ -506,7 +447,6 @@ string const CreateTmpDir(string const & tempdir, string const & mask)
 }
 
 
-static
 int DestroyTmpDir(string const & tmpdir, bool Allfiles)
 {
 #ifdef __EMX__
@@ -519,12 +459,25 @@ int DestroyTmpDir(string const & tmpdir, bool Allfiles)
                return -1;
        }
        return 0; 
-} 
+}
+
+} // namespace anon
 
 
 string const CreateBufferTmpDir(string const & pathfor)
 {
-       return CreateTmpDir(pathfor, "lyx_tmpbuf");
+       static int count;
+       static string const tmpdir(pathfor.empty() ? os::getTmpDir() : pathfor);
+       // We are in our own directory.  Why bother to mangle name?
+       // In fact I wrote this code to circumvent a problematic behaviour (bug?)
+       // of EMX mkstemp().
+       string const tmpfl = tmpdir + "/lyx_tmpbuf" + tostr(count++);
+       if (lyx::mkdir(tmpfl, 0777)) {
+               WriteFSAlert(_("Error! Couldn't create temporary directory:"),
+                            tmpdir);
+               return string();
+       }
+       return tmpfl;
 }
 
 
@@ -555,7 +508,7 @@ string const CreateLyXTmpDir(string const & deflt)
 }
 
 
-int DestroyLyXTmpDir (string const & tmpdir)
+int DestroyLyXTmpDir(string const & tmpdir)
 {
        return DestroyTmpDir (tmpdir, false); // Why false?
 }
@@ -564,7 +517,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(os::slashify_path(path), '/'));
 
        if (temp.empty()) {
                WriteAlert(_("Internal error!"),
@@ -580,30 +533,6 @@ bool createDirectory(string const & path, int permission)
 }
 
 
-#if 0
-// 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;
-}
-#endif
-
-
 // Strip filename from path name
 string const OnlyPath(string const & Filename)
 {
@@ -625,32 +554,20 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
 {
        // checks for already absolute path
        if (AbsolutePath(RelPath))
-#ifdef __EMX__
-               if (RelPath[0]!= '/' && RelPath[0]!= '\\')
-#endif
                return RelPath;
 
        // Copies given paths
-       string TempRel(CleanupPath(RelPath));
+       string TempRel(os::slashify_path(RelPath));
+       // Since TempRel is NOT absolute, we can safely replace "//" with "/"
+       TempRel = subst(TempRel, "//", "/");
 
        string TempBase;
 
-       if (!BasePath.empty()) {
-#ifndef __EMX__
+       if (AbsolutePath(BasePath))
                TempBase = BasePath;
-#else
-               char * with_drive = new char[_MAX_PATH];
-               _abspath(with_drive, BasePath.c_str(), _MAX_PATH);
-               TempBase = with_drive;
-               delete[] with_drive;
-#endif
-       } else
-               TempBase = lyx::getcwd(); //GetCWD();
-#ifdef __EMX__
-       if (AbsolutePath(TempRel))
-               return TempBase.substr(0, 2) + TempRel;
-#endif
-
+       else
+               TempBase = AddPath(lyx::getcwd(), BasePath);
+       
        // Handle /./ at the end of the path
        while(suffixIs(TempBase, "/./"))
                TempBase.erase(TempBase.length() - 2);
@@ -679,6 +596,9 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
                                TempBase.erase(i, string::npos);
                        else
                                TempBase += '/';
+               } else if (Temp.empty() && !RTemp.empty()) {
+                               TempBase = os::current_root() + RTemp;
+                               RTemp.erase();
                } else {
                        // Add this piece to TempBase
                        if (!suffixIs(TempBase, '/'))
@@ -688,7 +608,7 @@ string const MakeAbsPath(string const & RelPath, string const & BasePath)
        }
 
        // returns absolute path
-       return TempBase;
+       return os::slashify_path(TempBase);
 }
 
 
@@ -703,7 +623,7 @@ string const AddName(string const & path, string const & fname)
        string buf;
 
        if (path != "." && path != "./" && !path.empty()) {
-               buf = CleanupPath(path);
+               buf = os::slashify_path(path);
                if (!suffixIs(path, '/'))
                        buf += '/';
        }
@@ -733,7 +653,7 @@ bool AbsolutePath(string const & path)
 #ifndef __EMX__
        return (!path.empty() && path[0] == '/');
 #else
-       return (!path.empty() && (path[0] == '/' || (isalpha(static_cast<unsigned char>(path[0])) && path.length()>1 && path[1] == ':')));
+       return (!path.empty() && isalpha(static_cast<unsigned char>(path[0])) && path.length() > 1 && path[1] == ':');
 #endif
 }
 
@@ -805,18 +725,6 @@ string const NormalizePath(string const & path)
 }
 
 
-string const CleanupPath(string const & path) 
-{
-#ifdef __EMX__   /* SMiyata: This should fix searchpath bug. */
-       string temppath = subst(path, '\\', '/');
-       temppath = subst(temppath, "//", "/");
-       return lowercase(temppath);
-#else // On unix, nothing to do
-       return path;
-#endif
-}
-
-
 string const GetFileContents(string const & fname)
 {
        FileInfo finfo(fname);
@@ -928,33 +836,16 @@ string const ReplaceEnvironmentPath(string const & path)
 
 
 // Make relative path out of two absolute paths
-string const MakeRelPath(string const & abspath0, string const & basepath0)
+string const MakeRelPath(string const & abspath, string const & basepath)
 // 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
 // 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);
-       if (abspath.empty())
-               return "<unknown_path>";
-
        string::size_type const abslen = abspath.length();
        string::size_type const baselen = basepath.length();
-       
-       // Find first different character
-       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))
-       {
-               if (i) --i;     // here was the last match
-               while (i && abspath[i] != '/') --i;
-       }
+
+       string::size_type i = os::common_path(abspath, basepath);
 
        if (i == 0) {
                // actually no match - cannot make it relative
@@ -991,20 +882,18 @@ string const MakeRelPath(string const & abspath0, string const & basepath0)
 string const AddPath(string const & path, string const & path_2)
 {
        string buf;
-       string const path2 = CleanupPath(path_2);
+       string const path2 = os::slashify_path(path_2);
 
        if (!path.empty() && path != "." && path != "./") {
-               buf = CleanupPath(path);
+               buf = os::slashify_path(path);
                if (path[path.length() - 1] != '/')
                        buf += '/';
        }
 
-       if (!path2.empty()){
-               string::size_type p2start = path2.find_first_not_of('/');
-
-               string::size_type p2end = path2.find_last_not_of('/');
-
-               string tmp = path2.substr(p2start, p2end - p2start + 1);
+       if (!path2.empty()) {
+               string::size_type const p2start = path2.find_first_not_of('/');
+               string::size_type const p2end = path2.find_last_not_of('/');
+               string const tmp = path2.substr(p2start, p2end - p2start + 1);
                buf += tmp + '/';
        }
        return buf;
@@ -1031,7 +920,7 @@ ChangeExtension(string const & oldname, string const & extension)
        else
                ext = extension;
 
-       return CleanupPath(oldname.substr(0, last_dot) + ext);
+       return os::slashify_path(oldname.substr(0, last_dot) + ext);
 }
 
 
@@ -1088,10 +977,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;
                }
@@ -1108,14 +997,16 @@ bool LyXReadLink(string const & File, string & Link)
                                     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
@@ -1130,10 +1021,12 @@ cmdret const do_popen(string const & cmd)
                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*/)
@@ -1189,7 +1082,7 @@ void removeAutosaveFile(string const & filename)
        a += '#';
        a += OnlyFilename(filename);
        a += '#';
-       FileInfo fileinfo(a);
+       FileInfo const fileinfo(a);
        if (fileinfo.exist()) {
                if (lyx::unlink(a) != 0) {
                        WriteFSAlert(_("Could not delete auto-save file!"), a);