autodoc/inc/ary/idl/i_property.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: i_property.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_IDL_I_PROPERTY_HXX
  32 #define ARY_IDL_I_PROPERTY_HXX
  33
  34 // BASE CLASSES
  35 #include <ary/idl/i_ce.hxx>
  36
  37
  38
  39
  40 namespace ary
  41 {
  42 namespace idl
  43 {
  44 namespace ifc_property
  45 {
  46     struct attr;
  47 }
  48
  49
  50 /** Represents an IDL property.
  51 */
  52 class Property : public CodeEntity
  53 {
  54   public:
  55     enum E_ClassId { class_id = 2004 };
  56
  57     class Stereotypes
  58     {
  59       public:
  60         enum E_Flags
  61         {
  62             readonly = 1,
  63             bound = 2,
  64             constrained = 4,
  65             maybeambiguous = 8,
  66             maybedefault = 16,
  67             maybevoid = 32,
  68             removable = 64,
  69             transient = 128,
  70             s_MAX
  71         };
  72                             Stereotypes()       : nFlags(0) {}
  73
  74         bool                HasAny() const      { return nFlags != 0; }
  75         bool                IsReadOnly() const  { return (nFlags & UINT32(readonly)) != 0; }
  76         bool                IsBound() const     { return (nFlags & UINT32(bound)) != 0; }
  77         bool                IsConstrained() const
  78                                                 { return (nFlags & UINT32(constrained)) != 0; }
  79         bool                IsMayBeAmbiguous() const
  80                                                 { return (nFlags & UINT32(maybeambiguous)) != 0; }
  81         bool                IsMayBeDefault() const
  82                                                 { return (nFlags & UINT32(maybedefault)) != 0; }
  83         bool                IsMayBeVoid() const { return (nFlags & UINT32(maybevoid)) != 0; }
  84         bool                IsRemovable() const { return (nFlags & UINT32(removable)) != 0; }
  85         bool                IsTransient() const { return (nFlags & UINT32(transient)) != 0; }
  86
  87         void                Set_Flag(
  88                                 E_Flags         i_flag )
  89                                                 { nFlags |= UINT32(i_flag); }
  90       private:
  91         // DATA
  92         UINT32              nFlags;
  93     };
  94
  95
  96     // LIFECYCLE
  97                         Property(
  98                             const String &      i_sName,
  99                             Ce_id               i_nService,
 100                             Ce_id               i_nModule,
 101                             Type_id             i_nType,
 102                             Stereotypes         i_stereotypes );
 103                         ~Property();
 104     // INQUIRY
 105     Type_id             Type() const;
 106
 107   private:
 108     // Interface csv::ConstProcessorClient:
 109     virtual void        do_Accept(
 110                             csv::ProcessorIfc & io_processor ) const;
 111     // Interface ary::Object:
 112     virtual ClassId     get_AryClass() const;
 113
 114     // Interface CodeEntity
 115     virtual const String &  inq_LocalName() const;
 116     virtual Ce_id           inq_NameRoom() const;
 117     virtual Ce_id           inq_Owner() const;
 118     virtual E_SightLevel    inq_SightLevel() const;
 119
 120     friend struct ifc_property::attr;
 121
 122     // DATA
 123     String              sName;
 124     Ce_id               nOwner;
 125     Ce_id               nNameRoom;
 126
 127     Type_id             nType;
 128     Stereotypes         aStereotypes;
 129 };
 130
 131
 132
 133
 134 // IMPLEMENTATION
 135 inline Type_id
 136 Property::Type() const
 137 {
 138     return nType;
 139 }
 140
 141
 142
 143
 144 }   // namespace idl
 145 }   // namespace ary
 146 #endif