stilentity.h

Go to the documentation of this file.

/* $Revision: 159 $ */

/* $Id: stilentity.h 159 2006-12-06 21:41:00Z joel1234567 $ */

/*******************************************************************************
 * Copyright (c) 2006 International Business Machines Corporation
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.opensource.org/licenses/cpl1.0.php
 *
 * Contributors:
 *    Douglas Sprague, Joel Wheeler - initial API and implementation
 *
 * Modification Log:
 *     $Log: stilentity.h,v $
 *     Revision 1.1.1.1  2006/01/10 18:53:39  joel1234567
 *     Initial checkin
 *
 *
 *****************************************************************************/

#ifndef STILEntity_H
#define STILEntity_H


#include "stilcom.h"               // Common include
#include "stilcomstr.h"


// STILEntity Class
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILEntity {


  // - Public members
  public:

    enum Type {
      UndefinedEntity,

      __SIMPLE__STIL__ENTITIES,

      Alignment,
      Ann,
      Base,
      BreakPoint,       //5
      CategoryRef,
      DataBitCount,
      Date,
      DefaultState,
      ScanIn,           //10
      ScanOut,
      Source,
      Start,
      Goto,
      X,                //15
      Stop,             //16
      IddqTestPoint,
      Title,
      Termination,
      UserKeywords,
      UserStatement,    //21
      UserBlock,
      MacroDefsRef,
      PatternBurstRef,
      ProceduresRef,
      ScanStructuresRef,//26
      SelectorRef,
      SignalGroupsRef,
      TimingRef,
      WaveformTableRef,
      ScanChainRef,        //31

      TimeUnit,
      ResourceTag,

      __COMPLEX__STIL__ENTITIES,

      Main,             //35 for STIL Main Top-level object

      Terminations,     // for STILTerminations objects- SigRef Term's in PatternBursts
      Breakpoint,       //37
      Call,
      Category,
      Condition,
      Fixed,
      Header,           //42
      History,
      Infinite,
      Loop,
      Macro,
      MacroDefs,        //47
      MacroDef,
      MatchLoop,
      PatList,
      Pattern,
      PatternBurst,     //52
      PatternExec,
      Pattern_or_PatternBurst,
      Procedures,
      Procedure,
      Selector,         //57
      Shift,
      Signals,
      Signal,
      SignalGroups,
      SignalGroup,       //62
      ScanStructures,
      ScanChain,
      Timing,
      Variable,
      Vector,           //67
      VectorItem,
      Spec,

      WaveformTable,
      SubWaveforms,
      SubWaveform,       //72
      WaveformEvent,
      TimingWaveformRef,
      Waveforms,
      Waveform,
      WaveformItem,     //77
      WFCS,
      WFCSItem,

      __END__STIL__ENTITIES  //80
    };

    // - Default Constructor
    STILEntity();

    // - Construct given a Type
    STILEntity(Type);

    // - Copy Constructor
    STILEntity(const STILEntity &);

    // - Destructor
    virtual ~STILEntity();

    // - Assignment Operator
    STILEntity & operator=(const STILEntity &);

    // - Equality Operator
    bool operator==(const STILEntity &) const;

    // - Less Than Operator
    bool operator<(const STILEntity &) const;

    // - Initialize this STILEntity object specifying the type
    void        init(Type t);

    // - Write out this object to a given FILE with the specified indentation
    virtual void write(FILE * pOutFile, LONG indentation=0) const;

    // - Get/Set the Name attribute
    const sstring & getName() const;
    void           setName(const sstring &);

    // - Get/Set the Value attribute
    const sstring & getValue() const;
    void           setValue(const sstring &);

    // - Get/Set the Type attribute
    Type           getType() const;
    const sstring  getTypeAsString() const;
    void           setType(const Type);

    // - Get/Set the Label attribute
    const sstring & getLabel() const;
    void           setLabel(const sstring &);

    // - Get/Set the FileName attribute
    const sstring & getFileName() const;
    void           setFileName(const sstring &);

    // - Get/Set the LineNumber attribute
    LONG          getLineNumber() const;
    void           setLineNumber(LONG);

    // - Get/Set the Referenced attribute (has this entity been referenced)
    //bool           getReferenced() const;
    //void           setReferenced(bool);

    // - Get/Set the Semantic error flag
    bool           getSemanticErrors() const;
    void           setSemanticErrors(bool);

    // - Is this entity a simple STIL statement type (I.E. Ann, Termination,...)
    bool           isSimple() const;

    // - Get the parsing trace information (filename/line number)
    sstring         getParseInfo() const;

  // Protected members (accessable to derived classes)
  protected:

    //----------------------- private members --------------------------------

    sstring        m_name;             // Name of this STIL entity
    sstring        m_value;            // Value (UserStatements, Annotations,...)
    Type           m_type;             // Type of this STIL entity
    sstring        m_label;            // Label for this entity (optional)

    sstring        m_filename;         // Name of associated STIL file
    LONG           m_linenumber;       // Line number in associated STIL file
    bool           m_semanticErrors;  // Does this entity have semantic errors


}; // end STILEntity class

//----------------------------- inline functions -----------------------------
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring &   STILEntity::getName() const { return m_name; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setName(const sstring &n) { m_name = n; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring &   STILEntity::getValue() const { return m_value; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setValue(const sstring &v) { m_value = v; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline STILEntity::Type STILEntity::getType() const { return m_type; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setType(const Type t) { m_type = t; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring &   STILEntity::getLabel() const { return m_label; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setLabel(const sstring &l) { m_label = l; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring &   STILEntity::getFileName() const { return m_filename; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setFileName(const sstring &f) { m_filename = f; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline LONG            STILEntity::getLineNumber() const { return m_linenumber; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setLineNumber(LONG l) { m_linenumber = l; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline bool             STILEntity::getSemanticErrors() const { return m_semanticErrors; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void             STILEntity::setSemanticErrors(bool s) { m_semanticErrors = s; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline bool             STILEntity::isSimple() const { return m_type < __COMPLEX__STIL__ENTITIES; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline sstring           STILEntity::getParseInfo() const {
  char tmp[1024] = "";
  if (m_filename != "" || m_linenumber != 0) {
    sprintf(tmp,"[file=%s, line=%d]",m_filename.c_str(),m_linenumber);
  }
  return tmp;
}

#endif

---

This page last updated on 6 Jul 2007