libvaladoc/api/signal.vala

   1 /* signal.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 an signal.
  28  */
  29 public class Valadoc.Api.Signal : Member, Callable {
  30         private string? default_impl_cname;
  31         private string? dbus_name;
  32         private string? cname;
  33
  34
  35         /**
  36          * {@inheritDoc}
  37          */
  38         internal string? implicit_array_length_cparameter_name {
  39                 get;
  40                 set;
  41         }
  42
  43
  44         public Signal (Node parent, SourceFile file, string name, SymbolAccessibility accessibility,
  45                                    SourceComment? comment, string? cname, string? default_impl_cname, string? dbus_name, bool is_dbus_visible,
  46                                    bool is_virtual, Vala.Signal data)
  47         {
  48                 base (parent, file, name, accessibility, comment, data);
  49
  50                 this.default_impl_cname = default_impl_cname;
  51                 this.dbus_name = dbus_name;
  52                 this.cname = cname;
  53
  54                 this.is_dbus_visible = is_dbus_visible;
  55                 this.is_virtual = is_virtual;
  56         }
  57
  58         /**
  59          * Returns the name of this signal as it is used in C.
  60          */
  61         public string? get_cname () {
  62                 return cname;
  63         }
  64
  65         public string? get_default_impl_cname () {
  66                 return default_impl_cname;
  67         }
  68
  69         /**
  70          * Returns the dbus-name.
  71          */
  72         public string get_dbus_name () {
  73                 return dbus_name;
  74         }
  75
  76         /**
  77          * {@inheritDoc}
  78          */
  79         public TypeReference? return_type {
  80                 set;
  81                 get;
  82         }
  83
  84         /**
  85          * Specifies whether this signal is virtual
  86          */
  87         public bool is_virtual {
  88                 private set;
  89                 get;
  90         }
  91
  92         /**
  93          * Specifies whether this signal is visible for dbus
  94          */
  95         public bool is_dbus_visible {
  96                 private set;
  97                 get;
  98         }
  99
 100         /**
 101          * {@inheritDoc}
 102          */
 103         protected override Inline build_signature () {
 104                 var signature = new SignatureBuilder ();
 105
 106                 signature.append_keyword (accessibility.to_string ());
 107                 if (is_virtual) {
 108                         signature.append_keyword ("virtual");
 109                 }
 110
 111                 signature.append_keyword ("signal");
 112
 113                 signature.append_content (return_type.signature);
 114                 signature.append_symbol (this);
 115                 signature.append ("(");
 116
 117                 bool first = true;
 118                 foreach (Node param in get_children_by_type (NodeType.FORMAL_PARAMETER, false)) {
 119                         if (!first) {
 120                                 signature.append (",", false);
 121                         }
 122                         signature.append_content (param.signature, !first);
 123                         first = false;
 124                 }
 125
 126                 signature.append (")", false);
 127
 128                 return signature.get ();
 129         }
 130
 131         /**
 132          * {@inheritDoc}
 133          */
 134         public override NodeType node_type {
 135                 get { return NodeType.SIGNAL; }
 136         }
 137
 138         /**
 139          * {@inheritDoc}
 140          */
 141         public override void accept (Visitor visitor) {
 142                 visitor.visit_signal (this);
 143         }
 144 }
 145