ScopeStack.h

// This file is part of the "NcML Module" project, a BES module designed
// to allow NcML files to be used to be used as a wrapper to add
// AIS to existing datasets of any format.
//
// Copyright (c) 2009 OPeNDAP, Inc.
// Author: Michael Johnson  <m.johnson@opendap.org>
//
// For more information, please also see the main website: http://opendap.org/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// Please see the files COPYING and COPYRIGHT for more information on the GLPL.
//
// You can contact OPeNDAP, Inc. at PO Box 112, Saunderstown, RI. 02874-0112.
 
#ifndef __NCML_MODULE__SCOPE_STACK_H__
#define __NCML_MODULE__SCOPE_STACK_H__
 
#include <string>
#include <vector>

namespace ncml_module
{
  class ScopeStack
  {
  public: // Inner classes
    enum ScopeType { GLOBAL=0, VARIABLE_ATOMIC, VARIABLE_CONSTRUCTOR, ATTRIBUTE_ATOMIC, ATTRIBUTE_CONTAINER, NUM_SCOPE_TYPES};

    struct Entry
    {
      Entry(ScopeType theType, const std::string& theName);
      Entry() : type(GLOBAL) , name("") {}
 
      std::string getTypedName() const
      {
        return name + toString(type);
      }
 
      static const std::string& toString(ScopeType theType)
      {
        return sTypeStrings[theType];
      }
 
      ScopeType type;
      std::string name;
      static const std::string sTypeStrings[NUM_SCOPE_TYPES];
    };

  public:
 
    ScopeStack();
    virtual ~ScopeStack();
 
    void clear();
    void push(const std::string& name, ScopeType type) { push(Entry(type, name)); }
    void pop();
    const Entry& top() const;
 
    ScopeType topType() const { return top().type; }
    const std::string& topName() const { return top().name; }

    bool empty() const;

    int size() const;
 
    std::string getFullyQualifiedName() const { return getScopeString(); }

    std::string getScopeString() const;

    std::string getTypedScopeString() const;

    bool isCurrentScope(ScopeType type) const;
 
  private: // Method
 
    void push(const Entry& entry);

  private:
    std::vector<Entry> _scope;
  };
}
 
#endif /* __NCML_MODULE__SCOPE_STACK_H__ */