]> git.lyx.org Git - lyx.git/blobdiff - src/support/lyxlib.h
Remove non-copyable idioms
[lyx.git] / src / support / lyxlib.h
index da5a4858f9123a59aca938324e0f1541bc6034b5..23894ee2ebea1d47d077ca3344ada70edd32e89f 100644 (file)
@@ -1,67 +1,60 @@
 // -*- C++ -*-
-/* This file is part of
- * ====================================================== 
- * 
- *           LyX, The Document Processor
- *        
- *           Copyright (C) 1995 Matthias Ettrich
- *           Copyright (C) 1995-1999 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 <ctime>
-#include <unistd.h>
-
-#include "LString.h"
-#include "gettext.h"
-#include "support/filetools.h"
-
-/// generates an checksum
-unsigned long lyxsum(char const * file);
+// always include <math.h> (also with MSVC), to avoid compiler specific side effects
+#include <math.h>
 
-/// returns a date string
-inline char * date() 
+#ifdef _MSC_VER
+/// Replacement for C99 round()
+inline double round(double x)
 {
-       time_t tid;
-       if ((tid= time(0)) == static_cast<time_t>(-1))
-               return 0;
+       if (x < 0)
+               return ceil(x - 0.5);
        else
-               return ctime(&tid);
+               return floor(x + 0.5);
 }
+#endif
+
+namespace lyx {
+namespace support {
 
+/// FIXME: some point to this hmm ?
+int kill(int pid, int sig);
 
-// 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)?
-///
-inline string getUserName()
+/**
+ * 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)
 {
-       string userName(GetEnv("LOGNAME"));
-       if (userName.empty())
-               userName = GetEnv("USER");
-       if (userName.empty())
-               userName = _("unknown");
-       return userName;
+       return (number - error <= var && var <= number + error);
 }
 
-// This should have been a namespace
-struct lyx {
-       static char * getcwd(char * buffer, size_t size) {
-#ifndef __EMX__
-               return ::getcwd(buffer, size);
-#else
-               return ::_getcwd2(buffer, size);
-#endif
-       };
-       static int chdir(char const * name) {
-#ifndef __EMX__
-               return ::chdir(name);
-#else
-               return ::_chdir2(name);
-#endif
-       };
-};
-#endif
+/// round \p x to nearest integer
+inline int iround(double x)
+{
+       return static_cast<int>(round(x));
+}
+
+} // namespace support
+} // namespace lyx
+
+#endif /* LYX_LIB_H */