]> Creatis software - bbtk.git/blob - kernel/src/bbtkConfigurationFile.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkConfigurationFile.h
1 /*=========================================================================
2                                                                                 
3   Program:   bbtk
4   Module:    $RCSfile: bbtkConfigurationFile.h,v $
5   Language:  C++
6   Date:      $Date: 2008/02/14 09:32:54 $
7   Version:   $Revision: 1.4 $
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.
12
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.
16
17 =========================================================================*/
18 /**
19  *\file
20  *\brief Class bbtk::ConfigurationFile
21  */
22 /**
23  *\class bbtk::ConfigurationFile
24  *\brief DDD
25  *
26  */
27
28 #ifndef __bbtkConfigurationFile_h__
29 #define __bbtkConfigurationFile_h__
30
31 #include "bbtkSystem.h"
32 #include <string>
33
34
35 #ifdef WIN32
36 #define _CRT_SECURE_NO_DEPRECATE
37 #endif
38
39 #include <stdio.h>
40 #include <iostream>
41 #include <fstream>
42 #include <sstream>
43 #include <vector>
44
45
46 namespace bbtk
47 {
48   //==========================================================================
49   class BBTK_EXPORT  ConfigurationException
50   {
51   public:
52     ConfigurationException(const std::string& message) : mMessage(message) {}
53     
54     std::string mMessage;
55   };
56   //==========================================================================
57   
58   //==========================================================================
59   class BBTK_EXPORT ConfigurationFile
60   {
61   public:
62     
63     static ConfigurationFile const &GetInstance()
64     {
65       static ConfigurationFile f;
66       return f;
67     }
68     
69     ~ConfigurationFile();
70     
71   private:
72     ConfigurationFile();
73     void InstallPath ();
74     
75   public:
76     inline const std::string& Get_description() const
77     { return mDescription;}
78     inline const std::string& Get_url() const
79     { return mUrl;}
80     inline const std::string& Get_data_path() const
81     { return mData_path;}  
82     inline const std::string& Get_file_separator() const
83     { return mFile_separator;}
84     
85     inline const std::string& Get_bin_path() const
86     { return mBin_path;}
87     inline const std::string& Get_install_path() const
88     { return mInstall_path;}
89     inline const std::string& Get_doc_path() const
90     { return mDoc_path;}
91     inline const std::string& Get_rsc_path() const
92     { return mRsc_path;}
93     
94     inline const std::vector<std::string>& Get_bbs_paths() const
95     { return mBbs_paths;}
96     inline const std::vector<std::string>& Get_package_paths() const
97     { return mPackage_paths;}
98     inline const std::string& Get_config_xml_full_path() const
99     { return mConfig_xml_full_path;}
100     inline const std::string& Get_default_temp_dir() const
101     { return mDefault_temp_dir;}
102     
103   private:
104     void Read(const std::string& fileName);
105      std::string GetExecutablePath();
106      void CreateConfigXML( char *rootDirectory );
107     
108     // Attributes :
109   private :
110     std::string mDescription; 
111     /// Where is the file bbtk_config.xml
112     std::string mConfig_xml_full_path;  
113     
114     /// Set automatically :
115     /// The path to the executable (usually bbi)
116     std::string mBin_path;
117     /// The path to the install prefix (=mBinPath+"/..")
118     std::string mInstall_path;
119     /// The relative path to the doc folder (=BBTK_DOC_REL_PATH)
120     std::string mDoc_rel_path;
121     /// The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path)
122     std::string mDoc_path;
123     /// The relative path to the doc folder (=BBTK_BBS_REL_PATH)
124     std::string mBbs_rel_path;
125     /// The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path)
126     std::string mBbs_path;
127     /// The relative path to the rsc folder (=BBTK_RSC_REL_PATH)
128     std::string mRsc_rel_path;
129     /// The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path)
130     std::string mRsc_path;
131     /// The path to the bbtk data folder 
132     /// Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH
133     /// But can be overriden by value read from bbtk_config.xml
134     std::string mData_path;
135     
136     /// / or \, depending on the OS
137     std::string mFile_separator;
138     
139     /// Read from bbtk_config.xml file
140     /// Where the doc is
141     std::string mUrl;
142     /// Scripts  
143     std::vector<std::string> mBbs_paths; 
144     /// Package dlls    
145     std::vector<std::string> mPackage_paths;
146     /// If Packages link against extern dlls
147     std::vector<std::string> mExt_dll_paths;
148     /// Temp directory for generated data
149     std::string mDefault_temp_dir;       
150   };
151   
152   
153 }// namespace bbtk
154
155
156
157 #endif
158