PAutoRunParser.h

Go to the documentation of this file.

/********************************************************************************************

  PAutoRunParser.h

*********************************************************************************************

    begin                : Andreas Suter, 2006/03/14
    modfied:             :
    copyright            : (C) 2006 by
    email                : andreas.suter@psi.ch

********************************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef _PAUTORUNPARSER_H_
#define _PAUTORUNPARSER_H_

#include <QObject>
#include <QStringList>
#include <QMap>
#include <QVector>

#include <xercesc/sax2/Attributes.hpp>
#include <xercesc/sax2/DefaultHandler.hpp>

#include "lemAutoRun.h"

XERCES_CPP_NAMESPACE_USE

class PAutoRunParser;

//----------------------------------------------------------------------------------------------
typedef struct {
  int errorCode;    
  int lineNo;       
  QString errorMsg; 
} XMLParseError;

//----------------------------------------------------------------------------------------------
typedef QVector<XMLParseError> PXMLParseErrorVector;

//----------------------------------------------------------------------------------------------
typedef QVector<double> PXMLLoopListVector;

//----------------------------------------------------------------------------------------------
typedef struct {
  PXMLLoopListVector list;        
  double             iterator[3]; 
  AutoRunCmd         loopCmd;     
  PAutoRunCmdVector  cmd;         
  PAutoRunCmdVector  expandedCmd; 
} XMLLoopInfo;

//----------------------------------------------------------------------------------------------
typedef QVector<XMLLoopInfo> PXMLLoopInfoVector;

//----------------------------------------------------------------------------------------------
class PSAX2AutoRunParseHandler : public DefaultHandler
{
  public:
    enum EAutoRunKeyWords {eEmpty, eFln, eLineNo, eCmdStr, eAlias, eIgnoreAlarms, eIgnoreClients, eBPV, eComment, eOdbTag,
                           eSetSpinRot, eSetTfl, eSetTemp, eSetSampleHV, eSetRA_HV,
                           eSetTransportHV, eSetHvOff, eSetOdbData, eSetOdbDataArray,
                           eSetFieldWEWL, eSetFieldWEWH, eSetFieldDanfysik,
                           eSetField, eSetTitle, eSetTOF, eSetModInfo, eSetLEMSetup, eSetWait, eSetDump, eSetFOM,
                           eRunStart, eRunStop, eWarmUp, eDegaussDanfysik, eDegaussWEW, eDegauss, eDegaussSpinRot,
                           eCommentLine, eAlias_key, eAlias_value,
                           eLoop, eLoopList, eLoopIterator, eLoopElement, eLoopStart, eLoopStop, 
                           eLoopStep, eLoopSetTemp, eLoopSetSampleHV, eLoopSetFieldWEWL, eLoopSetFieldWEWH,
                           eLoopSetFieldDanfysik, eLoopSetField, eLoopTempTag, eLoopSampleHVTag, eLoopFieldTag,
                           eOdbSetPath, eOdbSetIndex, eOdbSetValue, eOdbReadPath, eOdbReadIndex,
                           eOdbTimeout, eOdbTolerance, eTfl_pos, eTfl_mode,
                           eTemp, eDeltaT, eStabilityTimeout, eHeaterRange, eP_pid, eI_pid,
                           eD_pid, eRamp, eFlow, eHv_value, eHv_left, eHv_top, eHv_right, eHv_bottom,
                           eField_value, eField_unit, eTitle, eOdb_sample, eOdb_temp, eOdb_field, eOdb_transp, eOdb_hv_samp,
                           eOdb_energy, eOdb_ra_diff_lr, eOdb_ra_diff_tb, eOdb_spin_rot,
                           eStart, eStop, eUnits, eMod, eMod_date, eSetup, eWait, eNo_events,
                           eNo_dumps, eDate, eTime, eVent, eCurrent, eTransportHvSettingFileName, eAngle, eNoDegauss, eChamber,
                           eLabel, eState};

    PSAX2AutoRunParseHandler(PAutoRunParser *arp);
    ~PSAX2AutoRunParseHandler();

    void startDocument();
    void startElement(const XMLCh *const uri, const XMLCh *const localname,
                      const XMLCh *const qname, const Attributes &attrs);
    void characters(const XMLCh *const chars, const XMLSize_t length);
    void endElement(const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname);
    void endDocument();

    void warning(const SAXParseException& exc);
    void error(const SAXParseException& exc);
    void fatalError(const SAXParseException& exc);
    void internalFatalError(QString& msg);

  private:
    bool   fFatalError; 

    PAutoRunParser    *fArp; 
    PAutoRunCmdVector *fAutoRunCmdVector; 

    QString fFlnAutoRunSeq;     
    int     fCurrentUserLineNo; 

    AutoRunCmd fAutoRunCmd; 
    void ClearAutoRunCmd();

    OdbTag fOdbTag; 

    EAutoRunKeyWords fKey;    
    EAutoRunKeyWords fCmdKey; 

    // loop handling
    int fLoopNo; 
    PXMLLoopInfoVector fLoopInfoVector; 

    void CheckOdbSetDataParamsStructure();
};

//----------------------------------------------------------------------------------------------
class PAutoRunParser : public QObject
{
  Q_OBJECT

  public:
    PAutoRunParser(QString userAutoRunSeqFln, QString &schemaPath, QString &xmlFln,
                   PAutoRunCmdVector *arcv, POdbTagVector *odbtagv);
    ~PAutoRunParser();

    void ConvertToXML();
    void Parse();
    int  GetParseErrorCounts() { return fParseErrorCounter; }

    PXMLParseErrorVector *GetXMLParseErrorVector() { return fXMLParseErrorVector; }
    PAutoRunCmdVector    *GetAutoRunCmdVector() { return fAutoRunCmdVector; }
    POdbTagVector        *GetOdbTagVector() { return fOdbTagVector; }

  signals:
    void ParseError(int noOfErrors, int idx, int errorNo, int line, QString errorMsg);

  private:
    friend class PSAX2AutoRunParseHandler;

    QString fInputFileName;        
    QString fAutoRunXMLSchemaPath; 
    QString fXMLFileName;          

    QMap<QString, QString> fAlias; 

    int fParseErrorCounter; 

    PAutoRunCmdVector *fAutoRunCmdVector; 
    POdbTagVector *fOdbTagVector; 

    QString CheckForAlias(QString &str);

    void ConvertAlias(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertIgnoreAlarms(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertIgnoreClients(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertBPV(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertComment(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertDegaussWEW(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertDegaussDanfysik(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertDegauss(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertDegaussSpinRot(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertDump(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertFieldWEWL(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertFieldWEWH(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertFieldDanfysik(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertField(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertFOM(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLEMSetup(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopStart(int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopList(QString &str, QString &offset, QStringList &xml);
    void ConvertLoopIterator(QString &str, QString &offset, QStringList &xml);
    void ConvertLoopTemp(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopSampleHV(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopFieldWEWL(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopFieldWEWH(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopFieldDanfysik(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopField(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertLoopEnd(QString &offset, QStringList &xml);
    void ConvertModerator(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertSampleHV(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertRA_HV(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertTransportHV(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertHVOff(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertOdbSetData(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertOdbSetDataArray(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertOdbTag(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertStart(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertStop(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertSpinRot(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertTfl(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertTemp(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertTitle(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertTOF(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertWait(QString &str, int lineNo, QString &offset, QStringList &xml);
    void ConvertWarmUp(QString &str, int lineNo, QString &offset, QStringList &xml);

    friend class PSAX2AutoRunParser;
    PXMLParseErrorVector *fXMLParseErrorVector; 
};

#endif // _PAUTORUNPARSER_H_