DirSearchPath Class Reference

search for files in a list of directories More...

#include </builds/gaudi/Gaudi/GaudiKernel/include/GaudiKernel/DirSearchPath.h>

Collaboration diagram for DirSearchPath:

Classes
class	eqPath

Public Types
typedef boost::filesystem::path	path

Public Member Functions
constructors
	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 More...
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) More...
bool	find (const path &file, path &fileFound) const
	returns a flag if file found in search path. Sets ref to completed path More...
std::list< path >	find_all (const path &file) const
	returns lists of files found in search path. More...

helpers
std::vector< path >	m_dirs
	the dir container More...
static bool	existsDir (const std::string &dirName)
	check dirName is valid More...
static bool	existsDir (const path &dir)
	check dir path is valid More...

Detailed Description

search for files in a list of directories

Author

Paolo Calafiura pcala.nosp@m.fiur.nosp@m.a@lbl.nosp@m..gov - ATLAS Collaboration

Definition at line 29 of file DirSearchPath.h.

Member Typedef Documentation

path

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

Definition at line 31 of file DirSearchPath.h.

Constructor & Destructor Documentation

DirSearchPath() [1/2]

DirSearchPath::DirSearchPath ( )

inline

Definition at line 35 of file DirSearchPath.h.

{ addCWD(); }

DirSearchPath() [2/2]

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

Exceptions

boost::filesystem::filesystem_error

Definition at line 39 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
  auto it = tok.begin();
  while ( it != tok.end() ) {
    try {
      path p( *( it++ ) );
      add( p );
    } catch ( boost::filesystem::filesystem_error& /*err*/ ) {}
  }
}

Member Function Documentation

add()

bool DirSearchPath::add

(

const path &

dir

)

Exceptions

filesystem_error

Definition at line 60 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;
}

addCWD()

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

existsDir() [1/2]

bool DirSearchPath::existsDir ( const path &  dir )

static

check dir path is valid

Definition at line 110 of file DirSearchPath.cpp.

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

existsDir() [2/2]

bool DirSearchPath::existsDir ( const std::string &  dirName )

static

check dirName is valid

Definition at line 103 of file DirSearchPath.cpp.

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

find() [1/2]

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 79 of file DirSearchPath.cpp.

                                                                  {
  bool rc( false );
  for ( const auto& iDir : m_dirs ) {
    path full{ iDir / file };
    if ( exists( full ) ) {
      fileFound = full;
      rc        = true;
      break;
    }
  }
  return rc;
}

find() [2/2]

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 69 of file DirSearchPath.cpp.

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

find_all()

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

(

const path &

file

)

const

returns lists of files found in search path.

Definition at line 93 of file DirSearchPath.cpp.

                                                                           {
  std::list<path> found;
  for ( const auto& iDir : m_dirs ) {
    path full{ iDir / file };
    if ( exists( full ) ) found.push_back( full );
  }
  return found;
}

Member Data Documentation

m_dirs

std::vector<path> DirSearchPath::m_dirs

private

the dir container

Definition at line 89 of file DirSearchPath.h.

---

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

• GaudiKernel/include/GaudiKernel/DirSearchPath.h
• GaudiKernel/src/Lib/DirSearchPath.cpp