1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
|
/* parameter.vala
*
* Copyright (C) 2008-2011 Florian Brosch
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Author:
* Florian Brosch <flo.brosch@gmail.com>
*/
using Valadoc.Content;
/**
* Represents a parameter in method, signal and delegate signatures.
*/
public class Valadoc.Api.Parameter : Symbol {
public Content.Run default_value {
get;
set;
}
/**
* Used to translate imported C-documentation
*/
internal string? implicit_array_length_cparameter_name {
get;
set;
}
/**
* Used to translate imported C-documentation
*/
internal string? implicit_closure_cparameter_name {
get;
set;
}
/**
* Used to translate imported C-documentation
*/
internal string? implicit_destroy_cparameter_name {
get;
set;
}
private Vala.ParameterDirection type;
public Parameter (Node parent, SourceFile file, string? name, Vala.SymbolAccessibility accessibility, Vala.ParameterDirection type, bool ellipsis, Vala.Parameter data) {
base (parent, file, name, accessibility, null, data);
assert ((name == null && ellipsis) || (name != null && !ellipsis));
this.ellipsis = ellipsis;
this.type = type;
}
/**
* Specifies whether the parameter direction is out
*/
public bool is_out {
get {
return type == Vala.ParameterDirection.OUT;
}
}
/**
* Specifies whether the parameter direction is ref
*/
public bool is_ref {
get {
return type == Vala.ParameterDirection.REF;
}
}
/**
* Specifies whether the parameter has a default value
*/
public bool has_default_value {
get {
return default_value != null;
}
}
/**
* The parameter type.
*/
public TypeReference? parameter_type {
set;
get;
}
/**
* Specifies whether the methods accepts a variable number of arguments
*/
public bool ellipsis {
private set;
get;
}
/**
* {@inheritDoc}
*/
public override NodeType node_type {
get { return NodeType.FORMAL_PARAMETER; }
}
/**
* {@inheritDoc}
*/
public override void accept (Visitor visitor) {
visitor.visit_formal_parameter (this);
}
/**
* {@inheritDoc}
*/
protected override Inline build_signature () {
var signature = new SignatureBuilder ();
if (ellipsis) {
signature.append ("...");
} else {
if (is_out) {
signature.append_keyword ("out");
} else if (is_ref) {
signature.append_keyword ("ref");
}
signature.append_content (parameter_type.signature);
signature.append (name);
if (has_default_value) {
signature.append ("=");
signature.append_content (default_value);
}
}
return signature.get ();
}
}
|