src/support/lyxlib.h

   1 // -*- C++ -*-
   2 /**
   3  * \file lyxlib.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * A selection of useful system functions made
   8  * handy for C++ usage.
   9  *
  10  * \author Lars Gullik Bjønnes
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef LYX_LIB_H
  16 #define LYX_LIB_H
  17
  18 #include "support/FileName.h"
  19
  20 #include <string>
  21
  22
  23 namespace lyx {
  24 namespace support {
  25
  26 /// get the current working directory
  27 FileName const getcwd();
  28 /// change to a directory, 0 is returned on success.
  29 int chdir(FileName const & name);
  30 /// Change file permissions
  31 bool chmod(FileName const & file, unsigned long int mode);
  32 /**
  33  * rename a file, returns false if it fails.
  34  * It can handle renames across partitions.
  35  */
  36 bool rename(FileName const & from, FileName const & to);
  37 /// copy a file, returns false it it fails
  38 bool copy(FileName const & from, FileName const & to,
  39           unsigned long int mode = (unsigned long int)-1);
  40 /// generates a checksum of a file
  41 unsigned long sum(FileName const & file);
  42 /// FIXME: some point to this hmm ?
  43 int kill(int pid, int sig);
  44 /// FIXME: same here
  45 void abort();
  46 /// create the given directory with the given mode
  47 /// \ret return 0 if the directory is successfully created
  48 int mkdir(FileName const & pathname, unsigned long int mode);
  49 /// create the given directory with the given mode, create all
  50 /// intermediate directories if necessary
  51 /// \ret return 0 if the directory is successfully created
  52 int makedir(char * pathname, unsigned long int mode=0755);
  53 /// (securely) create a temporary file in the given dir with the given mask
  54 /// \p mask must be in filesystem encoding
  55 FileName const tempName(FileName const & dir = FileName(),
  56                       std::string const & mask = std::string());
  57
  58
  59 /**
  60  * Returns true if var is approximately equal to number with allowed error
  61  * of 'error'.
  62  *
  63  * Usage: if (float_equal(var, number, 0.0001)) { }
  64  *
  65  * This will check if 'var' is approx. equal to 'number' with error of 1/1000
  66  */
  67 inline bool float_equal(double var, double number, double error)
  68 {
  69         return (number - error <= var && var <= number + error);
  70 }
  71
  72 } // namespace support
  73 } // namespace lyx
  74
  75 #endif /* LYX_LIB_H */