FileFinder Class Reference

#include <FileFinder.hpp>

Inherited by HeartFileFinder.

Collaboration diagram for FileFinder:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 FileFinder ()
 FileFinder (const std::string &rPath, RelativeTo::Value relativeTo)
 FileFinder (const std::string &rLeafName, const FileFinder &rParentOrSibling)
 FileFinder (const fs::path &rPath)
virtual ~FileFinder ()
virtual void SetPath (const std::string &rPath, RelativeTo::Value relativeTo)
virtual void SetPath (const std::string &rLeafName, const FileFinder &rParentOrSibling)
bool IsPathSet () const
bool Exists () const
bool IsFile () const
bool IsDir () const
bool IsEmpty () const
std::string GetAbsolutePath () const
bool IsNewerThan (const FileFinder &rOtherEntity) const
std::string GetLeafName () const
std::string GetLeafNameNoExtension () const
std::string GetExtension () const
FileFinder GetParent () const
std::string GetRelativePath (const FileFinder &rBasePath) const
FileFinder CopyTo (const FileFinder &rDest) const
void Remove () const
void DangerousRemove () const
std::vector< FileFinder > FindMatches (const std::string &rPattern) const

Static Public Member Functions

static bool IsAbsolutePath (const std::string &rPath)
static void ReplaceSpacesWithUnderscores (std::string &rPath)
static void ReplaceUnderscoresWithSpaces (std::string &rPath)
static void FakePath (RelativeTo::Value fakeWhat, const std::string &rFakePath)
static void StopFaking ()

Private Member Functions

void PrivateRemove (bool dangerous=false) const

Private Attributes

std::string mAbsPath

Static Private Attributes

static bool msFaking = false
static RelativeTo::Value msFakeWhat = RelativeTo::Absolute
static std::string msFakePath = ""

Detailed Description

A helper class for finding files or directories, given paths which can be relative to various locations (e.g. the Chaste source tree root, the current directory, the Chaste test output directory, or an absolute path).

Definition at line 68 of file FileFinder.hpp.

Constructor & Destructor Documentation

FileFinder::FileFinder (  ) 

Default constructor for subclasses to use. They should call SetPath() in their constructor.

This also allows classes to store a FileFinder instance that hasn't been properly set up yet, and assign to it later using operator=.

Definition at line 75 of file FileFinder.cpp.

Referenced by CopyTo(), FindMatches(), GetParent(), and PrivateRemove().

FileFinder::FileFinder ( const std::string &  rPath,
RelativeTo::Value  relativeTo 
)

Main constructor.

Parameters:
rPath the path to the file/dir to find
relativeTo how to interpret this path

Definition at line 80 of file FileFinder.cpp.

References SetPath().

FileFinder::FileFinder ( const std::string &  rLeafName,
const FileFinder &  rParentOrSibling 
)

Find a file (or folder) relative to some file or directory. If the second argument is a directory, we look for the given leaf name within it. If the second argument is a file, then we look for a sibling. An exception is raised if rParentOrSibling does not exist.

Parameters:
rLeafName the leaf name of the file/dir to find
rParentOrSibling where to look for it

Definition at line 85 of file FileFinder.cpp.

References SetPath().

FileFinder::FileFinder ( const fs::path &  rPath  ) 

Conversion constructor from a Boost Filesystem path object. Note that since fs::path has a conversion constructor from std::string, this allows us to be initialised with a string or character constant, too. The path will be interpreted as relative to the current working directory, unless it is an absolute path.

Parameters:
rPath the path to the file/dir to find

Definition at line 90 of file FileFinder.cpp.

References RelativeTo::Absolute, and SetPath().

FileFinder::~FileFinder (  )  [virtual]

Needed because we have virtual methods.

Definition at line 95 of file FileFinder.cpp.

Member Function Documentation

FileFinder FileFinder::CopyTo ( const FileFinder &  rDest  )  const

Copy this file or folder (recursively in the latter case) to the given destination. If the destination is a folder that exists, the source will be copied with the same name inside that folder. Otherwise the source will be copied with the given destination name.

If the source is a file and the destination is a file that exists it will be removed prior to copying. If the source is a folder and the destination is a file that exists then an error is thrown.

Parameters:
rDest where to copy to
Returns:
a finder for the copied entity

Definition at line 304 of file FileFinder.cpp.

References EXCEPTION, Exists(), FileFinder(), IsDir(), IsFile(), and mAbsPath.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo(), HeartConfig::CopySchema(), CardiacSimulation::CreateAndRun(), AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save(), and AbstractCardiacTissue< SPACE_DIM >::save().

void FileFinder::DangerousRemove (  )  const

This method will allow you to remove any file from under either * CHASTE_TEST_OUTPUT or * the source tree (but not elsewhere).

For this reason it is a very dangerous operation and should not be used if Remove could be instead.

BEWARE: if you have managed to set CHASTE_TEST_OUTPUT to "/" this could wipe your system!

Definition at line 417 of file FileFinder.cpp.

References PrivateRemove().

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo().

bool FileFinder::Exists (  )  const
Returns:
true if we exist.

Definition at line 176 of file FileFinder.cpp.

References mAbsPath.

Referenced by ColumnDataReader::ColumnDataReader(), Hdf5DataReader::CommonConstructor(), OutputFileHandler::CommonConstructor(), CellMLToSharedLibraryConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), HeartConfig::CopySchema(), CopyTo(), ExtendedBidomainTissue< SPACE_DIM >::CreateExtracellularConductivityTensors(), BidomainTissue< SPACE_DIM >::CreateExtracellularConductivityTensors(), AbstractCardiacTissue< ELEMENT_DIM, SPACE_DIM >::CreateIntracellularConductivityTensor(), ExtendedBidomainTissue< SPACE_DIM >::CreateIntracellularConductivityTensorSecondCell(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::InitialiseWriter(), IsNewerThan(), CellMLLoader::LoadCellMLFile(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), Hdf5DataWriter::OpenFile(), PrivateRemove(), AbstractPurkinjeCellFactory< ELEMENT_DIM, SPACE_DIM >::ReadJunctionsFile(), AbstractCardiacTissue< SPACE_DIM >::save(), and SetPath().

void FileFinder::FakePath ( RelativeTo::Value  fakeWhat,
const std::string &  rFakePath 
) [static]

For testing purposes, fake the value of one of the normally fixed paths, e.g. ChasteSourceRoot.

Parameters:
fakeWhat which path to fake
rFakePath its fake value

Definition at line 544 of file FileFinder.cpp.

References msFakePath, msFakeWhat, and msFaking.

std::vector< FileFinder > FileFinder::FindMatches ( const std::string &  rPattern  )  const
Returns:
a list of files in this folder matching a simple glob pattern. This method must be called on a FileFinder that points at a folder, and the pattern will be matched against file (or folder) names in that folder. The pattern can use a subset of shell-style glob syntax. A '?' anywhere in the string matches any single character at that position. A '*' may be used at the start or end of the string to match any number of leading or trailing characters, respectively. Hidden files (names starting with a '.') will never be matched.
Parameters:
rPattern the pattern to match names against

Definition at line 423 of file FileFinder.cpp.

References EXCEPTION, FileFinder(), IsDir(), mAbsPath, and PATH_LEAF_NAME.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo(), and AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save().

std::string FileFinder::GetAbsolutePath (  )  const
Returns:
the absolute path to this file/dir.

If this is a directory that exists (at the instant of this call), the absolute path is guaranteed to end in a '/'. Otherwise, the path is guaranteed not to end in a '/'.

Definition at line 217 of file FileFinder.cpp.

References IsDir(), and mAbsPath.

Referenced by ColumnDataReader::ColumnDataReader(), Hdf5DataReader::CommonConstructor(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), CellMLToSharedLibraryConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), OutputFileHandler::CopyFileTo(), FibreReader< DIM >::FibreReader(), AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::GenerateListOfDatasets(), OutputFileHandler::GetChasteTestOutputDirectory(), ElectroMechanicsProblemDefinition< DIM >::GetFibreSheetDirectionsFile(), DynamicModelLoaderRegistry::GetLoader(), GetRelativePath(), AbstractCardiacProblem< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::InitialiseWriter(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), Hdf5DataWriter::OpenFile(), OutputFileHandler::OutputFileHandler(), PrivateRemove(), AbstractPurkinjeCellFactory< ELEMENT_DIM, SPACE_DIM >::ReadJunctionsFile(), ArchiveLocationInfo::SetArchiveDirectory(), SetPath(), AbstractCardiacMechanicsSolver< ELASTICITY_SOLVER, DIM >::SetVariableFibreSheetDirections(), and AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteNclFile().

std::string FileFinder::GetExtension (  )  const
Returns:
the extension of the leaf name of this file or directory, if any. The '.' will be included in the extension if an extension exists.

Definition at line 243 of file FileFinder.cpp.

References mAbsPath.

Referenced by AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save().

std::string FileFinder::GetLeafName (  )  const
Returns:
the leaf name of this file or directory.

i.e. the individual file or directory name and none of the preceding folders on its path.

Definition at line 233 of file FileFinder.cpp.

References mAbsPath, and PATH_LEAF_NAME.

Referenced by CellMLLoader::LoadCellMLFile().

std::string FileFinder::GetLeafNameNoExtension (  )  const
Returns:
the leaf name of this file or directory, with any file extension removed.

i.e. the individual file or directory name and none of the preceding folders on its path.

Definition at line 238 of file FileFinder.cpp.

References mAbsPath.

Referenced by FibreConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), CellMLLoader::LoadCellMLFile(), and AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save().

FileFinder FileFinder::GetParent (  )  const
Returns:
a finder for the folder containing this file or directory.

Definition at line 248 of file FileFinder.cpp.

References RelativeTo::Absolute, EXCEPT_IF_NOT, FileFinder(), and mAbsPath.

Referenced by FibreConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), AbstractTetrahedralMesh< SPACE_DIM, SPACE_DIM >::save(), and SetPath().

std::string FileFinder::GetRelativePath ( const FileFinder &  rBasePath  )  const
Returns:
the relative path to this finder from another. Throws if this is not found under rBasePath.
Parameters:
rBasePath where the returned path should be relative to

Definition at line 257 of file FileFinder.cpp.

References EXCEPTION, and GetAbsolutePath().

Referenced by OutputFileHandler::GetRelativePath(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToMeshalyzerConverter(), Hdf5ToVtkConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToVtkConverter(), OutputFileHandler::OutputFileHandler(), and PostProcessingWriter< ELEMENT_DIM, SPACE_DIM >::WriteOutputDataToHdf5().

bool FileFinder::IsAbsolutePath ( const std::string &  rPath  )  [static]
Returns:
true if the path is absolute.
Parameters:
rPath the path to test

Definition at line 517 of file FileFinder.cpp.

Referenced by ExtendedBidomainProblem< DIM >::load(), AbstractCardiacProblem< DIM, DIM, 1 >::load(), ArchiveLocationInfo::SetMeshPathname(), ExecutableSupport::SetOutputDirectory(), and SetPath().

bool FileFinder::IsDir (  )  const
Returns:
true if we are pointing at a directory

Definition at line 186 of file FileFinder.cpp.

References mAbsPath.

Referenced by ColumnDataReader::ColumnDataReader(), Hdf5DataReader::CommonConstructor(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), CopyTo(), FindMatches(), GetAbsolutePath(), IsEmpty(), CardiacSimulationArchiver< PROBLEM_CLASS >::Migrate(), and SetPath().

bool FileFinder::IsEmpty (  )  const
Returns:
true if this is a file of size zero or if this is a folder, whether it contains no non-hidden items. If this doesn't exist, throws.

Definition at line 191 of file FileFinder.cpp.

References EXCEPTION, IsDir(), IsFile(), mAbsPath, and PATH_LEAF_NAME.

bool FileFinder::IsFile (  )  const
Returns:
true if we are pointing at a file

Definition at line 181 of file FileFinder.cpp.

References mAbsPath.

Referenced by OutputFileHandler::CopyFileTo(), CopyTo(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Hdf5ToMeshalyzerConverter(), IsEmpty(), and PrivateRemove().

bool FileFinder::IsNewerThan ( const FileFinder &  rOtherEntity  )  const
Returns:
true if this file/dir is newer than another file/dir. Compares modification times.
Parameters:
rOtherEntity the entity to test against.

Definition at line 226 of file FileFinder.cpp.

References Exists(), and mAbsPath.

Referenced by CellMLToSharedLibraryConverter::Convert().

bool FileFinder::IsPathSet (  )  const
Returns:
true if this FileFinder has been given a path.

Definition at line 171 of file FileFinder.cpp.

References mAbsPath.

Referenced by CellMLToSharedLibraryConverter::ConvertCellmlToSo(), ExecutableSupport::InitializePetsc(), ExecutableSupport::PrintError(), ExecutableSupport::WriteMachineInfoFile(), and ExecutableSupport::WriteProvenanceInfoFile().

void FileFinder::PrivateRemove ( bool  dangerous = false  )  const [private]

This is code common to Remove() and DangerousRemove(). Should remain private and not to be called from elsewhere. Remove() is only allowed to delete things with a .chaste_deletable_folder in the testoutput directory.

DangerousRemove() is allowed to delete anything in the source or testoutput directories.

Parameters:
dangerous whether we are doing a dangerous remove.

Definition at line 355 of file FileFinder.cpp.

References RelativeTo::ChasteSourceRoot, EXCEPTION, Exists(), FileFinder(), GetAbsolutePath(), OutputFileHandler::GetChasteTestOutputDirectory(), IsFile(), mAbsPath, OutputFileHandler::SIG_FILE_NAME, and ChastePosixPathFixer::ToPosix().

Referenced by DangerousRemove(), and Remove().

void FileFinder::Remove (  )  const

Recursively remove this file or folder. Since this is a potentially very dangerous operation, only locations under the Chaste test output folder may be removed.

Only folders created by an OutputFileHandler, or the contents of such a folder, may be deleted (folders that have .chaste_deletable_folder present).

If you need to delete a file or folder without .chaste_deletable_folder, then you have to use DangerousRemove().

Definition at line 412 of file FileFinder.cpp.

References PrivateRemove().

void FileFinder::ReplaceSpacesWithUnderscores ( std::string &  rPath  )  [static]

Replace any spaces in a path or filename with underscores.

Parameters:
rPath a path or file name

Definition at line 522 of file FileFinder.cpp.

void FileFinder::ReplaceUnderscoresWithSpaces ( std::string &  rPath  )  [static]

Replace any underscores in a path or filename with spaces (for making titles etc.).

Parameters:
rPath a path or file name

Definition at line 533 of file FileFinder.cpp.

void FileFinder::SetPath ( const std::string &  rLeafName,
const FileFinder &  rParentOrSibling 
) [virtual]

Change this FileFinder to point at a new location, relative to some file or directory.

Parameters:
rLeafName the leaf name of the file/dir to find
rParentOrSibling where to look for it

Definition at line 155 of file FileFinder.cpp.

References RelativeTo::Absolute, EXCEPTION, Exists(), GetAbsolutePath(), GetParent(), IsDir(), and SetPath().

void FileFinder::SetPath ( const std::string &  rPath,
RelativeTo::Value  relativeTo 
) [virtual]

Change this FileFinder to point at a new location.

Parameters:
rPath the path to the file/dir to find
relativeTo how to interpret this path

Definition at line 99 of file FileFinder.cpp.

References RelativeTo::Absolute, RelativeTo::AbsoluteOrCwd, ChasteBuildRootDir(), RelativeTo::ChasteSourceRoot, RelativeTo::ChasteTestOutput, RelativeTo::CWD, OutputFileHandler::GetChasteTestOutputDirectory(), IsAbsolutePath(), mAbsPath, msFakePath, msFakeWhat, msFaking, and NEVER_REACHED.

Referenced by AbstractHdf5Access::AbstractHdf5Access(), CellMLToSharedLibraryConverter::Convert(), CellMLToSharedLibraryConverter::ConvertCellmlToSo(), HeartConfig::CopySchema(), FileFinder(), OutputFileHandler::GetChasteTestOutputDirectory(), HeartFileFinder::HeartFileFinder(), ExecutableSupport::InitializePetsc(), HeartConfig::LoadFromCheckpoint(), ExecutableSupport::PrintError(), ExecutableSupport::SetOutputDirectory(), HeartConfig::SetParametersFile(), SetPath(), ExecutableSupport::WriteMachineInfoFile(), and ExecutableSupport::WriteProvenanceInfoFile().

void FileFinder::StopFaking (  )  [static]

Stop faking one of the fixed paths.

Definition at line 551 of file FileFinder.cpp.

References msFaking.

Member Data Documentation

std::string FileFinder::mAbsPath [private]

The absolute path to our file.

Definition at line 296 of file FileFinder.hpp.

Referenced by CopyTo(), Exists(), FindMatches(), GetAbsolutePath(), GetExtension(), GetLeafName(), GetLeafNameNoExtension(), GetParent(), IsDir(), IsEmpty(), IsFile(), IsNewerThan(), IsPathSet(), PrivateRemove(), and SetPath().

std::string FileFinder::msFakePath = "" [static, private]

The fake value of the faked path.

Definition at line 305 of file FileFinder.hpp.

Referenced by FakePath(), and SetPath().

RelativeTo::Value FileFinder::msFakeWhat = RelativeTo::Absolute [static, private]

Which path to fake.

Definition at line 302 of file FileFinder.hpp.

Referenced by FakePath(), and SetPath().

bool FileFinder::msFaking = false [static, private]

Whether to fake one of the fixed paths, e.g. ChasteSourceRoot.

Definition at line 299 of file FileFinder.hpp.

Referenced by FakePath(), SetPath(), and StopFaking().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2