DirSearchPath Class Reference

#include <DirSearchPath.h>

Collaboration diagram for DirSearchPath:

[legend]

List of all members.

---

Detailed Description

search for files in a list of directories

Author:

Paolo Calafiura <pcalafiura@lbl.gov> - ATLAS Collaboration

Id

DirSearchPath.h,v 1.2 2007/10/16 15:37:25 marcocle Exp

Definition at line 18 of file DirSearchPath.h.

Public Types
typedef boost::filesystem::path	path
Public Member Functions
structors
	DirSearchPath ()
	DirSearchPath (const std::string &stringifiedPath, const char *separator=",:")
modifiers
bool	add (const path &dir)
bool	addCWD ()
	add current work dir (*nix pwd) to path
accessors
bool	find (const std::string &fileName, std::string &fullFileName) const
	returns a flag if fileName found in search path, and sets ref to fully qualified file name (in native form)
bool	find (const path &file, path &fileFound) const
	returns a flag if file found in search path. Sets ref to completed path
std::list< path >	find_all (const path &file) const
	returns lists of files found in search path.
Static Public Member Functions
helpers
static bool	existsDir (const std::string &dirName)
	check dirName is valid
static bool	existsDir (const path &dir)
	check dir path is valid
Private Attributes
std::list< path >	m_dirs
	the dir container
Classes
class	eqPath
	name More...

---

Member Typedef Documentation

typedef boost::filesystem::path DirSearchPath::path

Definition at line 20 of file DirSearchPath.h.

---

Constructor & Destructor Documentation

DirSearchPath::DirSearchPath

(

)

[inline]

Definition at line 24 of file DirSearchPath.h.

{ addCWD(); }

DirSearchPath::DirSearchPath	(	const std::string &	stringifiedPath,
		const char *	separator = ",:"
	)

Exceptions:

boost::filesystem::filesystem_error

Definition at line 20 of file DirSearchPath.cpp.

                                                                                    {
  addCWD(); //FIXME is this a good idea?

  typedef  tokenizer<char_separator<char> > Tokenizer;

  Tokenizer tok(stringifiedPath, char_separator<char>(separator));


  //add names to dir container, filtering dir names to remove invalid ones
  //notice how we iterate over all tokens even if there is an illegal one
  Tokenizer::iterator it = tok.begin();
  while(it != tok.end()) {
    try {
      //path p( *(it++), boost::filesystem::native);
      // For some reason native() does not work with boost 1.31. Changed to no_check and cross the fingers....
      path p( *(it++), boost::filesystem::no_check);
      add(p);
    }
    catch (boost::filesystem::filesystem_error /*err*/) {
    }
  }
}

---

Member Function Documentation

bool DirSearchPath::add

(

const path &

dir

)

Exceptions:

filesystem_error

Definition at line 62 of file DirSearchPath.cpp.

                                       {
  bool dirExist(existsDir(dir));
  //add dir to path even if dir does not (yet) exist,
  // but don't add twice same dir
  if (m_dirs.end() == std::find_if(m_dirs.begin(), m_dirs.end(), eqPath(dir)))
    m_dirs.push_back(dir);
  return dirExist;
}

bool DirSearchPath::addCWD

(

)

add current work dir (*nix pwd) to path

Definition at line 58 of file DirSearchPath.cpp.

                           {
  return add(boost::filesystem::current_path());
}

bool DirSearchPath::find	(	const std::string &	fileName,
		std::string &	fullFileName
	)			const

returns a flag if fileName found in search path, and sets ref to fully qualified file name (in native form)

Definition at line 72 of file DirSearchPath.cpp.

                                                                           {
  bool rc(false);
  try {
    path fileFound;
    if ( (rc = find(path(fileName), fileFound)) )
      fullFileName = fileFound.native_directory_string();
  } catch (...) {}
  return rc;
}

bool DirSearchPath::find	(	const path &	file,
		path &	fileFound
	)			const

returns a flag if file found in search path. Sets ref to completed path

Definition at line 83 of file DirSearchPath.cpp.

                                                                {
  bool rc(false);
  for (std::list<path>::const_iterator iDir=m_dirs.begin(); iDir!=m_dirs.end(); ++iDir) {
    path full(*iDir / file);
    if (exists(full)) {
      fileFound = full;
      rc = true;
      break;
    }
  }
  return rc;
}

std::list< DirSearchPath::path > DirSearchPath::find_all

(

const path &

file

)

const

returns lists of files found in search path.

Definition at line 98 of file DirSearchPath.cpp.

                                              {
  std::list<path> found;
  for (std::list<path>::const_iterator iDir=m_dirs.begin(); iDir!=m_dirs.end(); ++iDir) {
    path full(*iDir / file);
    if (exists(full)) {
      found.push_back(full);
    }
  }
  return found;
}

bool DirSearchPath::existsDir

(

const std::string &

dirName

)

[static]

check dirName is valid

Definition at line 110 of file DirSearchPath.cpp.

                                                      {
  bool rc(false);
  try {
    rc=is_directory(path(dirName));
  } catch(...) {}
  return rc;
}

bool DirSearchPath::existsDir

(

const path &

dir

)

[static]

check dir path is valid

Definition at line 117 of file DirSearchPath.cpp.

                                             {
  return (exists(dir) && is_directory(dir));
}

---

Member Data Documentation

std::list<path> DirSearchPath::m_dirs [private]

the dir container

Definition at line 80 of file DirSearchPath.h.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r4/GaudiKernel/GaudiKernel/DirSearchPath.h
• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v20r4/GaudiKernel/src/Lib/DirSearchPath.cpp