Config.cxx

Go to the documentation of this file.

// $Id: Config.cxx,v 1.3 2009/01/06 20:41:27 fmwk Exp $
//
//
// messier@indiana.edu
#include "Config/Config.h"
#include <iomanip>
#include <iostream>
#include <sstream>
#include "Config/Param.h"
#include "Config/Table.h"

static bool gsNoEdits        = false;
static bool gsNoDefaultEdits = true;
static bool gsAllEditOK      = false;

//......................................................................

void cfg::Config::SetEditAllOK() { gsAllEditOK = true; }

//......................................................................

cfg::Config::Config(const char* name, 
                    const char* version, 
                    const char* source) : 
  fEditable( true    ),
  fName    ( name    ),
  fVersion ( version ),
  fSource  ( source  )
{ }

//......................................................................

cfg::Config::~Config() { fEditable = true; this->RemoveParam("*"); }

//......................................................................

const char* cfg::Config::GetName() const { return fName.c_str(); }

//......................................................................

const char* cfg::Config::GetVersion() const { return fVersion.c_str(); }

//......................................................................

const char* cfg::Config::GetSource() const { return fSource.c_str(); }

//......................................................................

bool cfg::Config::IsEditable() const { return fEditable; }

//......................................................................

const cfg::Param& cfg::Config::operator()(const char* pname) const 
{
//======================================================================
// Allows read-only access to parameters
//======================================================================
  cfg::Config::ParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    throw cfg::Exception(cfg::Exception::kParamNotFound,
                         pname, 
                         __FILE__,
                         __LINE__);
  }
  return (*itr->second);
}

//......................................................................

const cfg::Param& cfg::Config::operator()(const std::string& pname) const
{
//======================================================================
// Allows read-only access to parameters
//======================================================================
  cfg::Config::ParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw cfg::Exception(cfg::Exception::kParamNotFound,
                         os.str().c_str(),
                         __FILE__,
                         __LINE__);
  }
  return (*itr->second);
}

//......................................................................

cfg::Param& cfg::Config::Par(const char* pname) 
{
//======================================================================
// Allows non-const access to parameters
//======================================================================
  this->EditOK();
  std::string p(pname);
  cfg::Config::ParamMap::iterator itr = fParam.find(p);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw cfg::Exception(cfg::Exception::kParamNotFound,
                         os.str().c_str(),
                         __FILE__,
                         __LINE__);
  }
  return (*itr->second);
}

//......................................................................

cfg::Param& cfg::Config::Par(const std::string& pname)
{
//======================================================================
// Allows non-const access to parameters
//======================================================================
  this->EditOK();
  cfg::Config::ParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw cfg::Exception(cfg::Exception::kParamNotFound,
                         os.str().c_str(),
                         __FILE__,
                         __LINE__);
  }
  return (*itr->second);
}

//......................................................................

bool cfg::Config::EditOK() const 
{
//======================================================================
// Check if it is OK to edit this configuration. Throws exception is
// edit is not allowed
//======================================================================
  if (gsAllEditOK) return true;
  if (fEditable==false) {
    std::ostringstream os;
    os << "Attempt to get read access to read-only config "
       << "." << this->GetVersion();
    throw cfg::Exception(cfg::Exception::kConfigRO,
                         os.str().c_str(),
                         __FILE__,
                         __LINE__);
  }
  return fEditable;
}

//......................................................................

void cfg::Config::SetReadOnly(int flag) 
{
//======================================================================
// Set the read-only status for this configuration.
//   flag =  0 - allow read/write access
//   flag =  1 - read only access
//   flag = -1 - determine read/write accees based on R/W policies for
//               configurations
//======================================================================
  if (flag == 1 && fEditable == false) return; // RO already
  
  // First make sure we are allowed to change the state. Once set read
  // only the configuration is always read only
  this->EditOK();

  if (flag ==  0) { fEditable = true;  return; } // RW
  if (flag ==  1) { fEditable = false; return; } // RO

  // Apply policy to determine RW status
  
  // Edits turned off globally
  if (gsNoEdits == true) { fEditable = false; return; } // RO
  
  // Edits turned off globally for default configurations
  if ( (gsNoDefaultEdits == true) && (this->fVersion == "default") ) {
    fEditable = false; // RO
    return;
  }
  
  // Edit allowed
  fEditable = true; // RW
}

//......................................................................

void cfg::Config::SetSource(const char* filename) { fSource = filename; }

//......................................................................

void cfg::Config::AdoptParam(cfg::Param* p) 
{
//======================================================================
// Insert the parameter p into a configuration. If the parameter
// already exists in the configuration then replace it. Ownership of
// the parameter stored at p is transferred to the configuration.
//======================================================================
  this->EditOK();
  
  std::string s = p->GetName();
  
  // Check the parameter set for one of this name. If one is found
  // replace it
  cfg::Param* param = fParam[s];
  if (param==0) delete param;
  
  fParam[s] = p;
}

//......................................................................

void cfg::Config::RemoveParam(const char* which) 
{
//======================================================================
// Remove a selected parameter from the configuration. "*" removes all
// parameters
//======================================================================
  this->EditOK();

  std::string s(which);
  // If which is "*" remove all parameters
  if (s=="*") {
    cfg::Config::ParamMap::iterator    itr(fParam.begin());
    cfg::Config::ParamMap::iterator itrEnd(fParam.end());
    for (; itr!=itrEnd; ++itr) {
      if (itr->second) { delete itr->second; itr->second = 0; }
    }
    return;
  }
  
  // Otherwise just remove the named set
  cfg::Param* param = fParam[s];
  if (param==0) { delete param; fParam[s] = 0; }
}

//......................................................................

void cfg::Config::Copy(cfg::Config& dest, 
                       const cfg::Config& src,
                       const char* destVersion,
                       const char* destSource) 
{
//======================================================================
// Copy one configuration to another
//   dest - configuration to copy to
//   src  - configuration to copy from
//   destVersion - version tag appied to dest (default appends '.copy')
//   destSource  - source tag appied to dest (default appends '(copy)' )
//======================================================================
  dest.EditOK();

  dest.fName = src.fName;
  if (destVersion==0) { 
    dest.fVersion  = src.fVersion;
    dest.fVersion += ".copy";
  }
  else {
    dest.fVersion = destVersion;
  }
  if (destSource==0) {
    dest.fSource  = src.fSource;
    dest.fSource += "(copy)";
  }
  else {
    dest.fSource = destSource;
  }

  // Wipe the parameter map clean and build a new one using the cfg::Param
  // copy constructor on each element in the source map
  dest.RemoveParam("*");
  cfg::Config::ParamMap::const_iterator    itr(src.fParam.begin());
  cfg::Config::ParamMap::const_iterator itrEnd(src.fParam.end());
  for (; itr!=itrEnd; ++itr) {
    cfg::Param* p = new cfg::Param(*itr->second);
    dest.AdoptParam(p);
  }
}

//......................................................................

std::string cfg::Config::AsXML() const 
{
  // I'm not too excited about the need for "setprecision(8)" below,
  // but without it you seem to either lose precision with doubles and
  // floats or to gain bogus digits. The number 8 is fairly fine tuned
  // which is why I'm not excited -- I'd rather have something more
  // robust. Such is life I suppose.
  std::ostringstream xml;
  xml << "<config name=\"" << this->fName 
      << "\" version=\"" << this->fVersion << "\">\n";
  ParamMap::const_iterator itr(fParam.begin());
  ParamMap::const_iterator itrEnd(fParam.end());
  for (; itr!=itrEnd; ++itr) {
    const cfg::Param* p = itr->second;
    xml << "  <param name=\"" << p->GetName() << "\">\n"
        << "    <" << p->XMLTag() << "> "
        << std::setprecision(8) << (*p)
        << " </" << p->XMLTag() << ">\n";
    xml << "    " << p->GetComment() << "\n";
    xml << "  </param>\n";
  }
  xml << "</config>\n";
  return xml.str();
}

---