// -*- 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
+ Copyright 1995-2001, Matthias Ettrich and the LyX Team
*/
#ifndef LYX_FILETOOL_H
#pragma interface
#endif
-#include <cstdlib>
-#include <fcntl.h>
-#include <cerrno>
-
#include <vector>
-
-#include "debug.h"
+#include <utility>
#include "LString.h"
-#include "support/lstrings.h"
///
-string const CreateBufferTmpDir (string const & pathfor = string());
+string const CreateBufferTmpDir(string const & pathfor = string());
/// Creates directory. Returns true on succes.
bool createDirectory(string const & name, int permissions);
///
-string const CreateLyXTmpDir (string const & deflt);
+string const CreateLyXTmpDir(string const & deflt);
///
-int DestroyBufferTmpDir (string const & tmpdir);
+int DestroyBufferTmpDir(string const & tmpdir);
///
-int DestroyLyXTmpDir (string const & tmpdir);
+int DestroyLyXTmpDir(string const & tmpdir);
/** 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 FileOpenSearch(string const & path, string const & name,
string const & ext = string());
/** Returns the real name of file name in directory path, with optional
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 FileSearch(string const & path, string const & name,
string const & ext = string());
/// Returns a vector of all files in directory dir having extension ext.
string const & ext = 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 (string const & path);
/** Is a file readable ?
Returns true if the file `path' is readable.
\end{enumerate}
The third parameter `ext' is optional.
*/
-string const LibFileSearch(string const & dir, string const & name,
+string const LibFileSearch(string const & dir, string const & name,
string const & ext = string());
/** 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,
+i18nLibFileSearch(string const & dir, string const & name,
string const & ext = string());
+/** Takes a command with arguments as input and tries to see whether
+ the command itself can be found in one of the scripts/ directories.
+ If it is found, return the command with fully qualified script name,
+ either return it unchanged */
+string const LibScriptSearch(string const & command);
+
///
string const GetEnv(string const & envname);
/// 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);
-
/// Add a filename to a path. Any path from filename is stripped first.
string const AddName(string const & path, string const & fname);
/// Return the extension of the file (not including the .)
string const GetExtension(string const & name);
+/// Return the type of the file as an extension from contents
+string const getExtFromContents(string const & name);
+
+/// check for zipped file
+bool zippedFile(string const & name);
+
+/// unzip a file
+string const unzipFile(string const & zipped_file);
+
+/// Returns true is path is absolute
+bool AbsolutePath(string const & path);
+
/// Create absolute path. If impossible, don't do anything
string const ExpandPath(string const & path);
If relpath is absolute, just use that.
If basepath doesn't exist use CWD.
*/
-string const MakeAbsPath(string const & RelPath = string(),
+string const MakeAbsPath(string const & RelPath = string(),
string const & BasePath = 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);
+MakeDisplayPath(string const & path, unsigned int threshold = 1000);
/** Makes relative path out of absolute path.
If it is deeper than basepath,
/// Strips path from filename
string const OnlyFilename(string const & fname);
-/// Strips filename from path
-string const BasePath(string const & fname);
-
/// Get the contents of a file as a huge string
string const GetFileContents(string const & fname);
-/// Cleanup a path if necessary. Currently only useful with OS/2
-string const CleanupPath(string const & path);
-
/** Check and Replace Environmentvariables ${NAME} in Path.
Replaces all occurences of these, if they are found in the
environment.
*/
string const ReplaceEnvironmentPath(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 LyXReadLink(string const & file, string & link, bool resolve = false);
/// Uses kpsewhich to find tex files
string const findtexfile(string const & fil, string const & format);
/// remove the autosave-file and give a Message if it can't be done
void removeAutosaveFile(string const & filename);
+/// read the BoundingBox entry from a ps/eps/pdf-file
+string const readBB_from_PSFile(string const & file);
+
+typedef std::pair<int, string> cmd_ret;
+
+cmd_ret const RunCommand(string const & cmd);
+
#endif
projects / lyx.git / blobdiff