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 "support/docstring.h"
  16 #include "support/FileName.h"
  17
  18 #include <vector>
  19 #include <utility>
  20 #include <string>
  21
  22 namespace lyx {
  23 namespace support {
  24
  25 /// remove directory and all contents, returns true on success
  26 bool destroyDir(FileName const & tmpdir);
  27
  28 /// Creates the per buffer temporary directory
  29 std::string const createBufferTmpDir();
  30
  31 /// Creates directory. Returns true on success
  32 bool createDirectory(FileName const & name, int permissions);
  33
  34 /** Creates the global LyX temp dir.
  35   \p deflt can be an existing directory name. In this case a new directory
  36   inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
  37   created and used as the temporary directory.
  38   \return the tmp dir name or string() if something went wrong.
  39  */
  40 FileName const createLyXTmpDir(FileName const & deflt);
  41
  42 #if 0
  43 // FIXME unused. Should this be deleted or resurrected?
  44 /** Find file by searching several directories.
  45   Uses a string of paths separated by ";"s to find a file to open.
  46     Can't cope with pathnames with a ';' in them. Returns full path to file.
  47     If path entry begins with $$LyX/, use system_lyxdir.
  48     If path entry begins with $$User/, use user_lyxdir.
  49     Example: "$$User/doc;$$LyX/doc".
  50 */
  51 FileName const fileOpenSearch(std::string const & path,
  52                                  std::string const & name,
  53                                  std::string const & ext = std::string());
  54 #endif
  55
  56 /// How to search files
  57 enum search_mode {
  58         // The file must exist (return an empty file name otherwise)
  59         standard_mode,
  60         /// Only do file name expansion, return the complete name even if
  61         /// the file does not exist
  62         allow_unreadable
  63 };
  64
  65 /** Returns the real name of file name in directory path, with optional
  66   extension ext.
  67   The file is searched in the given path (unless it is an absolute
  68   file name), first directly, and then with extension .ext (if given).
  69   */
  70 FileName const fileSearch(std::string const & path,
  71                              std::string const & name,
  72                              std::string const & ext = std::string(),
  73                              search_mode mode = standard_mode);
  74
  75 /// Returns a vector of all files in directory dir having extension ext.
  76 std::vector<FileName> const dirList(FileName const & dir,
  77                                        std::string const & ext = std::string());
  78
  79 ///
  80 bool isLyXFilename(std::string const & filename);
  81
  82 ///
  83 bool isSGMLFilename(std::string const & filename);
  84
  85 ///
  86 bool isValidLaTeXFilename(std::string const & filename);
  87
  88 /** Returns the path of a library data file.
  89     Search the file name.ext in the subdirectory dir of
  90       -# user_lyxdir
  91       -# build_lyxdir (if not empty)
  92       -# system_lyxdir
  93     The third parameter `ext' is optional.
  94 */
  95 FileName const libFileSearch(std::string const & dir,
  96                                 std::string const & name,
  97                                 std::string const & ext = std::string());
  98
  99 /** Same as libFileSearch(), but tries first to find an
 100   internationalized version of the file by prepending $LANG_ to the
 101   name
 102   */
 103 FileName const
 104 i18nLibFileSearch(std::string const & dir,
 105                   std::string const & name,
 106                   std::string const & ext = std::string());
 107
 108 /// How to quote a filename
 109 enum quote_style {
 110         /** Quote for the (OS dependant) shell. This is needed for command
 111             line arguments of subprocesses. */
 112         quote_shell,
 113         /** Quote for python. Use this if you want to store a filename in a
 114             python script. Example: \code
 115             os << "infile = " << quoteName(filename) << '\\n';
 116             \endcode This uses double quotes, so that you can also use this
 117             to quote filenames as part of a string if the string is quoted
 118             with single quotes. */
 119         quote_python
 120 };
 121
 122 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
 123  *  and replaces "$$s/" with the path to the LyX support directory containing
 124  *  this script. If the script is not found, "$$s/" is removed. Executing the
 125  *  command will still fail, but the error message will make some sort of
 126  *  sense ;-)
 127  */
 128 std::string const libScriptSearch(std::string const & command,
 129                 quote_style style = quote_shell);
 130
 131 enum latex_path_extension {
 132         PROTECT_EXTENSION,
 133         EXCLUDE_EXTENSION
 134 };
 135
 136 enum latex_path_dots {
 137         LEAVE_DOTS,
 138         ESCAPE_DOTS
 139 };
 140
 141 /** @param path a file path in internal_path format. Ie, directories
 142  *  are indicated by '/', not by '\'.
 143  *
 144  *  Manipulates @c path into a form suitable for inclusion in a LaTeX
 145  *  document.
 146  *  If @c path contains LaTeX special characters, these are escaped.
 147  *  Eg, '~' -> '\\string~'
 148  *  If @c path contains spaces, then the returned path is enclosed in
 149  *  "-quotes. This last fix will lead to successful compiliation of the
 150  *  LaTeX file only if a sufficiently modern LaTeX compiler is used.
 151  *  If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
 152  *  This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
 153  *  (format=pdflatex 2005.4.11) in combination with
 154  *  pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
 155  *  It does not recognize the file extension if it is inside the quotes.
 156  *  If @c dots == ESCAPE_DOTS dots in the filename are replaced by
 157  *  "\\lyxdot ". This is needed for the \\includegraphics command if the
 158  *  automatic format selection is used.
 159  */
 160 std::string const latex_path(std::string const & path,
 161                 latex_path_extension extension = PROTECT_EXTENSION,
 162                 latex_path_dots dots = LEAVE_DOTS);
 163
 164 /// Substitutes active latex characters with underscores in filename
 165 std::string const makeLatexName(std::string const & file);
 166
 167 /** Put the name in quotes suitable for the current shell or python,
 168     depending on \p style. */
 169 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
 170
 171 /// Add a filename to a path. Any path from filename is stripped first.
 172 std::string const addName(std::string const & path, std::string const & fname);
 173
 174 /// Append sub-directory(ies) to path in an intelligent way
 175 std::string const addPath(std::string const & path, std::string const & path2);
 176
 177 /** Change extension of oldname to extension.
 178  If oldname does not have an extension, it is appended.
 179  If the extension is empty, any extension is removed from the name.
 180  */
 181 std::string const
 182 changeExtension(std::string const & oldname, std::string const & extension);
 183
 184 /// Remove the extension from \p name
 185 std::string const removeExtension(std::string const & name);
 186
 187 /** Add the extension \p ext to \p name.
 188  Use this instead of changeExtension if you know that \p name is without
 189  extension, because changeExtension would wrongly interpret \p name if it
 190  contains a dot.
 191  */
 192 std::string const
 193 addExtension(std::string const & name, std::string const & extension);
 194
 195 /// Return the extension of the file (not including the .)
 196 std::string const getExtension(std::string const & name);
 197
 198 /** Guess the file format name (as in Format::name()) from contents.
 199  Normally you don't want to use this directly, but rather
 200  Formats::getFormatFromFile().
 201  */
 202 std::string const getFormatFromContents(FileName const & name);
 203
 204 /// check for zipped file
 205 bool zippedFile(FileName const & name);
 206
 207 /** \return the name that LyX will give to the unzipped file \p zipped_file
 208   if the second argument of unzipFile() is empty.
 209  */
 210 std::string const unzippedFileName(std::string const & zipped_file);
 211
 212 /** Unzip \p zipped_file.
 213   The unzipped file is named \p unzipped_file if \p unzipped_file is not
 214   empty, and unzippedFileName(\p zipped_file) otherwise.
 215   Will overwrite an already existing unzipped file without warning.
 216  */
 217 FileName const unzipFile(FileName const & zipped_file,
 218                          std::string const & unzipped_file = std::string());
 219
 220 /// Returns true is path is absolute
 221 bool absolutePath(std::string const & path);
 222
 223 /// Create absolute path. If impossible, don't do anything
 224 std::string const expandPath(std::string const & path);
 225
 226 /** Convert relative path into absolute path based on a basepath.
 227   If relpath is absolute, just use that.
 228   If basepath doesn't exist use CWD.
 229   */
 230 FileName const makeAbsPath(std::string const & RelPath = std::string(),
 231                               std::string const & BasePath = std::string());
 232
 233 /** Creates a nice compact path for displaying. The parameter
 234   threshold, if given, specifies the maximal length of the path.
 235   */
 236 docstring const
 237 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
 238
 239 /** Makes relative path out of absolute path.
 240   If it is deeper than basepath,
 241   it's easy. If basepath and abspath share something (they are all deeper
 242   than some directory), it'll be rendered using ..'s. If they are completely
 243   different, then the absolute path will be used as relative path
 244   WARNING: the absolute path and base path must really be absolute paths!!!
 245   */
 246 docstring const
 247 makeRelPath(docstring const & abspath, docstring const & basepath);
 248
 249 /// Strip filename from path name
 250 std::string const onlyPath(std::string const & fname);
 251
 252 /** Normalize a path. Constracts path/../path
 253  *  Also converts paths like /foo//bar ==> /foo/bar
 254  */
 255 std::string const normalizePath(std::string const & path);
 256
 257 /// Strips path from filename
 258 std::string const onlyFilename(std::string const & fname);
 259
 260 /// Get the contents of a file as a huge std::string
 261 std::string const getFileContents(FileName const & fname);
 262
 263 /** Check and Replace Environmentvariables ${NAME} in Path.
 264     Replaces all occurences of these, if they are found in the
 265     environment.
 266     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 267 */
 268 std::string const replaceEnvironmentPath(std::string const & path);
 269
 270 /** Set \c link to the path \c file points to as a symbolic link.
 271     \return true if successful.
 272  */
 273 bool readLink(FileName const & file, FileName & link);
 274
 275 /**
 276  * Search a TeX file in all locations the latex compiler would search it,
 277  * with the help of kpsewhich.
 278  * The current working directory must be set correctly, so that relative
 279  * names work.
 280  * \param fil The filename to search
 281  * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
 282  */
 283 FileName const findtexfile(std::string const & fil,
 284                               std::string const & format);
 285
 286 /// remove the autosave-file and give a Message if it can't be done
 287 void removeAutosaveFile(std::string const & filename);
 288
 289 /// read the BoundingBox entry from a ps/eps/pdf-file
 290 std::string const readBB_from_PSFile(FileName const & file);
 291
 292 /** \param file1, file2 the two files to be compared. Must have absolute paths.
 293  *  \returns 1 if \c file1 has a more recent timestamp than \c file2,
 294  *           0 if their timestamps are the same,
 295  *          -1 if \c file2 has a more recent timestamp than \c file1.
 296  *  If one of the files does not exist, the return value indicates the file
 297  *  which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
 298  */
 299 int compare_timestamps(FileName const & file1, FileName const & file2);
 300
 301 typedef std::pair<int, std::string> cmd_ret;
 302
 303 cmd_ret const runCommand(std::string const & cmd);
 304
 305 } // namespace support
 306 } // namespace lyx
 307
 308 /// The following functions are implemented in minizip/zipunzip.cpp, and are not in
 309 /// the lyx::support namespace
 310
 311 /// zip several files to a zipfile. In-zip filenames are also specified
 312 bool zipFiles(std::string const & zipfile, std::vector<std::pair<std::string, std::string> > const & files);
 313
 314 /// Unzip a zip file to a directory
 315 bool unzipToDir(std::string const & zipfile, std::string const & path);
 316
 317
 318 #endif