autodoc/inc/ary/cpp/cp_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: cp_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_CP_DEF_HXX
  32 #define ARY_CPP_CP_DEF_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37     // OTHER
  38 #include <ary/cpp/c_types4cpp.hxx>
  39
  40 namespace ary
  41 {
  42 namespace cpp
  43 {
  44     class Define;
  45     class InputContext;
  46     class Macro;
  47 }
  48 }
  49
  50
  51
  52
  53 namespace ary
  54 {
  55 namespace cpp
  56 {
  57
  58
  59
  60 /** Acess to C++ defines and macros in the repository.
  61 */
  62 class DefPilot
  63 {
  64   public:
  65     typedef DefsList::const_iterator                DefsIterator;
  66
  67
  68
  69     // LIFECYCLE
  70     virtual             ~DefPilot() {}
  71
  72
  73     // OPERATIONS
  74     virtual Define &    Store_Define(
  75                             const InputContext& i_rContext,
  76                             const String  &     i_sName,
  77                             const StringVector &
  78                                                 i_rDefinition ) = 0;
  79     virtual Macro &     Store_Macro(
  80                             const InputContext& i_rContext,
  81                             const String  &     i_sName,
  82                             const StringVector &
  83                                                 i_rParams,
  84                             const StringVector &
  85                                                 i_rDefinition ) = 0;
  86     // INQUIRY
  87     virtual const DefineEntity &
  88                         Find_Def(
  89                             De_id               i_id ) const = 0;
  90     virtual DefsResultList
  91                         AllDefines() const = 0;
  92     virtual DefsResultList
  93                         AllMacros() const = 0;
  94 };
  95
  96
  97
  98
  99
 100 }   // namespace cpp
 101 }   // namespace ary
 102 #endif