X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkConfigurationFile.cxx;h=45f39dc9732e18e89dbbd539b4adf0a6bf5db538;hb=ab0cfcfdd031ff179ed1550874c648a54d8e1023;hp=1dd5780150951a1384e8d10c127799930cb4423c;hpb=157b1a61a177ccd0a3136f6e435880d949411c4d;p=bbtk.git diff --git a/kernel/src/bbtkConfigurationFile.cxx b/kernel/src/bbtkConfigurationFile.cxx index 1dd5780..45f39dc 100644 --- a/kernel/src/bbtkConfigurationFile.cxx +++ b/kernel/src/bbtkConfigurationFile.cxx @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk Module: $RCSfile: bbtkConfigurationFile.cxx,v $ Language: C++ - Date: $Date: 2008/02/14 09:57:18 $ - Version: $Revision: 1.6 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See doc/license.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. - - This software is distributed WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR - PURPOSE. See the above copyright notices for more information. - + Date: $Date: 2009/03/24 13:42:59 $ + Version: $Revision: 1.30 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale) +* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux +* +* This software is governed by the CeCILL-B license under French law and +* abiding by the rules of distribution of free software. You can use, +* modify and/ or redistribute the software under the terms of the CeCILL-B +* license as circulated by CEA, CNRS and INRIA at the following URL +* http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html +* or in the file LICENSE.txt. +* +* As a counterpart to the access to the source code and rights to copy, +* modify and redistribute granted by the license, users are provided only +* with a limited warranty and the software's author, the holder of the +* economic rights, and the successive licensors have only limited +* liability. +* +* The fact that you are presently reading this means that you have had +* knowledge of the CeCILL-B license and that you accept its terms. +* ------------------------------------------------------------------------ */ + /** *\file *\brief Class bbtk::ConfigurationFile @@ -26,9 +39,13 @@ #include "bbtkUtilities.h" #if defined(WIN32) -#include // for getcwd +# include // for getcwd +# include #endif + + + namespace bbtk { @@ -36,61 +53,125 @@ namespace bbtk /// Constructor ConfigurationFile::ConfigurationFile() { - // file separator -#if defined(_WIN32) - mFile_separator = "\\"; + + mFile_separator = VALID_FILE_SEPARATOR; + + // ==> Set system paths + mBin_path = Utilities::GetExecutablePath(); + + + + +/* EED 23 Mars 2009 +#ifdef MACOSX + mInstall_path = mBin_path + "/../../../.."; #else - mFile_separator = "/"; + mInstall_path = mBin_path + "/.."; #endif - - // ==> Set system paths - mBin_path = GetExecutablePath(); - mInstall_path = mBin_path + mFile_separator + ".."; +*/ +#ifdef MACOSX + + std::string macPath("Contents/MacOS"); + int sbp = mBin_path.length(); + int smp = macPath.length(); + if (mBin_path.compare( sbp-smp, smp, macPath )==0 ) + { + mBin_path = mBin_path + "/../../.."; + } + + +#endif + mInstall_path = mBin_path + "/.."; + + + // The relative path to the doc folder (=BBTK_DOC_REL_PATH) - mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH); + // mDoc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH); // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path) - mDoc_path = mInstall_path + mFile_separator + mDoc_rel_path; + // mDoc_path = mInstall_path + "/" + mDoc_rel_path; + // Have to create bbtk user's dirs if needed + + // LG 27/01/09 : doc is now user dependent + // and located in user's .bbtk dir /doc + // All dirs under .bbtk user's dir are set and created by: + InitializeDotBbtkStructure(); + // The relative path to the doc folder (=BBTK_BBS_REL_PATH) mBbs_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_BBS_REL_PATH); // The path to the bbs folder (=mInstall_path+"/"+mBbs_rel_path) - mBbs_path = mInstall_path + mFile_separator + mBbs_rel_path; - // The relative path to the rsc folder (=BBTK_RSC_REL_PATH) - // mRsc_rel_path = BBTK_STRINGIFY_SYMBOL(BBTK_RSC_REL_PATH); - // The path to the rsc folder (=mInstall_path+"/"+mRsc_rel_path) - // mRsc_path = mInstall_path + mFile_separator + mRsc_rel_path; - // The path to the bbtk data folder - // Initialized to mInstall_path+"/"+BBTK_DATA_REL_PATH - // But can be overriden by value read from bbtk_config.xml - mData_path = mInstall_path + mFile_separator + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH); - + mBbs_path = mInstall_path + "/" + mBbs_rel_path; + + mData_path = mInstall_path + "/" + BBTK_STRINGIFY_SYMBOL(BBTK_DATA_REL_PATH); + + Utilities::replace( mBin_path, + INVALID_FILE_SEPARATOR, + VALID_FILE_SEPARATOR); + Utilities::replace( mInstall_path, + INVALID_FILE_SEPARATOR, + VALID_FILE_SEPARATOR); + Utilities::replace( mBbs_path, + INVALID_FILE_SEPARATOR, + VALID_FILE_SEPARATOR); + Utilities::replace( mData_path, + INVALID_FILE_SEPARATOR, + VALID_FILE_SEPARATOR); + bbtkMessage("Config",1," ==> bin : '"< prefix : '"< doc : '"< bbs : '"< rsc : '"< data : '"< First we look for bbtk_config.xml in "." char buf[2048]; @@ -104,7 +185,10 @@ namespace bbtk // LG : throw an exception } - std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml"; + // std::string configXmlFullPathName = currentDir + mFile_separator + "bbtk_config.xml"; + std::string configXmlFullPathName = currentDir ; + configXmlFullPathName += "/bbtk_config.xml"; + Utilities::replace( configXmlFullPathName , INVALID_FILE_SEPARATOR , VALID_FILE_SEPARATOR); if ( Utilities::FileExists( configXmlFullPathName )) { @@ -117,12 +201,7 @@ namespace bbtk // ==> Then we look for bbtk_config.xml in ".bbtk" else { -#if defined(__GNUC__) - std::string str_home(getenv("HOME")); -#elif defined(_WIN32) - std::string str_home(getenv("USERPROFILE")); -#endif - configXmlFullPathName = str_home + mFile_separator + ".bbtk/bbtk_config.xml"; + configXmlFullPathName = Utilities::MakeUserSettingsFullFileName("bbtk_config.xml"); if (!Utilities::FileExists( configXmlFullPathName )) { // ==> Nothing found, we create bbtk_config.xml in ".bbtk" @@ -142,8 +221,75 @@ namespace bbtk } //========================================================================= + //========================================================================= + void ConfigurationFile::InitializeDotBbtkStructure() + { + mDot_bbtk_path = Utilities::GetUserSettingsDir(); + mDot_bbtk_is_new = false; + if (!Utilities::FileExists(mDot_bbtk_path)) mDot_bbtk_is_new = true; + Utilities::CreateDirectoryIfNeeded(mDot_bbtk_path); + + mDoc_path = Utilities::MakeUserSettingsFullFileName("doc"); + Utilities::CreateDirectoryIfNeeded(mDoc_path); + + std::string bbdoc_path = + Utilities::MakeUserSettingsFullFileName("doc/bbdoc"); + Utilities::CreateDirectoryIfNeeded(bbdoc_path); + + // Create help_contents.html if does not exist + std::string filename = Utilities::MakeUserSettingsFullFileName("doc/help_contents.html"); + if (!Utilities::FileExists(filename)) + { + bbtkDebugMessage("Config",1, + "* Creating [" << filename << "]" << std::endl); + // The path to the doc folder (=mInstall_path+"/"+mDoc_rel_path) + std::string doc_path = mInstall_path + "/" + + BBTK_STRINGIFY_SYMBOL(BBTK_DOC_REL_PATH) + "/"; + Utilities::MakeValidFileName(doc_path); + std::ofstream f; + f.open(filename.c_str(), std::ios::out ); + f << "" + << "Help Contents - bbtk " + << GetVersion() << "" + << "

Help Contents

" + << "Demos
" + << "Examples" + << "

Guides

" + << "User's Guide
" + << "Package Developer's Guide
" + << "bbtk library doxygen doc
" + << "

Boxes

" + << "" + << "Alphabetical list
" + << "" + << "List by package
" + << "" + << "List by category
" + << "" + << "List of adaptors
" + << "" + << ""; + } + mTemp_path = Utilities::MakeUserSettingsFullFileName("tmp"); + Utilities::CreateDirectoryIfNeeded(mTemp_path); + + } + //========================================================================= //========================================================================= void ConfigurationFile::CreateConfigXML( char *rootDirectory ) @@ -151,62 +297,19 @@ namespace bbtk FILE *fp; char configXml[250]; sprintf (configXml , "%s/bbtk_config.xml", rootDirectory); - bbtkMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl); + bbtkDebugMessage("Config",1, "in CreateConfigXML[" << configXml << "]" << std::endl); fp = fopen (configXml, "w"); fprintf(fp, "\n"); - // fprintf(fp, "\n"); fprintf(fp, "\n"); - fprintf(fp, " \n"); - // fprintf(fp, " http://www.creatis.insa-lyon.fr/software/bbtk \n"); - // fprintf(fp, " \n"); fprintf(fp, " \n"); - // fprintf(fp, " \n"); fprintf(fp, " \n"); - fprintf(fp, " \n");//, BBTK_DATA_PATH); - /// \todo find a decent default value ! - ///fprintf(fp, " %s \n", " "); - // when $ will be found, default_temp_dir value will be replaced - fprintf(fp, " $\n"); - fprintf(fp, "\n"); - fclose(fp); + fprintf(fp, "\n"); + fclose(fp); } //========================================================================= - - //========================================================================= - std::string ConfigurationFile::GetExecutablePath() - { - /// \todo : Think to delete it! - char *buf = (char *)malloc(512); - char *slash; - -#if defined(WIN32) - GetModuleFileName(NULL, buf, 511); - slash = strrchr(buf, '\\'); - if (slash) - { - *slash = 0; - } -#elif defined(__GNUC__) - int res; - res = readlink("/proc/self/exe", buf, 512); - if (res == -1) - return ""; - buf[res] = 0; - slash = strrchr(buf, '/'); - if (slash) - { - *slash = 0; - } -#else - return ""; -#endif - std::string ret(buf); - free(buf); - return ret; - } - //========================================================================= - + + //========================================================================= void ConfigurationFile::InstallPath () @@ -245,10 +348,6 @@ namespace bbtk char configPath[200]; sprintf(configPath, "%s/bbtk_config.xml",rootDirectory); - // makeDir - char makeDir[250]; - sprintf( makeDir, "mkdir \"%s\" ", rootDirectory); - // configXmlTmp char configXmlTmp[250]; sprintf(configXmlTmp, "%s/bbtk_config.xml.tmp", bbtk_path); @@ -258,23 +357,12 @@ namespace bbtk if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found (not installed) { - if (!Utilities::FileExists(rootDirectory)) // .bbtk not found - { - system(makeDir); // create .bbtk - } - // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk CreateConfigXML( rootDirectory );// create .bbtk } else { sprintf(copyFile,"cp %s %s/bbtk_config.xml ",configXmlTmp,rootDirectory ); - if (!Utilities::FileExists(rootDirectory)) - { - //std::cout << "makeDir[" << makeDir << "]" << std::endl; - system(makeDir); - } - if (!Utilities::FileExists(configPath)) { system(copyFile); @@ -314,11 +402,6 @@ namespace bbtk if (!Utilities::FileExists(configXmlTmp)) // bbtk_config.xml.tmp not found { - if (!Utilities::FileExists(rootDirectory)) // .bbtk not found - { - system(makeDir); // create .bbtk - } - // if "bbtk_path/bbtk_config.xml.tmp" doesn't exist, hard-create a minimum version in .bbtk CreateConfigXML( rootDirectory );// create .bbtk return; @@ -421,6 +504,7 @@ namespace bbtk } // default_temp_dir + /* if( BB.nChildNode((XMLCSTR)"default_temp_dir") ) GetTextOrClear(BB.getChildNode((XMLCSTR)"default_temp_dir"),mDefault_temp_dir); @@ -429,8 +513,125 @@ namespace bbtk size_t pos = mConfig_xml_full_path.find("bbtk_config.xml"); mDefault_temp_dir = mConfig_xml_full_path.substr (0,pos); } + */ + + GetHelp(2); + } + //========================================================================= + + //========================================================================= + bool ConfigurationFile::AddPackagePathsAndWrite( const std::string& path ) + { + bbtkDebugMessageInc("Config",9, + "ConfigurationFile::AddPackagePathsAndWrite(" + <error != eXMLErrorNone ) + { + std::string mess = GetErrorMessage(res,Get_config_xml_full_path()); + delete res; + bbtkDebugMessage("Config",1,mess<< std::endl); + bbtkError(mess); + } + delete res; + +#ifdef _WIN32 + std::string bbs_path = path + "/bbs"; +#else + std::string bbs_path = path + "/share/bbtk/bbs" ; +#endif + XMLNode BBSPATH = BB.addChild((XMLCSTR)"bbs_path"); + BBSPATH.addText((XMLCSTR)bbs_path.c_str()); + Utilities::replace(bbs_path, INVALID_FILE_SEPARATOR, VALID_FILE_SEPARATOR); + mBbs_paths.push_back(bbs_path); + +#ifdef _WIN32 + std::string pack_path = path + "/bin"; +#else + std::string pack_path = path ; +#endif + XMLNode PACKPATH = BB.addChild((XMLCSTR)"package_path"); + PACKPATH.addText((XMLCSTR)pack_path.c_str()); + Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); + mPackage_paths.push_back(pack_path); + +#ifdef _WIN32 + pack_path = path + "/RelWithDebInfo"; + PACKPATH = BB.addChild((XMLCSTR)"package_path"); + PACKPATH.addText((XMLCSTR)pack_path.c_str()); + Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); + mPackage_paths.push_back(pack_path); + pack_path = path + "/Debug"; + PACKPATH = BB.addChild((XMLCSTR)"package_path"); + PACKPATH.addText((XMLCSTR)pack_path.c_str()); + Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); + mPackage_paths.push_back(pack_path); + pack_path = path + "/Release"; + PACKPATH = BB.addChild((XMLCSTR)"package_path"); + PACKPATH.addText((XMLCSTR)pack_path.c_str()); + Utilities::replace(pack_path,INVALID_FILE_SEPARATOR,VALID_FILE_SEPARATOR); + mPackage_paths.push_back(pack_path); +#endif + + + XMLError err = BB.writeToFile((XMLCSTR)Get_config_xml_full_path().c_str()); + if ( err != eXMLErrorNone ) + { + std::string mess = GetErrorMessage(res,Get_config_xml_full_path()); + bbtkDebugMessage("Config",1,mess<< std::endl); + bbtkError(mess); + } + + return true; + } + //========================================================================= + + //========================================================================= + void ConfigurationFile::GetHelp(int level) const + { + bbtkDebugMessageInc("Config",9,"ConfigurationFile::GetHelp("<bbs_paths = Get_bbs_paths(); + const std::vectorpackage_paths = Get_package_paths(); + + bbtkMessage("Help",level, "=============" << std::endl); + bbtkMessage("Help",level, "Configuration" << std::endl); + bbtkMessage("Help",level, "=============" << std::endl); + bbtkMessage("Help",level, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl); + bbtkMessage("Help",level, "Documentation Path : [" << url << "]" << std::endl); + bbtkMessage("Help",level, "Data Path : [" << data_path << "]" << std::endl); + bbtkMessage("Help",level, "Temp Directory : [" << default_temp_dir << "]" << std::endl); + bbtkMessage("Help",level, "File Separator : [" << file_separator << "]" << std::endl); + + std::vector::const_iterator i; + + bbtkMessage("Help",level, "BBS Paths " << std::endl); + for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i ) + { + bbtkMessage("Help",level,"--- ["<<*i<<"]"<