* 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.
*/
#define LYX_FILETOOL_H
#include "support/docstring.h"
-#include "support/FileName.h"
-#include <vector>
#include <utility>
#include <string>
namespace lyx {
namespace support {
-/// Creates the per buffer temporary directory
-std::string const createBufferTmpDir();
+class FileName;
/** Creates the global LyX temp dir.
\p deflt can be an existing directory name. In this case a new directory
/// How to search files
enum search_mode {
- // The file must exist (return an empty file name otherwise)
- standard_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
- allow_unreadable
+ 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
FileName const fileSearch(std::string const & path,
std::string const & name,
std::string const & ext = std::string(),
- search_mode mode = standard_mode);
-
-/// Returns a vector of all files in directory dir having extension ext.
-std::vector<FileName> const dirList(FileName const & dir,
- std::string const & ext = std::string());
+ search_mode mode = must_exist);
///
-bool isLyXFilename(std::string const & filename);
+bool isLyXFileName(std::string const & filename);
///
-bool isSGMLFilename(std::string const & filename);
+bool isSGMLFileName(std::string const & filename);
-///
-bool isValidLaTeXFilename(std::string const & filename);
+/// check for characters in filenames not allowed by LaTeX
+bool isValidLaTeXFileName(std::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);
+
+/// 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
*/
FileName const libFileSearch(std::string const & dir,
std::string const & name,
- std::string const & ext = std::string());
+ std::string const & ext = std::string(),
+ search_mode mode = must_exist);
/** Same as libFileSearch(), but tries first to find an
internationalized version of the file by prepending $LANG_ to the
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';
* 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);
+std::string const commandPrep(std::string const & command);
enum latex_path_extension {
PROTECT_EXTENSION,
latex_path_dots dots = LEAVE_DOTS);
/// Substitutes active latex characters with underscores in filename
-std::string const makeLatexName(std::string const & file);
+FileName const makeLatexName(FileName const & file);
/** Put the name in quotes suitable for the current shell or python,
depending on \p style. */
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
-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.
/// Strip filename from path name
std::string const onlyPath(std::string const & fname);
-/** 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
-std::string const onlyFilename(std::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
*/
std::string const replaceEnvironmentPath(std::string const & path);
+/**
+ 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);
+
+/** 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);
+
/** Set \c link to the path \c file points to as a symbolic link.
\return true if successful.
*/
FileName 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(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,
*/
int compare_timestamps(FileName const & file1, FileName const & file2);
+/// \param lfuns: true if we're converting lfuns, false if prefs
+bool prefs2prefs(FileName const & filename, FileName const & tempfile,
+ bool lfuns);
+
+/// 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
-/// The following functions are implemented in minizip/zipunzip.cpp, and are not in
-/// the lyx::support namespace
-
-/// zip several files to a zipfile. In-zip filenames are also specified
-bool zipFiles(std::string const & zipfile, std::vector<std::pair<std::string, std::string> > const & files);
-
-/// Unzip a zip file to a directory
-bool unzipToDir(std::string const & zipfile, std::string const & path);
#endif
projects / lyx.git / blobdiff