1 /*=========================================================================
4 Module: $RCSfile: bbtkConfigurationFile.h,v $
6 Date: $Date: 2008/02/13 14:08:25 $
7 Version: $Revision: 1.3 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See doc/license.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 *\brief Class bbtk::ConfigurationFile
23 *\class bbtk::ConfigurationFile
28 #ifndef __bbtkConfigurationFile_h__
29 #define __bbtkConfigurationFile_h__
31 #include "bbtkSystem.h"
36 #define _CRT_SECURE_NO_DEPRECATE
40 #include "xmlParser.h"
49 //==========================================================================
50 class BBTK_EXPORT ConfigurationException
53 ConfigurationException(const std::string& message) : mMessage(message) {}
59 //==========================================================================
60 class BBTK_EXPORT ConfigurationFile
64 static ConfigurationFile const &GetInstance()
66 static ConfigurationFile f;
77 inline const std::string& Get_description() const
78 { return mDescription;}
79 inline const std::string& Get_url() const
81 inline const std::string& Get_data_path() const
83 inline const std::string& Get_file_separator() const
84 { return mFile_separator;}
86 inline const std::string& Get_bin_path() const
88 inline const std::string& Get_install_path() const
89 { return mInstall_path;}
90 inline const std::string& Get_doc_path() const
92 inline const std::string& Get_rsc_path() const
95 inline const std::vector<std::string>& Get_bbs_paths() const
97 inline const std::vector<std::string>& Get_package_paths() const
98 { return mPackage_paths;}
99 inline const std::string& Get_config_xml_full_path() const
100 { return mConfig_xml_full_path;}
101 inline const std::string& Get_default_temp_dir() const
102 { return mDefault_temp_dir;}
105 void Read(const std::string& fileName);
106 void GetTextOrClear(const XMLNode& node, std::string& var);
107 char *GetExecutablePath();
108 bool FileExists(std::string strFilename);
109 void CreateConfigXML( char *rootDirectory );
113 std::string mDescription;
114 /// Where is the file bbtk_config.xml
115 std::string mConfig_xml_full_path;
117 /// Set automatically :
118 /// The path to the executable (usually bbi)
119 std::string mBin_path;
120 /// The path to the install prefix (=mBinPath+"/..")
121 std::string mInstall_path;
122 /// The relative path to the doc folder (=BBTK_DOC_REL_PATH)
123 std::string mDoc_rel_path;
124 /// The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
125 std::string mDoc_path;
126 /// The relative path to the doc folder (=BBTK_BBS_REL_PATH)
127 std::string mBbs_rel_path;
128 /// The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
129 std::string mBbs_path;
130 /// The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
131 std::string mRsc_rel_path;
132 /// The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
133 std::string mRsc_path;
134 /// The path to the bbtk data folder
135 /// Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
136 /// But can be overriden by value read from bbtk_config.xml
137 std::string mData_path;
139 /// / or \, depending on the OS
140 std::string mFile_separator;
142 /// Read from bbtk_config.xml file
146 std::vector<std::string> mBbs_paths;
148 std::vector<std::string> mPackage_paths;
149 /// If Packages link against extern dlls
150 std::vector<std::string> mExt_dll_paths;
151 /// Default directory for generating Graph
152 std::string mDefault_temp_dir;