LUPI::FileInfo Namespace Reference

Classes
class	FileStat

Functions
std::string	realPath (std::string const &a_path)
std::string	_basename (std::string const &a_path)
std::string	basenameWithoutExtension (std::string const &a_path)
std::string	_dirname (std::string const &a_path)
bool	exists (std::string const &a_path)
bool	isDirectory (std::string const &a_path)
bool	createDirectories (std::string const &a_path)

Function Documentation

_basename()

std::string LUPI::FileInfo::_basename

(

std::string const &

a_path

)

Returns the base name of a path.

Parameters

a_path

[in] The path whose base name is returned.

Definition at line 82 of file LUPI_file.cc.

                                               {
 
    char *path = new char[a_path.size( ) + 1];
    strcpy( path, a_path.c_str( ) );
    std::string basename1( basename( path ) );
 
    delete[] path;
 
    return( basename1 );
}

_dirname()

std::string LUPI::FileInfo::_dirname

(

std::string const &

a_path

)

Returns the directory name of a path. This is, it removes the base name.

Parameters

a_path

[in] The path whose base name is returned.

Definition at line 112 of file LUPI_file.cc.

                                              {
 
    char *path = new char[a_path.size( ) + 1];
    strcpy( path, a_path.c_str( ) );
    std::string dirname1( dirname( (char *) path ) );
 
    delete[] path;
 
    return( dirname1 );
}

Referenced by createDirectories().

basenameWithoutExtension()

std::string LUPI::FileInfo::basenameWithoutExtension

(

std::string const &

a_path

)

Same as basename but removes, if a period (i.e., ".") exists in the string, the last "." and all following characters.

Parameters

a_path

[in] The path whose base name is returned without its extension.

Definition at line 99 of file LUPI_file.cc.

                                                              {
 
    std::size_t found = a_path.rfind( '.' );
 
    return( a_path.substr( 0, found ) );
}

Referenced by LUPI::ArgumentParser::parse().

createDirectories()

bool LUPI::FileInfo::createDirectories

(

std::string const &

a_path

)

Adds all needed directories to complete a_path.

Parameters

a_path

[in] The path that is checked for existence.

Returns

Returns true if the path exists (e.g., created if it does not exists) and false otherwise.

Definition at line 165 of file LUPI_file.cc.

                                                  {
 
    if( isDirectory( a_path ) ) return( true );
    if( ( a_path == LUPI_FILE_SEPARATOR ) || ( a_path == "." ) || ( a_path == "" ) ) return( true );
 
    std::string dirname1( _dirname( a_path ) );
    if( createDirectories( dirname1 ) ) {
#ifdef _WIN32
        int status = _mkdir( a_path.c_str( ) );
#else
        int status = mkdir( a_path.c_str( ), S_IRWXU | S_IRWXG | S_IRWXG );
#endif
        if( status == 0 ) return( true );
        switch( errno ) {
        case EEXIST :
            return( true );
        default :
            return( false );
        }
    }
 
    return( false );
}

Referenced by createDirectories().

exists()

bool LUPI::FileInfo::exists

(

std::string const &

a_path

)

Returns true if the path exists and false otherwise.

Parameters

a_path

[in] The path that is checked for existence.

Definition at line 129 of file LUPI_file.cc.

                                       {
 
#ifdef _WIN32
        return std::filesystem::exists( std::filesystem::path( a_path ) );
#else
        return( access( a_path.c_str( ), F_OK ) == 0 );
#endif
}

Referenced by GIDI::Map::Map::RIS_fileExist().

isDirectory()

bool LUPI::FileInfo::isDirectory

(

std::string const &

a_path

)

Returns true if path is a direction that exists and false otherwise.

Parameters

a_path

[in] The path that is checked for existence and is it a directory.

Returns

Returns true if the path exists (e.g., created if it does not exists) and false otherwise.

Definition at line 146 of file LUPI_file.cc.

                                            {
 
    try {
        FileStat fileStat( a_path );
        return( fileStat.isDirectory( ) ); }
    catch (...) {
    }
 
    return( false );
}

Referenced by createDirectories().

realPath()

std::string LUPI::FileInfo::realPath

(

std::string const &

a_path

)

This function takes a file path and returns its real path. On a Unix system, the system function realpath is called.

Parameters

a_path

[in] The path whose real path is to be determined.

Returns

The real path.

Definition at line 63 of file LUPI_file.cc.

                                              {    
        
    char *p1 = realpath( a_path.c_str( ), nullptr );
        
    if( p1 == nullptr ) {
        std::string errMsg( "realPath: file does not exist: " );
        throw Exception( errMsg + a_path );
    } 
    std::string basePath( p1 );
    free( p1 );
    return( basePath );
}

Referenced by GIDI::Map::BaseEntry::path().