The ReadWritePages class allow to handle a file of option containing pages. More...

#include <STK_ReadWritePages.h>

Public Member Functions
	ReadWritePages (std::string const &file_name=std::string())
	default constructor.

virtual	~ReadWritePages ()
	Destructor.

IPage const *	p_page (int const &pos) const
	get a constant page of option.

IPage *	p_page (int const &pos)
	get a page of option.

IPage const *	p_page (String const &name) const
	constant bookkeeping function.

IPage *	p_page (String const &name)
	bookkeeping function.

IPage const *	operator[] (int const &pos) const
	get a constant page of option.

IPage *	operator[] (int const &pos)
	get a page of option.

void	addPage (IPage const &page)
	Add a page of option to read and/or write.

bool	write (std::string const &file_name=std::string()) const
	Attempts to write the ReadWritePage to the location specified by file_name.

bool	write (ostream &os) const
	Attempts to write the ReadWritePage to the specified output stream.

bool	read (std::string const &file_name=std::string())
	Attempts to read the specified file.

bool	read (istream &is)
	Attempts to read the pages from an input stream.

bool	validate ()
	validate all the pages.

String const &	error () const
	give the last error message encountered

Protected Attributes
ContPage	pages_
	The list of page to read and/or write.

stringstream	buffer_
	the string buffer containing the file with all the options.

std::string	file_name_
	Name of the Current file to read/write.

String	msg_error_
	The last error message.

Private Types
typedef std::vector< IPage * >	ContPage
	type of the container for the pages.

Detailed Description

The ReadWritePages class allow to handle a file of option containing pages.

See also: IPage.

A file of pages of option have the form

 # My favorites
[Favorites]
computer = fruit
color = vaguely grey
 
  [[softwares]]
  os  = linux    # error else ?
  ide = eclipse
 
# My personal informations
[Personal]
age = 40
weight = 75.5
measures = 60, 90, 60 # A list is separated with commas

The 'Favorites' page has a 'softwares' subpage. Pages are indicated using the page name in square brackets. Subpage are made by increasing the number of matching square brackets around the page name.

Note that the whitespace are not significants in this example, but as with code indentation visually shows the structure of the information.

Comments can be added using the symbol '#'. All remaining character on the same line are ignored.

Definition at line 77 of file STK_ReadWritePages.h.

Member Typedef Documentation

◆ ContPage

typedef std::vector<IPage*> STK::ReadWritePages::ContPage

private

type of the container for the pages.

Definition at line 81 of file STK_ReadWritePages.h.

Constructor & Destructor Documentation

◆ ReadWritePages()

STK::ReadWritePages::ReadWritePages ( std::string const & file_name = std::string() )

default constructor.

Instantiates an instance of ReadWritePage and reads the specified file.

Parameters

file_name name of the file to read/write

Definition at line 42 of file STK_ReadWritePages.cpp.

                              : file_name_(file_name)
                              , msg_error_("")
{ }

◆ ~ReadWritePages()

STK::ReadWritePages::~ReadWritePages ( )

virtual

Destructor.

Definition at line 47 of file STK_ReadWritePages.cpp.

{
  // delete all pages
  for (ContPage::size_type it = 0; it < pages_.size(); it++)
  {
    delete pages_[it];
  }
}

References pages_.

Member Function Documentation

◆ addPage()

void STK::ReadWritePages::addPage ( IPage const & page )

Add a page of option to read and/or write.

Parameters

page	the page of option to add

Definition at line 59 of file STK_ReadWritePages.cpp.

60{ pages_.push_back(page.clone());}

References pages_.

◆ error()

String const & STK::ReadWritePages::error ( ) const

inline

give the last error message encountered

Returns: the last message error encountered

Definition at line 171 of file STK_ReadWritePages.h.

171{ return msg_error_;}

References msg_error_.

◆ operator[]() [1/2]

IPage * STK::ReadWritePages::operator[] ( int const & pos )

inline

get a page of option.

Parameters

pos	the position of the page of option

Returns: the page at the position pos

Definition at line 130 of file STK_ReadWritePages.h.

131 { return pages_.at(ContPage::size_type(pos));}

References pages_.

◆ operator[]() [2/2]

IPage const * STK::ReadWritePages::operator[] ( int const & pos ) const

inline

get a constant page of option.

Parameters

pos	the position of the page of option

Returns: the page at the position pos

Definition at line 123 of file STK_ReadWritePages.h.

124 { return pages_.at(ContPage::size_type(pos));}

References pages_.

◆ p_page() [1/4]

IPage * STK::ReadWritePages::p_page ( int const & pos )

inline

get a page of option.

Parameters

pos	the position of the page of option

Returns: the page at the position pos

Definition at line 104 of file STK_ReadWritePages.h.

105 { return pages_.at(ContPage::size_type(pos));}

References pages_.

◆ p_page() [2/4]

IPage const * STK::ReadWritePages::p_page ( int const & pos ) const

inline

get a constant page of option.

Parameters

pos	the position of the page of option

Returns: the page at the position pos

Definition at line 97 of file STK_ReadWritePages.h.

98 { return pages_.at(ContPage::size_type(pos));}

References pages_.

◆ p_page() [3/4]

IPage * STK::ReadWritePages::p_page ( String const & name )

bookkeeping function.

Find a page given its name

Parameters

name	name of the Page to find

Returns: NULL if the variable is not found, the page otherwise

Definition at line 194 of file STK_ReadWritePages.cpp.

{
  String Uname = toUpperString(name);
  // read all pages
  for (ContPage::iterator it = pages_.begin(); it != pages_.end(); it++)
  {
    // read curent page
    if ((*it)->name() == Uname) return *it;
  }
  // return null pointer
  return 0;
}

References pages_, and STK::toUpperString().

◆ p_page() [4/4]

IPage const * STK::ReadWritePages::p_page ( String const & name ) const

constant bookkeeping function.

Parameters

name	name of the Page to find

Returns: NULL if the variable is not found, the page otherwise

Definition at line 177 of file STK_ReadWritePages.cpp.

{
  String Uname = toUpperString(name);
  // read all pages
  for (ContPage::const_iterator it = pages_.begin(); it != pages_.end(); it++)
  {
    // read curent page
    if ((*it)->name() == Uname) return *it;
  }
  // return null pointer
  return 0;
}

References pages_, and STK::toUpperString().

◆ read() [1/2]

bool STK::ReadWritePages::read ( istream & is )

Attempts to read the pages from an input stream.

Parameters

is	name of the input stream to read

Returns: true if successful, false if an error is encountered.

Definition at line 141 of file STK_ReadWritePages.cpp.

{
  try
  {
    // read all pages
    for (ContPage::iterator it = pages_.begin(); it != pages_.end(); it++)
    {
      // go to the beginning of the stream
      is.seekg(0, ios::beg);
      // read curent page
      (*it)->read(is);
    }
    validate();
    // no error catch
    return true;
  }
  catch(const Exception& e)
  { msg_error_ = e.error();}
  return false;
}

References STK::IRunnerBase::error(), msg_error_, pages_, and validate().

◆ read() [2/2]

bool STK::ReadWritePages::read ( std::string const & file_name = std::string() )

Attempts to read the specified file.

Parameters

file_name name of the file to read

Returns: true if successful, false if an error is encountered.

Definition at line 110 of file STK_ReadWritePages.cpp.

{
  // save file_name
  if (!file_name.empty()) file_name_  = file_name;
  try
  {
    // try to open the file
    ifstream is(file_name_.c_str());
    if (!is.is_open())
    {
      msg_error_ = "In ReadWritePages::read(" + file_name
                 + "). Could not open file.";
      return false;
    }
    // copy integrally the file in the buffer
    buffer_ << is.rdbuf();
    // close file
    is.close();
    // read buffer
    return read(buffer_);
  }
  catch(const Exception& e)
  { msg_error_ = e.error(); }
  return false;
}

References buffer_, STK::IRunnerBase::error(), file_name_, msg_error_, and read().

Referenced by read().

◆ validate()

bool STK::ReadWritePages::validate ( )

validate all the pages.

return true if all the page are validated, false otherwise.

Definition at line 162 of file STK_ReadWritePages.cpp.

{
  // read all pages
  for (ContPage::iterator it = pages_.begin(); it != pages_.end(); it++)
  {
    // the method valdite should throw an Exception
    (*it)->validate();
  }
  return true;
}

References pages_.

Referenced by read().

◆ write() [1/2]

bool STK::ReadWritePages::write ( ostream & os ) const

Attempts to write the ReadWritePage to the specified output stream.

Parameters

os	name of output stream to write

Returns: true if successful, false if an error is encountered.

Definition at line 92 of file STK_ReadWritePages.cpp.

{
  try
  {
    // Write all pages
    for (ContPage::const_iterator it = pages_.begin(); it != pages_.end(); it++)
    { (*it)->write(os);}
    return true;
  }
  catch(const Exception& e)
  { msg_error_ = e.error();}
  return false;
}

References STK::IRunnerBase::error(), msg_error_, and pages_.

◆ write() [2/2]

bool STK::ReadWritePages::write ( std::string const & file_name = std::string() ) const

Attempts to write the ReadWritePage to the location specified by file_name.

Parameters

file_name name of the file to write

Returns: true if successful, false if an error is encountered.

Definition at line 67 of file STK_ReadWritePages.cpp.

{
  // save file_name
  if (!file_name.empty()) file_name_  = file_name;
  try
  {
    ofstream os(file_name.c_str());
    if (os.fail())
    {
      msg_error_ = "In ReadWritePages::write(" + file_name
                 + "). Could not open file.";
      return false;
    }
    return write(os);
  }
  catch(const Exception& e)
  { msg_error_ = e.error(); }
  return false;
}

References STK::IRunnerBase::error(), file_name_, msg_error_, and write().

Referenced by write().

Member Data Documentation

◆ buffer_

stringstream STK::ReadWritePages::buffer_

protected

the string buffer containing the file with all the options.

Definition at line 177 of file STK_ReadWritePages.h.

Referenced by read().

◆ file_name_

std::string STK::ReadWritePages::file_name_

mutableprotected

Name of the Current file to read/write.

Definition at line 179 of file STK_ReadWritePages.h.

Referenced by read(), and write().

◆ msg_error_

String STK::ReadWritePages::msg_error_

mutableprotected

The last error message.

Definition at line 181 of file STK_ReadWritePages.h.

Referenced by error(), read(), read(), write(), and write().

◆ pages_

ContPage STK::ReadWritePages::pages_

protected

The list of page to read and/or write.

Definition at line 175 of file STK_ReadWritePages.h.

Referenced by addPage(), operator[](), operator[](), p_page(), p_page(), p_page(), p_page(), read(), validate(), write(), and ~ReadWritePages().

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

Public Member Functions

Protected Attributes

Private Types

Detailed Description

Member Typedef Documentation

◆ ContPage

Constructor & Destructor Documentation

◆ ReadWritePages()

◆ ~ReadWritePages()

Member Function Documentation

◆ addPage()

◆ error()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ p_page() [1/4]

◆ p_page() [2/4]

◆ p_page() [3/4]

◆ p_page() [4/4]

◆ read() [1/2]

◆ read() [2/2]

◆ validate()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ buffer_

◆ file_name_

◆ msg_error_

◆ pages_