autodoc/inc/ary/idl/i_property.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_IDL_I_PROPERTY_HXX
  21 #define ARY_IDL_I_PROPERTY_HXX
  22
  23 // BASE CLASSES
  24 #include <ary/idl/i_ce.hxx>
  25
  26
  27
  28
  29 namespace ary
  30 {
  31 namespace idl
  32 {
  33 namespace ifc_property
  34 {
  35     struct attr;
  36 }
  37
  38
  39 /** Represents an IDL property.
  40 */
  41 class Property : public CodeEntity
  42 {
  43   public:
  44     enum E_ClassId { class_id = 2004 };
  45
  46     class Stereotypes
  47     {
  48       public:
  49         enum E_Flags
  50         {
  51             readonly = 1,
  52             bound = 2,
  53             constrained = 4,
  54             maybeambiguous = 8,
  55             maybedefault = 16,
  56             maybevoid = 32,
  57             removable = 64,
  58             transient = 128,
  59             s_MAX
  60         };
  61                             Stereotypes()       : nFlags(0) {}
  62
  63         bool                HasAny() const      { return nFlags != 0; }
  64         bool                IsReadOnly() const  { return (nFlags & UINT32(readonly)) != 0; }
  65         bool                IsBound() const     { return (nFlags & UINT32(bound)) != 0; }
  66         bool                IsConstrained() const
  67                                                 { return (nFlags & UINT32(constrained)) != 0; }
  68         bool                IsMayBeAmbiguous() const
  69                                                 { return (nFlags & UINT32(maybeambiguous)) != 0; }
  70         bool                IsMayBeDefault() const
  71                                                 { return (nFlags & UINT32(maybedefault)) != 0; }
  72         bool                IsMayBeVoid() const { return (nFlags & UINT32(maybevoid)) != 0; }
  73         bool                IsRemovable() const { return (nFlags & UINT32(removable)) != 0; }
  74         bool                IsTransient() const { return (nFlags & UINT32(transient)) != 0; }
  75
  76         void                Set_Flag(
  77                                 E_Flags         i_flag )
  78                                                 { nFlags |= UINT32(i_flag); }
  79       private:
  80         // DATA
  81         UINT32              nFlags;
  82     };
  83
  84
  85     // LIFECYCLE
  86                         Property(
  87                             const String &      i_sName,
  88                             Ce_id               i_nService,
  89                             Ce_id               i_nModule,
  90                             Type_id             i_nType,
  91                             Stereotypes         i_stereotypes );
  92                         ~Property();
  93     // INQUIRY
  94     Type_id             Type() const;
  95
  96   private:
  97     // Interface csv::ConstProcessorClient:
  98     virtual void        do_Accept(
  99                             csv::ProcessorIfc & io_processor ) const;
 100     // Interface ary::Object:
 101     virtual ClassId     get_AryClass() const;
 102
 103     // Interface CodeEntity
 104     virtual const String &  inq_LocalName() const;
 105     virtual Ce_id           inq_NameRoom() const;
 106     virtual Ce_id           inq_Owner() const;
 107     virtual E_SightLevel    inq_SightLevel() const;
 108
 109     friend struct ifc_property::attr;
 110
 111     // DATA
 112     String              sName;
 113     Ce_id               nOwner;
 114     Ce_id               nNameRoom;
 115
 116     Type_id             nType;
 117     Stereotypes         aStereotypes;
 118 };
 119
 120
 121
 122
 123 // IMPLEMENTATION
 124 inline Type_id
 125 Property::Type() const
 126 {
 127     return nType;
 128 }
 129
 130
 131
 132
 133 }   // namespace idl
 134 }   // namespace ary
 135 #endif
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */