autodoc/source/ary/cpp/ca_def.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: ca_def.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_CA_DEF_HXX
  32 #define ARY_CPP_CA_DEF_HXX
  33
  34 // USED SERVICES
  35     // BASE CLASSES
  36 #include <ary/cpp/cp_def.hxx>
  37     // OTHER
  38 #include "cs_def.hxx"
  39
  40
  41
  42 namespace ary
  43 {
  44 namespace cpp
  45 {
  46     class Def_Storage;
  47     class RepositoryPartition;
  48 }
  49 }
  50
  51
  52
  53
  54
  55 namespace ary
  56 {
  57 namespace cpp
  58 {
  59
  60
  61
  62
  63 class DefAdmin : public DefPilot
  64 {
  65   public:
  66     // LIFECYCLE
  67                         DefAdmin(
  68                             RepositoryPartition &
  69                                                 io_myReposyPartition );
  70                         ~DefAdmin();
  71
  72     // INQUIRY
  73     const Def_Storage & Storage() const;
  74
  75     // INHERITED
  76     // Interface DefPilot:
  77     virtual Define &    Store_Define(
  78                             const InputContext& i_rContext,
  79                             const String  &     i_sName,
  80                             const StringVector &
  81                                                 i_rDefinition );
  82     virtual Macro &     Store_Macro(
  83                             const InputContext& i_rContext,
  84                             const String  &     i_sName,
  85                             const StringVector &
  86                                                 i_rParams,
  87                             const StringVector &
  88                                                 i_rDefinition );
  89     virtual const DefineEntity &
  90                         Find_Def(
  91                             De_id               i_id ) const;
  92     virtual DefsResultList
  93                         AllDefines() const;
  94     virtual DefsResultList
  95                         AllMacros() const;
  96
  97   private:
  98     // DATA
  99     Def_Storage     aStorage;
 100     RepositoryPartition *
 101                     pCppRepositoryPartition;
 102 };
 103
 104
 105
 106
 107 // IMPLEMENTATION
 108 inline const Def_Storage &
 109 DefAdmin::Storage() const
 110 {
 111     return aStorage;
 112 }
 113
 114
 115
 116 }   // namespace cpp
 117 }   // namespace ary
 118 #endif