1 /*=========================================================================
4 Module: $RCSfile: bbtkConfigurationFile.h,v $
6 Date: $Date: 2008/09/10 07:25:23 $
7 Version: $Revision: 1.8 $
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
49 //==========================================================================
50 class BBTK_EXPORT ConfigurationException
53 ConfigurationException(const std::string& message) : mMessage(message) {}
57 //==========================================================================
59 //==========================================================================
60 class BBTK_EXPORT ConfigurationFile
64 static ConfigurationFile const &GetInstance()
66 static ConfigurationFile f;
77 void GetHelp(int level) const;
79 inline const std::string& Get_description() const
80 { return mDescription;}
81 // inline const std::string& Get_url() const
83 inline const std::string& Get_data_path() const
85 inline const std::string& Get_file_separator() const
86 { return mFile_separator;}
88 inline const std::string& Get_bin_path() const
90 inline const std::string& Get_install_path() const
91 { return mInstall_path;}
92 inline const std::string& Get_doc_path() const
94 inline const std::string& Get_rsc_path() const
97 inline const std::string& Get_root_bbs_path() const
99 inline const std::vector<std::string>& Get_bbs_paths() const
100 { return mBbs_paths;}
101 inline const std::vector<std::string>& Get_package_paths() const
102 { return mPackage_paths;}
103 inline const std::string& Get_config_xml_full_path() const
104 { return mConfig_xml_full_path;}
105 inline const std::string& Get_default_temp_dir() const
106 { return mDefault_temp_dir;}
109 void Read(const std::string& fileName);
110 std::string GetExecutablePath();
111 void CreateConfigXML( char *rootDirectory );
115 std::string mDescription;
116 /// Where is the file bbtk_config.xml
117 std::string mConfig_xml_full_path;
119 /// Set automatically :
120 /// The path to the executable (usually bbi)
121 std::string mBin_path;
122 /// The path to the install prefix (=mBinPath+"/..")
123 std::string mInstall_path;
124 /// The relative path to the doc folder (=BBTK_DOC_REL_PATH)
125 std::string mDoc_rel_path;
126 /// The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
127 std::string mDoc_path;
128 /// The relative path to the doc folder (=BBTK_BBS_REL_PATH)
129 std::string mBbs_rel_path;
130 /// The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
131 std::string mBbs_path;
132 /// The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
133 std::string mRsc_rel_path;
134 /// The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
135 std::string mRsc_path;
136 /// The path to the bbtk data folder
137 /// Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
138 /// But can be overriden by value read from bbtk_config.xml
139 std::string mData_path;
141 /// / or \, depending on the OS
142 std::string mFile_separator;
144 /// Read from bbtk_config.xml file
148 std::vector<std::string> mBbs_paths;
150 std::vector<std::string> mPackage_paths;
151 /// If Packages link against extern dlls
152 std::vector<std::string> mExt_dll_paths;
153 /// Temp directory for generated data
154 std::string mDefault_temp_dir;