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 };
  55
  56 /** Returns the real name of file name in directory path, with optional
  57   extension ext.
  58   The file is searched in the given path (unless it is an absolute
  59   file name), first directly, and then with extension .ext (if given).
  60   */
  61 FileName const fileSearch(std::string const & path,
  62                              std::string const & name,
  63                              std::string const & ext = std::string(),
  64                              search_mode mode = must_exist);
  65
  66 ///
  67 bool isLyXFileName(std::string const & filename);
  68
  69 ///
  70 bool isSGMLFileName(std::string const & filename);
  71
  72 /// check for characters in filenames not allowed by LaTeX
  73 bool isValidLaTeXFileName(std::string const & filename);
  74
  75 /** check for characters in filenames that might lead to
  76   problems when manually compiling the LaTeX export of LyX
  77   and opening the result with some older DVI-viewers
  78 */
  79 bool isValidDVIFileName(std::string const & filename);
  80
  81 /** Returns the path of a library data file.
  82     Search the file name.ext in the subdirectory dir of
  83       -# user_lyxdir
  84       -# build_lyxdir (if not empty)
  85       -# system_lyxdir
  86     The third parameter `ext' is optional.
  87 */
  88 FileName const libFileSearch(std::string const & dir,
  89                                 std::string const & name,
  90                                 std::string const & ext = std::string());
  91
  92 /** Same as libFileSearch(), but tries first to find an
  93   internationalized version of the file by prepending $LANG_ to the
  94   name
  95   */
  96 FileName const
  97 i18nLibFileSearch(std::string const & dir,
  98                   std::string const & name,
  99                   std::string const & ext = std::string());
 100
 101 /** Same as libFileSearch(), but tries first to find a preferred
 102   version of the file by appending the icon set name to the dir
 103   */
 104 FileName const
 105 imageLibFileSearch(std::string & dir, 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 commandPrep(std::string const & command);
 129
 130 enum latex_path_extension {
 131         PROTECT_EXTENSION,
 132         EXCLUDE_EXTENSION
 133 };
 134
 135 enum latex_path_dots {
 136         LEAVE_DOTS,
 137         ESCAPE_DOTS
 138 };
 139
 140 /** @param path a file path in internal_path format. Ie, directories
 141  *  are indicated by '/', not by '\'.
 142  *
 143  *  Manipulates @c path into a form suitable for inclusion in a LaTeX
 144  *  document.
 145  *  If @c path contains LaTeX special characters, these are escaped.
 146  *  Eg, '~' -> '\\string~'
 147  *  If @c path contains spaces, then the returned path is enclosed in
 148  *  "-quotes. This last fix will lead to successful compiliation of the
 149  *  LaTeX file only if a sufficiently modern LaTeX compiler is used.
 150  *  If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
 151  *  This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
 152  *  (format=pdflatex 2005.4.11) in combination with
 153  *  pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
 154  *  It does not recognize the file extension if it is inside the quotes.
 155  *  If @c dots == ESCAPE_DOTS dots in the filename are replaced by
 156  *  "\\lyxdot ". This is needed for the \\includegraphics command if the
 157  *  automatic format selection is used.
 158  */
 159 std::string const latex_path(std::string const & path,
 160                 latex_path_extension extension = PROTECT_EXTENSION,
 161                 latex_path_dots dots = LEAVE_DOTS);
 162
 163 /// Substitutes active latex characters with underscores in filename
 164 FileName const makeLatexName(FileName const & file);
 165
 166 /** Put the name in quotes suitable for the current shell or python,
 167     depending on \p style. */
 168 std::string const quoteName(std::string const & file, quote_style style = quote_shell);
 169
 170 /// Add a filename to a path. Any path from filename is stripped first.
 171 std::string const addName(std::string const & path, std::string const & fname);
 172
 173 /// Append sub-directory(ies) to path in an intelligent way
 174 std::string const addPath(std::string const & path, std::string const & path2);
 175
 176 /** Change extension of oldname to extension.
 177  If oldname does not have an extension, it is appended.
 178  If the extension is empty, any extension is removed from the name.
 179  */
 180 std::string const
 181 changeExtension(std::string const & oldname, std::string const & extension);
 182
 183 /// Remove the extension from \p name
 184 std::string const removeExtension(std::string const & name);
 185
 186 /** Add the extension \p ext to \p name.
 187  Use this instead of changeExtension if you know that \p name is without
 188  extension, because changeExtension would wrongly interpret \p name if it
 189  contains a dot.
 190  */
 191 std::string const
 192 addExtension(std::string const & name, std::string const & extension);
 193
 194 /// Return the extension of the file (not including the .)
 195 std::string const getExtension(std::string const & name);
 196
 197 /** \return the name that LyX will give to the unzipped file \p zipped_file
 198   if the second argument of unzipFile() is empty.
 199  */
 200 std::string const unzippedFileName(std::string const & zipped_file);
 201
 202 /** Unzip \p zipped_file.
 203   The unzipped file is named \p unzipped_file if \p unzipped_file is not
 204   empty, and unzippedFileName(\p zipped_file) otherwise.
 205   Will overwrite an already existing unzipped file without warning.
 206  */
 207 FileName const unzipFile(FileName const & zipped_file,
 208                          std::string const & unzipped_file = std::string());
 209
 210 /// Create absolute path. If impossible, don't do anything
 211 std::string const expandPath(std::string const & path);
 212
 213 /** Convert relative path into absolute path based on a basepath.
 214   If relpath is absolute, just use that.
 215   If basepath doesn't exist use CWD.
 216   */
 217 FileName const makeAbsPath(std::string const & RelPath = std::string(),
 218                               std::string const & BasePath = std::string());
 219
 220 /** Creates a nice compact path for displaying. The parameter
 221   threshold, if given, specifies the maximal length of the path.
 222   */
 223 docstring const
 224 makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
 225
 226 /** Makes relative path out of absolute path.
 227   If it is deeper than basepath,
 228   it's easy. If basepath and abspath share something (they are all deeper
 229   than some directory), it'll be rendered using ..'s. If they are completely
 230   different, then the absolute path will be used as relative path
 231   WARNING: the absolute path and base path must really be absolute paths!!!
 232   */
 233 docstring const
 234 makeRelPath(docstring const & abspath, docstring const & basepath);
 235
 236 /// Strip filename from path name
 237 std::string const onlyPath(std::string const & fname);
 238
 239 /// Strips path from filename
 240 std::string const onlyFileName(std::string const & fname);
 241
 242 /** Check and Replace Environmentvariables ${NAME} in Path.
 243     Replaces all occurences of these, if they are found in the
 244     environment.
 245     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 246 */
 247 std::string const replaceEnvironmentPath(std::string const & path);
 248
 249 /**
 250    Return a string to be used as a prefix to a command for setting the
 251    environment of the TeX engine with respect to the path \p path.
 252  */
 253 std::string latexEnvCmdPrefix(std::string const & path);
 254
 255 /** Replace all references to a current directory (a lonely '.' or
 256     the prefix "./") in \c pathlist with \c path. Also prefixes
 257     all non-absolute paths with \c path.
 258 */
 259 std::string const replaceCurdirPath(std::string const & path, std::string const & pathlist);
 260
 261 /** Set \c link to the path \c file points to as a symbolic link.
 262     \return true if successful.
 263  */
 264 bool readLink(FileName const & file, FileName & link);
 265
 266 /**
 267  * Search a TeX file in all locations the latex compiler would search it,
 268  * with the help of kpsewhich.
 269  * The current working directory must be set correctly, so that relative
 270  * names work.
 271  * \param fil The filename to search
 272  * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
 273  */
 274 FileName const findtexfile(std::string const & fil,
 275                               std::string const & format);
 276
 277 /** \param file1, file2 the two files to be compared. Must have absolute paths.
 278  *  \returns 1 if \c file1 has a more recent timestamp than \c file2,
 279  *           0 if their timestamps are the same,
 280  *          -1 if \c file2 has a more recent timestamp than \c file1.
 281  *  If one of the files does not exist, the return value indicates the file
 282  *  which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
 283  */
 284 int compare_timestamps(FileName const & file1, FileName const & file2);
 285
 286 /// \param lfuns: true if we're converting lfuns, false if prefs
 287 bool prefs2prefs(FileName const & filename, FileName const & tempfile,
 288                  bool lfuns);
 289
 290 typedef std::pair<int, std::string> cmd_ret;
 291
 292 cmd_ret const runCommand(std::string const & cmd);
 293
 294 int fileLock(const char * lock_file);
 295 void fileUnlock(int fd, const char * lock_file);
 296
 297 } // namespace support
 298 } // namespace lyx
 299
 300
 301
 302 #endif