-// -*- C++-*-
+// -*- C++ -*-
/**
* \file filetools.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#ifndef LYX_FILETOOL_H
#define LYX_FILETOOL_H
-#include <vector>
-#include <utility>
-#include "LString.h"
-#include "os.h"
+#include "support/docstring.h"
+#include <utility>
+#include <string>
namespace lyx {
namespace support {
-/// remove directory and all contents, returns 0 on success
-int destroyDir(string const & tmpdir);
-
-///
-string const CreateBufferTmpDir(string const & pathfor = string());
-
-/// Creates directory. Returns true on success
-bool createDirectory(string const & name, int permissions);
+class FileName;
-///
-string const CreateLyXTmpDir(string const & deflt);
+/** Creates the global LyX temp dir.
+ \p deflt can be an existing directory name. In this case a new directory
+ inside \p deflt is created. If \p deflt does not exist yet, \p deflt is
+ created and used as the temporary directory.
+ \return the tmp dir name or string() if something went wrong.
+ */
+FileName const createLyXTmpDir(FileName const & deflt);
+#if 0
+// FIXME unused. Should this be deleted or resurrected?
/** Find file by searching several directories.
Uses a string of paths separated by ";"s to find a file to open.
Can't cope with pathnames with a ';' in them. Returns full path to file.
If path entry begins with $$User/, use user_lyxdir.
Example: "$$User/doc;$$LyX/doc".
*/
-string const FileOpenSearch(string const & path, string const & name,
- string const & ext = string());
+FileName const fileOpenSearch(std::string const & path,
+ std::string const & name,
+ std::string const & ext = std::string());
+#endif
+
+/// How to search files
+enum search_mode {
+ /// The file must exist (return an empty file name otherwise)
+ must_exist,
+ /// Only do file name expansion, return the complete name even if
+ /// the file does not exist
+ may_not_exist,
+ /// The (image) file may be present with hi-dpi resolution -
+ /// the lookup checks for a file named "image" + "@2x" + ".ext" first.
+ /// If found it will return e.g. "image@2x.png" instead of "image.png".
+ /// Otherwise it will work as must_exist.
+ check_hidpi
+};
/** Returns the real name of file name in directory path, with optional
extension ext.
The file is searched in the given path (unless it is an absolute
file name), first directly, and then with extension .ext (if given).
*/
-string const FileSearch(string const & path, string const & name,
- string const & ext = string());
+FileName const fileSearch(std::string const & path,
+ std::string const & name,
+ std::string const & ext = std::string(),
+ search_mode mode = must_exist);
-/// Returns a vector of all files in directory dir having extension ext.
-std::vector<string> const DirList(string const & dir,
- string const & ext = string());
-
-/** Is directory read only?
- returns
- true: dir writeable
- false: not writeable
-*/
-bool IsDirWriteable (string const & path);
+///
+bool isLyXFileName(std::string const & filename);
-/** Is a file readable ?
- Returns true if the file `path' is readable.
- */
-bool IsFileReadable (string const & path);
+///
+bool isSGMLFileName(std::string const & filename);
-/** Is file read only?
- returns
- 1: read-write
- 0: read_only
- -1: error (doesn't exist, no access, anything else)
- */
-int IsFileWriteable (string const & path);
+/// check for characters in filenames not allowed by LaTeX
+bool isValidLaTeXFileName(std::string const & filename);
-///
-bool IsLyXFilename(string const & filename);
+/** check for characters in filenames that might lead to
+ problems when manually compiling the LaTeX export of LyX
+ and opening the result with some older DVI-viewers
+*/
+bool isValidDVIFileName(std::string const & filename);
-///
-bool IsSGMLFilename(string const & filename);
+/// check whether the file has binary contents
+bool isBinaryFile(FileName const & filename);
/** Returns the path of a library data file.
- Search the file name.ext in the subdirectory dir of
- \begin{enumerate}
- \item user_lyxdir
- \item build_lyxdir (if not empty)
- \item system_lyxdir
- \end{enumerate}
+ Search the file name.ext in the subdirectory dir of
+ -# user_lyxdir
+ -# build_lyxdir (if not empty)
+ -# system_lyxdir
The third parameter `ext' is optional.
*/
-string const LibFileSearch(string const & dir, string const & name,
- string const & ext = string());
+FileName const libFileSearch(std::string const & dir,
+ std::string const & name,
+ std::string const & ext = std::string(),
+ search_mode mode = must_exist);
-/** Same as LibFileSearch(), but tries first to find an
+/** Same as libFileSearch(), but tries first to find an
internationalized version of the file by prepending $LANG_ to the
name
*/
-string const
-i18nLibFileSearch(string const & dir, string const & name,
- string const & ext = string());
-
-/** Takes a command such as "sh $$s/convertDefault.sh file.in file.out"
- * and replaces "$$s/" with the path to the "most important" of LyX's
- * script directories containing this script. If the script is not found,
- * "$$s/" is removed. Executing the command will still fail, but the
- * error message will make some sort of sense ;-)
+FileName const
+i18nLibFileSearch(std::string const & dir,
+ std::string const & name,
+ std::string const & ext = std::string());
+
+/** Same as libFileSearch(), but tries first to find a preferred
+ version of the file by appending the icon set name to the dir
+ */
+FileName const
+imageLibFileSearch(std::string & dir, std::string const & name,
+ std::string const & ext = std::string(),
+ search_mode mode = must_exist);
+
+/// How to quote a filename
+enum quote_style {
+ /** Quote for the (OS dependant) shell. This is needed for command
+ line arguments of subprocesses. */
+ quote_shell,
+ /** Quote a file name for the (OS dependant) shell. This is needed
+ for file names as command line arguments of subprocesses. */
+ quote_shell_filename,
+ /** Quote for python. Use this if you want to store a filename in a
+ python script. Example: \code
+ os << "infile = " << quoteName(filename) << '\\n';
+ \endcode This uses double quotes, so that you can also use this
+ to quote filenames as part of a string if the string is quoted
+ with single quotes. */
+ quote_python
+};
+
+/** Takes a command such as "python $$s/scripts/convertDefault.py file.in file.out"
+ * and replaces "$$s/" with the path to the LyX support directory containing
+ * this script. If the script is not found, "$$s/" is removed. Executing the
+ * command will still fail, but the error message will make some sort of
+ * sense ;-)
*/
-string const LibScriptSearch(string const & command);
+std::string const commandPrep(std::string const & command);
-///
-string const GetEnv(string const & envname);
+enum latex_path_extension {
+ PROTECT_EXTENSION,
+ EXCLUDE_EXTENSION
+};
-/// A helper function.
-string const GetEnvPath(string const & name);
+enum latex_path_dots {
+ LEAVE_DOTS,
+ ESCAPE_DOTS
+};
+
+/** @param path a file path in internal_path format. Ie, directories
+ * are indicated by '/', not by '\'.
+ *
+ * Manipulates @c path into a form suitable for inclusion in a LaTeX
+ * document.
+ * If @c path contains LaTeX special characters, these are escaped.
+ * Eg, '~' -> '\\string~'
+ * If @c path contains spaces, then the returned path is enclosed in
+ * "-quotes. This last fix will lead to successful compiliation of the
+ * LaTeX file only if a sufficiently modern LaTeX compiler is used.
+ * If @c ext == EXCLUDE_EXTENSION the extension is left outside the quotes.
+ * This is needed for pdfeTeX, Version 3.141592-1.21a-2.2 (Web2C 7.5.4)
+ * (format=pdflatex 2005.4.11) in combination with
+ * pdftex.def 2002/06/19 v0.03k graphics/color for pdftex:
+ * It does not recognize the file extension if it is inside the quotes.
+ * If @c dots == ESCAPE_DOTS dots in the filename are replaced by
+ * "\\lyxdot ". This is needed for the \\includegraphics command if the
+ * automatic format selection is used.
+ */
+std::string const latex_path(std::string const & path,
+ latex_path_extension extension = PROTECT_EXTENSION,
+ latex_path_dots dots = LEAVE_DOTS);
/// Substitutes active latex characters with underscores in filename
-string const MakeLatexName(string const & file);
+FileName const makeLatexName(FileName const & file);
-/// Put the name in quotes suitable for the current shell
-string const QuoteName(string const & file);
+/** Put the name in quotes suitable for the current shell or python,
+ depending on \p style. */
+std::string const quoteName(std::string const & file, quote_style style = quote_shell);
/// Add a filename to a path. Any path from filename is stripped first.
-string const AddName(string const & path, string const & fname);
+std::string const addName(std::string const & path, std::string const & fname);
/// Append sub-directory(ies) to path in an intelligent way
-string const AddPath(string const & path, string const & path2);
+std::string const addPath(std::string const & path, std::string const & path2);
/** Change extension of oldname to extension.
If oldname does not have an extension, it is appended.
If the extension is empty, any extension is removed from the name.
*/
-string const
-ChangeExtension(string const & oldname, string const & extension);
-
-/// Return the extension of the file (not including the .)
-string const GetExtension(string const & name);
+std::string const
+changeExtension(std::string const & oldname, std::string const & extension);
-/// Return the type of the file as an extension from contents
-string const getExtFromContents(string const & name);
+/// Remove the extension from \p name
+std::string const removeExtension(std::string const & name);
-/// check for zipped file
-bool zippedFile(string const & name);
+/** Add the extension \p ext to \p name.
+ Use this instead of changeExtension if you know that \p name is without
+ extension, because changeExtension would wrongly interpret \p name if it
+ contains a dot.
+ */
+std::string const
+addExtension(std::string const & name, std::string const & extension);
-/// unzip a file
-string const unzipFile(string const & zipped_file);
+/// Return the extension of the file (not including the .)
+std::string const getExtension(std::string const & name);
-/// Returns true is path is absolute
-bool AbsolutePath(string const & path);
+/** \return the name that LyX will give to the unzipped file \p zipped_file
+ if the second argument of unzipFile() is empty.
+ */
+std::string const unzippedFileName(std::string const & zipped_file);
-/// Create absolute path. If impossible, don't do anything
-string const ExpandPath(string const & path);
+/** Unzip \p zipped_file.
+ The unzipped file is named \p unzipped_file if \p unzipped_file is not
+ empty, and unzippedFileName(\p zipped_file) otherwise.
+ Will overwrite an already existing unzipped file without warning.
+ */
+FileName const unzipFile(FileName const & zipped_file,
+ std::string const & unzipped_file = std::string());
/** Convert relative path into absolute path based on a basepath.
If relpath is absolute, just use that.
If basepath doesn't exist use CWD.
*/
-string const MakeAbsPath(string const & RelPath = string(),
- string const & BasePath = string());
+FileName const makeAbsPath(std::string const & RelPath = std::string(),
+ std::string const & BasePath = std::string());
/** Creates a nice compact path for displaying. The parameter
threshold, if given, specifies the maximal length of the path.
*/
-string const
-MakeDisplayPath(string const & path, unsigned int threshold = 1000);
+docstring const
+makeDisplayPath(std::string const & path, unsigned int threshold = 1000);
/** Makes relative path out of absolute path.
If it is deeper than basepath,
different, then the absolute path will be used as relative path
WARNING: the absolute path and base path must really be absolute paths!!!
*/
-string const
-MakeRelPath(string const & abspath, string const & basepath);
+docstring const
+makeRelPath(docstring const & abspath, docstring const & basepath);
/// Strip filename from path name
-string const OnlyPath(string const & fname);
-
-/** Normalize a path. Constracts path/../path
- * Also converts paths like /foo//bar ==> /foo/bar
- */
-string const NormalizePath(string const & path);
+std::string const onlyPath(std::string const & fname);
/// Strips path from filename
-string const OnlyFilename(string const & fname);
-
-/// Get the contents of a file as a huge string
-string const GetFileContents(string const & fname);
+std::string const onlyFileName(std::string const & fname);
/** Check and Replace Environmentvariables ${NAME} in Path.
Replaces all occurences of these, if they are found in the
environment.
Variables are defined by Var := '${' [a-zA-Z_][a-zA-Z_0-9]* '}'
*/
-string const ReplaceEnvironmentPath(string const & path);
-
-/* Set \c link to the path \c file points to as a symbolic link.
- If \c resolve is true, then \c link is an absolute path
- Returns true if successful */
-bool LyXReadLink(string const & file, string & link, bool resolve = false);
+std::string const replaceEnvironmentPath(std::string const & path);
-/// Uses kpsewhich to find tex files
-string const findtexfile(string const & fil, string const & format);
+/**
+ Return a string to be used as a prefix to a command for setting the
+ environment of the TeX engine with respect to the paths \p path and \p lpath.
+ */
+std::string latexEnvCmdPrefix(std::string const &path, std::string const & lpath);
-/// remove the autosave-file and give a Message if it can't be done
-void removeAutosaveFile(string const & filename);
+/** Replace all references to a current directory (a lonely '.' or
+ the prefix "./") in \c pathlist with \c path. Also prefixes
+ all non-absolute paths with \c path.
+*/
+std::string const replaceCurdirPath(std::string const & path, std::string const & pathlist);
-/// read the BoundingBox entry from a ps/eps/pdf-file
-string const readBB_from_PSFile(string const & file);
+/** Set \c link to the path \c file points to as a symbolic link.
+ \return true if successful.
+ */
+bool readLink(FileName const & file, FileName & link);
-/** Copy \c file to directory \c path. The file name is manipulated
- so that eg some/path/to/file becomes some_path_to_file.
- \param path where to put the file
- \param file the file that is copied
- \returns this file name if the file is copied successfully, else
- \returns an empty string.
+/**
+ * Search a TeX file in all locations the latex compiler would search it,
+ * with the help of kpsewhich.
+ * The current working directory must be set correctly, so that relative
+ * names work.
+ * \param fil The filename to search
+ * \param format The file format as used by kpsewhich, e.g. "bib", "bst" etc.
+ */
+FileName const findtexfile(std::string const & fil,
+ std::string const & format);
+
+/** \param file1, file2 the two files to be compared. Must have absolute paths.
+ * \returns 1 if \c file1 has a more recent timestamp than \c file2,
+ * 0 if their timestamps are the same,
+ * -1 if \c file2 has a more recent timestamp than \c file1.
+ * If one of the files does not exist, the return value indicates the file
+ * which does exist. Eg, if \c file1 exists but \c file2 does not, return 1.
*/
-string const copyFileToDir(string const & path, string const & file);
+int compare_timestamps(FileName const & file1, FileName const & file2);
-typedef std::pair<int, string> cmd_ret;
+/// \param lfuns: true if we're converting lfuns, false if prefs
+bool prefs2prefs(FileName const & filename, FileName const & tempfile,
+ bool lfuns);
-cmd_ret const RunCommand(string const & cmd);
+/// Does file \p file need to be updated by configure.py?
+bool configFileNeedsUpdate(std::string const & file);
+
+typedef std::pair<int, std::string> cmd_ret;
+
+cmd_ret const runCommand(std::string const & cmd);
+
+int fileLock(const char * lock_file);
+void fileUnlock(int fd, const char * lock_file);
} // namespace support
} // namespace lyx
+
+
#endif
projects / lyx.git / blobdiff