ClearSilverNode.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: ClearSilverNode.h,v 1.10 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 ClearSilverNode_h_
#define ClearSilverNode_h_ 1

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

class _hdf;                     // forward declarations
class _attr;

namespace ClearSilver
{
  class ClearSilverNode : boost::equality_comparable<ClearSilverNode>
  {
  public:
    typedef _hdf HDF;
    typedef _attr HDF_ATTR;

  private:
    HDF* node_;

  public:
    //\{
                                // Default constructor.
    ClearSilverNode ();
    explicit ClearSilverNode (HDF*);
    ClearSilverNode (const ClearSilverNode&);
    ~ClearSilverNode () throw();

    ClearSilverNode& operator = (const ClearSilverNode& n);
    ClearSilverNode& operator = (const char* value);
    ClearSilverNode& operator = (const std::string&);
    ClearSilverNode& operator = (int);
    ClearSilverNode& operator = (bool);
    //\}

    //\{
    bool empty () const;
    //\}

    //\{
    operator bool () const;
    //\}

    //\{
    std::string name () const;
    std::string value () const;
    //\}

    //\{
    HDF* get () const;
    ClearSilverNode top () const;
    ClearSilverNode next () const;
    ClearSilverNode child () const;
    HDF_ATTR* attr () const;
    //\}

    //\{
    std::string get_value (const std::string& key,
                           const std::string& default_value) const;
    void set_value (const std::string& key, const std::string& value);
    void set_value (const std::string& key, int value);
    void set_value (const std::string& key, unsigned int value);
    void set_value (const std::string& key, bool value);

    ClearSilverNode get_node (const std::string&);
    ClearSilverNode get_obj (const std::string&) const;
    ClearSilverNode get_child (const std::string&) const;

    void remove_tree ();
    void remove_tree (const std::string&);

    void read_file (const std::string&);
    void write_file (const std::string&) const;
    void dump (const std::string&) const;

    void copy (const std::string&, const ClearSilverNode&);
    //\}

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

    static bool& debug ();

    //\{
    static std::string Boolean (bool);
    static std::string True ();
    static std::string False ();
    //\}

    void swap (ClearSilverNode&) throw();

    void sort (ClearSilverNodeComparator::Ptr);
  };
};                              // namespace ClearSilver

#endif

---