// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2000 The LyX Team.
+/**
+ * \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 "LString.h"
-
-// Where can I put this? I found the occurence of the same code
-// three/four times. Don't you think it better to use a macro definition
-// (an inlined member of some class)?
+#include "support/std_string.h"
-// This should have been a namespace
-#ifdef CXX_WORKING_NAMESPACES
-///
namespace lyx {
- ///
- char * getcwd(char * buffer, size_t size);
- ///
- int chdir(char const * name);
- ///
- int chdir(string const & name);
- /// Returns false it it fails
- bool rename(char const * from, char const * to);
- /// Returns false if it fails
- bool rename(string const & from, string const & to);
- /// Returns false it it fails
- bool copy(string const & from, string const & to);
- /// generates a checksum
- unsigned long sum(char const * file);
- /// generates a checksum
- unsigned long sum(string const & file);
- /// returns a date string (not used currently)
- char * date();
- /// returns the name of the user (not used currently)
- string const getUserName();
- ///
- int kill(int pid, int sig);
- ///
- void abort();
- ///
- int mkdir(string const & pathname, mode_t mode);
- ///
- int putenv(char const * str);
- ///
- int unlink(string const & file);
- ///
- int rmdir(string const & file);
- ///
- int atoi(string const & nstr);
+namespace support {
+
+/// get the current working directory
+string const getcwd();
+/// change to a directory, 0 is returned on success.
+int chdir(string const & name);
+/**
+ * rename a file, returns false if it fails.
+ * It can handle renames across partitions.
+ */
+bool rename(string const & from, string const & to);
+/// copy a file, returns false it it fails
+bool copy(string const & from, string const & to);
+/// generates a checksum of a file
+unsigned long sum(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(string const & pathname, unsigned long int mode);
+/// put a C string into the environment
+int putenv(char const * str);
+/// unlink the given file
+int unlink(string const & file);
+/// remove the given directory
+int rmdir(string const & file);
+/// convert the given string to an integer
+int atoi(string const & nstr);
+/// (securely) create a temporary file in the given dir with the given prefix
+string const tempName(string const & dir = string(),
+ string const & mask = 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(float var, float number, float error)
+{
+ return (number - error <= var && var <= number + error);
}
-#else
-///
-struct lyx {
- ///
- static char * getcwd(char * buffer, size_t size);
- ///
- static int chdir(char const * name);
- ///
- static int chdir(string const & name);
- /// Returns false it it fails
- static bool rename(char const * from, char const * to);
- /// Returns false if it fails
- static bool rename(string const & from, string const & to);
- /// Returns false it it fails
- static bool copy(string const & from, string const & to);
- /// generates a checksum
- static unsigned long sum(char const * file);
- /// generates a checksum
- static unsigned long sum(string const & file);
- /// returns a date string (not used currently)
- static char * date();
- /// returns the name of the user (not used currently)
- static string const getUserName();
- ///
- static int kill(int pid, int sig);
- ///
- static void abort();
- ///
- static int mkdir(string const & pathname, unsigned long int mode);
- ///
- static int putenv(char const * str);
- ///
- static int unlink(string const & file);
- ///
- static int rmdir(string const & file);
- ///
- static int atoi(string const & nstr);
-};
-#endif // CXX_WORKING_NAMESPACES
-#endif
+
+} // namespace support
+} // namespace lyx
+
+#endif /* LYX_LIB_H */