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