ParserUtils.h

Go to the documentation of this file.

// $Id: ParserUtils.h,v 1.7 2007/09/25 08:02:11 marcocle Exp $
// ============================================================================
// CVS tag $Name:  $ 
// ============================================================================
#ifndef JOBOPTIONSSVC_PARSERUTILS_H 
#define JOBOPTIONSSVC_PARSERUTILS_H 1
// ============================================================================
// Include files
// ============================================================================
// STD & STL 
// ============================================================================
#include <string>
#include <vector>
#include <map>
#include <iostream>
// ============================================================================
// local
// ============================================================================
#include "Catalogue.h"
#include "Position.h"
// ============================================================================

// ============================================================================

namespace Gaudi
{
  namespace Parsers 
  {
    class Message 
    {
    public:
      enum Severity
        {
          E_ERROR   = 1 ,
          E_WARNING = 2 ,
          E_NOTICE  = 3 , 
          E_VERBOSE = 4
        };
      enum Code
        {       
          C_OK                         = 0 ,
          C_FILENOTFOUND               = 1 ,
          C_FILENOTOPENED              = 2 ,
          C_SYNTAXERROR                = 3 ,
          C_UNITNOTFOUND               = 4 ,
          C_PROPERTYNOTFOUND           = 5 ,
          C_CANNOTADDTONOTVECTOR       = 6 ,
          C_CANNOTREMOVEFROMNOTVECTOR  = 7 ,
          C_ZEROREMOVED                = 8 ,
          C_BADREFERENCE               = 9  
        };
    public:
      Message
      ( const Severity& severity, 
        const Code& code, 
        const std::string& message) 
        : m_severity ( severity )
        , m_code     ( code     )
        , m_message  ( message  )
      {};
      const std::string& message(void) const{return m_message;}
      const Severity& severity(void) const{return m_severity;}
      const Code& code(void) const{return m_code;};
    private:
      Severity    m_severity ;
      Code        m_code     ;
      std::string m_message  ;
    };
    
    
    class Parser
    {
    public:
      typedef std::vector<Gaudi::Parsers::Message> MessagesStoreT;
      typedef std::map<std::string,double> UnitsStoreT;
      enum Sign
        {
          S_ASSIGN      = 0 ,
          S_PLUSASSIGN  = 1 ,
          S_MINUSASSIGN = 2
        };
      Parser (Catalogue& catalogue, std::vector<std::string>& included, std::ostream& m = std::cout ) ;
      Parser (Catalogue& catalogue, std::vector<std::string>& included, 
                                const std::vector<std::string>& searchPath , 
                                std::ostream& m = std::cout ) ;
      Parser (Catalogue& catalogue, std::vector<std::string>& included, 
                                const std::string& searchPath ,
                                std::ostream& m = std::cout  ) ;
    public:
      StatusCode parse(const std::string& fileName);
      const std::vector<Message>& messages(){return m_messages;}
      int errorsCount();
      UnitsStoreT& units(void) {return m_units;}
      void matchInclude
      (const std::string& fileName,const Position& pos);
      void matchUnits
      (const std::string& fileName,const Position& pos);
      long double matchUnit
      (const std::string& unit,const Position& pos);
      void matchUnitEntry
      (const std::string& newUnit, 
       double value,
       const Position& pos);
      void matchAssign
      (const std::string& objName,
       const std::string& propName,
       const Sign& oper, 
       const std::vector<std::string>& vectorValues,
       const Position& pos, bool isVector);
      void setIsPrint(bool on, const Position& pos);
      void setIsPrintOptions(bool on, const Position& pos);
    private:
      bool m_isPrint;
      bool m_isPrintOptions;
      std::vector<std::string> m_searchPath;
      Catalogue&                m_catalogue;
      std::vector<std::string>& m_included;    
      MessagesStoreT m_messages;
      UnitsStoreT    m_units;
      std::ostream&  m_stream ;
    private:
      void initUnits();
      StatusCode parseFile
      ( const std::string& fileName ,
        const Position& pos,
        bool isUnitFile=false);
      void resolveReferences();
      void addMessage
      ( const Message::Severity& severity, 
        const Message::Code& code, 
        const std::string& message, 
        const Position& pos);
      std::string severityName
      (Message::Severity severity);
      bool isIncluded(const std::string& fileName);
      std::string sign(Sign aSign);
      std::string valueToString
      (std::vector<std::string> value, bool isVector);
      bool isPrint(){ return m_isPrint;}
      void printOptions();
      std::string posString(int line, int column);
    };

    
    StatusCode parse
    ( Parser                parser    ,
      const std::string&    fileName  ,
      std::vector<Message>& msgs      ) ;
    
    StatusCode parse
    ( const std::string&                    filename   ,
      const std::vector<std::string>&       searchPath ,
      Catalogue&                        catalogue  ,
          std::vector<std::string>& included,
      std::vector<Message>& messages   ) ;
    
    StatusCode parse
    ( const std::string&                    filename   ,
      const std::string&                    searchPath ,
      Catalogue&            catalogue  ,
          std::vector<std::string>& included,
      std::vector<Message>& messages   ) ;
    
    StatusCode parse
    ( const std::string&                   filename  ,
      Catalogue&           catalogue ,
          std::vector<std::string>& included,
      std::vector<Message>& messages  ) ;    

    namespace Utils 
    {
      // ======================================================================
      StatusCode getEnv(const std::string& envName,std::string& envValue);
      // ======================================================================
      StatusCode searchFile
      ( const std::string&              fileInput  , 
        bool                            addCurrent ,
        const std::vector<std::string>& dirs       , 
        std::string&                    fileOutput ) ;
      // ======================================================================
      std::string removeEnvironment(const std::string& input);
      // ======================================================================
      bool isWin();
      std::string pathSeparator();
      // ======================================================================
      std::vector<std::string> 
      extractPath ( const std::string& input , bool removeEnv = true );
      // ======================================================================
      StatusCode readFile ( const std::string& name , std::string& result ) ;
      // ======================================================================
      StatusCode parseValue
      ( const std::string&        input        ,
        std::string&              stringResult ,
        std::vector<std::string>& vectorResult ) ;
      // ======================================================================
      
    } // end of namespace Utils
  } // end of namespace Parsers
} // end of namespace Gaudi

// ============================================================================
// The END 
// ============================================================================
#endif // JOBOPTIONSSVC_PARSERUTILS_H
// ============================================================================