gum::Directory Class Reference

Cross-platform directory utility. More...

#include <agrum/core/utils_dir.h>

Public Member Functions
	Directory ()
	Contructor. More...
	Directory (const std::string &directory)
	Contructor. More...
	Directory (const Directory &dir)
	Copy contructor. More...
	~Directory ()
	Destructor. More...
bool	isValid () const
	Returns true if directory has been opened, false otherwise. More...
std::vector< std::string >	entries () const
	Return directory content. More...
Directory	parent () const
	Returns directory parent. More...
std::string	path () const
	Returns directory path. More...
std::string	absolutePath () const
	Returns directory absolute path. More...
Directory &	operator= (const Directory &d)
	Copy operator. More...

Static Public Member Functions
static bool	isDir (const std::string &path)
	&brief Return true if directory is a valid directory, false otherwise. More...

Detailed Description

Cross-platform directory utility.

Definition at line 62 of file utils_dir.h.

Constructor & Destructor Documentation

Directory() [1/3]

gum::Directory::Directory

(

)

Contructor.

Definition at line 40 of file utils_dir.cpp.

Referenced by isDir(), and parent().

: m_dirPtr(nullptr) { GUM_CONSTRUCTOR(Directory); }

Here is the caller graph for this function:

Directory() [2/3]

gum::Directory::Directory

(

const std::string &

directory

)

Contructor.

Parameters

directory

The path to the directory.

Definition at line 43 of file utils_dir.cpp.

References m_dirName, and m_dirPtr.

                                                 : m_dirName(directory) {
    GUM_CONSTRUCTOR(Directory);
    m_dirPtr = opendir(m_dirName.c_str());
  }

Directory() [3/3]

gum::Directory::Directory

(

const Directory &

dir

)

Copy contructor.

Parameters

dir	The gum::Directory to copy.

Definition at line 49 of file utils_dir.cpp.

References m_dirName, and m_dirPtr.

                                           : m_dirName(dir.m_dirName) {
    GUM_CONSTRUCTOR(Directory);
    m_dirPtr = opendir(m_dirName.c_str());
  }

~Directory()

gum::Directory::~Directory

(

)

Destructor.

Definition at line 55 of file utils_dir.cpp.

References m_dirPtr.

                        {
    GUM_DESTRUCTOR(Directory);

    if (m_dirPtr != nullptr) closedir(m_dirPtr);
  }

Member Function Documentation

absolutePath()

std::string gum::Directory::absolutePath

(

)

const

Returns directory absolute path.

Returns

Returns directory absolute path.

Definition at line 91 of file utils_dir.cpp.

References isValid(), and m_dirName.

Referenced by gum::prm::o3prmr::O3prmrInterpreter::import(), and gum::prm::o3prm::O3prmReader< double >::readFile().

                                          {
    std::string result;

    if (!isValid()) return result;

    char oldWD[255];

    if (getcwd(oldWD, 255) == nullptr) return result;

    if (chdir(m_dirName.c_str()) != 0) return result;

    char absPath[255];

    if (getcwd(absPath, 254) != nullptr) result = std::string(absPath) + '/';

    if (chdir(oldWD) != 0)
      std::cerr << "Warning : Could not go to previous working directory. ("
                << __FILE__ << ":" << __LINE__ << ")" << std::endl;

    return result;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

entries()

std::vector< std::string > gum::Directory::entries

(

)

const

Return directory content.

Returns

Return directory content.

Definition at line 65 of file utils_dir.cpp.

References isValid(), and m_dirPtr.

                                                  {
    std::vector< std::string > result;

    if (!isValid()) return result;

    rewinddir(m_dirPtr);

    dirent* entry;

    while ((entry = readdir(m_dirPtr)))
      result.push_back(std::string(entry->d_name));

    return result;
  }

Here is the call graph for this function:

isDir()

bool gum::Directory::isDir ( const std::string &  path )

static

&brief Return true if directory is a valid directory, false otherwise.

Parameters

path	The path to test. &return Return true if directory is a valid directory, false otherwise.

Definition at line 35 of file utils_dir.cpp.

References Directory().

Referenced by gum::prm::o3prmr::O3prmrInterpreter::addPath().

                                                  {
    return Directory(directory).isValid();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isValid()

bool gum::Directory::isValid

(

)

const

Returns true if directory has been opened, false otherwise.

Returns

Returns true if directory has been opened, false otherwise.

Definition at line 62 of file utils_dir.cpp.

References m_dirPtr.

Referenced by absolutePath(), entries(), and parent().

{ return m_dirPtr != nullptr; }

Here is the caller graph for this function:

operator=()

Directory & gum::Directory::operator=

(

const Directory &

d

)

Copy operator.

Parameters

d	The gum::Directory to copy.

Returns

Returns this gum::Directory.

Definition at line 113 of file utils_dir.cpp.

References m_dirName, and m_dirPtr.

                                                    {
    if (m_dirPtr != nullptr) closedir(m_dirPtr);

    m_dirName = d.m_dirName;

    m_dirPtr = opendir(m_dirName.c_str());

    return *this;
  }

parent()

Directory gum::Directory::parent

(

)

const

Returns directory parent.

Returns

Returns directory parent.

Definition at line 81 of file utils_dir.cpp.

References Directory(), isValid(), and m_dirName.

                                    {
    if (!isValid()) return Directory();

    return Directory(m_dirName + "../");
  }

Here is the call graph for this function:

path()

std::string gum::Directory::path

(

)

const

Returns directory path.

Returns

Returns directory path.

Definition at line 88 of file utils_dir.cpp.

References m_dirName.

{ return m_dirName; }

Member Data Documentation

m_dirName

std::string gum::Directory::m_dirName

private

The directory path.

Definition at line 134 of file utils_dir.h.

Referenced by absolutePath(), Directory(), operator=(), parent(), and path().

m_dirPtr

DIR* gum::Directory::m_dirPtr

mutableprivate

A pointer towards the Directory stream.

Definition at line 137 of file utils_dir.h.

Referenced by Directory(), entries(), isValid(), operator=(), and ~Directory().

---

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

• agrum/core/utils_dir.h
• agrum/core/utils_dir.cpp