]> Creatis software - bbtk.git/blobdiff - kernel/src/bbtkUtilities.h
Move some general usage methods to Utilities, to avoid dupplicate code :
[bbtk.git] / kernel / src / bbtkUtilities.h
index b83193fd91e4aee1d9ec002fea8d31317cb5f13e..d9c3193a0a07eac9f7c8cdcefb62fed751a76e84 100644 (file)
@@ -3,8 +3,8 @@
   Program:   bbtk
   Module:    $RCSfile: bbtkUtilities.h,v $
   Language:  C++
-  Date:      $Date: 2008/01/22 15:02:00 $
-  Version:   $Revision: 1.1 $
+  Date:      $Date: 2008/01/22 16:55:04 $
+  Version:   $Revision: 1.2 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See doc/license.txt or
 #ifndef __bbtkUtilities_h_INCLUDED__
 #define __bbtkUtilities_h_INCLUDED__
 
+#include "bbtkConfigurationFile.h"
 #include "bbtkSystem.h"
 #include <string>
+#include <sys/stat.h>
+#ifdef CMAKE_HAVE_TERMIOS_H
+#include <termios.h>
+#define BBTK_USE_TERMIOS_BASED_PROMPT
+#endif
 
 namespace bbtk
 {
   /// Holds various usefull methods 
   struct BBTK_EXPORT Utilities
-  {    
+  {
+   // See : http://www.techbytes.ca/techbyte103.html for more O.S.
+   static inline bool FileExists(std::string strFilename) 
+   {
+     struct stat stFileInfo;
+     bool blnReturn;
+     int intStat;
+
+     // Attempt to get the file attributes
+     intStat = stat(strFilename.c_str(),&stFileInfo);
+     if(intStat == 0) {
+       // We were able to get the file attributes
+       // so the file obviously exists.
+       blnReturn = true;
+     } else {
+       // We were not able to get the file attributes.
+       // This may mean that we don't have permission to
+       // access the folder which contains this file. If you
+       // need to do that level of checking, lookup the
+       // return values of stat which will give you
+       // more details on why stat failed.
+       blnReturn = false;
+     }
+
+     return(blnReturn);
+   }
+
+
+// ===================================================================================
+
+  static std::string ExtractPackageName(const std::string  &name, 
+                                         std::string& path)
+  {
+    std::string pkgname;
+    path = "";
+
+    std::string::size_type slash_position = name.find_last_of("/\\");
+    if (slash_position != std::string::npos) 
+      {
+       pkgname = name.substr(slash_position+1,std::string::npos);   
+       path = name.substr(0,slash_position); 
+       //      std::cout << "F:P='"<<path<<"'"<<std::endl;//+1,std::string::npos); 
+      } 
+    else 
+      {
+       pkgname = name;  
+      }      
+          
+    // remove {.so | dll} if any
+    std::string::size_type dot_position = pkgname.find_last_of('.');      
+    if (dot_position != std::string::npos){
+      pkgname = pkgname.substr(0,dot_position);
+    }      
+#if defined(__GNUC__)
+    
+    // GCC mechanism
+    // shared lib name = libbb<name>.so
+
+      // remove {libbb} if any
+    if (memcmp ( pkgname.c_str(), "libbb", 5) == 0) {
+      pkgname =  pkgname.substr(5, pkgname.length());
+    }
+      /*
+      /// \ \todo     what would happen if (stupid) user names his package 'libbb' ?!?
+      /// \ --> Should be forbidden!
+      */
+#elif defined(_WIN32)
+
+       // WIN 32 mechanism
+       // shared lib name = <name>.dll
+
+     // remove {bb} if any
+    if (memcmp (pkgname.c_str(), "bb", 2) == 0) {
+       pkgname =  pkgname.substr(2, pkgname.length());  
+    } 
+         
+     /*
+     /// \ \todo     what would happen if (stupid) user names his package 'bb' ?!?
+     /// \ --> Should be forbidden!
+     */
+#else
+    bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
+#endif      
+    return pkgname;
+  }
+
+// ===================================================================================
+
+  static std::string ExtractScriptName(const std::string  &name)
+  {
+    std::string pkgname;
+
+    std::string::size_type slash_position = name.find_last_of("/\\");
+    if (slash_position != std::string::npos) {
+      pkgname =name.substr(slash_position+1,std::string::npos);
+    } else {
+      pkgname = name;
+    }
+    // remove {.bbs } if any
+    std::string::size_type dot_position = pkgname.find_last_of('.');
+    if (dot_position != std::string::npos){
+      pkgname = pkgname.substr(0,dot_position);
+    }
+    return pkgname;
+  }
+
+// ===================================================================================
+
+  static std::string ExpandLibName(const std::string &name, bool verbose)
+  {
+     // -----   Think of expanding path name ( ./ ../ ../../ )
+
+    char buf[2048]; // for getcwd
+    char * currentDir = getcwd(buf, 2048);
+    std::string cwd(currentDir);
+    std::string libname(name);
+
+    // tooHigh : true is user supplies a library pathname with too many "../"
+    bool tooHigh = false;
+
+    if ( name[0] == '/' ||  name[0] == '\\' )
+    {
+      return(libname);
+    } 
+    else if  (name[0] == '.' && (name[1] == '/' || name[1] == '\\') ) 
+    {
+      libname = cwd  + ConfigurationFile::GetInstance().Get_file_separator () + name.substr(2, name.length());
+      return(libname);
+    } 
+    else if ( name[0] == '.' &&  name[1] == '.' && (name[2] == '/' || name[2] == '\\') ) 
+    {
+      if ( IsAtRoot(cwd) )  // hope it gets / (for Linux),  C: D: (for Windows)
+      {  
+     // if we are already at / or c: --> hopeless  
+         if (verbose)
+           std::cout << "   File path [" <<  name << "] doesn't exist" << std::endl;
+         tooHigh = true;
+      }
+      else
+      {
+         // iterate on ../ and go up from the current working dir!
+         std::string a(name); 
+         bool alreadyProcessRoot = false;
+         for(;;)
+         {
+            std::string::size_type slash_position = cwd.find_last_of(ConfigurationFile::GetInstance().Get_file_separator ());
+            if (slash_position != std::string::npos) {
+             if (slash_position == 0)
+                slash_position = 1;
+              cwd = cwd.substr(0,slash_position/*+1*/);
+                 a = a.substr(3, name.length());  // remove ../
+              if (a == "" || alreadyProcessRoot)
+              {
+                if (verbose)
+                  std::cout << "   File path [" <<  name << "] doesn't exist" << std::endl;
+                tooHigh = true;
+                break;
+              }
+             // std::string b = cwd + a;
+              libname =  cwd;
+              char c = cwd[cwd.size()-1];
+              if (c != '/' && c != '\\' )
+                libname += ConfigurationFile::GetInstance().Get_file_separator ();
+              libname += a;
+
+              if ( a[0] != '.' ) // if . (probabely ../), loop again
+                break;
+
+              if (IsAtRoot(cwd))
+                alreadyProcessRoot = true;
+            }
+         } // end iterating on ../
+      }
+      if (tooHigh)
+         libname="";
+      return (libname);
+
+    }  // -----   End of expanding path name   ( ./ ../ ../../ )
+
+    // To avoid warning
+    return(""); // Will never get here!
+  }
+
+// ===================================================================================
+
+  static std::string MakeLibnameFromPath(std::string path, std::string pkgname)
+  {
+    std::string libname = path;
+    char c = path[path.size()-1];    
+#if defined(__GNUC__)
+       if (c != '/')
+          libname += "/libbb";
+       libname += pkgname;
+       libname += ".so";
+         
+#elif defined(_WIN32)
+       if (c != '\\')
+          libname = path+"\\bb";
+       libname += pkgname;
+       libname += ".dll";
+#endif
+    return libname;    
+  }
+
+// ===================================================================================
+
+  static inline std::string MakePkgnameFromPath(std::string path, std::string pkgname)
+  {
+    std::string libname = path;
+         char c = path[path.size()-1];
+         if (c != '/' && c != '\\')
+            libname +=  ConfigurationFile::GetInstance().Get_file_separator ();
+         libname += pkgname;
+         libname += ".bbs";
+    return libname;
+  }
+
+// ===================================================================================
+
+ static inline  bool IsAtRoot(std::string cwd)
+  {
+    if ( cwd == "/"                             // hope it gets /     (for Linux)
+        || (cwd.size() <= 3 && cwd[1] == ':') ) // hope it gets C: D: (for Windows)
+      return (true);
+    else
+      return(false);
+}
+
+// ===================================================================================
+
+    static inline void SplitAroundFirstDot( const std::string& in,
+                                            std::string& left,
+                                            std::string& right)
+   {
+      std::string delimiter = ".";
+      std::string::size_type pos = in.find_first_of(delimiter);
+      if (std::string::npos != pos) 
+      {
+        left = in.substr(0,pos);
+        right = in.substr(pos+1,in.size());
+
+      }
+      /*
+      else
+      {
+        bbtkError(in<<" : expected 'a.b' format but no dot found");
+      }
+      */
+      left ="";
+      right = "";
+    }
+
     static inline std::string get_file_name(const std::string& s) 
     { 
       std::string::size_type slash_position = s.find_last_of("/\\");
@@ -48,7 +305,7 @@ namespace bbtk
       else 
       {
         return s;
-      }      
+      }
     }