autodoc/inc/ary/cpp/c_macro.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_macro.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_CPP_C_MACRO_HXX
  32 #define ARY_CPP_C_MACRO_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <ary/cpp/c_de.hxx>
  38
  39
  40
  41 namespace ary
  42 {
  43 namespace cpp
  44 {
  45
  46
  47 /** A C/C++ macro ("#define ABC(a,b)") statement, but no simple define.
  48
  49     @see Define
  50 */
  51 class Macro : public DefineEntity
  52 {
  53   public:
  54     enum E_ClassId { class_id = 1602 };
  55
  56                         Macro();
  57                         Macro(      /// Used for: #define DEFINE xyz
  58                             const String  &     i_name,
  59                             const StringVector &
  60                                                 i_params,
  61                             const StringVector &
  62                                                 i_definition,
  63                             loc::Le_id          i_declaringFile );
  64                         ~Macro();
  65     const StringVector &  Params() const          { return aParams; }
  66
  67   private:
  68     // Interface csv::ConstProcessorClient
  69     virtual void        do_Accept(
  70                             csv::ProcessorIfc & io_processor ) const;
  71     // Interface ary::Object
  72     virtual ClassId     get_AryClass() const;
  73
  74     // Interface DefineEntity:
  75     virtual const StringVector &
  76                         inq_DefinitionText() const;
  77     // DATA
  78     StringVector          aParams;
  79     StringVector          aDefinition;
  80 };
  81
  82
  83
  84
  85 }   // namespace cpp
  86 }   // namespace ary
  87 #endif