//===- RPNExpr.h ----------------------------------------------------------===//
//
//                     The MCLinker Project
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#ifndef MCLD_SCRIPT_RPNEXPR_H_
#define MCLD_SCRIPT_RPNEXPR_H_

#include "mcld/Config/Config.h"
#include "mcld/Object/SectionMap.h"
#include "mcld/Support/Allocators.h"

#include <vector>

namespace mcld {

class ExprToken;
class Fragment;

/** \class RpnExpr
 *  \brief This class defines the interfaces to a rpn expression.
 */

class RpnExpr {
 public:
  typedef std::vector<ExprToken*> TokenQueue;
  typedef TokenQueue::const_iterator const_iterator;
  typedef TokenQueue::iterator iterator;

 private:
  friend class Chunk<RpnExpr, MCLD_SYMBOLS_PER_INPUT>;
  RpnExpr();

 public:
  ~RpnExpr();

  const_iterator begin() const { return m_TokenQueue.begin(); }
  iterator begin() { return m_TokenQueue.begin(); }
  const_iterator end() const { return m_TokenQueue.end(); }
  iterator end() { return m_TokenQueue.end(); }

  size_t size() const { return m_TokenQueue.size(); }

  bool empty() const { return m_TokenQueue.empty(); }

  bool hasDot() const;

  void dump() const;

  void push_back(ExprToken* pToken);

  iterator insert(iterator pPosition, ExprToken* pToken);

  void erase(iterator pPosition);

  /* factory methods */
  static RpnExpr* create();
  static void destroy(RpnExpr*& pRpnExpr);
  static void clear();

  // buildHelperExpr - build the helper expr:
  //                   ADDR ( `output_sect' ) + SIZEOF ( `output_sect' )
  static RpnExpr* buildHelperExpr(SectionMap::iterator pIter);
  // buildHelperExpr - build the helper expr: `fragment'
  static RpnExpr* buildHelperExpr(Fragment& pFrag);

 private:
  TokenQueue m_TokenQueue;
};

}  // namespace mcld

#endif  // MCLD_SCRIPT_RPNEXPR_H_