autodoc/inc/ary/cpp/c_vari.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_vari.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_VARI_HXX
  32 #define ARY_CPP_C_VARI_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <ary/cpp/c_ce.hxx>
  38     // OTHER
  39 #include <ary/cessentl.hxx>
  40 #include <ary/cpp/c_types4cpp.hxx>
  41 #include <ary/cpp/c_vfflag.hxx>
  42
  43
  44
  45 namespace ary
  46 {
  47 namespace cpp
  48 {
  49
  50
  51 /** A C++ variable or constant declaration.
  52 */
  53 class Variable : public CodeEntity
  54 {
  55   public:
  56     // LIFECYCLE
  57     enum E_ClassId { class_id = 1005 };
  58
  59                         Variable(
  60                             const String  &     i_sLocalName,
  61                             Ce_id               i_nOwner,
  62                             E_Protection        i_eProtection,
  63                             loc::Le_id          i_nFile,
  64                             Type_id             i_nType,
  65                             VariableFlags       i_aFlags,
  66                             const String  &     i_sArraySize,
  67                             const String  &     i_sInitValue );
  68                         ~Variable();
  69
  70
  71     // INQUIRY
  72     Type_id             Type() const;
  73     const String  &     ArraySize() const;
  74     const String  &     Initialisation() const;
  75     E_Protection        Protection() const      { return eProtection; }
  76
  77   private:
  78     // Interface csv::ConstProcessorClient
  79     virtual void        do_Accept(
  80                             csv::ProcessorIfc & io_processor ) const;
  81
  82     // Interface ary::cpp::CodeEntity
  83     virtual const String  &
  84                         inq_LocalName() const;
  85     virtual Cid         inq_Owner() const;
  86     virtual Lid                 inq_Location() const;
  87
  88     // Interface ary::cpp::CppEntity
  89     virtual ClassId     get_AryClass() const;
  90
  91     // DATA
  92     CeEssentials                aEssentials;
  93     Type_id             nType;
  94     E_Protection                eProtection;
  95     VariableFlags       aFlags;
  96     String              sArraySize;
  97     String              sInitialisation;
  98 };
  99
 100
 101
 102 // IMPLEMENTATION
 103 inline Type_id
 104 Variable::Type() const
 105     { return nType; }
 106 inline const String  &
 107 Variable::ArraySize() const
 108     { return sArraySize; }
 109 inline const String  &
 110 Variable::Initialisation() const
 111     { return sInitialisation; }
 112
 113
 114
 115 }   // namespace cpp
 116 }   // namespace ary
 117 #endif