-// -*- C++-*-
-/* lyx-filetool.h : tools functions for file/path handling
- this file is part of LyX, the High Level Word Processor
- Copyright 1995-1999, 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 <vector>
+#include <utility>
+#include <string>
-#include <cstdio>
-#include <cstdlib>
-#include <fcntl.h>
-#include <cerrno>
-#include "debug.h"
-#include "LString.h"
-#include "support/lstrings.h"
-
-/** A file class.
- Use this instead of FILE *, it gives a much better structure.
- It should prehaps do a bit more error checking than it does now.
- Currently it is a verbatim copy from p309 of Bjarne Stroupstrups
- The C++ Programming Language. + some additions.
- */
-class FilePtr {
-public:
- ///
- enum file_mode {
- read,
- write,
- update,
- truncate
- };
- ///
- FilePtr(string const & name, file_mode mode) {
- init();
- do_open(name, mode);
- }
- ///
- FilePtr(FILE * pp) { init(); p = pp; }
- ///
- ~FilePtr() { close(); }
-
- /** Use this if you want to rebind the FilePtr to another file.
- */
- FilePtr & reopen(string const & name, file_mode mode) {
- // close the file it it is already open
- close();
- // Now open the file.
- do_open(name, mode);
-
- return *this;
- }
- /** Close the file.
- Use this with some carefullness. After it has been used
- the FilePtr is unusable. Only use it if it is important
- that the file is closed before the FilePtr goes out
- of scope. */
- int close() {
- if (p) {
- int result = fclose(p);
- p = 0;
- return result;
- } else
- return 0;
- }
- /// automatic converson to FILE* if that is needed.
- operator FILE*() { return p; }
- ///
- FilePtr & operator=(FILE * f) { p=f; return *this;}
- ///
- FILE * operator()() { return p; }
-private:
- ///
- void do_open(string const & name, file_mode mode) {
- string modestr;
-
- switch(mode) {
- // do appropiate #ifdef here so support EMX
-#ifndef __EMX__
- case read: modestr = "r"; break;
- case write: modestr = "w"; break;
-#else
- case read: modestr = "rt"; break; // Can read both DOS & UNIX text files.
- case write: modestr = "w"; break; // Write UNIX text files.
-#endif
-
- case update: modestr = "r+"; break;
- case truncate: modestr = "w+"; break;
- }
- // Should probably be rewritten to use open(2)
- if((p = fopen(name.c_str(), modestr.c_str()))) {
- // file succesfully opened.
- if (fcntl(fileno(p),F_SETFD,FD_CLOEXEC) == -1) {
- p = 0;
- }
- } else {
- // we have an error let's check what it is.
- switch(errno) {
- case EINVAL:
- // Internal LyX error.
- lyxerr << "FilePtr: Wrong parameter given to fopen." << endl;
- break;
- default:
- // unknown error
- break;
- }
- }
- }
- ///
- void init() { p = 0; }
- ///
- FILE * p;
-};
+namespace lyx {
+namespace support {
+/// remove directory and all contents, returns 0 on success
+int destroyDir(std::string const & tmpdir);
-///
-string 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 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.
+ */
+std::string const createLyXTmpDir(std::string 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 FileOpenSearch (string const & path, string const & name,
- string const & ext = string());
+std::string 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 FileSearch(string const & path, string const & name,
- string const & ext = string());
+std::string 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<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
- */
-int IsDirWriteable (string const & path);
+ returns
+ true: dir writeable
+ false: not writeable
+*/
+bool IsDirWriteable (std::string const & path);
/** Is a file readable ?
Returns true if the file `path' is readable.
*/
-bool IsFileReadable (string const & path);
+bool IsFileReadable (std::string const & path);
/** Is file read only?
returns
0: read_only
-1: error (doesn't exist, no access, anything else)
*/
-int IsFileWriteable (string const & path);
+int IsFileWriteable (std::string 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
\end{enumerate}
The third parameter `ext' is optional.
*/
-string LibFileSearch(string const & dir, string const & name,
- string const & ext = string());
+std::string 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
internationalized version of the file by prepending $LANG_ to the
- name
+ name
*/
-string i18nLibFileSearch(string const & dir, string const & name,
- string const & ext = string());
+std::string const
+i18nLibFileSearch(std::string const & dir, std::string const & name,
+ std::string const & ext = std::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 ;-)
+ */
+std::string const LibScriptSearch(std::string const & command);
///
-string GetEnv(string const & envname);
+std::string const GetEnv(std::string const & envname);
/// A helper function.
-string GetEnvPath(string const & name);
+std::string const GetEnvPath(std::string const & name);
-///
-bool PutEnv(string const & envstr);
+/// Substitutes active latex characters with underscores in filename
+std::string const MakeLatexName(std::string const & file);
-///
-bool PutEnvPath(string const & envstr);
-
-/// Substitutes spaces with underscores in filename (and path)
-string SpaceLess(string const & file);
-
-/** Returns an unique name to be used as a temporary file. If given,
- 'mask' should the prefix to the temporary file, the rest of the
- temporary filename will be made from the pid and three letters.
- */
-string TmpFileName(string const & dir = string(),
- string const & mask = "lyx_tmp");
-
-/// Is a filename/path absolute?
-bool AbsolutePath(string const & path);
+/// Put the name in quotes suitable for the current shell
+std::string const QuoteName(std::string const & file);
/// Add a filename to a path. Any path from filename is stripped first.
-string 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 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 no_path is true, the path is stripped from the filename.
If oldname does not have an extension, it is appended.
If the extension is empty, any extension is removed from the name.
*/
-string ChangeExtension(string const & oldname, string const & extension,
- bool no_path);
+std::string const
+ChangeExtension(std::string const & oldname, std::string const & extension);
-/// Create absolute path. If impossible, don't do anything
-string ExpandPath(string const & path);
+/// Return the extension of the file (not including the .)
+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(std::string const & name);
+
+/// check for zipped file
+bool zippedFile(std::string 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.
+ */
+std::string const unzipFile(std::string const & zipped_file,
+ std::string const & unzipped_file = std::string());
-/// gets current working directory
-string GetCWD();
+/// 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.
*/
-string 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 MakeDisplayPath(string const & path, unsigned int threshold=1000);
+std::string 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 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 OnlyPath(string const & fname);
+std::string const OnlyPath(std::string const & fname);
-/// Normalize a path. Constracts path/../path
-string 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 OnlyFilename(string const & fname);
+std::string const OnlyFilename(std::string const & fname);
-/// Cleanup a path if necessary. Currently only useful with OS/2
-string CleanupPath(string const & path) ;
+/// Get the contents of a file as a huge std::string
+std::string const GetFileContents(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 ReplaceEnvironmentPath(string const & path);
+std::string const ReplaceEnvironmentPath(std::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(std::string const & file, std::string & link, bool resolve = false);
+
+/// Uses kpsewhich to find tex files
+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(std::string const & filename);
+
+/// read the BoundingBox entry from a ps/eps/pdf-file
+std::string const readBB_from_PSFile(std::string 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(std::string const & file1, std::string const & file2);
+
+typedef std::pair<int, std::string> cmd_ret;
+
+cmd_ret const RunCommand(std::string const & cmd);
-/* Set Link to the path File Points to as a symbolic link.
- Return True if succesfull, False other wise */
-bool LyXReadLink(string const & file, string & Link);
+} // namespace support
+} // namespace lyx
#endif
projects / lyx.git / blobdiff