ConfigFileParser.h

Go to the documentation of this file.

//******************************************************************************
// This file is part of AmpTools, a package for performing Amplitude Analysis
// 
// Copyright Trustees of Indiana University 2010, all rights reserved
// 
// This software written by Matthew Shepherd, Ryan Mitchell, and 
//                  Hrayr Matevosyan at Indiana University, Bloomington
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer. 
// 2. Redistributions in binary form must reproduce the above copyright
//    notice and author attribution, this list of conditions and the
//    following disclaimer in the documentation and/or other materials
//    provided with the distribution.
// 3. Neither the name of the University nor the names of its contributors
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// 
// Creation of derivative forms of this software for commercial
// utilization may be subject to restriction; written permission may be
// obtained from the Trustees of Indiana University.
// 
// INDIANA UNIVERSITY AND THE AUTHORS MAKE NO REPRESENTATIONS OR WARRANTIES, 
// EXPRESS OR IMPLIED.  By way of example, but not limitation, INDIANA 
// UNIVERSITY MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCANTABILITY OR 
// FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THIS SOFTWARE OR 
// DOCUMENTATION WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS, 
// OR OTHER RIGHTS.  Neither Indiana University nor the authors shall be 
// held liable for any liability with respect to any claim by the user or 
// any other party arising from use of the program.
//******************************************************************************


#if !defined(CONFIGFILEPARSER)
#define CONFIGFILEPARSER

#include <utility>
#include <string>
#include <vector>
#include <map>
#include <set>
#include <complex>
#include "IUAmpTools/ConfigurationInfo.h"

using namespace std;

class ConfigFileLine;


class ConfigFileParser
{

  public:

    ConfigFileParser();


    ConfigFileParser(const string& configFile);


    ConfigFileParser(istream& input);


    void readConfigFile(const string& configFile);


    void readConfigFile(istream& input);


    ~ConfigFileParser() {}


    ConfigurationInfo* getConfigurationInfo() {return m_configurationInfo;}


    const vector<ConfigFileLine>& getConfigFileLines() const {return m_configFileLines;}


    void displayConfigFile() const;


    static void setVerboseParsing(bool verboseParsing = false) 
                                    {m_verboseParsing = verboseParsing;}



  private:


      // read from a given file

    vector<ConfigFileLine> readConfigFileLines(const string& configFile) const;


      // read from a stream

    vector<ConfigFileLine> readConfigFileLines(istream& input) const;


      // expand the "include" and "define" statements

    vector<ConfigFileLine> expandConfigFileLines(vector<ConfigFileLine> configFileLines) const;


      // set up the ConfigurationInfo object

    void setupConfigurationInfo();


      // Do checks on the syntax, check keywords, etc.

    void checkSyntax() const;


      // Do the setup for each keyword

    void doFit           (const ConfigFileLine& line);
    void doKeyword       (const ConfigFileLine& line);
    void doReaction      (const ConfigFileLine& line);
    void doParameter     (const ConfigFileLine& line);
    void doData          (const ConfigFileLine& line);
    void doNormInt       (const ConfigFileLine& line);
    void doSum           (const ConfigFileLine& line);
    void doAmplitude     (const ConfigFileLine& line);
    void doInitialize    (const ConfigFileLine& line);
    void doPermute       (const ConfigFileLine& line);
    void doConstrain     (const ConfigFileLine& line);
    void doScale         (const ConfigFileLine& line);


      // Member data

    string                  m_fitName;
    string                  m_configFile;
    set<string>             m_userKeywords;
    static bool             m_verboseParsing;
    vector<ConfigFileLine>  m_configFileLines;
    ConfigurationInfo*      m_configurationInfo;


};


inline istream& operator>>( istream& input, ConfigFileParser& parser ){
  parser.readConfigFile( input );  return input;
}


class ConfigFileLine
{

  public:

    ConfigFileLine(const string& fileName, int lineNumber, const string& line);

    string          line()           const {return m_line;}
    string          fileName()       const {return m_fileName;}
    int             lineNumber()     const {return m_lineNumber;}
    string          keyword()        const {return m_keyword;}
    vector<string>  arguments()      const {return m_arguments;}
    bool            comment()        const {return m_comment;}

    void            printLine()      const {cout << "(" << m_lineNumber << ") " << 
                                                    m_fileName   << " >>   " << 
                                                    m_line       << endl;}

    void            printArguments() const {cout << "KEYWORD:  " << m_keyword << endl;
                                            cout << "ARGUMENTS: " << endl;
                                            for ( unsigned int i = 0; i < m_arguments.size(); i++){
                                              cout << m_arguments[i] << endl;}}

    void            flushDefinition(const string& word, const vector<string>& definition);

  private:

    string          m_line;
    string          m_fileName;
    int             m_lineNumber;
    string          m_keyword;
    vector<string>  m_arguments;
    bool            m_comment;

};


#endif