Nodes.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: Nodes.h,v 1.8 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 Nodes_h_
#define Nodes_h_ 1

#include <list>
#include <string>
#include <boost/operators.hpp>
#include "ClearSilverNode.h"

namespace ClearSilver
{
  class Nodes : boost::equality_comparable<Nodes>
  {
  private:
    typedef std::list<std::string> NameContainer;
    typedef std::list<ClearSilverNode> NodeContainer;

  public:
    typedef std::string Name;
    typedef NodeContainer::size_type size_type;

  private:
    NodeContainer nodes_;
    NameContainer names_;

  public:
    //\{
    Nodes ();
    Nodes (const Nodes& n);
    ~Nodes ();
    Nodes& operator = (const Nodes& n);
    //\}

    bool empty () const;
    size_type size () const;
    std::string path () const;
    size_type depth () const;

    void push (const Name&, const ClearSilverNode&);
    void pop ();
    ClearSilverNode top () const;

    void swap (Nodes&) throw();

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

    static bool& debug ();

    void print () const;
  };
};                              // namespace ClearSilver

#endif

---