Gray C++ Libraries  0.0.2
A set of C++ libraries for MSVC, GNU on Windows, WinCE, Linux
GrayLib::cManifestRoot Class Reference

#include <cManifestDir.h>

Inheritance diagram for GrayLib::cManifestRoot:
GrayLib::cManifestContext GrayLib::cSyncContext

Public Member Functions

 cManifestRoot (cStringF sRootDir, const FILECHAR_t *pszManifestFileName=nullptr)
 
 ~cManifestRoot ()
 
cStringF get_RootDir () const
 
void put_RootDir (cStringF sRootDir)
 
bool isRootDir (const FILECHAR_t *pszDirPath) const
 
bool isInRootPath (const FILECHAR_t *pszDirPath) const
 
cStringF makeFullPath (const FILECHAR_t *pszRelativePath) const
 
cStringF makeRelativePath (const FILECHAR_t *pszDirPath) const
 
HRESULT ReadSearchForTitle (cStringF &sPathRet, const FILECHAR_t *pszTitle, int iDescendLevels) const
 

Public Attributes

const FILECHAR_tm_pszManifestFileName
 "Manifest.scp" // name of the local manifest files. (one per dir) More...
 

Static Public Attributes

static const FILECHAR_tk_pszManifestDefault = _FN("Manifest.scp")
 "Manifest.scp" More...
 

Protected Attributes

cStringF m_sRootDir
 full path to the (local system) root directory we are syncing or building manifests for. More...
 

Detailed Description

Root level directory for the manifest creation process. May not be true system root of course.

Todo:
? place all manifests in a single directory off root ?

Constructor & Destructor Documentation

◆ cManifestRoot()

GrayLib::cManifestRoot::cManifestRoot ( cStringF  sRootDir,
const FILECHAR_t pszManifestFileName = nullptr 
)

◆ ~cManifestRoot()

GrayLib::cManifestRoot::~cManifestRoot ( )

Member Function Documentation

◆ get_RootDir()

cStringF GrayLib::cManifestRoot::get_RootDir ( ) const
inline

Get the install root folder path.

◆ isInRootPath()

bool GrayLib::cManifestRoot::isInRootPath ( const FILECHAR_t pszDirPath) const
inline

◆ isRootDir()

bool GrayLib::cManifestRoot::isRootDir ( const FILECHAR_t pszDirPath) const
inline

◆ makeFullPath()

cStringF GrayLib::cManifestRoot::makeFullPath ( const FILECHAR_t pszRelativePath) const
inline

◆ makeRelativePath()

cStringF GrayLib::cManifestRoot::makeRelativePath ( const FILECHAR_t pszDirPath) const
inline

Make sure path is relative to the local root.

◆ put_RootDir()

void GrayLib::cManifestRoot::put_RootDir ( cStringF  sRootDir)
inline

◆ ReadSearchForTitle()

HRESULT GrayLib::cManifestRoot::ReadSearchForTitle ( cStringF sPathRet,
const FILECHAR_t pszTitle,
int  iDescendLevels 
) const

We are looking for a file (without ext) in the manifest and below. pszTitle = Name + EXT

Member Data Documentation

◆ k_pszManifestDefault

const FILECHAR_t * GrayLib::cManifestRoot::k_pszManifestDefault = _FN("Manifest.scp")
static

"Manifest.scp"

◆ m_pszManifestFileName

const FILECHAR_t* GrayLib::cManifestRoot::m_pszManifestFileName

"Manifest.scp" // name of the local manifest files. (one per dir)

◆ m_sRootDir

cStringF GrayLib::cManifestRoot::m_sRootDir
protected

full path to the (local system) root directory we are syncing or building manifests for.


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