2 /* lyx-filetool.h : tools functions for file/path handling
3 this file is part of LyX, the High Level Word Processor
4 Copyright 1995-2000, Matthias Ettrich and the LyX Team
20 #include "support/lstrings.h"
24 string const CreateBufferTmpDir (string const & pathfor = string());
26 /// Creates directory. Returns true on succes.
27 bool createDirectory(string const & name, int permissions);
30 string const CreateLyXTmpDir (string const & deflt);
33 int DestroyBufferTmpDir (string const & tmpdir);
36 int DestroyLyXTmpDir (string const & tmpdir);
38 /** Find file by searching several directories.
39 Uses a string of paths separated by ";"s to find a file to open.
40 Can't cope with pathnames with a ';' in them. Returns full path to file.
41 If path entry begins with $$LyX/, use system_lyxdir.
42 If path entry begins with $$User/, use user_lyxdir.
43 Example: "$$User/doc;$$LyX/doc".
45 string const FileOpenSearch (string const & path, string const & name,
46 string const & ext = string());
48 /** Returns the real name of file name in directory path, with optional
50 The file is searched in the given path (unless it is an absolute
51 file name), first directly, and then with extension .ext (if given).
53 string const FileSearch(string const & path, string const & name,
54 string const & ext = string());
56 /** Is directory read only?
60 -1: error- couldn't find out, or unsure
62 int IsDirWriteable (string const & path);
64 /** Is a file readable ?
65 Returns true if the file `path' is readable.
67 bool IsFileReadable (string const & path);
69 /** Is file read only?
73 -1: error (doesn't exist, no access, anything else)
75 int IsFileWriteable (string const & path);
78 bool IsLyXFilename(string const & filename);
80 /** Returns the path of a library data file.
81 Search the file name.ext in the subdirectory dir of
84 \item build_lyxdir (if not empty)
87 The third parameter `ext' is optional.
89 string const LibFileSearch(string const & dir, string const & name,
90 string const & ext = string());
92 /** Same as LibFileSearch(), but tries first to find an
93 internationalized version of the file by prepending $LANG_ to the
97 i18nLibFileSearch(string const & dir, string const & name,
98 string const & ext = string());
101 string const GetEnv(string const & envname);
103 /// A helper function.
104 string const GetEnvPath(string const & name);
107 bool PutEnv(string const & envstr);
110 bool PutEnvPath(string const & envstr);
112 /// Substitutes active latex characters with underscores in filename
113 string const MakeLatexName(string const & file);
115 /// Put the name in quotes suitable for the current shell
116 string const QuoteName(string const & file);
118 /** Returns an unique name to be used as a temporary file. If given,
119 'mask' should the prefix to the temporary file, the rest of the
120 temporary filename will be made from the pid and three letters.
123 TmpFileName(string const & dir = string(),
124 string const & mask = "lyx_tmp");
126 /// Is a filename/path absolute?
127 bool AbsolutePath(string const & path);
129 /// Add a filename to a path. Any path from filename is stripped first.
130 string const AddName(string const & path, string const & fname);
132 /// Append sub-directory(ies) to path in an intelligent way
133 string const AddPath(string const & path, string const & path2);
135 /** Change extension of oldname to extension.
136 If oldname does not have an extension, it is appended.
137 If the extension is empty, any extension is removed from the name.
140 ChangeExtension(string const & oldname, string const & extension);
142 /// Create absolute path. If impossible, don't do anything
143 string const ExpandPath(string const & path);
145 /// gets current working directory
146 string const GetCWD();
149 /** Convert relative path into absolute path based on a basepath.
150 If relpath is absolute, just use that.
151 If basepath doesn't exist use CWD.
153 string const MakeAbsPath(string const & RelPath = string(),
154 string const & BasePath = string());
156 /** Creates a nice compact path for displaying. The parameter
157 threshold, if given, specifies the maximal length of the path.
160 MakeDisplayPath(string const & path,
161 unsigned int threshold = 1000);
163 /** Makes relative path out of absolute path.
164 If it is deeper than basepath,
165 it's easy. If basepath and abspath share something (they are all deeper
166 than some directory), it'll be rendered using ..'s. If they are completely
167 different, then the absolute path will be used as relative path
168 WARNING: the absolute path and base path must really be absolute paths!!!
171 MakeRelPath(string const & abspath, string const & basepath);
173 /// Strip filename from path name
174 string const OnlyPath(string const & fname);
176 /// Normalize a path. Constracts path/../path
177 string const NormalizePath(string const & path);
179 /// Strips path from filename
180 string const OnlyFilename(string const & fname);
182 /// Get the contents of a file as a huge string
183 string const GetFileContents(string const & fname);
185 /// Cleanup a path if necessary. Currently only useful with OS/2
186 string const CleanupPath(string const & path);
188 /** Check and Replace Environmentvariables ${NAME} in Path.
189 Replaces all occurences of these, if they are found in the
191 Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
193 string const ReplaceEnvironmentPath(string const & path);
195 /* Set Link to the path file points to as a symbolic link.
196 Returns true if successful */
197 bool LyXReadLink(string const & file, string & Link);
199 /* Uses kpsewhich to find tex files */
200 string const findtexfile(string const & fil, string const & format);