contrib/libstdc++/include/ext/pb_ds/detail/pat_trie_/node_base.hpp

   1 // -*- C++ -*-
   2
   3 // Copyright (C) 2005, 2006 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the terms
   7 // of the GNU General Public License as published by the Free Software
   8 // Foundation; either version 2, or (at your option) any later
   9 // version.
  10
  11 // This library is distributed in the hope that it will be useful, but
  12 // WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License
  17 // along with this library; see the file COPYING.  If not, write to
  18 // the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
  19 // MA 02111-1307, USA.
  20
  21 // As a special exception, you may use this file as part of a free
  22 // software library without restriction.  Specifically, if other files
  23 // instantiate templates or use macros or inline functions from this
  24 // file, or you compile this file and link it with other files to
  25 // produce an executable, this file does not by itself cause the
  26 // resulting executable to be covered by the GNU General Public
  27 // License.  This exception does not however invalidate any other
  28 // reasons why the executable file might be covered by the GNU General
  29 // Public License.
  30
  31 // Copyright (C) 2004 Ami Tavory and Vladimir Dreizin, IBM-HRL.
  32
  33 // Permission to use, copy, modify, sell, and distribute this software
  34 // is hereby granted without fee, provided that the above copyright
  35 // notice appears in all copies, and that both that copyright notice
  36 // and this permission notice appear in supporting documentation. None
  37 // of the above authors, nor IBM Haifa Research Laboratories, make any
  38 // representation about the suitability of this software for any
  39 // purpose. It is provided "as is" without express or implied
  40 // warranty.
  41
  42 /**
  43  * @file node_base.hpp
  44  * Contains a pat_trie_node_base base for a patricia tree.
  45  */
  46
  47 #ifndef PB_DS_PAT_TRIE_NODE_BASE_HPP
  48 #define PB_DS_PAT_TRIE_NODE_BASE_HPP
  49
  50 #include <ext/pb_ds/detail/pat_trie_/node_metadata_base.hpp>
  51
  52 namespace pb_ds
  53 {
  54   namespace detail
  55   {
  56 #define PB_DS_CLASS_T_DEC \
  57     template<typename Type_Traits, typename E_Access_Traits,    \
  58              typename Metadata, typename Allocator>
  59
  60 #define PB_DS_CLASS_C_DEC \
  61     pat_trie_node_base<Type_Traits, E_Access_Traits, Metadata, Allocator>
  62
  63 #define PB_DS_PAT_TRIE_SUBTREE_DEBUG_INFO_C_DEC \
  64     pat_trie_subtree_debug_info<Type_Traits, E_Access_Traits, Allocator>
  65
  66     enum pat_trie_node_type
  67       {
  68         pat_trie_internal_node_type,
  69         pat_trie_leaf_node_type,
  70         pat_trie_head_node_type
  71       };
  72
  73     template<typename Type_Traits,
  74              typename E_Access_Traits,
  75              typename Metadata,
  76              typename Allocator>
  77     struct pat_trie_node_base : public pat_trie_node_metadata_base<
  78       Metadata,
  79       Allocator>
  80     {
  81     public:
  82       typedef
  83       typename Allocator::template rebind<
  84       pat_trie_node_base>::other::pointer
  85       node_pointer;
  86
  87       typedef
  88       typename Allocator::template rebind<
  89         E_Access_Traits>::other::const_pointer
  90       const_e_access_traits_pointer;
  91
  92 #ifdef _GLIBCXX_DEBUG
  93       typedef
  94       std::pair<
  95         typename E_Access_Traits::const_iterator,
  96         typename E_Access_Traits::const_iterator>
  97       subtree_debug_info;
  98 #endif
  99
 100       pat_trie_node_base(pat_trie_node_type type);
 101
 102 #ifdef _GLIBCXX_DEBUG
 103       void
 104       assert_valid(const_e_access_traits_pointer p_traits) const;
 105
 106       virtual subtree_debug_info
 107       assert_valid_imp(const_e_access_traits_pointer p_traits) const = 0;
 108 #endif
 109
 110       node_pointer m_p_parent;
 111       const pat_trie_node_type m_type;
 112     };
 113
 114     PB_DS_CLASS_T_DEC
 115     PB_DS_CLASS_C_DEC::
 116     pat_trie_node_base(pat_trie_node_type type) : m_type(type)
 117     { }
 118
 119 #ifdef _GLIBCXX_DEBUG
 120     PB_DS_CLASS_T_DEC
 121     void
 122     PB_DS_CLASS_C_DEC::
 123     assert_valid(const_e_access_traits_pointer p_traits) const
 124     { assert_valid_imp(p_traits); }
 125 #endif
 126
 127 #undef PB_DS_CLASS_T_DEC
 128 #undef PB_DS_CLASS_C_DEC
 129 #undef PB_DS_PAT_TRIE_SUBTREE_DEBUG_INFO_C_DEC
 130
 131   } // namespace detail
 132 } // namespace pb_ds
 133
 134 #endif