src/support/filetools.h

   1 // -*- C++-*-
   2 /* lyx-filetool.h : tools functions for file/path handling
   3    this file is part of LyX, the High Level Word Processor
   4    Copyright 1995-2000, Matthias Ettrich and the LyX Team
   5 */
   6
   7 #ifndef LYX_FILETOOL_H
   8 #define LYX_FILETOOL_H
   9
  10 #ifdef __GNUG__
  11 #pragma interface
  12 #endif
  13
  14 #include <cstdlib>
  15 #include <fcntl.h>
  16 #include <cerrno>
  17
  18 #include "debug.h"
  19 #include "LString.h"
  20 #include "support/lstrings.h"
  21
  22
  23 ///
  24 string CreateBufferTmpDir (string const & pathfor = string());
  25
  26 /// Creates directory. Returns true on succes.
  27 bool createDirectory(string const & name, int permissions);
  28
  29 ///
  30 string CreateLyXTmpDir (string const & deflt);
  31
  32 ///
  33 int DestroyBufferTmpDir (string const & tmpdir);
  34
  35 ///
  36 int DestroyLyXTmpDir (string const & tmpdir);
  37
  38 /** Find file by searching several directories.
  39   Uses a string of paths separated by ";"s to find a file to open.
  40     Can't cope with pathnames with a ';' in them. Returns full path to file.
  41     If path entry begins with $$LyX/, use system_lyxdir.
  42     If path entry begins with $$User/, use user_lyxdir.
  43     Example: "$$User/doc;$$LyX/doc".
  44 */
  45 string FileOpenSearch (string const & path, string const & name,
  46                        string const & ext = string());
  47
  48 /** Returns the real name of file name in directory path, with optional
  49   extension ext.
  50   The file is searched in the given path (unless it is an absolute
  51   file name), first directly, and then with extension .ext (if given).
  52   */
  53 string FileSearch(string const & path, string const & name,
  54                   string const & ext = string());
  55
  56 /** Is directory read only?
  57   returns
  58     1: dir writeable
  59     0: not writeable
  60    -1: error- couldn't find out, or unsure
  61   */
  62 int IsDirWriteable (string const & path);
  63
  64 /** Is a file readable ?
  65   Returns true if the file `path' is readable.
  66  */
  67 bool IsFileReadable (string const & path);
  68
  69 /** Is file read only?
  70   returns
  71     1: read-write
  72     0: read_only
  73    -1: error (doesn't exist, no access, anything else)
  74   */
  75 int IsFileWriteable (string const & path);
  76
  77 ///
  78 bool IsLyXFilename(string const & filename);
  79
  80 /** Returns the path of a library data file.
  81   Search the file name.ext in the subdirectory dir of
  82   \begin{enumerate}
  83     \item user_lyxdir
  84     \item build_lyxdir (if not empty)
  85     \item system_lyxdir
  86   \end{enumerate}
  87     The third parameter `ext' is optional.
  88 */
  89 string LibFileSearch(string const & dir, string const & name,
  90                      string const & ext = 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 string i18nLibFileSearch(string const & dir, string const & name,
  97                          string const & ext = string());
  98
  99 ///
 100 string GetEnv(string const & envname);
 101
 102 /// A helper function.
 103 string GetEnvPath(string const & name);
 104
 105 ///
 106 bool PutEnv(string const & envstr);
 107
 108 ///
 109 bool PutEnvPath(string const & envstr);
 110
 111 /// Substitutes active latex characters with underscores in filename
 112 string MakeLatexName(string const & file);
 113
 114 /// Put the name in quotes suitable for the current shell
 115 string QuoteName(string const & file);
 116
 117 /** Returns an unique name to be used as a temporary file. If given,
 118   'mask' should the prefix to the temporary file, the rest of the
 119   temporary filename will be made from the pid and three letters.
 120   */
 121 string TmpFileName(string const & dir = string(),
 122                    string const & mask = "lyx_tmp");
 123
 124 /// Is a filename/path absolute?
 125 bool AbsolutePath(string const & path);
 126
 127 /// Add a filename to a path. Any path from filename is stripped first.
 128 string AddName(string const & path, string const & fname);
 129
 130 /// Append sub-directory(ies) to path in an intelligent way
 131 string AddPath(string const & path, string const & path2);
 132
 133 /** Change extension of oldname to extension.
 134  If oldname does not have an extension, it is appended.
 135  If the extension is empty, any extension is removed from the name.
 136  */
 137 string ChangeExtension(string const & oldname, string const & extension);
 138
 139 /// Create absolute path. If impossible, don't do anything
 140 string ExpandPath(string const & path);
 141
 142 /// gets current working directory
 143 string GetCWD();
 144
 145
 146 /** Convert relative path into absolute path based on a basepath.
 147   If relpath is absolute, just use that.
 148   If basepath doesn't exist use CWD.
 149   */
 150 string MakeAbsPath(string const & RelPath = string(),
 151                    string const & BasePath = string());
 152
 153 /** Creates a nice compact path for displaying. The parameter
 154   threshold, if given, specifies the maximal length of the path.
 155   */
 156 string MakeDisplayPath(string const & path, unsigned int threshold= 1000);
 157
 158 /** Makes relative path out of absolute path.
 159   If it is deeper than basepath,
 160   it's easy. If basepath and abspath share something (they are all deeper
 161   than some directory), it'll be rendered using ..'s. If they are completely
 162   different, then the absolute path will be used as relative path
 163   WARNING: the absolute path and base path must really be absolute paths!!!
 164   */
 165 string MakeRelPath(string const & abspath, string const & basepath);
 166
 167 /// Strip filename from path name
 168 string OnlyPath(string const & fname);
 169
 170 /// Normalize a path. Constracts path/../path
 171 string NormalizePath(string const & path);
 172
 173 /// Strips path from filename
 174 string OnlyFilename(string const & fname);
 175
 176 /// Get the contents of a file as a huge string
 177 string GetFileContents(string const & fname);
 178
 179 /// Cleanup a path if necessary. Currently only useful with OS/2
 180 string CleanupPath(string const & path) ;
 181
 182 /** Check and Replace Environmentvariables ${NAME} in Path.
 183     Replaces all occurences of these, if they are found in the
 184     environment.
 185     Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
 186 */
 187 string ReplaceEnvironmentPath(string const & path);
 188
 189 /* Set Link to the path file points to as a symbolic link.
 190    Returns true if successful */
 191 bool LyXReadLink(string const & file, string & Link);
 192
 193 /* Uses kpsewhich to find tex files */
 194 string findtexfile(string const & fil, string const & format);
 195
 196 #endif