a DiskList implementation for local directories More...

#include <DiskListLocal.h>

Inheritance diagram for SH::DiskListLocal:

Collaboration diagram for SH::DiskListLocal:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
	DiskListLocal (const std::string &val_dir)
	make the listing for the given directory
	DiskListLocal (const std::string &val_dir, const std::string &val_prefix)
	make the listing for the given directory, but replacing the directory with prefix for the path
virtual	~DiskListLocal ()
	standard destructor
bool	next ()
	get the next list entry
std::string	path () const
	the path for the current entry.
std::string	fileName () const
	the filename for the current entry
DiskList *	openDir () const
	make a new list object for the sub-directory
std::string	dirname () const
	the base path for the directory listed

Protected Member Functions
virtual bool	getNext ()
	get the next list entry
virtual std::string	getPath () const
	the path for the current entry.
virtual DiskList *	doOpenDir () const
	make a new list object for the sub-directory
virtual std::string	getDirname () const
	the base path for the directory listed

Private Types
enum	State { S_BLANK , S_VALID , S_DONE , S_BROKEN }
	the current state More...

Private Attributes
std::string	m_dir
	the directory we are reading
std::string	m_prefix
	the directory from with to read actual files
void *	m_dirp
	the directory pointer used
std::string	m_file
	the file we last fetched
State	m_state
	the current state

Detailed Description

a DiskList implementation for local directories

Definition at line 26 of file DiskListLocal.h.

Member Enumeration Documentation

◆ State

enum SH::DiskList::State

privateinherited

the current state

Enumerator
S_BLANK	just initialized
S_VALID	holding a valid entry
S_DONE	finished reading entries
S_BROKEN	an error occured

Definition at line 166 of file DiskList.h.

    {
      S_BLANK,  
      S_VALID,  
      S_DONE,   
      S_BROKEN  
    };

Constructor & Destructor Documentation

◆ DiskListLocal() [1/2]

SH::DiskListLocal::DiskListLocal ( const std::string & val_dir )

make the listing for the given directory

Parameters

val_dir the directory to list

Guarantee: strong

Failures: out of memory II

Definition at line 38 of file DiskListLocal.cxx.

    : m_dir (val_dir), m_prefix (val_dir), m_dirp (0)
  {
    RCU_NEW_INVARIANT (this);
  }

◆ DiskListLocal() [2/2]

SH::DiskListLocal::DiskListLocal	(	const std::string &	val_dir,
		const std::string &	val_prefix )

make the listing for the given directory, but replacing the directory with prefix for the path

Parameters

val_dir	the directory to list
val_prefix	the prefix with which val_dir will be replaced in the reported paths

Guarantee: strong

Failures: out of memory II

Rationale: this mechanism is meant to allow scanning file servers using one protocol, but then accessing them using another

Definition at line 47 of file DiskListLocal.cxx.

    : m_dir (val_dir), m_prefix (val_prefix), m_dirp (0)
  {
    RCU_NEW_INVARIANT (this);
  }

◆ ~DiskListLocal()

SH::DiskListLocal::~DiskListLocal ( )

virtual

standard destructor

Guarantee: no-fail

Definition at line 56 of file DiskListLocal.cxx.

  {
    RCU_DESTROY_INVARIANT (this);
 
    if (m_dirp)
    {
      gSystem->FreeDirectory (m_dirp);
      m_dirp = 0;
    }
  }

Member Function Documentation

◆ dirname()

std::string SH::DiskList::dirname ( ) const

inherited

the base path for the directory listed

Guarantee: strong

Failures: out of memory II

Definition at line 110 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    return getDirname ();
  }

◆ doOpenDir()

DiskList * SH::DiskListLocal::doOpenDir ( ) const

protectedvirtual

make a new list object for the sub-directory

Returns: a new list object for the sub-directory, or NULL if it is not a directory

Precondition: (soft) next() has been called successfully

Guarantee: strong

Failures: out of memory III

Rationale: the virtual part of DiskList::openDir()

Implements SH::DiskList.

Definition at line 109 of file DiskListLocal.cxx.

  {
    RCU_READ_INVARIANT (this);
 
    std::unique_ptr<DiskListLocal> result
      (new DiskListLocal (m_dir + "/" + m_file, m_prefix + "/" + m_file));
    result->m_dirp = gSystem->OpenDirectory (result->m_dir.c_str());
    if (result->m_dirp)
      return result.release();
    return 0;
  }

◆ fileName()

std::string SH::DiskList::fileName ( ) const

inherited

the filename for the current entry

Returns: the filename for the current entry

Precondition: (soft) next() has been called successfully

Guarantee: strong

Failures: out of memory III

Definition at line 87 of file DiskList.cxx.

  {
    // no invariant used
    std::string result = path();
    std::string::size_type split = result.rfind ('/');
    if (split != std::string::npos)
      result = result.substr (split + 1);
    return result;
  }

◆ getDirname()

std::string SH::DiskListLocal::getDirname ( ) const

protectedvirtual

the base path for the directory listed

Guarantee: strong

Failures: out of memory II

Rationale: the virtual part of DiskList::dirname()

Implements SH::DiskList.

Definition at line 124 of file DiskListLocal.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_dir;
  }

◆ getNext()

bool SH::DiskListLocal::getNext ( )

protectedvirtual

get the next list entry

Returns: whether we found another entry

Guarantee: basic

Failures: i/o errors

Rationale: the virtual part of DiskList::next()

Implements SH::DiskList.

Definition at line 70 of file DiskListLocal.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
 
    if (!m_dirp)
    {
      m_dirp = gSystem->OpenDirectory (m_dir.c_str());
      if (!m_dirp)
    RCU_THROW_MSG ("could not open directory " + m_dir);
    }
 
    const char *subresult = 0;
    do
    {
      subresult = gSystem->GetDirEntry (m_dirp);
      if (subresult == 0)
      {
    gSystem->FreeDirectory (m_dirp);
    m_dirp = 0;
    m_file.clear ();
    return false;
      }
    } while (strcmp (subresult, ".") == 0 || strcmp (subresult, "..") == 0);
    m_file = subresult;
    return subresult;
  }

◆ getPath()

std::string SH::DiskListLocal::getPath ( ) const

protectedvirtual

the path for the current entry.

Returns: the path for the current entry

Precondition: (soft) next() has been called successfully

Guarantee: strong failures: out of memory III

Rationale: the virtual part of DiskList::path()

Implements SH::DiskList.

Definition at line 100 of file DiskListLocal.cxx.

  {
    RCU_READ_INVARIANT (this);
    return m_prefix + "/" + m_file;
  }

◆ next()

bool SH::DiskList::next ( )

inherited

get the next list entry

Returns: whether we found another entry

Guarantee: basic

Failures: i/o errors

Definition at line 53 of file DiskList.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    switch (m_state)
    {
    case S_BLANK:
    case S_VALID:
      m_state = S_BROKEN;
      if (getNext())
    m_state = S_VALID;
      else
    m_state = S_DONE;
      return m_state == S_VALID;
    case S_DONE:
      RCU_THROW_MSG ("already finished processing list");
    case S_BROKEN:
      RCU_THROW_MSG ("list is in error state");
    };
    return false; // compiler dummy
  }

◆ openDir()

DiskList * SH::DiskList::openDir ( ) const

inherited

make a new list object for the sub-directory

Returns: a new list object for the sub-directory, or NULL if it is not a directory

Precondition: (soft) next() has been called successfully

Guarantee: strong

Failures: out of memory III

Definition at line 100 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_state == S_VALID, "getNext() has not been called successfully");
    return doOpenDir();
  }

◆ path()

std::string SH::DiskList::path ( ) const

inherited

the path for the current entry.

Returns: the path for the current entry

Precondition: (soft) next() has been called successfully

Guarantee: strong failures: out of memory III

Definition at line 77 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_state == S_VALID, "getNext() has not been called successfully");
    return getPath();
  }

◆ testInvariant()

void SH::DiskListLocal::testInvariant ( ) const

test the invariant of this object

Guarantee: no-fail

Definition at line 31 of file DiskListLocal.cxx.

33 {

34 }

Member Data Documentation

◆ m_dir

std::string SH::DiskListLocal::m_dir

private

the directory we are reading

Definition at line 109 of file DiskListLocal.h.

◆ m_dirp

void* SH::DiskListLocal::m_dirp

private

the directory pointer used

Definition at line 117 of file DiskListLocal.h.

◆ m_file

std::string SH::DiskListLocal::m_file

private

the file we last fetched

Definition at line 121 of file DiskListLocal.h.

◆ m_prefix

std::string SH::DiskListLocal::m_prefix

private

the directory from with to read actual files

Definition at line 113 of file DiskListLocal.h.

◆ m_state

State SH::DiskList::m_state

privateinherited

the current state

Definition at line 174 of file DiskList.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ DiskListLocal() [1/2]

◆ DiskListLocal() [2/2]

◆ ~DiskListLocal()

Member Function Documentation

◆ dirname()

◆ doOpenDir()

◆ fileName()

◆ getDirname()

◆ getNext()

◆ getPath()

◆ next()

◆ openDir()

◆ path()

◆ testInvariant()

Member Data Documentation

◆ m_dir

◆ m_dirp

◆ m_file

◆ m_prefix

◆ m_state