autodoc/source/ary/idl/i_nnfinder.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: i_nnfinder.hxx,v $
  10  * $Revision: 1.4 $
  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_IDL_NNFINDER_HXX
  32 #define ARY_IDL_NNFINDER_HXX
  33
  34 // USED SERVICES
  35 #include "is_ce.hxx"
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44
  45
  46 /** Gives context info for tree search functions.
  47
  48     @collab ->ary::Search_SubTree<>()
  49     @collab ->ary::Search_SubTree_UpTillRoot<>()
  50 */
  51 class Find_ModuleNode
  52 {
  53   public:
  54     typedef Ce_id                           id_type;
  55     typedef StringVector::const_iterator    name_iterator;
  56
  57     // LIFECYCLE
  58                         Find_ModuleNode(
  59                             const Ce_Storage &  i_rStorage,
  60                             name_iterator       it_begin,
  61                             name_iterator       it_end,
  62                             const String &      i_sName )
  63                             :   rStorage(i_rStorage),
  64                                 itBegin(it_begin),
  65                                 itEnd(it_end),
  66                                 sName2Search(i_sName) { if (itBegin != itEnd ? (*itBegin).empty() : false) ++itBegin; }
  67     // OPERATIONS
  68     const Module *      operator()(
  69                             id_type             i_id ) const
  70                             { return i_id.IsValid()
  71                                         ?   & ary_cast<Module>(rStorage[i_id])
  72                                         :   0; }
  73
  74     name_iterator       Begin() const           { return itBegin; }
  75     name_iterator       End() const             { return itEnd; }
  76     const String &      Name2Search() const     { return sName2Search; }
  77
  78   private:
  79     // DATA
  80     const Ce_Storage &  rStorage;
  81     name_iterator       itBegin;
  82     name_iterator       itEnd;
  83     String              sName2Search;
  84 };
  85
  86
  87
  88
  89 class Types_forSetCe_Id
  90 {
  91   public:
  92     typedef Ce_id                           element_type;
  93     typedef Ce_Storage                      find_type;
  94
  95     //  KORR_FUTURE: Check, if this sorting is right or the ary standard
  96     //  sorting should be used.
  97     struct sort_type
  98     {
  99                         sort_type(
 100                             const find_type &   i_rFinder )
 101                                                 : rFinder(i_rFinder) {}
 102         bool            operator()(
 103                             const element_type   &
 104                                                 i_r1,
 105                             const element_type   &
 106                                                 i_r2 ) const
 107         {
 108             return rFinder[i_r1].LocalName()
 109                    < rFinder[i_r2].LocalName();
 110         }
 111
 112       private:
 113         const find_type &     rFinder;
 114
 115     };
 116 };
 117
 118
 119 }   // namespace idl
 120 }   // namespace ary
 121 #endif