libvaladoc/api/property.vala

   1 /* property.vala
   2  *
   3  * Copyright (C) 2008-2011  Florian Brosch
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA
  18  *
  19  * Author:
  20  *      Florian Brosch <flo.brosch@gmail.com>
  21  */
  22
  23
  24 using Valadoc.Content;
  25
  26 /**
  27  * Represents a property declaration.
  28  */
  29 public class Valadoc.Api.Property : Member {
  30         private PropertyBindingType binding_type;
  31         private string? dbus_name;
  32         private string? cname;
  33
  34         public Property (Node parent, SourceFile file, string name, SymbolAccessibility accessibility,
  35                                          SourceComment? comment, string? cname, string? dbus_name, bool is_dbus_visible,
  36                                          PropertyBindingType binding_type, Vala.Property data)
  37         {
  38                 base (parent, file, name, accessibility, comment, data);
  39
  40                 this.is_dbus_visible = is_dbus_visible;
  41                 this.binding_type = binding_type;
  42
  43                 this.dbus_name = dbus_name;
  44                 this.cname = cname;
  45         }
  46
  47         /**
  48          * Returns the name of this method as it is used in C.
  49          */
  50         public string? get_cname () {
  51                 return cname;
  52         }
  53
  54         /**
  55          * Returns the dbus-name.
  56          */
  57         public string get_dbus_name () {
  58                 return dbus_name;
  59         }
  60
  61         /**
  62          * The property type.
  63          */
  64         public TypeReference? property_type {
  65                 set;
  66                 get;
  67         }
  68
  69         /**
  70          * Specifies whether the property is virtual.
  71          */
  72         public bool is_virtual {
  73                 get {
  74                         return binding_type == PropertyBindingType.VIRTUAL;
  75                 }
  76         }
  77
  78         /**
  79          * Specifies whether the property is abstract.
  80          */
  81         public bool is_abstract {
  82                 get {
  83                         return binding_type == PropertyBindingType.ABSTRACT;
  84                 }
  85         }
  86
  87         /**
  88          * Specifies whether the property is override.
  89          */
  90         public bool is_override {
  91                 get {
  92                         return binding_type == PropertyBindingType.OVERRIDE;
  93                 }
  94         }
  95
  96         /**
  97          * Specifies whether the property is visible.
  98          */
  99         public bool is_dbus_visible {
 100                 private set;
 101                 get;
 102         }
 103
 104         public PropertyAccessor? setter {
 105                 set;
 106                 get;
 107         }
 108
 109         public PropertyAccessor? getter {
 110                 set;
 111                 get;
 112         }
 113
 114         /**
 115          * Specifies the virtual or abstract property this property overrides.
 116          */
 117         public Property base_property {
 118                 set;
 119                 get;
 120         }
 121
 122         /**
 123          * {@inheritDoc}
 124          */
 125         internal override void parse_comments (Settings settings, DocumentationParser parser) {
 126                 if (getter != null && getter.is_browsable (settings)) {
 127                         getter.parse_comments (settings, parser);
 128                 }
 129
 130                 if (setter != null && setter.is_browsable (settings)) {
 131                         setter.parse_comments (settings, parser);
 132                 }
 133
 134                 base.parse_comments (settings, parser);
 135         }
 136
 137         /**
 138          * {@inheritDoc}
 139          */
 140         internal override void check_comments (Settings settings, DocumentationParser parser) {
 141                 if (getter != null && getter.is_browsable (settings)) {
 142                         getter.check_comments (settings, parser);
 143                 }
 144
 145                 if (setter != null && setter.is_browsable (settings)) {
 146                         setter.check_comments (settings, parser);
 147                 }
 148
 149                 base.check_comments (settings, parser);
 150         }
 151
 152
 153         /**
 154          * {@inheritDoc}
 155          */
 156         protected override Inline build_signature () {
 157                 var signature = new SignatureBuilder ();
 158
 159                 signature.append_keyword (accessibility.to_string ());
 160                 if (is_abstract) {
 161                         signature.append_keyword ("abstract");
 162                 } else if (is_override) {
 163                         signature.append_keyword ("override");
 164                 } else if (is_virtual) {
 165                         signature.append_keyword ("virtual");
 166                 }
 167
 168                 signature.append_content (property_type.signature);
 169                 signature.append_symbol (this);
 170                 signature.append ("{");
 171
 172                 if (setter != null && setter.do_document) {
 173                         signature.append_content (setter.signature);
 174                 }
 175
 176                 if (getter != null && getter.do_document) {
 177                         signature.append_content (getter.signature);
 178                 }
 179
 180                 signature.append ("}");
 181
 182                 return signature.get ();
 183         }
 184
 185         /**
 186          * {@inheritDoc}
 187          */
 188         public override NodeType node_type {
 189                 get { return NodeType.PROPERTY; }
 190         }
 191
 192         /**
 193          * {@inheritDoc}
 194          */
 195         public override void accept (Visitor visitor) {
 196                 visitor.visit_property (this);
 197         }
 198 }
 199