bbtk::Utilities Class Reference

Holds various usefull methods. More...

#include <bbtkUtilities.h>

List of all members.

Static Public Member Functions
static std::string	GetExecutablePath ()
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)
static void	MakeValidFileName (std::string &name)
static std::string	GetUserSettingsDir ()
	Returns the 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 &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)
static int	Explore (std::string const &dirpath, bool recursive, std::vector< std::string > &Filenames)
	Explore a directory with possibility of recursion return number of files read.
static void	SubsBackslashN (std::string &s)
static void	replace (std::string &str, const std::string &what, const std::string &with)
static void	html_format (std::string &str)
static bool	loosematch (std::string stdLine, std::string stdOptions)

---

Detailed Description

Holds various usefull methods.

various usefull methods

Definition at line 73 of file bbtkUtilities.h.

---

Member Function Documentation

void bbtk::Utilities::CreateDirectoryIfNeeded

(

std::string const &

dirName

)

[static]

Definition at line 357 of file bbtkUtilities.cxx.

References FileExists().

Referenced by bbtk::ConfigurationFile::InitializeDotBbtkStructure().

  {
    if (FileExists(dirName)) return;
    std::string cmd("mkdir \"");
    cmd += dirName;
    cmd += "\"";
    system(cmd.c_str());
  }  

Here is the call graph for this function:

Here is the caller graph for this function:

std::string bbtk::Utilities::ExpandLibName	(	const std::string &	name,
		bool	verbose
	)			[static]

Definition at line 166 of file bbtkUtilities.cxx.

References bbtk::ConfigurationFile::Get_file_separator(), bbtk::ConfigurationFile::GetInstance(), and IsAtRoot().

Referenced by bbtk::Factory::LoadPackage(), and bbtk::InterpreterVirtual::SwitchToFile().

    {
      // -----   Think of expanding path name ( ./ ../ ../../ )
      
      char buf[2048]; // for getcwd
      char * currentDir = getcwd(buf, 2048);
      std::string cwd(currentDir);
      std::string libname(name);
      std::string fileSeparator;
      fileSeparator = ConfigurationFile::GetInstance().Get_file_separator();
      // tooHigh : true is user supplies a library pathname with too many "../"
      bool tooHigh = false;
      
      //std::cout << "------------------cwd ["  << cwd << "] name [" << name << "]" << std::endl;
      
      if ( name[0] == '/' ||  name[1] == ':' ) // Linux or Windows absolute name
        {
          return(libname);
        }
      else if  ( name =="." )
        {
          libname = cwd  + fileSeparator;
          return(libname);
        }
      else if  (name[0] == '.' && (name[1] == '/' || name[1] == '\\') )
        {
          libname = cwd  + fileSeparator + 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;

          //if (a[a.size()-1] != fileSeparator[0])
          //   a.append(fileSeparator);
//std::cout << "------------------a ["  << a << "]" << std::endl;

         for(;;)  // wild loop !
         {
            std::string::size_type slash_position = cwd.find_last_of(fileSeparator);
            if (slash_position != std::string::npos) {
             if (slash_position == 0)
                slash_position = 1;
              cwd = cwd.substr(0,slash_position/*+1*/);
//std::cout << "------------------cwd ["  << cwd << "]" << std::endl;
            //  if (a == "..") {
            //    a = "";
            //    break;
            //   }
            //   else
                 a = a.substr(3, /*name.length()*/ a.length());  // remove ../
//std::cout << "------------------a ["  << a << "]" << std::endl;  
              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 += fileSeparator;
              libname += a;

              if ( a[0] != '.' ) // if . (probabely ../), loop again
                break;

              if (IsAtRoot(cwd))
                alreadyProcessRoot = true;
            }
         } // end iterating on ../
      }
//std::cout << "------------------out of loop]" << std::endl;        
      if (tooHigh)
         libname="";
      return (libname);

    }  // -----   End of expanding path name   ( ./ ../ ../../ )

    std::cout <<"* ERROR in ExpandLibName : should never get here!" << std::endl;
    // To avoid warning
    return(""); // Will never get here!
  }

Here is the call graph for this function:

Here is the caller graph for this function:

int bbtk::Utilities::Explore	(	std::string const &	dirpath,
		bool	recursive,
		std::vector< std::string > &	Filenames
	)			[static]

Explore a directory with possibility of recursion return number of files read.

Parameters:

	dirpath	directory to explore
	recursive	whether we want recursion or not

Definition at line 468 of file bbtkUtilities.cxx.

Referenced by bbtk::InterpreterVirtual::SwitchToFile().

  {
    int numberOfFiles = 0;
    std::string fileName;
      
      std::string dirName = dirpath;
      
#ifdef _MSC_VER
      WIN32_FIND_DATA fileData;
   HANDLE hFile = FindFirstFile((dirName+"\\*").c_str(), &fileData);

   for(BOOL b = (hFile != INVALID_HANDLE_VALUE); b;
       b = FindNextFile(hFile, &fileData))
   {
      fileName = fileData.cFileName;
      if ( fileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY )
      {
         // Need to check for . and .. to avoid infinite loop
         if ( fileName != "." && fileName != ".." && recursive )
         {
            numberOfFiles += Explore(dirName+ "\\"+fileName,recursive,Filenames);
         }
      }
      else
      {
         Filenames.push_back(dirName+"\\"+fileName);
         numberOfFiles++;
      }
   }
   DWORD dwError = GetLastError();
   if (hFile != INVALID_HANDLE_VALUE) 
      FindClose(hFile);
   if (dwError != ERROR_NO_MORE_FILES) 
   {
      LPVOID lpMsgBuf;
      FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
                    FORMAT_MESSAGE_FROM_SYSTEM|
                    FORMAT_MESSAGE_IGNORE_INSERTS,
                    NULL,GetLastError(),
                    MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
                    (LPTSTR) &lpMsgBuf,0,NULL);

     // ErrorMacro("FindNextFile error. Error is " << (char *)lpMsgBuf
     //             <<" for the directory : "<<dirName);
      
      return 0;
   }

#else
  // Real POSIX implementation: scandir is a BSD extension only, and doesn't 
  // work on debian for example
//std::cout <<"in Explor dirname[" << dirName << "]" << std::endl; 
   DIR* dir = opendir(dirName.c_str());
   if (!dir)
   {
      return 0;
   }
//std::cout <<"Open OK" << std::endl; 
   // According to POSIX, the dirent structure contains a field char d_name[]
   // of unspecified size, with at most NAME_MAX characters preceeding the
   // terminating null character. Use of other fields will harm the  porta-
   // bility of your programs.

   struct stat buf;
   dirent *d;
   for (d = readdir(dir); d; d = readdir(dir))
   {
      fileName = dirName + "/" + d->d_name;
//std::cout <<"in Explor filename[" << fileName << "]" << std::endl;      
      if( stat(fileName.c_str(), &buf) != 0 )
      {
         //ErrorMacro( strerror(errno) );
      }
      if ( S_ISREG(buf.st_mode) )    //is it a regular file?
      {
         Filenames.push_back( fileName );
         numberOfFiles++;
      }
      else if ( S_ISDIR(buf.st_mode) ) //directory?
      {
         if ( d->d_name[0] != '.' && recursive ) //we also skip hidden files
         {
            numberOfFiles += Explore( fileName, recursive, Filenames);
         }
      }
      else
      {
         //ErrorMacro( "Unexpected error" );
         return -1;
      }
   }
   if( closedir(dir) != 0 )
   {
     // ErrorMacro( strerror(errno) );
   }
#endif

  return numberOfFiles;

}

Here is the caller graph for this function:

std::string bbtk::Utilities::ExtractPackageName	(	const std::string &	name,
		std::string &	path
	)			[static]

Definition at line 86 of file bbtkUtilities.cxx.

References bbtkError.

Referenced by bbtk::Factory::LoadPackage().

    {
      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());
      }
      /*
      */
#elif defined(_WIN32)
      
      // WIN 32 mechanism
      // shared lib name = <name>.dll
      
      // EED Problem loading package call bbtkTools
      //     // remove {bb} if any
      if (memcmp (pkgname.c_str(), "bb", 2) == 0) {
        pkgname =  pkgname.substr(2, pkgname.length());  
      }
      
      /*
     */
#else
      bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
#endif      
      return pkgname;
    }

Here is the caller graph for this function:

std::string bbtk::Utilities::ExtractScriptName	(	const std::string &	name,
		std::string &	path
	)			[static]

Definition at line 144 of file bbtkUtilities.cxx.

Referenced by main(), bbtk::InterpreterVirtual::SwitchToFile(), and bbtk::Transcriptor::Transcriptor().

    {
      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);
        path = name.substr(0,slash_position);      
      } 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;
    }

Here is the caller graph for this function:

bool bbtk::Utilities::FileExists

(

std::string

strFilename

)

[static]

Definition at line 55 of file bbtkUtilities.cxx.

Referenced by bbtk::Interpreter::commandHelp(), bbtk::ConfigurationFile::ConfigurationFile(), CreateDirectoryIfNeeded(), bbtk::ConfigurationFile::InitializeDotBbtkStructure(), bbtk::ConfigurationFile::InstallPath(), bbtk::Factory::LoadPackage(), bbtk::WxGUIScriptingInterface::LoadPerspective(), bbtk::WxGUIScriptingInterface::OnMenuPlugPackage(), bbtk::Executer::ShowGraph(), and bbtk::InterpreterVirtual::SwitchToFile().

    {
      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);
    }

Here is the caller graph for this function:

std::string bbtk::Utilities::get_file_name

(

const std::string &

s

)

[static]

Definition at line 446 of file bbtkUtilities.cxx.

Referenced by bbtk::WxGUITextEditor::NewPage().

  { 
    std::string::size_type slash_position = s.find_last_of("/\\");
    if (slash_position != std::string::npos) 
      {
        return  s.substr(slash_position+1,std::string::npos);   
      }
    else 
      {
        return s;
      }
  }

Here is the caller graph for this function:

std::string bbtk::Utilities::GetExecutablePath

(

)

[static]

Definition at line 743 of file bbtkUtilities.cxx.

References bbtkGlobalError, bbtk::get_app_path(), PATH_MAX, and VALID_FILE_SEPARATOR_CHAR.

Referenced by bbtk::ConfigurationFile::ConfigurationFile(), and bbtk::ConfigurationFile::InstallPath().

  {
    char name[PATH_MAX];
    int err = get_app_path(name, PATH_MAX);
    if (err) 
      {
        bbtkGlobalError("Could not determine current executable path ?");  
      }
    
    // remove the exe name
    char *slash;                
    slash = strrchr(name, VALID_FILE_SEPARATOR_CHAR);
    if (slash)
      {
        *slash = 0;
      }
    return name;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string bbtk::Utilities::GetUserSettingsDir

(

)

[static]

Returns the user settings dir, e.g. /home/username/.bbtk.

Definition at line 326 of file bbtkUtilities.cxx.

References MakeValidFileName().

Referenced by bbtk::ConfigurationFile::InitializeDotBbtkStructure().

  {
#if defined(__GNUC__)
    std::string str_home(getenv("HOME"));
#elif defined(_WIN32)
    std::string str_home(getenv("USERPROFILE"));
#endif
    std::string fullname = str_home + "/.bbtk";
    MakeValidFileName(fullname);
    return fullname;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

static void bbtk::Utilities::html_format

(

std::string &

str

)

[inline, static]

Definition at line 178 of file bbtkUtilities.h.

Referenced by bbtk::Factory::CreateHtmlIndex(), bbtk::Package::CreateHtmlPage(), bbtk::ComplexBlackBoxDescriptor::InsertHtmlHelp(), and bbtk::BlackBoxDescriptor::InsertHtmlHelp().

    {
      replace( str, "&", "&" );
      replace( str, "<", "&lt;" );
      replace( str, ">", "&gt;" );
    }

Here is the caller graph for this function:

bool bbtk::Utilities::IsAtRoot

(

std::string

cwd

)

[static]

Definition at line 369 of file bbtkUtilities.cxx.

Referenced by ExpandLibName().

  {
    if ( cwd == "/"              // hope it gets /     (for Linux)
         || (cwd.size() <= 3 && cwd[1] == ':') ) // hope it gets C: D: (for Windows)
      return (true);
    else
      return(false);
  }

Here is the caller graph for this function:

bool bbtk::Utilities::IsDirectory

(

std::string const &

dirName

)

[static]

Definition at line 380 of file bbtkUtilities.cxx.

Referenced by bbtk::InterpreterVirtual::SwitchToFile().

  {
    struct stat fs;
    
    if ( stat(dirName.c_str(), &fs) == 0 )
      {
#if _WIN32
        return ((fs.st_mode & _S_IFDIR) != 0);
#else
        return S_ISDIR(fs.st_mode);
#endif
      }
    else
      {
        return false;
      }
  }

Here is the caller graph for this function:

bool bbtk::Utilities::loosematch	(	std::string	stdLine,
		std::string	stdOptions
	)			[static]

Definition at line 590 of file bbtkUtilities.cxx.

References bbtk::i, and SplitString().

  {
    bool result=false;
    std::vector<std::string> tokens;
    SplitString ( stdOptions,"|", tokens);
    int i,size=tokens.size();  
    for (i=0; i<size; i++)
      {           
#ifdef WIN32
        if ( strcmpi(stdLine.c_str(),tokens[i].c_str())==0) 
          { 
            result=true; 
          }               
#else
        if ( strcasecmp(stdLine.c_str(),tokens[i].c_str())==0) 
          { 
            result=true; 
          }               
#endif
        
      }
    return result;
  }

Here is the call graph for this function:

std::string bbtk::Utilities::MakeLibnameFromPath	(	std::string	path,
		std::string	pkgname
	)			[static]

Definition at line 265 of file bbtkUtilities.cxx.

Referenced by bbtk::Factory::LoadPackage().

  {
    std::string libname = path;
        if(path.size()>0){
                char c = path[path.size()-1];    
#if defined(__GNUC__)
       if (c != '/')
          libname += "/libbb";
       else
          libname += "libbb";
       libname += pkgname;
#if defined(MACOSX)
          libname += ".dylib";
#else
          libname += ".so";
#endif  
          
#elif defined(_WIN32)
       if (c != '\\') 
          libname += "\\bb";
       else
          libname += "bb";
       libname += pkgname;
       libname += ".dll";
#endif
        }
    
    return libname;    
  }

Here is the caller graph for this function:

std::string bbtk::Utilities::MakePkgnameFromPath	(	std::string	path,
		std::string	pkgname,
		bool	addExt
	)			[static]

Definition at line 297 of file bbtkUtilities.cxx.

References bbtk::ConfigurationFile::Get_file_separator(), and bbtk::ConfigurationFile::GetInstance().

Referenced by bbtk::InterpreterVirtual::SwitchToFile().

  {
    std::string libname = path;
        if(path.size()>0){
                char c = path[path.size()-1];
                if (c != '/' && c != '\\')
                {
                   libname +=  ConfigurationFile::GetInstance().Get_file_separator ();
                }
                libname += pkgname;
                if (addExt)
                {
                   int l = libname.size();
                   if (l>4)
                   {
                          if (libname.substr(l-4, 4) != ".bbs")
                          {
                                   libname = libname + ".bbs";
                          }
                   }
                }
        }
    
    return libname;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

std::string bbtk::Utilities::MakeUserSettingsFullFileName

(

const std::string &

name

)

[static]

Builds the complete path to the file 'name' located in user settings dir, e.g. /home/username/.bbtk/

Builds the complete path to the file 'name' located in user settings dir, e.g. /home/username/.bbtk/

Definition at line 342 of file bbtkUtilities.cxx.

References MakeValidFileName().

Referenced by bbtk::ConfigurationFile::ConfigurationFile(), bbtk::ConfigurationFile::InitializeDotBbtkStructure(), bbtk::WxGUIScriptingInterface::LoadPerspective(), and bbtk::WxGUIScriptingInterface::SavePerspective().

  {
#if defined(__GNUC__)
    std::string str_home(getenv("HOME"));
#elif defined(_WIN32)
    std::string str_home(getenv("USERPROFILE"));
#endif
    std::string fullname = str_home + "/.bbtk/" + name;
    MakeValidFileName(fullname);
    return fullname;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

static void bbtk::Utilities::MakeValidFileName

(

std::string &

name

)

[inline, static]

Makes a valid filename with string (replaces invalid file seps by valid ones)

Definition at line 105 of file bbtkUtilities.h.

References INVALID_FILE_SEPARATOR, and VALID_FILE_SEPARATOR.

Referenced by GetUserSettingsDir(), bbtk::ConfigurationFile::InitializeDotBbtkStructure(), and MakeUserSettingsFullFileName().

    {
      replace( name, 
               INVALID_FILE_SEPARATOR , 
               VALID_FILE_SEPARATOR);
    }

Here is the caller graph for this function:

static void bbtk::Utilities::replace	(	std::string &	str,
		const std::string &	what,
		const std::string &	with
	)			[inline, static]

Definition at line 165 of file bbtkUtilities.h.

Referenced by bbtk::ConfigurationFile::AddPackagePathsAndWrite(), bbtk::ConfigurationFile::ConfigurationFile(), and bbtk::InterpreterVirtual::LoadScript().

    {
      std::string::size_type pos = str.find( what );
          while ( pos != std::string::npos )
      {
        str.replace( pos, what.size(), with );
        pos = str.find( what, pos+what.size()-1 );
      } 
    }

Here is the caller graph for this function:

void bbtk::Utilities::SplitAroundFirstDot	(	const std::string &	in,
		std::string &	left,
		std::string &	right
	)			[static]

Definition at line 400 of file bbtkUtilities.cxx.

References bbtkGlobalError.

Referenced by bbtk::InterpreterVirtual::DoInterpretLine(), and bbtk::Executer::Print().

  {
    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
      {
        left ="";
        right = "";
        bbtkGlobalError("Token '"<<in<<"' : expected 'a.b' format but no dot found");
      }
  }

Here is the caller graph for this function:

void bbtk::Utilities::SplitString	(	const std::string &	str,
		const std::string &	delimiters,
		std::vector< std::string > &	tokens
	)			[static]

Definition at line 422 of file bbtkUtilities.cxx.

Referenced by bbtk::Factory::CreateHtmlIndex(), bbtk::ComplexBlackBoxDescriptor::InsertHtmlHelp(), bbtk::BlackBoxDescriptor::InsertHtmlHelp(), loosematch(), and bbtk::InterpreterVirtual::SplitLine().

  {
    // Skip delimiters at beginning.
    std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
    // Find first delimiter.
    std::string::size_type pos     = str.find_first_of(delimiters, lastPos);
    
    while (std::string::npos != pos || std::string::npos != lastPos)
      {
        // Found a token, add it to the vector.
        tokens.push_back(str.substr(lastPos, pos - lastPos));
        // Skip delimiters.  Note the "not_of"
        lastPos = str.find_first_not_of(delimiters, pos);
        // Find next delimiter
        pos = str.find_first_of(delimiters, lastPos);
      }
    
  }

Here is the caller graph for this function:

void bbtk::Utilities::SubsBackslashN

(

std::string &

s

)

[static]

Definition at line 573 of file bbtkUtilities.cxx.

Referenced by bbtk::Executer::Print().

    {
      std::string ss("\\n");
      std::string::size_type pos = 0;
      pos = s.find(ss,0);
      const char* cr = "\n";
      while ( pos != std::string::npos )
        {
          s.replace(pos,2,cr,1);
          pos = s.find(ss, pos-1);
        }
    }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkUtilities.h
• /Users/davila/Creatis/All5/creatools_source/bbtk/kernel/src/bbtkUtilities.cxx