ConstHDF.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: ConstHDF.h,v 1.9 2006/05/16 20:06:34 brook Exp $
 */

/*
 * ClearSilver++ Software License.
 *
 * Copyright (c) 2005,2006 Brook Milligan <brook@nmsu.edu>
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ConstHDF_h_
#define ConstHDF_h_ 1

#include <string>
#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include "ClearSilverNode.h"
#include "ConstHDFNode.h"
#include "Nodes.h"
#include "RootNode.h"

namespace ClearSilver
{
  class HDF;                    // forward declaration

  class ConstHDF : public ConstHDFNode, boost::equality_comparable<ConstHDF>
  {
    public:
      //\{
      typedef size_t size_type;
      struct input_iterator_tag {};
      struct forward_iterator_tag : public input_iterator_tag {};
      typedef forward_iterator_tag iterator_category;
      typedef ConstHDF value_type;
      typedef ptrdiff_t difference_type;
      typedef ConstHDF* pointer;
      typedef ConstHDF reference;
      typedef ConstHDF const_reference;
      typedef ConstHDF const_iterator;
      //\}

  public:
    //\{
    ConstHDF ();
    explicit ConstHDF (const char* path);
    explicit ConstHDF (const std::string& path);
    explicit ConstHDF (const RootNode&);
    explicit ConstHDF (const HDF&);
    ConstHDF (const ConstHDF&);
    ~ConstHDF () throw();

    ConstHDF& operator = (const ConstHDF&);
    //\}

    //\{
    size_type depth () const;
    std::string path () const;
    //\}

    //\{
    const_reference operator [] (const char* key) const;
    const_reference operator [] (const std::string&) const;
    //\}

    //\{
    const_iterator begin () const;
    const_iterator end () const;

    const_iterator find (const char* key) const;
    const_iterator find (const std::string& key) const;
    //\}

    //\{
    const_iterator& operator ++ ();
    const_iterator  operator ++ (int);
    value_type operator * ();
    pointer operator -> ();
    //\}

    virtual ClearSilverNode node () const;

    ClearSilverNode root () const;

    void swap (ConstHDF&) throw();

    friend bool operator == (const reference&, const reference&);

    static bool& debug ();

  protected:
    virtual Nodes::Nodes nodes () const;
    virtual Nodes::Nodes& nodes ();
    virtual void push (const Name&, const ClearSilverNode&);
    virtual void pop ();
    virtual ClearSilverNode top () const;

  private:
    typedef boost::shared_ptr<_hdf> Ptr;

  private:
    RootNode root_;
    Nodes nodes_;
  };
};                              // namespace ClearSilver

#endif

---