torc::common::DirectoryTree Class Reference

Encapsulation of filesystem paths that are used by the library. More...

#include <DirectoryTree.hpp>

Public Member Functions
	DirectoryTree (const char *argv0)
	Mandatory constructor. More...

Static Public Member Functions
static const boost::filesystem::path &	getRelativePath (void)
	Returns the relative path from the working directory to the executable home. More...
static const boost::filesystem::path &	getWorkingPath (void)
	Returns the absolute path to the working directory. More...
static const boost::filesystem::path &	getExecutablePath (void)
	Returns the absolute path to the executable directory. More...
static const boost::filesystem::path &	getDevicesPath (void)
	Returns the absolute path to the family and device database directory. More...
static const boost::filesystem::path &	getLogPath (void)
	Returns the absolute path to the log files directory. More...

Static Protected Attributes
static boost::filesystem::path	sRelativePath
	Relative path from the working directory to the executable home. More...
static boost::filesystem::path	sWorkingPath
	Absolute path to the working directory. More...
static boost::filesystem::path	sExecutablePath
	Absolute path to the executable directory. More...
static boost::filesystem::path	sEdaPath
	Absolute path to the EDA libraries directory. More...
static boost::filesystem::path	sDevicesPath
	Absolute path to the family and device database directory. More...
static boost::filesystem::path	sLogPath
	Absolute path to the log files directory. More...

Detailed Description

Encapsulation of filesystem paths that are used by the library.

Definition at line 28 of file DirectoryTree.hpp.

Constructor & Destructor Documentation

torc::common::DirectoryTree::DirectoryTree

(

const char *

argv0

)

Mandatory constructor.

Parameters

argv0

The zero-th argument passed to main in argv[]. DirectoryTree needs this to derive the relative path from the working directory to the executable, until such a time as Boost provides a better approach.

Extracts the zero-th argument, and builds the various static paths used by the executable.

Definition at line 40 of file DirectoryTree.cpp.

                                                  {
        // resolve symbolic links for the executable if necessary
        boost::filesystem::path argvPath(argv0);
        char buffer[FILENAME_MAX];
        ssize_t count = readlink(argv0, buffer, sizeof(buffer));
        if(count != -1) {
            buffer[count] = 0;
            argvPath = buffer;
            //std::cout << "Resolving symbolic link " << argv[0] << " to executable name " << path 
            //  << std::endl;
        }
        //std::cout << ">>>> argvPath: " << argvPath << std::endl;
        // get the working directory and the relative executable path
        sWorkingPath = boost::filesystem::initial_path();
        //std::cout << ">>>> sWorkingPath: " << sWorkingPath << std::endl;
        sRelativePath = argvPath.parent_path(); // so much for relative paths ...
        //std::cout << ">>>> sRelativePath: " << sRelativePath << std::endl;
        // get the executable path
        sExecutablePath = sRelativePath;
        // build the eda and log paths
        sLogPath = sExecutablePath;
        // build the database path
        sDevicesPath = sExecutablePath / cDevicesNameConst;
        if(!exists(sDevicesPath)) 
            sDevicesPath = sExecutablePath / cTorcNameConst / cDevicesNameConst;

        // normalize each of the paths
        sRelativePath.normalize();
        sWorkingPath.normalize();
        sExecutablePath.normalize();
        sDevicesPath.normalize();
        sLogPath.normalize();
    }

Here is the call graph for this function:

Member Function Documentation

static const boost::filesystem::path& torc::common::DirectoryTree::getDevicesPath ( void  )

inlinestatic

Returns the absolute path to the family and device database directory.

Definition at line 60 of file DirectoryTree.hpp.

{ return sDevicesPath; }

Here is the caller graph for this function:

static const boost::filesystem::path& torc::common::DirectoryTree::getExecutablePath ( void  )

inlinestatic

Returns the absolute path to the executable directory.

Definition at line 58 of file DirectoryTree.hpp.

{ return sExecutablePath; }

Here is the caller graph for this function:

static const boost::filesystem::path& torc::common::DirectoryTree::getLogPath ( void  )

inlinestatic

Returns the absolute path to the log files directory.

Definition at line 62 of file DirectoryTree.hpp.

{ return sLogPath; }

Here is the caller graph for this function:

static const boost::filesystem::path& torc::common::DirectoryTree::getRelativePath ( void  )

inlinestatic

Returns the relative path from the working directory to the executable home.

Definition at line 54 of file DirectoryTree.hpp.

{ return sRelativePath; }

Here is the caller graph for this function:

static const boost::filesystem::path& torc::common::DirectoryTree::getWorkingPath ( void  )

inlinestatic

Returns the absolute path to the working directory.

Definition at line 56 of file DirectoryTree.hpp.

{ return sWorkingPath; }

Here is the caller graph for this function:

Field Documentation

boost::filesystem::path torc::common::DirectoryTree::sDevicesPath

staticprotected

Absolute path to the family and device database directory.

Definition at line 40 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sEdaPath

staticprotected

Absolute path to the EDA libraries directory.

Definition at line 38 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sExecutablePath

staticprotected

Absolute path to the executable directory.

Definition at line 36 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sLogPath

staticprotected

Absolute path to the log files directory.

Definition at line 42 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sRelativePath

staticprotected

Relative path from the working directory to the executable home.

Definition at line 32 of file DirectoryTree.hpp.

boost::filesystem::path torc::common::DirectoryTree::sWorkingPath

staticprotected

Absolute path to the working directory.

Definition at line 34 of file DirectoryTree.hpp.

---

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

• DirectoryTree.hpp
• DirectoryTree.cpp