summaryrefslogtreecommitdiff
path: root/libvaladoc/api/visitor.vala
blob: bf66a456b134e8580e7db1c1e253d7389dcdf3fc (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
/* visitor.vala
 *
 * Copyright (C) 2008-2009 Florian Brosch, Didier Villevalois
 *
 * 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:
 * 	Didier 'Ptitjes Villevalois <ptitjes@free.fr>
 */


/**
 * Abstract visitor for traversing API.
 */
public abstract class Valadoc.Api.Visitor : GLib.Object {
	/**
	 * Visit operation called for api trees.
	 *
	 * @param item a tree
	 */
	public virtual void visit_tree (Tree item) {
	}

	/**
	 * Visit operation called for packages like gir-files and vapi-files.
	 *
	 * @param item a package
	 */
	public virtual void visit_package (Package item) {
	}

	/**
	 * Visit operation called for namespaces
	 *
	 * @param item a namespace
	 */
	public virtual void visit_namespace (Namespace item) {
	}

	/**
	 * Visit operation called for interfaces.
	 *
	 * @param item a interface
	 */
	public virtual void visit_interface (Interface item) {
	}

	/**
	 * Visit operation called for classes.
	 *
	 * @param item a class
	 */
	public virtual void visit_class (Class item) {
	}

	/**
	 * Visit operation called for structs.
	 *
	 * @param item a struct
	 */
	public virtual void visit_struct (Struct item) {
	}

	/**
	 * Visit operation called for properties.
	 *
	 * @param item a property
	 */
	public virtual void visit_property (Property item) {
	}

	/**
	 * Visit operation called for fields.
	 *
	 * @param item a field
	 */
	public virtual void visit_field (Field item) {
	}

	/**
	 * Visit operation called for constants.
	 *
	 * @param item a constant
	 */
	public virtual void visit_constant (Constant item) {
	}

	/**
	 * Visit operation called for delegates.
	 *
	 * @param item a delegate
	 */
	public virtual void visit_delegate (Delegate item) {
	}

	/**
	 * Visit operation called for signals.
	 *
	 * @param item a signal
	 */
	public virtual void visit_signal (Signal item) {
	}

	/**
	 * Visit operation called for methods.
	 *
	 * @param item a method
	 */
	public virtual void visit_method (Method item) {
	}

	/**
	 * Visit operation called for type parameters.
	 *
	 * @param item a type parameter
	 */
	public virtual void visit_type_parameter (TypeParameter item) {
	}

	/**
	 * Visit operation called for formal parameters.
	 *
	 * @param item a formal parameter
	 */
	public virtual void visit_formal_parameter (FormalParameter item) {
	}

	/**
	 * Visit operation called for error domains.
	 *
	 * @param item a error domain
	 */
	public virtual void visit_error_domain (ErrorDomain item) {
	}

	/**
	 * Visit operation called for error codes.
	 *
	 * @param item a error code
	 */
	public virtual void visit_error_code (ErrorCode item) {
	}

	/**
	 * Visit operation called for enums.
	 *
	 * @param item a enum
	 */
	public virtual void visit_enum (Enum item) {
	}

	/**
	 * Visit operation called for enum values.
	 *
	 * @param item a enum value
	 */
	public virtual void visit_enum_value (EnumValue item) {
	}
}