summaryrefslogtreecommitdiff
path: root/libvaladoc/api/propertyaccessor.vala
blob: 56ad067192b6cad067d33abb134df414d94a1223 (plain)
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
/* propertyaccessor.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 get or set accessor of a property.
 */
public class Valadoc.Api.PropertyAccessor : Symbol {
	private Ownership ownership;
	private string? cname;

	public PropertyAccessor (Property parent, SourceFile file, string name, Vala.SymbolAccessibility accessibility,
							 Vala.PropertyAccessor data)
	{
		base (parent, file, name, accessibility, null, data);

		this.ownership = get_property_ownership (data);
		this.cname = Vala.get_ccode_name (data);
	}

	Ownership get_property_ownership (Vala.PropertyAccessor element) {
		if (element.value_type.value_owned) {
			return Ownership.OWNED;
		}

		// the exact type (weak, unowned) does not matter
		return Ownership.UNOWNED;
	}

	/**
	 * {@inheritDoc}
	 */
	public override NodeType node_type {
		get { return NodeType.PROPERTY_ACCESSOR; }
	}

	/**
	 * Returns the name of this property accessor as it is used in C.
	 */
	public string? get_cname () {
		return cname;
	}

	/**
	 * {@inheritDoc}
	 */
	public override void accept (Visitor visitor) {
	}

	/**
	 * Specifies whether this accessor may be used to construct the property.
	 */
	public bool is_construct {
		get {
			return ((Vala.PropertyAccessor) data).construction;
		}
	}

	/**
	 * Specifies whether this accessor is a setter.
	 */
	public bool is_set {
		get {
			return ((Vala.PropertyAccessor) data).writable;
		}
	}

	/**
	 * Specifies whether this accessor is a getter.
	 */
	public bool is_get {
		get {
			return ((Vala.PropertyAccessor) data).readable;
		}
	}

	/**
	 * Specifies whether the property is owned.
	 */
	public bool is_owned {
		get {
			return ownership == Ownership.OWNED;
		}
	}

	/**
	 * {@inheritDoc}
	 */
	protected override Inline build_signature () {
		var signature = new SignatureBuilder ();

		// FIXME
		if (!do_document) {
			return signature.get ();
		}

		if (((Property) parent).accessibility != accessibility) {
			signature.append_keyword (accessibility.to_string ());
		}

		if (is_set || is_construct) {
			if (is_owned) {
				signature.append_keyword ("owned");
			}
			if (is_set) {
				signature.append_keyword ("set");
			}
			if (is_construct) {
				signature.append_keyword ("construct");
			}
		} else if (is_get) {
			if (is_owned) {
				signature.append_keyword ("owned");
			}
			signature.append_keyword ("get");
		}
		signature.append (";", false);

		return signature.get ();
	}
}