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   \begin{enumerate}
  82     \item user_lyxdir
  83     \item build_lyxdir (if not empty)
  84     \item system_lyxdir
  85   \end{enumerate}
  86     The third parameter `ext' is optional.
  87 */
  88 std::string const LibFileSearch(std::string const & dir, std::string const & name,
  89                      std::string const & ext = std::string());
  90
  91 /** Same as LibFileSearch(), but tries first to find an
  92   internationalized version of the file by prepending $LANG_ to the
  93   name
  94   */
  95 std::string const
  96 i18nLibFileSearch(std::string const & dir, std::string const & name,
  97                   std::string const & ext = std::string());
  98
  99 /** Takes a command such as "sh $$s/scripts/convertDefault.sh file.in file.out"
 100  *  and replaces "$$s/" with the path to the LyX support directory containing
 101  *  this script. If the script is not found, "$$s/" is removed. Executing the
 102  *  command will still fail, but the error message will make some sort of
 103  *  sense ;-)
 104  */
 105 std::string const LibScriptSearch(std::string const & command);
 106
 107 /// Substitutes active latex characters with underscores in filename
 108 std::string const MakeLatexName(std::string const & file);
 109
 110 /// Put the name in quotes suitable for the current shell
 111 std::string const QuoteName(std::string const & file);
 112
 113 /// Add a filename to a path. Any path from filename is stripped first.
 114 std::string const AddName(std::string const & path, std::string const & fname);
 115
 116 /// Append sub-directory(ies) to path in an intelligent way
 117 std::string const AddPath(std::string const & path, std::string const & path2);
 118
 119 /** Change extension of oldname to extension.
 120  If oldname does not have an extension, it is appended.
 121  If the extension is empty, any extension is removed from the name.
 122  */
 123 std::string const
 124 ChangeExtension(std::string const & oldname, std::string const & extension);
 125
 126 /// Return the extension of the file (not including the .)
 127 std::string const GetExtension(std::string const & name);
 128
 129 /** Guess the file format name (as in Format::name()) from contents.
 130  Normally you don't want to use this directly, but rather
 131  Formats::getFormatFromFile().
 132  */
 133 std::string const getFormatFromContents(std::string const & name);
 134
 135 /// check for zipped file
 136 bool zippedFile(std::string const & name);
 137
 138 /** \return the name that LyX will give to the unzipped file \p zipped_file
 139   if the second argument of unzipFile() is empty.
 140  */
 141 std::string const unzippedFileName(std::string const & zipped_file);
 142
 143 /** Unzip \p zipped_file.
 144   The unzipped file is named \p unzipped_file if \p unzipped_file is not
 145   empty, and unzippedFileName(\p zipped_file) otherwise.
 146   Will overwrite an already existing unzipped file without warning.
 147  */
 148 std::string const unzipFile(std::string const & zipped_file,
 149                             std::string const & unzipped_file = std::string());
 150
 151 /// Returns true is path is absolute
 152 bool AbsolutePath(std::string const & path);
 153
 154 /// Create absolute path. If impossible, don't do anything
 155 std::string const ExpandPath(std::string const & path);
 156
 157 /** Convert relative path into absolute path based on a basepath.
 158   If relpath is absolute, just use that.
 159   If basepath doesn't exist use CWD.
 160   */
 161 std::string const MakeAbsPath(std::string const & RelPath = std::string(),
 162                          std::string const & BasePath = std::string());
 163
 164 /** Creates a nice compact path for displaying. The parameter
 165   threshold, if given, specifies the maximal length of the path.
 166   */
 167 std::string const
 168 MakeDisplayPath(std::string const & path, unsigned int threshold = 1000);
 169
 170 /** Makes relative path out of absolute path.
 171   If it is deeper than basepath,
 172   it's easy. If basepath and abspath share something (they are all deeper
 173   than some directory), it'll be rendered using ..'s. If they are completely
 174   different, then the absolute path will be used as relative path
 175   WARNING: the absolute path and base path must really be absolute paths!!!
 176   */
 177 std::string const
 178 MakeRelPath(std::string const & abspath, std::string const & basepath);
 179
 180 /// Strip filename from path name
 181 std::string const OnlyPath(std::string const & fname);
 182
 183 /** Normalize a path. Constracts path/../path
 184  *  Also converts paths like /foo//bar ==> /foo/bar
 185  */
 186 std::string const NormalizePath(std::string const & path);
 187
 188 /// Strips path from filename
 189 std::string const OnlyFilename(std::string const & fname);
 190
 191 /// Get the contents of a file as a huge std::string
 192 std::string const GetFileContents(std::string const & fname);
 193
 194 /** Check and Replace Environmentvariables ${NAME} in Path.
 195     Replaces all occurences of these, if they are found in the
 196     environment.
 197     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 198 */
 199 std::string const ReplaceEnvironmentPath(std::string const & path);
 200
 201 /* Set \c link to the path \c file points to as a symbolic link.
 202    If \c resolve is true, then \c link is an absolute path
 203    Returns true if successful */
 204 bool LyXReadLink(std::string const & file, std::string & link, bool resolve = false);
 205
 206 /// Uses kpsewhich to find tex files
 207 std::string const findtexfile(std::string const & fil, std::string const & format);
 208
 209 /// remove the autosave-file and give a Message if it can't be done
 210 void removeAutosaveFile(std::string const & filename);
 211
 212 /// read the BoundingBox entry from a ps/eps/pdf-file
 213 std::string const readBB_from_PSFile(std::string const & file);
 214
 215 /** \param file1, file2 the two files to be compared. Must have absolute paths.
 216  *  \returns 1 if \c file1 has a more recent timestamp than \c file2,
 217  *           0 if their timestamps are the same,
 218  *          -1 if \c file2 has a more recent timestamp than \c file1.
 219  *  If one of the files does not exist, the return value indicates the file
 220  *  which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
 221  */
 222 int compare_timestamps(std::string const & file1, std::string const & file2);
 223
 224 typedef std::pair<int, std::string> cmd_ret;
 225
 226 cmd_ret const RunCommand(std::string const & cmd);
 227
 228 } // namespace support
 229 } // namespace lyx
 230
 231 #endif