KVBase.h

/***************************************************************************
                          kvbase.h  -  description
                             -------------------
    begin                : Thu May 16 2002
    copyright            : (C) 2002 by J.D. Frankland
    email                : frankland@ganil.fr
 
$Id: KVBase.h,v 1.42 2009/03/12 13:59:40 franklan Exp $
***************************************************************************/
 
#ifndef KVBASE_H
#define KVBASE_H
#include <optional>
#include "KVConfig.h"
#include "KVError.h"
#include "TNamed.h"
#include "RVersion.h"
#include "TString.h"
#include "KVLockfile.h"
#include "TPluginManager.h"
#include "TF1.h"
#include "TEnv.h"
class KVString;
#ifdef WITH_RSQLITE
namespace KVSQLite {
   class database;
}
#endif
 
class KVBase: public TNamed {
 
private:
    UInt_t fNumber;
protected:
    TString fLabel;
 
private:
    static Bool_t fEnvIsInit;
    static TString fWorkingDirectory;
 
   void init();
   static void ReadGUIMimeTypes();
   static void ReadConfigFiles();
 
public:
 
   static void Deprecated(const char* method, const char* advice);
 
   enum EKaliVedaBits {
      kIsKaliVedaObject = BIT(23)   //all KVBase-derived objects have this bit set in TObject::fBits
   };
 
   static Bool_t IsEnvInit()
   {
      return fEnvIsInit;
   }
   static void InitEnvironment();
   KVBase();
   KVBase(const Char_t* name, const Char_t* title = "");
   KVBase(const KVBase&);
   KVBase& operator=(const KVBase&);
 
   virtual void SetType(const Char_t* str)
   {
      SetTitle(str);
   }
   virtual const Char_t* GetType() const
   {
      return GetTitle();
   }
   static const Char_t* WorkingDirectory()
   {
      return fWorkingDirectory.Data();
   }
   Bool_t IsType(const Char_t* typ, bool case_insensitive = false) const
   {
      TString this_type(GetType());
      return this_type.CompareTo(typ, case_insensitive ? TString::kIgnoreCase : TString::kExact) == 0;
   }
   Bool_t IsCalled(const Char_t* name, bool case_insensitive = false) const
   {
      TString this_name(GetName());
      return this_name.CompareTo(name, case_insensitive ? TString::kIgnoreCase : TString::kExact) == 0;
   }
   void SetLabel(const Char_t* lab)
   {
      fLabel = lab;
   }
   const Char_t* GetLabel() const
   {
      return fLabel;
   }
   Bool_t HasLabel() const
   {
      return fLabel.Length();
   }
   Bool_t IsLabelled(const Char_t* l, bool case_insensitive = false) const
   {
      return fLabel.CompareTo(l, case_insensitive ? TString::kIgnoreCase : TString::kExact) == 0;
   }
   void Print(Option_t* option = "") const override;
   virtual void List()
   {
   }
   virtual void SetNumber(UInt_t num)
   {
      fNumber = num;
   }
   UInt_t GetNumber() const
   {
      return fNumber;
   }
   void Clear(Option_t* opt = "") override;
#if ROOT_VERSION_CODE >= ROOT_VERSION(3,4,0)
   void Copy(TObject&) const override;
#else
   virtual void Copy(TObject&);
#endif
 
   static Bool_t SearchKVFile(const Char_t* name, TString& fullpath,
                              const Char_t* kvsubdir = "");
#ifdef WITH_RSQLITE
   static Bool_t SearchAndOpenKVFile(const Char_t* name, KVSQLite::database& dbfile,
                                     const Char_t* kvsubdir = "");
#endif
   static Bool_t SearchAndOpenKVFile(const Char_t* name, std::ifstream& file,
                                     const Char_t* kvsubdir = "", KVLockfile* locks = 0);
   static Bool_t SearchAndOpenKVFile(const Char_t* name, std::ofstream& file,
                                     const Char_t* kvsubdir = "", KVLockfile* locks = 0);
   static void BackupFileWithDate(const Char_t* path);
   static TPluginHandler* LoadPlugin(const Char_t* base,
                                     const Char_t* uri = "0");
   static const Char_t* GetPluginURI(const Char_t* base, const Char_t* plugin);
   static const Char_t* GetListOfPlugins(const Char_t* base);
   static const Char_t* GetListOfPluginURIs(const Char_t* base);
   static Bool_t IsThisAPlugin(const TString& uri, TString& base);
   static void OpenTempFile(TString& base, std::ofstream& fp);       /* open temp file with basename 'base' */
   static void GetTempFileName(TString& base);
 
   static const Char_t* GetKVVersion();
   static int   GetKVMajorVersion();
   static int   GetKVMinorVersion();
   static int   GetKVPatchVersion();
   static const Char_t* GetKVBuildDate();
   static const Char_t* GetKVBuildTime();
   static const Char_t* GetKVBuildType();
   static const Char_t* GetKVBuildUser();
   static const Char_t* GetKVSourceDir();
   static const Char_t* GetKVBuildDir();
 
#ifdef WITH_GIT_INFOS
   static const Char_t* gitBranch();
   static const Char_t* gitCommit();
#endif
 
   static const Char_t* GetETCDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetDATADIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetDATABASEFilePath();
   static const Char_t* GetLIBDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetINCDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetBINDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetWORKDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetTEMPLATEDIRFilePath(const Char_t* namefile = "");
   static const Char_t* GetExampleFilePath(const Char_t* library, const Char_t* namefile);
   static bool is_gnuinstall()
   {
#ifdef WITH_GNU_INSTALL
      return true;
#else
      return false;
#endif
   }
 
   static Bool_t FindExecutable(TString& exec, const Char_t* path =
                                   "$(PATH)");
 
   static const Char_t* FindFile(const Char_t* search, TString& wfil);
   static Bool_t FindClassSourceFiles(const KVString& class_name, KVString& imp_file,
                                      KVString& dec_file, const KVString& dir_name = ".");
 
   static Bool_t AreEqual(Double_t x, Double_t y, Long64_t maxdif = 1);
 
   static Bool_t OpenContextMenu(const char* method, TObject* obj, const char* alt_method_name = "");
 
   static void CombineFiles(const Char_t* file1, const Char_t* file2, const Char_t* newfilename, Bool_t keep = kTRUE);
 
   virtual TObject* GetObject() const;
 
   static void PrintSplashScreen();
 
   template<typename ValType>
   static ValType GetDataSetEnv(const KVString& dataset, const KVString& type, const ValType& defval = {})
   {
 
      KVString temp = dataset + "." + type;
      if (gEnv->Defined(temp)) return gEnv->GetValue(temp.Data(), defval);
      return gEnv->GetValue(type, defval);
   }
 
   enum class GetX_status
   {
      ok,
      above_maximum,
      below_minimum,
      at_maximum,
      at_minimum
   };
 
   static Double_t ProtectedGetX(const TF1* func, Double_t val, GetX_status& status, std::optional<Double_t> xmin = {}, std::optional<Double_t> xmax = {});
   static Double_t ProtectedGetX(const TF1& func, Double_t val, GetX_status& status, std::optional<Double_t> xmin = {}, std::optional<Double_t> xmax = {});
 
   static std::optional<TString> AbsoluteUnixPath(const TString&);
 
   ClassDefOverride(KVBase, 4)          //Base class for all KaliVeda objects
};
 
extern void AssignAndDelete(TString& target, char* tobedeleted);
Bool_t SearchFile(const Char_t* name, TString& fullpath, int ndirs, ...);
#endif