stilsigrefexpr.h

Go to the documentation of this file.

/*******************************************************************************
 * 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
 *
 *****************************************************************************/

#ifndef STILSigRefExpr_H
#define STILSigRefExpr_H


#include "stilcom.h"           // Common include
#include "stilcomstr.h"
#include "stilsignal.h"        // STIL Signal class
#include "stilsignallist.h"    // STIL SignalList class

#include <list>                // ANSI STL list class
#include <stack>               // ANSI STL stack class

class STILEvalEngine;

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILSigRefExpr : public STILEntity {

  // - Public members
  public:

    friend struct STILSigRefExpr_Data;

    // Allowed operators
    enum Operator {
      UndefinedOperator, 
      Plus,              
      Minus,             
      LeftParen,         
      RightParen         
    };

    // - Default Constructor
    STILSigRefExpr();

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

    // - Destructor
    virtual ~STILSigRefExpr();

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

    // - Initialize this STILSigRefExpr object.
    void        init();

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


    // - Add an operator to this expression
    void           addOp(Operator op);

    // - Add an identifier to this expression (with optional indexing)
    void           addId(const sstring & id, LONG idx1=-1, LONG idx2=-1);

    // - Get the text sstring representation of this expression
    const sstring & getText() const;

    // enumeration for node type
    enum NodeType {
      UndefinedNodeType,  
      Id,                 
      Op                  
    };

    struct STILSigRefExpr_Data {
      NodeType type;      
      char *   identifier;
      LONG     idx1;      
      LONG     idx2;      
      Operator op;        
    };

    struct STILSigRefExpr_Node;       

    struct STILSigRefExpr_Node {
      STILSigRefExpr_Data  data;      
      STILSigRefExpr_Node *l_tree;    
      STILSigRefExpr_Node *r_tree;    
    };

    // - Print underlying expression tree recursively (for debug purposes)
    void           printTree(const STILSigRefExpr_Node * p_tree = NULL) const;

    // - Clear out all storage associated with this expression
    void           clearTree(STILSigRefExpr_Node * p_tree = NULL);

    // - Clear out all storage associated with this expression
    void           copyTree(STILSigRefExpr_Node *&,const STILSigRefExpr_Node *);

    // - Evaluate the SigRefExpr
//    STILSignalList eval(const STILSymbolTable*, const STILSigRefExpr_Node *p_tree = NULL);
//    STILSignalList& eval(const STILEvalEngine*, const STILSigRefExpr_Node  *p_tree = NULL);
    STILSignalList eval(const STILEvalEngine*, const STILSigRefExpr_Node  *p_tree = NULL);

  // Private members
  private:

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

    STILSigRefExpr_Node *       m_exprTree;   // Pointer to top of expression tree
    sstring                      m_exprText;  // String representation of expression
    std::stack<void *,std::list<void *> > m_parenStack;// Stack of subtrees from parens
    bool                        m_errInEval;  //If the SigRefExpr references
                                              //an undefined Signal
}; // end STILSigRefExpr class

//----------------------------- inline functions -----------------------------
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring & STILSigRefExpr::getText() const { return m_exprText; }


#endif

---

This page last updated on 6 Jul 2007