autodoc/source/ary/cpp/c_reposypart.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: c_reposypart.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_CPP_C_REPOSYPART_HXX
  32 #define ARY_CPP_C_REPOSYPART_HXX
  33
  34
  35
  36 // BASE CLASSES
  37 #include <cpp_internalgate.hxx>
  38
  39 namespace ary
  40 {
  41 namespace cpp
  42 {
  43     class CeAdmin;
  44     class DefAdmin;
  45     class TypeAdmin;
  46 }
  47 }
  48
  49
  50
  51
  52 namespace ary
  53 {
  54 namespace cpp
  55 {
  56
  57
  58
  59 /** The C++ partition of the repository.
  60 */
  61 class RepositoryPartition : public InternalGate
  62 {
  63   public:
  64                         RepositoryPartition(
  65                             RepositoryCenter &  i_reposyImpl );
  66     virtual             ~RepositoryPartition();
  67
  68     // INHERITED
  69         // Interface Gate:
  70     virtual void        Calculate_AllSecondaryInformation();
  71 //                            const ::autodoc::Options &
  72 //                                                i_options );
  73     virtual const String &
  74                         RepositoryTitle() const;
  75     virtual const CodeEntity *
  76                         Search_RelatedCe(
  77                             Type_id                     i_type ) const;
  78     virtual const ::ary::cpp::CppEntity *
  79                         Search_Entity(
  80                             GlobalId            i_id ) const;
  81     virtual uintt       Get_AlphabeticalList(
  82                             List_GlobalIds &    o_result,
  83                             const char *        i_begin,
  84                             const char *        i_end ) const;
  85     virtual const CePilot &
  86                         Ces() const;
  87     virtual const DefPilot &
  88                         Defs() const;
  89     virtual const TypePilot &
  90                         Types() const;
  91     virtual const loc::LocationPilot &
  92                         Locations() const;
  93     virtual CePilot &   Ces();
  94     virtual DefPilot &  Defs();
  95     virtual TypePilot & Types();
  96     virtual loc::LocationPilot &
  97                         Locations();
  98   private:
  99     // Locals
 100     void                Connect_AllTypes_2_TheirRelated_CodeEntites();
 101
 102     // DATA
 103     RepositoryCenter *  pRepositoryCenter;
 104
 105     Dyn<CeAdmin>        pCes;
 106     Dyn<TypeAdmin>      pTypes;
 107     Dyn<DefAdmin>       pDefs;
 108     Dyn<loc::LocationPilot>
 109                         pLocations;
 110 };
 111
 112
 113
 114
 115 }   //  namespace cpp
 116 }   //  namespace ary
 117 #endif