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
  17 #include <utility>
  18 #include <string>
  19 #include <set>
  20
  21 namespace lyx {
  22 namespace support {
  23
  24 class FileName;
  25
  26 /// Record used temp file names
  27 static std::set<std::string> tmp_names_;
  28
  29 /// Get a temporary file name.
  30 /**
  31 * The actual temp file (QTemporaryFile object) is immediately
  32 * destroyed after the name has been generated, so a new file
  33 * has to be created manually from the name.
  34 * This is needed if the temp file has to be manually removed
  35 * (e.g., when temp files are used as conversion target, and the initial
  36 * file only serves as a placeholder), since QTemporaryFile objects
  37 * cannot be manually removed at least on Windows (they are always
  38 * kept open internally even after close()).
  39 * In order to avoid race conditions due to duplicate names, we record
  40 * all used temp file names.
  41 * If you don't have to remove the temp file manually, use TempFile instead!
  42 */
  43 FileName const tempFileName(FileName, bool const dir = false);
  44 /// Get temporary file name with custom path
  45 FileName const tempFileName(FileName const &, std::string const &, bool const dir = false);
  46 /// Get temporary file name with default path
  47 FileName const tempFileName(std::string const &, bool const dir = false);
  48
  49 /// Remove and unregister a temporary file.
  50 void removeTempFile(FileName const &);
  51
  52 /** Creates the global LyX temp dir.
  53   \p deflt can be an existing directory name. In this case a new directory
  54   inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
  55   created and used as the temporary directory.
  56   \return the tmp dir name or string() if something went wrong.
  57  */
  58 FileName const createLyXTmpDir(FileName const & deflt);
  59
  60 #if 0
  61 // FIXME unused. Should this be deleted or resurrected?
  62 /** Find file by searching several directories.
  63   Uses a string of paths separated by ";"s to find a file to open.
  64     Can't cope with pathnames with a ';' in them. Returns full path to file.
  65     If path entry begins with $$LyX/, use system_lyxdir.
  66     If path entry begins with $$User/, use user_lyxdir.
  67     Example: "$$User/doc;$$LyX/doc".
  68 */
  69 FileName const fileOpenSearch(std::string const & path,
  70                                  std::string const & name,
  71                                  std::string const & ext = std::string());
  72 #endif
  73
  74 /// How to search files
  75 enum search_mode {
  76         /// The file must exist (return an empty file name otherwise)
  77         must_exist,
  78         /// Only do file name expansion, return the complete name even if
  79         /// the file does not exist
  80         may_not_exist,
  81         /// The (image) file may be present with hi-dpi resolution -
  82         /// the lookup checks for a file named "image" + "@2x" + ".ext" first.
  83         /// If found it will return e.g. "image@2x.png" instead of "image.png".
  84         /// Otherwise it will work as must_exist.
  85         check_hidpi
  86 };
  87
  88 /** Returns the real name of file name in directory path, with optional
  89   extension ext.
  90   The file is searched in the given path (unless it is an absolute
  91   file name), first directly, and then with extension .ext (if given).
  92   */
  93 FileName const fileSearch(std::string const & path,
  94                              std::string const & name,
  95                              std::string const & ext = std::string(),
  96                              search_mode mode = must_exist);
  97
  98 ///
  99 bool isLyXFileName(std::string const & filename);
 100
 101 ///
 102 bool isSGMLFileName(std::string const & filename);
 103
 104 /// check for characters in filenames not allowed by LaTeX
 105 bool isValidLaTeXFileName(std::string const & filename);
 106
 107 /** check for characters in filenames that might lead to
 108   problems when manually compiling the LaTeX export of LyX
 109   and opening the result with some older DVI-viewers
 110 */
 111 bool isValidDVIFileName(std::string const & filename);
 112
 113 /// check whether the file has binary contents
 114 bool isBinaryFile(FileName const & filename);
 115
 116 /** Returns the path of a library data file.
 117     Search the file name.ext in the subdirectory dir of
 118       -# user_lyxdir
 119       -# build_lyxdir (if not empty)
 120       -# system_lyxdir
 121     \p onlyglobal determines whether user_lyxdir should be included.
 122     ext, search_mode and onlyglobal are optional.
 123 */
 124 FileName const libFileSearch(std::string const & dir,
 125                                 std::string const & name,
 126                                 std::string const & ext = std::string(),
 127                                 search_mode mode = must_exist,
 128                                 bool const onlyglobal = false);
 129
 130 /** Same as libFileSearch(), but tries first to find an
 131   internationalized version of the file by prepending $LANG_ to the
 132   name
 133   */
 134 FileName const
 135 i18nLibFileSearch(std::string const & dir,
 136                   std::string const & name,
 137                   std::string const & ext = std::string());
 138
 139 /** Same as libFileSearch(), but tries first to find a preferred
 140   version of the file by appending the icon set name to the dir
 141   */
 142 FileName const
 143 imageLibFileSearch(std::string & dir, std::string const & name,
 144                    std::string const & ext = std::string(),
 145                    search_mode mode = must_exist);
 146
 147 /// How to quote a filename
 148 enum quote_style {
 149         /** Quote for the (OS dependent) shell. This is needed for command
 150             line arguments of subprocesses. */
 151         quote_shell,
 152         /** Quote a file name for the (OS dependent) shell. This is needed
 153             for file names as command line arguments of subprocesses. */
 154         quote_shell_filename,
 155         /** Quote for python. Use this if you want to store a filename in a
 156             python script. Example: \code
 157             os << "infile = " << quoteName(filename) << '\\n';
 158             \endcode This uses double quotes, so that you can also use this
 159             to quote filenames as part of a string if the string is quoted
 160             with single quotes. */
 161         quote_python
 162 };
 163
 164 /** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
 165  *  and replaces "$$s/" with the path to the LyX support directory containing
 166  *  this script. If the script is not found, "$$s/" is removed. Executing the
 167  *  command will still fail, but the error message will make some sort of
 168  *  sense ;-)
 169  */
 170 std::string const commandPrep(std::string const & command);
 171
 172 enum latex_path_extension {
 173         PROTECT_EXTENSION,
 174         EXCLUDE_EXTENSION
 175 };
 176
 177 enum latex_path_dots {
 178         LEAVE_DOTS,
 179         ESCAPE_DOTS
 180 };
 181
 182 /** @param path a file path in internal_path format. Ie, directories
 183  *  are indicated by '/', not by '\'.
 184  *
 185  *  Manipulates @c path into a form suitable for inclusion in a LaTeX
 186  *  document.
 187  *  If @c path contains LaTeX special characters, these are escaped.
 188  *  Eg, '~' -> '\\string~'
 189  *  If @c path contains spaces, then the returned path is enclosed in
 190  *  "-quotes. This last fix will lead to successful compilation of the
 191  *  LaTeX file only if a sufficiently modern LaTeX compiler is used.
 192  *  If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
 193  *  This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
 194  *  (format=pdflatex 2005.4.11) in combination with
 195  *  pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
 196  *  It does not recognize the file extension if it is inside the quotes.
 197  *  If @c dots == ESCAPE_DOTS dots in the filename are replaced by
 198  *  "\\lyxdot ". This is needed for the \\includegraphics command if the
 199  *  automatic format selection is used.
 200  */
 201 std::string const latex_path(std::string const & path,
 202                 latex_path_extension extension = PROTECT_EXTENSION,
 203                 latex_path_dots dots = LEAVE_DOTS);
 204
 205 /// Substitutes active latex characters with underscores in filename
 206 FileName const makeLatexName(FileName const & file);
 207
 208 /** Put the name in quotes suitable for the current shell or python,
 209     depending on \p style. */
 210 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
 211
 212 /// Add a filename to a path. Any path from filename is stripped first.
 213 std::string const addName(std::string const & path, std::string const & fname);
 214
 215 /// Add a relative path to a path. Does not strip the pathname
 216 std::string const addPathName(std::string const & path, std::string const & fname);
 217
 218 /// Append sub-directory(ies) to path in an intelligent way. Will append the
 219 /// trailing directory separator if that is not provided.
 220 std::string const addPath(std::string const & path, std::string const & path2);
 221
 222 /** Change extension of oldname to extension.
 223  If oldname does not have an extension, it is appended.
 224  If the extension is empty, any extension is removed from the name.
 225  */
 226 std::string const
 227 changeExtension(std::string const & oldname, std::string const & extension);
 228
 229 /// Remove the extension from \p name
 230 std::string const removeExtension(std::string const & name);
 231
 232 /** Add the extension \p ext to \p name.
 233  Use this instead of changeExtension if you know that \p name is without
 234  extension, because changeExtension would wrongly interpret \p name if it
 235  contains a dot.
 236  */
 237 std::string const
 238 addExtension(std::string const & name, std::string const & extension);
 239
 240 /// Return the extension of the file (not including the .)
 241 std::string const getExtension(std::string const & name);
 242
 243 /// Provide a scheme (such as "file") if not present. Assumes absolute path input.
 244 docstring const provideScheme(docstring const & name, docstring const & scheme);
 245
 246 /** \return the name that LyX will give to the unzipped file \p zipped_file
 247   if the second argument of unzipFile() is empty.
 248  */
 249 std::string const unzippedFileName(std::string const & zipped_file);
 250
 251 /** Unzip \p zipped_file.
 252   The unzipped file is named \p unzipped_file if \p unzipped_file is not
 253   empty, and unzippedFileName(\p zipped_file) otherwise.
 254   Will overwrite an already existing unzipped file without warning.
 255  */
 256 FileName const unzipFile(FileName const & zipped_file,
 257                          std::string const & unzipped_file = std::string());
 258
 259 /** Convert relative path into absolute path based on a basepath.
 260   If relpath is absolute, just use that.
 261   If basepath doesn't exist use CWD.
 262   */
 263 FileName const makeAbsPath(std::string const & RelPath = std::string(),
 264                               std::string const & BasePath = std::string());
 265
 266 /** Creates a nice compact path for displaying. The parameter
 267   threshold, if given, specifies the maximal length of the path.
 268   */
 269 docstring const
 270 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
 271
 272 /** Makes relative path out of absolute path.
 273   If it is deeper than basepath,
 274   it's easy. If basepath and abspath share something (they are all deeper
 275   than some directory), it'll be rendered using ..'s. If they are completely
 276   different, then the absolute path will be used as relative path
 277   WARNING: the absolute path and base path must really be absolute paths!!!
 278   */
 279 docstring const
 280 makeRelPath(docstring const & abspath, docstring const & basepath);
 281
 282 /// Strip filename from path name
 283 std::string const onlyPath(std::string const & fname);
 284
 285 /// Strips path from filename
 286 std::string const onlyFileName(std::string const & fname);
 287
 288 /** Check and Replace Environmentvariables ${NAME} in Path.
 289     Replaces all occurrences of these, if they are found in the
 290     environment.
 291     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 292 */
 293 std::string const replaceEnvironmentPath(std::string const & path);
 294
 295 /**
 296    Return a string to be used as a prefix to a command for setting the
 297    environment of the TeX engine with respect to the paths \p path and \p lpath.
 298  */
 299 std::string latexEnvCmdPrefix(std::string const &path, std::string const & lpath);
 300
 301 /** Replace all references to a current directory (a lonely '.' or
 302     the prefix "./") in \c pathlist with \c path. Also prefixes
 303     all non-absolute paths with \c path.
 304 */
 305 std::string const replaceCurdirPath(std::string const & path, std::string const & pathlist);
 306
 307 /** Set \c link to the path \c file points to as a symbolic link.
 308     \return true if successful.
 309  */
 310 bool readLink(FileName const & file, FileName & link);
 311
 312 /**
 313  * Search a TeX file in all locations the latex compiler would search it,
 314  * with the help of kpsewhich.
 315  * The current working directory must be set correctly, so that relative
 316  * names work.
 317  * \param fil The filename to search
 318  * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
 319  */
 320 FileName const findtexfile(std::string const & fil,
 321                                                    std::string const & format,
 322                                                    bool const onlykpse = false);
 323
 324 /** \param file1, file2 the two files to be compared. Must have absolute paths.
 325  *  \returns 1 if \c file1 has a more recent timestamp than \c file2,
 326  *           0 if their timestamps are the same,
 327  *          -1 if \c file2 has a more recent timestamp than \c file1.
 328  *  If one of the files does not exist, the return value indicates the file
 329  *  which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
 330  */
 331 int compare_timestamps(FileName const & file1, FileName const & file2);
 332
 333 /// \param lfuns: true if we're converting lfuns, false if prefs
 334 bool prefs2prefs(FileName const & filename, FileName const & tempfile,
 335                  bool lfuns);
 336
 337 /// Does file \p file need to be updated by configure.py?
 338 bool configFileNeedsUpdate(std::string const & file);
 339
 340 struct cmd_ret {
 341         bool valid;
 342         std::string result;
 343 };
 344
 345 cmd_ret const runCommand(std::string const & cmd);
 346
 347 int fileLock(const char * lock_file);
 348 void fileUnlock(int fd, const char * lock_file);
 349
 350 /** Return the hex-encoded cryptographic hash of a string.
 351  * This function is typically used to create relatively stable file names,
 352  * because cryptographic hash functions ensure that very small changes in the
 353  * input result in large changes in the output.
 354  * Due to inherent limits of path length in Windows we allow very short version
 355  * (effectively leftmost 6 bytes encoded via 12 chars in hex) while increasing the
 356  * probability of collision (via shorten=true).
 357  * There is no limit in the length of the input string: it can be a file name
 358  * or the contents of a file, for instance.
 359  */
 360 std::string toHexHash(const std::string & str, bool shorten=false);
 361
 362 /// Replace non-ASCII characters to ensure that the string can be used as a
 363 /// file name on all platforms and as a LaTeX name.
 364 std::string sanitizeFileName(const std::string & str);
 365
 366 } // namespace support
 367 } // namespace lyx
 368
 369
 370
 371 #endif