-// -*- C++-*-
-/* lyx-filetool.h : tools functions for file/path handling
- this file is part of LyX, the High Level Word Processor
- Copyright 1995-2000, Matthias Ettrich and the LyX Team
-*/
+// -*- 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
+ *
+ * Full author contact details are available in file CREDITS.
+ */
#ifndef LYX_FILETOOL_H
#define LYX_FILETOOL_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include <cstdlib>
-#include <fcntl.h>
-#include <cerrno>
+#include "support/docstring.h"
+#include "support/filename.h"
#include <vector>
+#include <utility>
+#include <string>
-#include "debug.h"
-#include "LString.h"
-#include "support/lstrings.h"
+namespace lyx {
+namespace support {
+/// remove directory and all contents, returns true on success
+bool destroyDir(std::string const & tmpdir);
-///
-string const CreateBufferTmpDir (string const & pathfor = string());
+/// Creates the per buffer temporary directory
+std::string const createBufferTmpDir();
-/// Creates directory. Returns true on succes.
-bool createDirectory(string const & name, int permissions);
+/// Creates directory. Returns true on success
+bool createDirectory(std::string const & name, int permissions);
-///
-string const CreateLyXTmpDir (string const & deflt);
-
-///
-int DestroyBufferTmpDir (string const & tmpdir);
-
-///
-int DestroyLyXTmpDir (string const & tmpdir);
+/** 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);
/** Find file by searching several directories.
Uses a string of paths separated by ";"s to find a file to open.
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());
/** 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());
/// Returns a vector of all files in directory dir having extension ext.
-std::vector<string> const DirList(string const & dir,
- string const & ext = string());
+std::vector<std::string> const dirList(std::string const & dir,
+ std::string const & ext = std::string());
/** Is directory read only?
- returns
- 1: dir writeable
- 0: not writeable
- -1: error- couldn't find out, or unsure
+ returns
+ true: dir writeable
+ false: not writeable
*/
-int IsDirWriteable (string const & path);
+bool isDirWriteable(std::string const & path);
/** Is a file readable ?
Returns true if the file `path' is readable.
*/
-bool IsFileReadable (string const & path);
-
-/** 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);
+bool isFileReadable(FileName const & path);
///
-bool IsLyXFilename(string const & filename);
+bool isLyXFilename(std::string const & filename);
///
-bool IsSGMLFilename(string const & filename);
+bool isSGMLFilename(std::string 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());
-/** 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
+ name
*/
-string const
-i18nLibFileSearch(string const & dir, string const & name,
- string const & ext = string());
-
-///
-string const GetEnv(string const & envname);
-
-/// A helper function.
-string const GetEnvPath(string const & name);
-
-///
-bool PutEnv(string const & envstr);
-
-///
-bool PutEnvPath(string const & envstr);
+FileName const
+i18nLibFileSearch(std::string const & dir,
+ std::string const & name,
+ std::string const & ext = std::string());
+
+/// 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 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 ;-)
+ */
+std::string const libScriptSearch(std::string const & command,
+ quote_style style = quote_shell);
+
+enum latex_path_extension {
+ PROTECT_EXTENSION,
+ EXCLUDE_EXTENSION
+};
+
+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);
+std::string const makeLatexName(std::string const & file);
-/// Put the name in quotes suitable for the current shell
-string const QuoteName(string const & file);
-
-/// Is a filename/path absolute?
-bool AbsolutePath(string const & path);
+/** 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);
+std::string const
+changeExtension(std::string const & oldname, std::string const & extension);
+
+/// Remove the extension from \p name
+std::string const removeExtension(std::string const & name);
/// Return the extension of the file (not including the .)
-string const GetExtension(string const & name);
+std::string const getExtension(std::string const & name);
+
+/** Guess the file format name (as in Format::name()) from contents.
+ Normally you don't want to use this directly, but rather
+ Formats::getFormatFromFile().
+ */
+std::string const getFormatFromContents(FileName const & name);
+
+/// check for zipped file
+bool zippedFile(FileName const & name);
+
+/** \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);
+
+/** 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());
+
+/// Returns true is path is absolute
+bool absolutePath(std::string const & path);
/// Create absolute path. If impossible, don't do anything
-string const ExpandPath(string const & path);
+std::string const expandPath(std::string const & path);
/** 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());
+std::string 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);
+std::string const
+makeRelPath(std::string const & abspath, std::string const & basepath);
/// Strip filename from path name
-string const OnlyPath(string const & fname);
+std::string const onlyPath(std::string const & fname);
-/// Normalize a path. Constracts path/../path
-string const NormalizePath(string const & path);
+/** Normalize a path. Constracts path/../path
+ * Also converts paths like /foo//bar ==> /foo/bar
+ */
+std::string const normalizePath(std::string const & path);
/// Strips path from filename
-string const OnlyFilename(string const & fname);
+std::string const onlyFilename(std::string const & fname);
-/// Get the contents of a file as a huge string
-string const GetFileContents(string const & fname);
+/// Get the contents of a file as a huge std::string
+std::string const getFileContents(FileName 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);
+std::string const replaceEnvironmentPath(std::string const & path);
-/* Set Link to the path file points to as a symbolic link.
+/* 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 readLink(std::string const & file,
+ std::string & link,
+ bool resolve = false);
/// Uses kpsewhich to find tex files
-string const findtexfile(string const & fil, string const & format);
+std::string const findtexfile(std::string const & fil,
+ std::string const & format);
/// remove the autosave-file and give a Message if it can't be done
-void removeAutosaveFile(string const & filename);
+void removeAutosaveFile(std::string const & filename);
+
+/// read the BoundingBox entry from a ps/eps/pdf-file
+std::string const readBB_from_PSFile(FileName const & file);
+
+/** \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.
+ */
+int compare_timestamps(FileName const & file1, FileName const & file2);
+
+typedef std::pair<int, std::string> cmd_ret;
+
+cmd_ret const runCommand(std::string const & cmd);
+
+} // namespace support
+} // namespace lyx
#endif