DbmCmdOptions.cxx

Go to the documentation of this file.

#include <cstring>
// DbmCmdOptions                                                     //
//                                                                    //
// Package: Dbm (Database Maintenance).                               //
//                                                                    //
// N. West 12/2001                                                    //
//                                                                    //
// Concept: Collection of command options.                            //
//                                                                    //
// Purpose: To simplify command option processing; options come both  //
//          from user and DbmLogFile.                                 //
//                                                                    //

#include <cstdlib>
#include <cstring>

#include "DatabaseMaintenance/DbmCmdOptions.h"
#include "JobControl/JobCommand.h" 
#include "LeakChecker/Lea.h"
#include "Util/UtilString.h"
#include "MessageService/MsgService.h"

using namespace std;

ClassImp(DbmCmdOptions)


//   Definition of static data members
//   *********************************

CVSID("$Id: DbmCmdOptions.cxx,v 1.7 2009/02/28 21:46:12 gmieg Exp $");

// Definition of member functions (alphabetical order)
// ***************************************************


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

DbmCmdOptions::DbmCmdOptions(const string& validOpts,
                             JobCommand* jcmd,
                             const std::list<std::string>* defaultOpts) :
fIsValid(kTRUE),
fValidOpts(":")
{
//
//
//  Purpose:  Default constructor
//
//  Arguments:
//    validOpts    in    Option list of colon separated valid options
//                       e.g."--Since:--File".  Default = "".
//    jcmd         in    JobCommand to process. Optional, default = 0.
//    defaultOpts  in    Ordered list of default options.
//                       If none supplied, use --Table --File (see 
//                       ProcessCmd).
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Create a DbmCmdOptions.


//  Program Notes:-
//  =============

//  None.

  LEA_CTOR    //Leak Checker

  MSG("Dbm", Msg::kVerbose) << "Creating DbmCmdOptions" << endl;
  
//  Add leading and trailing colons to simplify searching.
  fValidOpts += validOpts;
  fValidOpts += ':';
  if ( jcmd ) ProcessCmd( *jcmd, defaultOpts );

}

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

DbmCmdOptions::~DbmCmdOptions() {
//
//
//  Purpose: Destructor
//
//  Arguments: 
//    None.
//
//  Return:    n/a
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Destroy DbmCmdOptions.


//  Program Notes:-
//  =============

//  None.

  LEA_DTOR    //Leak Checker

  MSG("Dbm", Msg::kVerbose) << "Destroying DbmCmdOptions" << endl;

}

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

Bool_t DbmCmdOptions::AddOpt(const string& opt, JobCommand& jcmd) {
//
//
//  Purpose:  Add option, plus associated value, if valid.
//
//  Arguments: 
//    opt          in    Option to be stored.
//    jcmd         in    JobCommand holding option value, if any.
//                 out   Option removed, if any.
//
//  Return:   kTRUE if option permitted 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Add option plus associated value if valid.  If no associated
//    value, stored "yes".

//  Program Notes:-
//  =============

//  None.


//  Collect option if any.
  string val("yes");
  Bool_t hasOpt = kFALSE;

  if ( opt == "--Date"           ) hasOpt = kTRUE;
  if ( opt == "--DatabaseNumber" ) hasOpt = kTRUE;
  if ( opt == "--Detector"       ) hasOpt = kTRUE;
  if ( opt == "--File"           ) hasOpt = kTRUE;
  if ( opt == "--LogFile"        ) hasOpt = kTRUE;
  if ( opt == "--NumSeqNo"       ) hasOpt = kTRUE;
  if ( opt == "--Reason"         ) hasOpt = kTRUE;
  if ( opt == "--SimFlag"        ) hasOpt = kTRUE;
  if ( opt == "--SeqNo"          ) hasOpt = kTRUE;
  if ( opt == "--SeqNoMin"       ) hasOpt = kTRUE;
  if ( opt == "--SeqNoMax"       ) hasOpt = kTRUE;
  if ( opt == "--Since"          ) hasOpt = kTRUE;
  if ( opt == "--Table"          ) hasOpt = kTRUE;
  if ( opt == "--Task"           ) hasOpt = kTRUE;
  if ( opt == "--UpdateTime"     ) hasOpt = kTRUE;

  if ( hasOpt ) {
    const char* valPtr = jcmd.PopOpt();
    if ( ! valPtr) {
      MSG("Dbm",Msg::kError) << "Option " << opt 
                             << " must be followed by a value" << endl;
      fIsValid = kFALSE;
      return kFALSE;
    }
  else val = valPtr;
  }
  return AddOpt(opt,val);
}
Bool_t DbmCmdOptions::AddOpt(const string& opt, const string& val) {
//
//
//  Purpose:  Add option, plus associated value, if valid.
//
//  Arguments: 
//    opt          in    Option to be stored.
//    jcmd         in    JobCommand holding option value, if any.
//                 out   Option removed, if any.
//
//  Return:   kTRUE if option permitted 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Add option plus associated value if valid. 

//  Program Notes:-
//  =============

//  None.

// Store if valid.
  if ( ! IsValid( opt ) ) {
    MSG("Dbm",Msg::kError) << "Option " << opt 
                           << " not allowed for this command" << endl;
    fIsValid = kFALSE;
    return kFALSE;
  }
  if ( TestOpt(opt) 
     ) MSG("Dbm",Msg::kWarning) << "Option " << opt 
                                << " has been duplicated" << endl;
  fOptsMap[opt] = val;
  return fIsValid;

}
//.....................................................................

void DbmCmdOptions::GetOptIntList(const std::string& opt, std::list<int>& nos) const {
//
//
//  Purpose:  Parse and return a comma separated list.
//
//  Arguments: 
//    opt          in    The option whose value is the comma separated list.
//    nos          in    The initial list
//                 out   Updated to include the list of numbers.
//                       If any error, the list will be cleared to zero 
//                        (including anything that pre-existed the call to this function).
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Treat option value associated with supplied option as a comma separated
//    list of integers and stored them in the supplied list.

  string optValue = this->GetOptString(opt);
  bool fail = (opt == "no");

  if ( ! fail ) {
    std::vector<std::string> ls;
    UtilString::StringTok(ls,optValue,",");
    if ( ls.size() == 0 ) fail = true;
    else {
      std::vector<std::string>::iterator    itr = ls.begin();
      std::vector<std::string>::iterator itrEnd = ls.end();
      while ( itr != itrEnd ) {
        if ( UtilString::IsInt(itr->c_str()) ) nos.push_back(atoi(itr->c_str()));
        else fail = true;
        ++itr;
      }
    }
  }

  if ( fail ) nos.clear();

}

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

Int_t DbmCmdOptions::GetOptInt(const string& opt) const {
//
//
//  Purpose:  Return associated option value as an integer
//
//  Arguments: 
//    opt          in    Option whose value is to be returned.
//
//  Return:    0 if option not currently stored
//             otherwise the option value or 1 if none.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Return associated option value as an integer.

  string value = this->GetOptString(opt);
  if ( opt == "no"  ) return 0;
  if ( opt == "yes" ) return 1;
  return atoi(value.c_str());


}

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

string DbmCmdOptions::GetOptString(const string& opt) const {
//
//
//  Purpose:  Return associated option value as a string.
//
//  Arguments: 
//    opt          in    Option whose value is to be returned.
//
//  Return:    "no" if option not currently stored
//             otherwise the option value or "yes" if none.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o  Return associated option value as a string.

//  Program Notes:-
//  =============

//  As we are careful to check that key exists before using
//  the non-const operator[], its O.K. to cast away const.

  DbmCmdOptions* me = const_cast<DbmCmdOptions*>(this);
  return TestOpt(opt) ? me->fOptsMap[opt] : "no";

}
//.....................................................................

string DbmCmdOptions::GetOpts() const {
//
//
//  Purpose:  Return string containing all options.
//
//  Arguments: None.
//
//  Return:  String containing all options.  
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return string containing all options.

//  Program Notes:-
//  =============

//  None.

  string opts;
  for ( map<string,string>::const_iterator itr = fOptsMap.begin();
        itr != fOptsMap.end();
        ++itr ) {
    opts += (*itr).first + " " + (*itr).second + " ";
  }
  return opts;

}
Bool_t DbmCmdOptions::IsValid(const string& opt) const {
//
//
//  Purpose:  Test to see if option is valid.
//
//  Arguments: 
//    opt          in    Option to be tested.
//
//  Return:   kTRUE if option permitted 
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Test to see if option is valid.

//  Program Notes:-
//  =============

//  None.

// Look up option is valid list.
  string optStr(":");
  optStr += opt;
  optStr += ':';
  return  fValidOpts.find(optStr) != string::npos;

}

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

Bool_t DbmCmdOptions::ProcessCmd(JobCommand& jcmd,
                                 const std::list<std::string>* defaultOpts) {
//
//
//  Purpose:  Process JobCommand storing all options.
//
//  Arguments: 
//    jcmd         in    JobCommand to be processed.
//                 out   Exhausted JobCommand.
//    defaultOpts  in    Ordered list of default options.
//                       If none supplied, use --Table --File
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Process JobCommand storing all options.
//  
//  o Supply default options to the first  parameters 
//    i.e. options that do not start "-" and are permitted.


//  Program Notes:-
//  =============

//  None.

  // Provide a default for the default!
  std::list<std::string> defDefOPts;
  defDefOPts.push_back("--Table");
  defDefOPts.push_back("--File");

  if ( defaultOpts == 0 ) defaultOpts = &defDefOPts;
  
  std::list<std::string>::const_iterator 
          defOptsItr    = defaultOpts->begin();
  std::list<std::string>::const_iterator 
          defOptsItrEnd = defaultOpts->end();

  const char* opt = jcmd.PopOpt();
  while (opt) {

//  Deal with option.
    if ( opt[0] == '-' ) {

      string option = opt;
      AddOpt(opt, jcmd);
    }
 
// Deal with parameter.
   else {

     // Pick up next default option, if any.
     std::string defaultOpt = "";
     if ( defOptsItr != defOptsItrEnd ) {
       defaultOpt = *defOptsItr;
       ++defOptsItr;
     }

     // Permit default if defined, not yet used and is valid.
      if (  defaultOpt != "" && ! TestOpt(defaultOpt) && IsValid(defaultOpt) 
          ) AddOpt(defaultOpt, opt);

      else {
        MSG("Dbm",Msg::kWarning) << "Unknown parameter " << opt << endl;
        fIsValid = kFALSE;
      }
    }

    opt = jcmd.PopOpt(); 
  }   // loop over options

  return fIsValid;

}

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

Bool_t DbmCmdOptions::TestOpt(const string& opt) const {
//
//
//  Purpose:  Test existence of option.
//
//  Arguments: 
//    opt          in    Option whose value is to be tested.
//
//  Return:    kTRUE if option exists, otherwise kFALSE.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Test existence of option.

//  Program Notes:-
//  =============

//  None.

  map<string,string>::const_iterator loc = fOptsMap.find(opt);
  return loc != fOptsMap.end();

}

/*    Template for New Member Function

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

DbmCmdOptions:: {
//
//
//  Purpose:  
//
//  Arguments: 
//    xxxxxxxxx    in    yyyyyy
//
//  Return:    
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o 

//  Program Notes:-
//  =============

//  None.


}

*/

---