ConstHDFNode.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: ConstHDFNode.h,v 1.7 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 ConstHDFNode_h_
#define ConstHDFNode_h_ 1

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

namespace ClearSilver
{
  class ConstHDFNode
  {
  public:
    typedef std::string Name;

  private:
    bool is_iterator_;          // is this an iterator?

  private:
                                // unimplemented assignment
    ConstHDFNode& operator = (const ConstHDFNode& n);

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

  protected:
    void swap (ConstHDFNode&) throw();

    Nodes find_node (const std::string&) const;
    bool& is_iterator ();

  public:
    //\{
                                // constructors
    ConstHDFNode ();
    ConstHDFNode (const ConstHDFNode& n);
    ~ConstHDFNode () throw();
    //\}

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

    //\{
    operator bool () const;
    operator std::string () const;
    //\}

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

    //\{
    std::string get_value () const;
    std::string get_value (const char* key) const;
    std::string get_value (const std::string& key) const;
    std::string get_value (const char* key, const char* default_value) const;
    std::string get_value (const std::string& key,
                           const std::string& default_value) const;
    
    void write_file (const char * filename) const;
    void write_file (const std::string& filename) const;

    void dump () const;
    void dump (const char* prefix) const;
    void dump (const std::string& prefix) const;
    //\}

    virtual ClearSilverNode node () const = 0;

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

    bool is_dataset () const;
    bool is_reference () const;
    bool is_iterator () const;

   static bool& debug ();
  };
};                              // namespace ClearSilver

#endif

---