summaryrefslogtreecommitdiff
path: root/libvaladoc/api/struct.vala
blob: 93bbce778e4c33eb6825b60bdbb2ba6ca92fa70c (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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/* struct.vala
 *
 * Copyright (C) 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 struct declaration.
 */
public class Valadoc.Api.Struct : TypeSymbol {
	private string? dup_function_cname;
	private string? copy_function_cname;
	private string? free_function_cname;
	private string? destroy_function_cname;
	private string? type_id;
	private string? cname;

	public Struct (Node parent, SourceFile file, string name, SymbolAccessibility accessibility,
				   SourceComment? comment, string? cname, string? type_macro_name,
				   string? type_function_name, string? type_id, string? dup_function_cname,
				   string? copy_function_cname, string? destroy_function_cname,
				   string? free_function_cname, bool is_basic_type, void* data)
	{
		base (parent, file, name, accessibility, comment, type_macro_name, null, null,
			type_function_name, is_basic_type, data);

		this.dup_function_cname = dup_function_cname;
		this.copy_function_cname = copy_function_cname;
		this.free_function_cname = free_function_cname;
		this.destroy_function_cname = destroy_function_cname;

		this.cname = cname;
	}

	/**
	 * Specifies the base struct.
	 */
	public TypeReference? base_type {
		set;
		get;
	}


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

	/**
	 * Returns the C symbol representing the runtime type id for this data type.
	 */
	public string? get_type_id () {
		return type_id;
	}

	/**
	 * Returns the C function name that duplicates instances of this data
	 * type.
	 */
	public string? get_dup_function_cname () {
		return dup_function_cname;
	}

	/**
	 * Returns the C function name that copies instances of this data
	 * type.
	 */
	public string? get_copy_function_cname () {
		return copy_function_cname;
	}

	/**
	 * Returns the C function name that frees instances of this data type.
	 */
	public string? get_free_function_cname () {
		return free_function_cname;
	}

	/**
	 * Returns the C function name that destroys instances of this data type.
	 */
	public string? get_destroy_function_cname () {
		return destroy_function_cname;
	}

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

	/**
	 * {@inheritDoc}
	 */
	public override void accept (Visitor visitor) {
		visitor.visit_struct (this);
	}


	private Vala.Set<Struct> _known_child_structs = new Vala.HashSet<Struct> ();

	/**
	 * Returns a list of all known structs based on this struct
	 */
	public Vala.Collection<Struct> get_known_child_structs () {
		return _known_child_structs;
	}

	public void register_child_struct (Struct stru) {
		if (this.base_type != null) {
			((Struct) this.base_type.data_type).register_child_struct (stru);
		}

		_known_child_structs.add (stru);
	}


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

		signature.append_keyword (accessibility.to_string ());
		signature.append_keyword ("struct");
		signature.append_symbol (this);

		var type_parameters = get_children_by_type (NodeType.TYPE_PARAMETER, false);
		if (type_parameters.size > 0) {
			signature.append ("<", false);
			bool first = true;
			foreach (Item param in type_parameters) {
				if (!first) {
					signature.append (",", false);
				}
				signature.append_content (param.signature, false);
				first = false;
			}
			signature.append (">", false);
		}

		if (base_type != null) {
			signature.append (":");

			signature.append_content (base_type.signature);
		}

		return signature.get ();
	}
}