X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fsupport%2Flyxlib.h;h=287a707e49519750c745c7680e6e83b838d218a5;hb=faa87bf9f30b943397429a04254d96963bbf38bc;hp=f7512a7c72032bd0756d428348a3c52b0ac95bb5;hpb=c36aa67f7bbf964a624be7ced9b3bf03148ab1db;p=lyx.git diff --git a/src/support/lyxlib.h b/src/support/lyxlib.h index f7512a7c72..287a707e49 100644 --- a/src/support/lyxlib.h +++ b/src/support/lyxlib.h @@ -1,38 +1,40 @@ // -*- 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 "LString.h" +namespace lyx { +namespace support { + +/// FIXME: some point to this hmm ? +int kill(int pid, int sig); + +/** + * 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); +} -// 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)? +} // namespace support +} // namespace lyx -// This should have been a namespace -struct lyx { - /// - static char * getcwd(char * buffer, size_t size); - /// - static int chdir(char const * name); - /// generates an checksum - static unsigned long sum(char const * file); - /// returns a date string - static char * date(); - /// - static string getUserName(); - /// - static int kill(int pid, int sig); - /// - static void abort(); -}; -#endif +#endif /* LYX_LIB_H */