autodoc/inc/ary/cpp/c_ce.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_ce.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_C_CE_HXX
  32 #define ARY_CPP_C_CE_HXX
  33
  34
  35 // USED SERVICES
  36     // BASE CLASSES
  37 #include <ary/cpp/c_cppentity.hxx>
  38     // COMPONENTS
  39 #include <ary/doc/d_docu.hxx>
  40     // PARAMETERS
  41 #include <ary/cpp/c_types4cpp.hxx>
  42 #include <ary/cpp/c_traits.hxx>
  43 #include <ary/loc/loc_types4loc.hxx>
  44
  45
  46 namespace ary
  47 {
  48 namespace cpp
  49 {
  50
  51 typedef loc::Le_id  Lid;
  52
  53
  54
  55 /** Represents a C++ code entity.
  56 */
  57 class CodeEntity : public ary::cpp::CppEntity
  58 {
  59   public:
  60     typedef Ce_Traits       traits_t;
  61
  62     // LIFECYCLE
  63     virtual                             ~CodeEntity() {}
  64
  65     // INQUIRY
  66     Ce_id               CeId() const            { return Ce_id(Id()); }
  67     const String  &     LocalName() const;
  68     Cid                 Owner() const;
  69     Lid                         Location() const;
  70     bool                IsVisible() const;
  71
  72     // ACCESS
  73     void                Set_InVisible()         { bIsVisible = false; }
  74
  75   protected:
  76                         CodeEntity() : bIsVisible(true) {}
  77
  78   private:
  79     // Locals
  80     virtual const String  &
  81                         inq_LocalName() const = 0;
  82     virtual Cid         inq_Owner() const = 0;
  83     virtual Lid                 inq_Location() const = 0;
  84
  85     // DATA
  86     mutable bool        bIsVisible;
  87 };
  88
  89
  90 // IMPLEMENTATION
  91 inline const String  &
  92 CodeEntity::LocalName() const
  93     { return inq_LocalName(); }
  94 inline Cid
  95 CodeEntity::Owner() const
  96     { return inq_Owner(); }
  97 inline Lid
  98 CodeEntity::Location() const
  99     { return inq_Location(); }
 100
 101
 102
 103
 104 }   // namespace cpp
 105 }   // namespace ary
 106 #endif