HDFAttributes.h

Go to the documentation of this file.

/* -*- c++ -*-
 * $Id: HDFAttributes.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 HDFAttributes_h_
#define HDFAttributes_h_ 1

#include <iterator>
#include <boost/operators.hpp>
#include <boost/shared_ptr.hpp>
#include "Nodes.h"

class _attr;                    // forward declaration

namespace ClearSilver
{
  class HDFAttributes : boost::equality_comparable<HDFAttributes>
  {
  public:
    //\{
    typedef size_t size_type;
    typedef char* key_type;

    class mapped_type
    {
    public:
      mapped_type ();
      mapped_type (const char*);
      mapped_type (std::string);
      mapped_type (char**);     // assume non-nil pointer
      mapped_type (const mapped_type&);
      ~mapped_type () throw();
      mapped_type& operator = (const mapped_type&);
      mapped_type& operator = (const char*); // assume non-nil pointer
      void swap (mapped_type&) throw();
      operator char* ();
      operator const char* () const;

    private:
      char * value_;
      char** valuep_;           // pointer to owner of data (for assignment)
    };

    typedef std::pair<const key_type, mapped_type> value_type;
    typedef value_type& reference;
    typedef const value_type& const_reference;
    
    class iterator : boost::equality_comparable<HDFAttributes::iterator>
    {
      friend class HDFAttributes;
    public:
      struct forward_iterator_tag;
      typedef forward_iterator_tag iterator_category;

    public:
      iterator ();
      explicit iterator (_attr*);
      iterator (const iterator&);
      ~iterator () throw();
      iterator& operator = (const iterator&);
      void swap (iterator&) throw ();

      operator bool () const;
      value_type  operator * ();
      value_type* operator -> ();
      iterator& operator ++ ();
      iterator  operator ++ (int);

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

    private:
      _attr* node_;
      boost::shared_ptr<value_type> value_;
    };

    class const_iterator
      : boost::equality_comparable<HDFAttributes::const_iterator>
    {
      friend class HDFAttributes;
    public:
      struct forward_iterator_tag;
      typedef forward_iterator_tag iterator_category;

    public:
      const_iterator ();
      explicit const_iterator (_attr*);
      const_iterator (const const_iterator&);
      ~const_iterator () throw();
      const_iterator& operator = (const const_iterator&);
      void swap (const_iterator&) throw ();

      operator bool () const;
      value_type  operator * ();
      value_type* operator -> ();
      const_iterator& operator ++ ();
      const_iterator  operator ++ (int);

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

    private:
      _attr* node_;
      boost::shared_ptr<value_type> value_;
    };
    //\}

  public:
    //\{
    HDFAttributes ();
    explicit HDFAttributes (const Nodes& path, _attr* head);
    HDFAttributes (const HDFAttributes&);
    ~HDFAttributes () throw();

    HDFAttributes& operator = (const HDFAttributes&);

    void swap (HDFAttributes&) throw();
    //\}

    //\{
    size_type size () const;
    bool empty () const;
    size_type count (const key_type& key);
    iterator find (const key_type& key);
    const_iterator find (const key_type& key) const;
    //\}

    mapped_type operator [] (const key_type&);

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

    //\{
    std::pair<iterator,bool> insert (const value_type&);
    iterator insert (iterator, const value_type&);
    size_type erase (const key_type&) throw();
    void erase (iterator);
    void erase (iterator begin, iterator end);
    void clear () throw();
    //\}

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

    static bool& debug ();

  private:
    Nodes path_;
    _attr* head_;
  };

};                              // namespace ClearSilver

#endif

---