autodoc/inc/ary/loc/loc_traits.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: loc_traits.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_LOC_TRAITS_HXX
  32 #define ARY_LOC_TRAITS_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36     // COMPONENTS
  37     // PARAMETERS
  38 #include <ary/loc/loc_types4loc.hxx>
  39
  40
  41 namespace ary
  42 {
  43 namespace symtree
  44 {
  45     template <class> class Node;
  46 }
  47 }
  48
  49
  50
  51
  52 namespace ary
  53 {
  54 namespace loc
  55 {
  56
  57
  58
  59 /** Basic traits for derived ones of ->LocationEntity.
  60 */
  61 struct Le_Traits
  62 {
  63     typedef LocationEntity      entity_base_type;
  64     typedef Le_id               id_type;
  65
  66     static entity_base_type &
  67                         EntityOf_(
  68                             id_type             i_id );
  69 };
  70
  71
  72 /** An instance of SYMBOL_TRAITS for ->::ary::symtree::Node.
  73
  74     @see ::ary::symtree::Node
  75 */
  76 struct LeNode_Traits : public Le_Traits
  77 {
  78     static symtree::Node<LeNode_Traits> *
  79                         NodeOf_(
  80                             entity_base_type &  i_entity );
  81
  82     static entity_base_type *
  83                         ParentOf_(
  84                             const entity_base_type &
  85                                                 i_entity );
  86     template <class KEY>
  87     static id_type      Search_(
  88                             const entity_base_type &
  89                                                 i_entity,
  90                             const KEY &         i_localKey );
  91 };
  92
  93
  94
  95 /** An instance of COMPARE for ->::ary::SortedIds<>.
  96
  97     @see ::ary::SortedIds<>
  98 */
  99 struct Le_Compare : public Le_Traits
 100 {
 101     typedef  String             key_type;
 102
 103     static const key_type &
 104                         KeyOf_(
 105                             const entity_base_type &
 106                                                 i_entity );
 107     static bool         Lesser_(
 108                             const key_type &    i_1,
 109                             const key_type &    i_2 );
 110 };
 111
 112
 113
 114
 115
 116 } // namespace loc
 117 } // namespace ary
 118 #endif