1 /*=========================================================================
3 Module: $RCSfile: bbtkUtilities.cxx,v $
5 Date: $Date: 2009/01/29 08:45:29 $
6 Version: $Revision: 1.13 $
7 =========================================================================*/
9 /* ---------------------------------------------------------------------
11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
14 * This software is governed by the CeCILL-B license under French law and
15 * abiding by the rules of distribution of free software. You can use,
16 * modify and/ or redistribute the software under the terms of the CeCILL-B
17 * license as circulated by CEA, CNRS and INRIA at the following URL
18 * http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
19 * or in the file LICENSE.txt.
21 * As a counterpart to the access to the source code and rights to copy,
22 * modify and redistribute granted by the license, users are provided only
23 * with a limited warranty and the software's author, the holder of the
24 * economic rights, and the successive licensors have only limited
27 * The fact that you are presently reading this means that you have had
28 * knowledge of the CeCILL-B license and that you accept its terms.
29 * ------------------------------------------------------------------------ */
32 #include "bbtkUtilities.h"
33 #include "bbtkMessageManager.h"
35 #if defined(MACOSX) // assume this is OSX
36 # include <sys/param.h>
37 # include <mach-o/dyld.h> // _NSGetExecutablePath : must add -framework CoreFoundation to link line
40 # define PATH_MAX MAXPATHLEN
44 #ifndef PATH_MAX // If not defined yet : do it
45 # define PATH_MAX 2048
53 // ======================================================================
54 // See : http://www.techbytes.ca/techbyte103.html for more O.S.
55 bool Utilities::FileExists(std::string strFilename)
57 struct stat stFileInfo;
61 // Attempt to get the file attributes
62 intStat = stat(strFilename.c_str(),&stFileInfo);
65 // We were able to get the file attributes
66 // so the file obviously exists.
71 // We were not able to get the file attributes.
72 // This may mean that we don't have permission to
73 // access the folder which contains this file. If you
74 // need to do that level of checking, lookup the
75 // return values of stat which will give you
76 // more details on why stat failed.
84 // =====================================================================
86 std::string Utilities::ExtractPackageName(const std::string &name,
92 std::string::size_type slash_position = name.find_last_of("/\\");
93 if (slash_position != std::string::npos)
95 pkgname = name.substr(slash_position+1,std::string::npos);
96 path = name.substr(0,slash_position);
97 // std::cout << "F:P='"<<path<<"'"<<std::endl;//+1,std::string::npos);
104 // remove {.so | dll} if any
105 std::string::size_type dot_position = pkgname.find_last_of('.');
106 if (dot_position != std::string::npos){
107 pkgname = pkgname.substr(0,dot_position);
109 #if defined(__GNUC__)
112 // shared lib name = libbb<name>.so
114 // remove {libbb} if any
115 if (memcmp ( pkgname.c_str(), "libbb", 5) == 0) {
116 pkgname = pkgname.substr(5, pkgname.length());
119 /// \ \todo what would happen if (stupid) user names his package 'libbb' ?!?
120 /// \ --> Should be forbidden!
122 #elif defined(_WIN32)
125 // shared lib name = <name>.dll
127 // EED Problem loading package call bbtkTools
128 // // remove {bb} if any
129 if (memcmp (pkgname.c_str(), "bb", 2) == 0) {
130 pkgname = pkgname.substr(2, pkgname.length());
134 /// \ \todo what would happen if (stupid) user names his package 'bb' ?!?
135 /// \ --> Should be forbidden!
138 bbtkError("neither __GNUC__ nor _WIN32 ?!? How did you compile ?");
143 //=====================================================================
144 std::string Utilities::ExtractScriptName(const std::string &name,
149 std::string::size_type slash_position = name.find_last_of("/\\");
150 if (slash_position != std::string::npos) {
151 pkgname =name.substr(slash_position+1,std::string::npos);
152 path = name.substr(0,slash_position);
156 // remove {.bbs } if any
157 std::string::size_type dot_position = pkgname.find_last_of('.');
158 if (dot_position != std::string::npos){
159 pkgname = pkgname.substr(0,dot_position);
164 // ========================================================================
166 std::string Utilities::ExpandLibName(const std::string &name, bool verbose)
168 // ----- Think of expanding path name ( ./ ../ ../../ )
170 char buf[2048]; // for getcwd
171 char * currentDir = getcwd(buf, 2048);
172 std::string cwd(currentDir);
173 std::string libname(name);
174 std::string fileSeparator;
175 fileSeparator = ConfigurationFile::GetInstance().Get_file_separator();
176 // tooHigh : true is user supplies a library pathname with too many "../"
177 bool tooHigh = false;
179 //std::cout << "------------------cwd [" << cwd << "] name [" << name << "]" << std::endl;
181 if ( name[0] == '/' || name[1] == ':' ) // Linux or Windows absolute name
185 else if ( name =="." )
187 libname = cwd + fileSeparator;
190 else if (name[0] == '.' && (name[1] == '/' || name[1] == '\\') )
192 libname = cwd + fileSeparator + name.substr(2, name.length());
195 else if ( name[0] == '.' && name[1] == '.' /* && (name[2] == '/' || name[2] == '\\') */ )
197 if ( IsAtRoot(cwd) ) // hope it gets / (for Linux), C: D: (for Windows)
199 // if we are already at / or c: --> hopeless
201 std::cout << " File path [" << name << "] doesn't exist" << std::endl;
206 // iterate on ../ and go up from the current working dir!
208 bool alreadyProcessRoot = false;
210 //if (a[a.size()-1] != fileSeparator[0])
211 // a.append(fileSeparator);
212 //std::cout << "------------------a [" << a << "]" << std::endl;
214 for(;;) // wild loop !
216 std::string::size_type slash_position = cwd.find_last_of(fileSeparator);
217 if (slash_position != std::string::npos) {
218 if (slash_position == 0)
220 cwd = cwd.substr(0,slash_position/*+1*/);
221 //std::cout << "------------------cwd [" << cwd << "]" << std::endl;
227 a = a.substr(3, /*name.length()*/ a.length()); // remove ../
228 //std::cout << "------------------a [" << a << "]" << std::endl;
229 if (a == "" || alreadyProcessRoot)
232 std::cout << " File path : [" << name << "] doesn't exist" << std::endl;
236 // std::string b = cwd + a;
238 char c = cwd[cwd.size()-1];
239 if (c != '/' && c != '\\' )
240 libname += fileSeparator;
243 if ( a[0] != '.' ) // if . (probabely ../), loop again
247 alreadyProcessRoot = true;
249 } // end iterating on ../
251 //std::cout << "------------------out of loop]" << std::endl;
256 } // ----- End of expanding path name ( ./ ../ ../../ )
258 std::cout <<"* ERROR in ExpandLibName : should never get here!" << std::endl;
260 return(""); // Will never get here!
263 // ===================================================================================
265 std::string Utilities::MakeLibnameFromPath(std::string path, std::string pkgname)
267 std::string libname = path;
268 char c = path[path.size()-1];
269 #if defined(__GNUC__)
281 #elif defined(_WIN32)
292 // ===================================================================================
294 std::string Utilities::MakePkgnameFromPath(std::string path, std::string pkgname, bool addExt)
296 std::string libname = path;
297 char c = path[path.size()-1];
298 if (c != '/' && c != '\\')
300 libname += ConfigurationFile::GetInstance().Get_file_separator ();
305 int l = libname.size();
308 if (libname.substr(l-4, 4) != ".bbs")
310 libname = libname + ".bbs";
316 // =======================================================================
318 // =======================================================================
319 /// Returns the user settings dir, e.g. /home/username/.bbtk
320 std::string Utilities::GetUserSettingsDir()
322 #if defined(__GNUC__)
323 std::string str_home(getenv("HOME"));
324 #elif defined(_WIN32)
325 std::string str_home(getenv("USERPROFILE"));
327 std::string fullname = str_home + "/.bbtk";
328 MakeValidFileName(fullname);
333 // =======================================================================
334 /// Builds the complete path to the file 'name' located
335 /// in user settings dir, e.g. /home/username/.bbtk/
336 std::string Utilities::MakeUserSettingsFullFileName(const std::string& name)
338 #if defined(__GNUC__)
339 std::string str_home(getenv("HOME"));
340 #elif defined(_WIN32)
341 std::string str_home(getenv("USERPROFILE"));
343 std::string fullname = str_home + "/.bbtk/" + name;
344 MakeValidFileName(fullname);
347 // =======================================================================
350 // =======================================================================
351 void Utilities::CreateDirectoryIfNeeded( std::string const &dirName)
353 if (FileExists(dirName)) return;
354 std::string cmd("mkdir \"");
359 // =======================================================================
362 //========================================================================
363 bool Utilities::IsAtRoot(std::string cwd)
365 if ( cwd == "/" // hope it gets / (for Linux)
366 || (cwd.size() <= 3 && cwd[1] == ':') ) // hope it gets C: D: (for Windows)
371 // ======================================================================
373 // ======================================================================
374 bool Utilities::IsDirectory(std::string const &dirName)
378 if ( stat(dirName.c_str(), &fs) == 0 )
381 return ((fs.st_mode & _S_IFDIR) != 0);
383 return S_ISDIR(fs.st_mode);
391 // =======================================================================
393 // =======================================================================
394 void Utilities::SplitAroundFirstDot( const std::string& in,
398 std::string delimiter = ".";
399 std::string::size_type pos = in.find_first_of(delimiter);
400 if (std::string::npos != pos)
402 left = in.substr(0,pos);
403 right = in.substr(pos+1,in.size());
410 bbtkGlobalError("Token '"<<in<<"' : expected 'a.b' format but no dot found");
413 //=======================================================================
415 //=======================================================================
416 void Utilities::SplitString ( const std::string& str,
417 const std::string& delimiters,
418 std::vector<std::string>& tokens)
420 // Skip delimiters at beginning.
421 std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
422 // Find first delimiter.
423 std::string::size_type pos = str.find_first_of(delimiters, lastPos);
425 while (std::string::npos != pos || std::string::npos != lastPos)
427 // Found a token, add it to the vector.
428 tokens.push_back(str.substr(lastPos, pos - lastPos));
429 // Skip delimiters. Note the "not_of"
430 lastPos = str.find_first_not_of(delimiters, pos);
431 // Find next delimiter
432 pos = str.find_first_of(delimiters, lastPos);
436 //=======================================================================
439 // ======================================================================
440 std::string Utilities::get_file_name(const std::string& s)
442 std::string::size_type slash_position = s.find_last_of("/\\");
443 if (slash_position != std::string::npos)
445 return s.substr(slash_position+1,std::string::npos);
452 //=======================================================================
455 // ========================================================================
457 * \brief Explore a directory with possibility of recursion
458 * return number of files read
459 * @param dirpath directory to explore
460 * @param recursive whether we want recursion or not
462 int Utilities::Explore(std::string const &dirpath, bool recursive, std::vector<std::string> &Filenames)
464 int numberOfFiles = 0;
465 std::string fileName;
467 std::string dirName = dirpath;
470 WIN32_FIND_DATA fileData;
471 HANDLE hFile = FindFirstFile((dirName+"\\*").c_str(), &fileData);
473 for(BOOL b = (hFile != INVALID_HANDLE_VALUE); b;
474 b = FindNextFile(hFile, &fileData))
476 fileName = fileData.cFileName;
477 if ( fileData.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY )
479 // Need to check for . and .. to avoid infinite loop
480 if ( fileName != "." && fileName != ".." && recursive )
482 numberOfFiles += Explore(dirName+ "\\"+fileName,recursive,Filenames);
487 Filenames.push_back(dirName+"\\"+fileName);
491 DWORD dwError = GetLastError();
492 if (hFile != INVALID_HANDLE_VALUE)
494 if (dwError != ERROR_NO_MORE_FILES)
497 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|
498 FORMAT_MESSAGE_FROM_SYSTEM|
499 FORMAT_MESSAGE_IGNORE_INSERTS,
501 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
502 (LPTSTR) &lpMsgBuf,0,NULL);
504 // ErrorMacro("FindNextFile error. Error is " << (char *)lpMsgBuf
505 // <<" for the directory : "<<dirName);
511 // Real POSIX implementation: scandir is a BSD extension only, and doesn't
512 // work on debian for example
513 //std::cout <<"in Explor dirname[" << dirName << "]" << std::endl;
514 DIR* dir = opendir(dirName.c_str());
519 //std::cout <<"Open OK" << std::endl;
520 // According to POSIX, the dirent structure contains a field char d_name[]
521 // of unspecified size, with at most NAME_MAX characters preceeding the
522 // terminating null character. Use of other fields will harm the porta-
523 // bility of your programs.
527 for (d = readdir(dir); d; d = readdir(dir))
529 fileName = dirName + "/" + d->d_name;
530 //std::cout <<"in Explor filename[" << fileName << "]" << std::endl;
531 if( stat(fileName.c_str(), &buf) != 0 )
533 //ErrorMacro( strerror(errno) );
535 if ( S_ISREG(buf.st_mode) ) //is it a regular file?
537 Filenames.push_back( fileName );
540 else if ( S_ISDIR(buf.st_mode) ) //directory?
542 if ( d->d_name[0] != '.' && recursive ) //we also skip hidden files
544 numberOfFiles += Explore( fileName, recursive, Filenames);
549 //ErrorMacro( "Unexpected error" );
553 if( closedir(dir) != 0 )
555 // ErrorMacro( strerror(errno) );
559 return numberOfFiles;
562 //=======================================================================
565 //=======================================================================
566 // Replaces substrings "\\n" by a real carriage return "\n"
567 void Utilities::SubsBackslashN ( std::string& s )
569 std::string ss("\\n");
570 std::string::size_type pos = 0;
572 const char* cr = "\n";
573 while ( pos != std::string::npos )
575 s.replace(pos,2,cr,1);
576 pos = s.find(ss, pos-1);
579 //=======================================================================
582 //=======================================================================
584 bool Utilities::loosematch(std::string stdLine,std::string stdOptions)
587 std::vector<std::string> tokens;
588 SplitString ( stdOptions,"|", tokens);
589 int i,size=tokens.size();
590 for (i=0; i<size; i++)
593 if ( strcmpi(stdLine.c_str(),tokens[i].c_str())==0)
598 if ( strcasecmp(stdLine.c_str(),tokens[i].c_str())==0)
607 //=========================================================================
609 //=========================================================================
610 // From http://www.fltk.org/newsgroups.php?gfltk.general+v:22083
612 int get_app_path (char *pname, size_t pathsize)
615 /* Oddly, the readlink(2) man page says no NULL is appended. */
616 /* So you have to do it yourself, based on the return value: */
617 pathsize --; /* Preserve a space to add the trailing NULL */
618 long result = readlink("/proc/self/exe", pname, pathsize);
621 pname[result] = 0; /* add the #@!%ing NULL */
623 if ((access(pname, 0) == 0))
624 return 0; /* file exists, return OK */
625 /*else name doesn't seem to exist, return FAIL (falls
631 long result = GetModuleFileName(NULL, pname, pathsize);
634 /* fix up the dir slashes... */
635 int len = strlen(pname);
637 for (idx = 0; idx < len; idx++)
639 if (pname[idx] == '\\') pname[idx] = '/';
642 for (idx = len-1; idx >=0 ; idx--)
644 if (pname[idx] == '/')
651 if ((access(pname, 0) == 0))
652 return 0; /* file exists, return OK */
653 /*else name doesn't seem to exist, return FAIL (falls
659 char *p = getexecname();
662 /* According to the Sun manpages, getexecname will
663 "normally" return an */
664 /* absolute path - BUT might not... AND that IF it is not,
666 /* getcwd() will "usually" be the correct thing... Urgh!
669 /* check pathname is absolute (begins with a / ???) */
670 if (p[0] == '/') /* assume this means we have an
673 strncpy(pname, p, pathsize);
674 if ((access(pname, 0) == 0))
675 return 0; /* file exists, return OK */
677 else /* if not, prepend getcwd() then check if file
680 getcwd(pname, pathsize);
681 long result = strlen(pname);
682 strncat(pname, "/", (pathsize - result));
684 strncat(pname, p, (pathsize - result));
686 if ((access(pname, 0) == 0))
687 return 0; /* file exists, return OK */
688 /*else name doesn't seem to exist, return FAIL
694 #ifdef MACOSX /* assume this is OSX */
696 from http://www.hmug.org/man/3/NSModule.html
698 extern int _NSGetExecutablePath(char *buf, unsigned long
701 _NSGetExecutablePath copies the path of the executable
702 into the buffer and returns 0 if the path was successfully
703 copied in the provided buffer. If the buffer is not large
704 enough, -1 is returned and the expected buffer size is
705 copied in *bufsize. Note that _NSGetExecutablePath will
706 return "a path" to the executable not a "real path" to the
707 executable. That is the path may be a symbolic link and
708 not the real file. And with deep directories the total
709 bufsize needed could be more than MAXPATHLEN.
712 char *given_path = (char*)malloc(MAXPATHLEN * 2);
713 if (!given_path) return status;
715 uint32_t npathsize = MAXPATHLEN * 2;
716 long result = _NSGetExecutablePath(given_path, &npathsize);
718 { /* OK, we got something - now try and resolve the real path...
720 if (realpath(given_path, pname) != NULL)
722 if ((access(pname, 0) == 0))
723 status = 0; /* file exists, return OK */
730 return -1; /* Path Lookup Failed */
732 //=========================================================================
736 //=========================================================================
737 std::string Utilities::GetExecutablePath()
740 int err = get_app_path(name, PATH_MAX);
743 bbtkGlobalError("Could not determine current executable path ?");
746 // remove the exe name
748 slash = strrchr(name, VALID_FILE_SEPARATOR_CHAR);
755 //=========================================================================