autodoc/inc/ary/cpp/c_tydef.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_tydef.hxx,v $
  10  * $Revision: 1.5 $
  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_TYDEF_HXX
  32 #define ARY_CPP_C_TYDEF_HXX
  33
  34
  35
  36 // USED SERVICES
  37     // BASE CLASSES
  38 #include <ary/cpp/c_ce.hxx>
  39     // OTHER
  40 #include <ary/cessentl.hxx>
  41 #include <ary/cpp/c_types4cpp.hxx>
  42
  43
  44
  45 namespace ary
  46 {
  47 namespace cpp
  48 {
  49
  50
  51 /** A C++ typedef declaration.
  52 */
  53 class Typedef : public CodeEntity
  54 {
  55   public:
  56     // LIFECYCLE
  57     enum E_ClassId { class_id = 1003 };
  58
  59                         Typedef(
  60                             const String  &     i_sLocalName,
  61                             Ce_id               i_nOwner,
  62                             E_Protection        i_eProtection,
  63                             Lid                 i_nFile,
  64                             Type_id             i_nDescribingType );
  65                         ~Typedef();
  66     // INQUIRY
  67     Type_id             DescribingType() const;
  68     E_Protection        Protection() const      { return eProtection; }
  69
  70   private:
  71     // Interface csv::ConstProcessorClient
  72     virtual void        do_Accept(
  73                             csv::ProcessorIfc & io_processor ) const;
  74
  75     // Interface ary::cpp::CodeEntity
  76     virtual const String  &
  77                         inq_LocalName() const;
  78     virtual Cid         inq_Owner() const;
  79     virtual Lid                 inq_Location() const;
  80
  81     // Interface ary::cpp::CppEntity
  82     virtual ClassId     get_AryClass() const;
  83
  84     // DATA
  85     CeEssentials                aEssentials;
  86     Type_id             nDescribingType;
  87     E_Protection                eProtection;
  88 };
  89
  90
  91
  92 // IMPLEMENTATION
  93 inline Type_id
  94 Typedef::DescribingType() const
  95 {
  96     return nDescribingType;
  97 }
  98
  99
 100
 101 }   //  namespace cpp
 102 }   //  namespace ary
 103 #endif