mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-21 15:18:45 +00:00
177a1c42aa
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@9555 a592a061-630c-0410-9148-cb99ea01b6c8
69 lines
1.9 KiB
C++
69 lines
1.9 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file lyxlib.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* A selection of useful system functions made
|
|
* handy for C++ usage.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef LYX_LIB_H
|
|
#define LYX_LIB_H
|
|
|
|
#include <string>
|
|
|
|
|
|
namespace lyx {
|
|
namespace support {
|
|
|
|
/// get the current working directory
|
|
std::string const getcwd();
|
|
/// change to a directory, 0 is returned on success.
|
|
int chdir(std::string const & name);
|
|
/**
|
|
* rename a file, returns false if it fails.
|
|
* It can handle renames across partitions.
|
|
*/
|
|
bool rename(std::string const & from, std::string const & to);
|
|
/// copy a file, returns false it it fails
|
|
bool copy(std::string const & from, std::string const & to);
|
|
/// generates a checksum of a file
|
|
unsigned long sum(std::string const & file);
|
|
/// FIXME: some point to this hmm ?
|
|
int kill(int pid, int sig);
|
|
/// FIXME: same here
|
|
void abort();
|
|
/// create the given directory with the given mode
|
|
int mkdir(std::string const & pathname, unsigned long int mode);
|
|
/// put variable=value as a C std::string into the environment
|
|
bool putenv(std::string const & varname, std::string const & value);
|
|
/// unlink the given file
|
|
int unlink(std::string const & file);
|
|
/// (securely) create a temporary file in the given dir with the given prefix
|
|
std::string const tempName(std::string const & dir = std::string(),
|
|
std::string const & mask = std::string());
|
|
|
|
|
|
/**
|
|
* Returns true if var is approximately equal to number with allowed error
|
|
* of 'error'.
|
|
*
|
|
* Usage: if (float_equal(var, number, 0.0001)) { }
|
|
*
|
|
* This will check if 'var' is approx. equal to 'number' with error of 1/1000
|
|
*/
|
|
inline bool float_equal(double var, double number, double error)
|
|
{
|
|
return (number - error <= var && var <= number + error);
|
|
}
|
|
|
|
} // namespace support
|
|
} // namespace lyx
|
|
|
|
#endif /* LYX_LIB_H */
|