src/support/filetools.h

   1 // -*- C++ -*-
   2 /**
   3  * \file filetools.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef LYX_FILETOOL_H
  13 #define LYX_FILETOOL_H
  14
  15 #include <vector>
  16 #include <utility>
  17 #include <string>
  18
  19 namespace lyx {
  20 namespace support {
  21
  22 /// remove directory and all contents, returns true on success
  23 bool destroyDir(std::string const & tmpdir);
  24
  25 /// Creates the per buffer temporary directory
  26 std::string const createBufferTmpDir();
  27
  28 /// Creates directory. Returns true on success
  29 bool createDirectory(std::string const & name, int permissions);
  30
  31 /** Creates the global LyX temp dir.
  32   \p deflt can be an existing directory name. In this case a new directory
  33   inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
  34   created and used as the temporary directory.
  35   \return the tmp dir name or string() if something went wrong.
  36  */
  37 std::string const createLyXTmpDir(std::string const & deflt);
  38
  39 /** Find file by searching several directories.
  40   Uses a string of paths separated by ";"s to find a file to open.
  41     Can't cope with pathnames with a ';' in them. Returns full path to file.
  42     If path entry begins with $$LyX/, use system_lyxdir.
  43     If path entry begins with $$User/, use user_lyxdir.
  44     Example: "$$User/doc;$$LyX/doc".
  45 */
  46 std::string const FileOpenSearch(std::string const & path, std::string const & name,
  47                        std::string const & ext = std::string());
  48
  49 /** Returns the real name of file name in directory path, with optional
  50   extension ext.
  51   The file is searched in the given path (unless it is an absolute
  52   file name), first directly, and then with extension .ext (if given).
  53   */
  54 std::string const FileSearch(std::string const & path, std::string const & name,
  55                   std::string const & ext = std::string());
  56
  57 /// Returns a vector of all files in directory dir having extension ext.
  58 std::vector<std::string> const DirList(std::string const & dir,
  59                                   std::string const & ext = std::string());
  60
  61 /** Is directory read only?
  62   returns
  63     true: dir writeable
  64     false: not writeable
  65 */
  66 bool isDirWriteable (std::string const & path);
  67
  68 /** Is a file readable ?
  69   Returns true if the file `path' is readable.
  70  */
  71 bool isFileReadable (std::string const & path);
  72
  73 ///
  74 bool isLyXFilename(std::string const & filename);
  75
  76 ///
  77 bool isSGMLFilename(std::string const & filename);
  78
  79 /** Returns the path of a library data file.
  80     Search the file name.ext in the subdirectory dir of
  81       -# user_lyxdir
  82       -# build_lyxdir (if not empty)
  83       -# system_lyxdir
  84     The third parameter `ext' is optional.
  85 */
  86 std::string const LibFileSearch(std::string const & dir, std::string const & name,
  87                      std::string const & ext = std::string());
  88
  89 /** Same as LibFileSearch(), but tries first to find an
  90   internationalized version of the file by prepending $LANG_ to the
  91   name
  92   */
  93 std::string const
  94 i18nLibFileSearch(std::string const & dir, std::string const & name,
  95                   std::string const & ext = std::string());
  96
  97 /** Takes a command such as "sh $$s/scripts/convertDefault.sh file.in file.out"
  98  *  and replaces "$$s/" with the path to the LyX support directory containing
  99  *  this script. If the script is not found, "$$s/" is removed. Executing the
 100  *  command will still fail, but the error message will make some sort of
 101  *  sense ;-)
 102  */
 103 std::string const LibScriptSearch(std::string const & command);
 104
 105 enum latex_path_extension {
 106         PROTECT_EXTENSION,
 107         EXCLUDE_EXTENSION
 108 };
 109
 110 enum latex_path_dots {
 111         LEAVE_DOTS,
 112         ESCAPE_DOTS
 113 };
 114
 115 /** @param path a file path in internal_path format. Ie, directories
 116  *  are indicated by '/', not by '\'.
 117  *
 118  *  Manipulates @c path into a form suitable for inclusion in a LaTeX
 119  *  document.
 120  *  If @c path contains LaTeX special characters, these are escaped.
 121  *  Eg, '~' -> '\\string~'
 122  *  If @c path contains spaces, then the returned path is enclosed in
 123  *  "-quotes. This last fix will lead to successful compiliation of the
 124  *  LaTeX file only if a sufficiently modern LaTeX compiler is used.
 125  *  If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
 126  *  This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
 127  *  (format=pdflatex 2005.4.11) in combination with
 128  *  pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
 129  *  It does not recognize the file extension if it is inside the quotes.
 130  *  If @c dots == ESCAPE_DOTS dots in the filename are replaced by
 131  *  "\\lyxdot ". This is needed for the \\includegraphics command if the
 132  *  automatic format selection is used.
 133  */
 134 std::string const latex_path(std::string const & path,
 135                 latex_path_extension extension = PROTECT_EXTENSION,
 136                 latex_path_dots dots = LEAVE_DOTS);
 137
 138 /// Substitutes active latex characters with underscores in filename
 139 std::string const MakeLatexName(std::string const & file);
 140
 141 /// Put the name in quotes suitable for the current shell
 142 std::string const QuoteName(std::string const & file);
 143
 144 /// Add a filename to a path. Any path from filename is stripped first.
 145 std::string const AddName(std::string const & path, std::string const & fname);
 146
 147 /// Append sub-directory(ies) to path in an intelligent way
 148 std::string const AddPath(std::string const & path, std::string const & path2);
 149
 150 /** Change extension of oldname to extension.
 151  If oldname does not have an extension, it is appended.
 152  If the extension is empty, any extension is removed from the name.
 153  */
 154 std::string const
 155 ChangeExtension(std::string const & oldname, std::string const & extension);
 156
 157 /// Remove the extension from \p name
 158 std::string const removeExtension(std::string const & name);
 159
 160 /// Return the extension of the file (not including the .)
 161 std::string const GetExtension(std::string const & name);
 162
 163 /** Guess the file format name (as in Format::name()) from contents.
 164  Normally you don't want to use this directly, but rather
 165  Formats::getFormatFromFile().
 166  */
 167 std::string const getFormatFromContents(std::string const & name);
 168
 169 /// check for zipped file
 170 bool zippedFile(std::string const & name);
 171
 172 /** \return the name that LyX will give to the unzipped file \p zipped_file
 173   if the second argument of unzipFile() is empty.
 174  */
 175 std::string const unzippedFileName(std::string const & zipped_file);
 176
 177 /** Unzip \p zipped_file.
 178   The unzipped file is named \p unzipped_file if \p unzipped_file is not
 179   empty, and unzippedFileName(\p zipped_file) otherwise.
 180   Will overwrite an already existing unzipped file without warning.
 181  */
 182 std::string const unzipFile(std::string const & zipped_file,
 183                             std::string const & unzipped_file = std::string());
 184
 185 /// Returns true is path is absolute
 186 bool AbsolutePath(std::string const & path);
 187
 188 /// Create absolute path. If impossible, don't do anything
 189 std::string const ExpandPath(std::string const & path);
 190
 191 /** Convert relative path into absolute path based on a basepath.
 192   If relpath is absolute, just use that.
 193   If basepath doesn't exist use CWD.
 194   */
 195 std::string const MakeAbsPath(std::string const & RelPath = std::string(),
 196                          std::string const & BasePath = std::string());
 197
 198 /** Creates a nice compact path for displaying. The parameter
 199   threshold, if given, specifies the maximal length of the path.
 200   */
 201 std::string const
 202 MakeDisplayPath(std::string const & path, unsigned int threshold = 1000);
 203
 204 /** Makes relative path out of absolute path.
 205   If it is deeper than basepath,
 206   it's easy. If basepath and abspath share something (they are all deeper
 207   than some directory), it'll be rendered using ..'s. If they are completely
 208   different, then the absolute path will be used as relative path
 209   WARNING: the absolute path and base path must really be absolute paths!!!
 210   */
 211 std::string const
 212 MakeRelPath(std::string const & abspath, std::string const & basepath);
 213
 214 /// Strip filename from path name
 215 std::string const OnlyPath(std::string const & fname);
 216
 217 /** Normalize a path. Constracts path/../path
 218  *  Also converts paths like /foo//bar ==> /foo/bar
 219  */
 220 std::string const NormalizePath(std::string const & path);
 221
 222 /// Strips path from filename
 223 std::string const OnlyFilename(std::string const & fname);
 224
 225 /// Get the contents of a file as a huge std::string
 226 std::string const GetFileContents(std::string const & fname);
 227
 228 /** Check and Replace Environmentvariables ${NAME} in Path.
 229     Replaces all occurences of these, if they are found in the
 230     environment.
 231     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 232 */
 233 std::string const ReplaceEnvironmentPath(std::string const & path);
 234
 235 /* Set \c link to the path \c file points to as a symbolic link.
 236    If \c resolve is true, then \c link is an absolute path
 237    Returns true if successful */
 238 bool LyXReadLink(std::string const & file, std::string & link, bool resolve = false);
 239
 240 /// Uses kpsewhich to find tex files
 241 std::string const findtexfile(std::string const & fil, std::string const & format);
 242
 243 /// remove the autosave-file and give a Message if it can't be done
 244 void removeAutosaveFile(std::string const & filename);
 245
 246 /// read the BoundingBox entry from a ps/eps/pdf-file
 247 std::string const readBB_from_PSFile(std::string const & file);
 248
 249 /** \param file1, file2 the two files to be compared. Must have absolute paths.
 250  *  \returns 1 if \c file1 has a more recent timestamp than \c file2,
 251  *           0 if their timestamps are the same,
 252  *          -1 if \c file2 has a more recent timestamp than \c file1.
 253  *  If one of the files does not exist, the return value indicates the file
 254  *  which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
 255  */
 256 int compare_timestamps(std::string const & file1, std::string const & file2);
 257
 258 typedef std::pair<int, std::string> cmd_ret;
 259
 260 cmd_ret const RunCommand(std::string const & cmd);
 261
 262 } // namespace support
 263 } // namespace lyx
 264
 265 #endif