]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkUtilities.h
*** empty log message ***
[bbtk.git] / kernel / src / bbtkUtilities.h
index 910f4da4c1180ad72659d5043a8632ce1cfc7efe..6d0c2cfe467a12ec6cc05f76f182e0bbb62b5fa4 100644 (file)
@@ -1,21 +1,34 @@
-/*=========================================================================
-                                                                                
+/*=========================================================================                                                                               
   Program:   bbtk
   Module:    $RCSfile: bbtkUtilities.h,v $
   Language:  C++
-  Date:      $Date: 2008/05/06 13:45:12 $
-  Version:   $Revision: 1.15 $
-                                                                                
-  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/01/27 14:22:57 $
+  Version:   $Revision: 1.19 $
 =========================================================================*/
 
+/* ---------------------------------------------------------------------
+
+* 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 
 #include <cctype>    // std::toupper
 //#include "bbtkMessageManager.h"
 
+#if defined(__GNUC__) // gcc 4.3
+#include <stdlib.h>
+#endif
+
 namespace bbtk
 {
   /// Holds various usefull methods 
   struct BBTK_EXPORT Utilities
   {
-    
+    //  ======================================================================
+    static std::string GetExecutablePath();
+
     // ======================================================================
     // See : http://www.techbytes.ca/techbyte103.html for more O.S.
     static bool FileExists(std::string strFilename);
     
     // =====================================================================
-    
     static std::string ExtractPackageName(const std::string  &name, 
                                          std::string& path);
-
+    
     //=====================================================================
     static std::string ExtractScriptName(const std::string &name,
                                         std::string& path);
-  
+    
     // ========================================================================
-
     static std::string ExpandLibName(const std::string &name, bool verbose);
-   
-// ===================================================================================
+    
+    // =======================================================================
+    static std::string MakeLibnameFromPath(std::string path, std::string pkgname);
+    
+    // =====================================================================
+    static std::string MakePkgnameFromPath(std::string path, 
+                                          std::string pkgname, bool addExt);
+    //========================================================================
+    
+    
+    // =======================================================================
+    /// Makes a valid filename with string (replaces invalid file seps 
+    /// by valid ones)
+    static inline void MakeValidFileName(std::string& name)
+    {
+      replace( name, 
+              INVALID_FILE_SEPARATOR , 
+              VALID_FILE_SEPARATOR);
+    }
 
-  static std::string MakeLibnameFromPath(std::string path, std::string pkgname);
-// ===================================================================================
+    // =======================================================================
+    /// Returns the user settings dir, e.g. /home/username/.bbtk
+    static std::string GetUserSettingsDir();
 
-  static std::string MakePkgnameFromPath(std::string path, std::string pkgname, bool addExt);
-    //========================================================================
+    // =======================================================================
+    /// Builds the complete path to the file 'name' located 
+    /// in user settings dir, e.g. /home/username/.bbtk/
+    static std::string MakeUserSettingsFullFileName(const std::string& name);
+    
     
     static bool IsAtRoot(std::string cwd);
     // ======================================================================
     
     static bool IsDirectory(std::string const &dirName);
-    // ===================================================================================
+
+    static void CreateDirectoryIfNeeded( std::string const &dirName);
+    // =======================================================================
     
     static void SplitAroundFirstDot( const std::string& in,
-                                            std::string& left,
+                                    std::string& left,
                                             std::string& right);
-    //=======================================================================
+    //======================================================================
     static void SplitString ( const std::string& str, 
                                     const std::string& delimiters, 
                                     std::vector<std::string>& tokens);
-    //=======================================================================
+    //====================================================================
     
     
-    // ===================================================================================
+    // ====================================================================
     
     static std::string get_file_name(const std::string& s) ;
-   
     
-    // ===================================================================================
+    
+    // ====================================================================
     /**
      * \brief   Explore a directory with possibility of recursion
      *          return number of files read
@@ -111,8 +150,8 @@ namespace bbtk
      * @param  recursive whether we want recursion or not
      */
     static int Explore(std::string const &dirpath, bool recursive, std::vector<std::string> &Filenames);
-
-
+    
+    
     //=======================================================================
     // Replaces substrings "\\n" by a real carriage return "\n"
     static void SubsBackslashN ( std::string& s );