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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/* girwriter.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.Api;
/**
* Code visitor generating .gir file for the public interface.
*/
public class Valadoc.GirWriter : Vala.GIRWriter {
private GtkdocRenderer renderer;
private SymbolResolver resolver;
public GirWriter (SymbolResolver resolver) {
this.renderer = new GtkdocRenderer ();
this.resolver = resolver;
}
private string? translate (Content.Comment? documentation) {
if (documentation == null) {
return null;
}
renderer.render_symbol (documentation);
return MarkupWriter.escape (renderer.content);
}
private string? translate_taglet (Content.Taglet? taglet) {
if (taglet == null) {
return null;
}
renderer.render_children (taglet);
return MarkupWriter.escape (renderer.content);
}
protected override string? get_interface_comment (Vala.Interface viface) {
Interface iface = resolver.resolve (viface) as Interface;
return translate (iface.documentation);
}
protected override string? get_struct_comment (Vala.Struct vst) {
Struct st = resolver.resolve (vst) as Struct;
return translate (st.documentation);
}
protected override string? get_enum_comment (Vala.Enum ven) {
Enum en = resolver.resolve (ven) as Enum;
return translate (en.documentation);
}
protected override string? get_class_comment (Vala.Class vc) {
Class c = resolver.resolve (vc) as Class;
return translate (c.documentation);
}
protected override string? get_error_code_comment (Vala.ErrorCode vecode) {
ErrorCode ecode = resolver.resolve (vecode) as ErrorCode;
return translate (ecode.documentation);
}
protected override string? get_enum_value_comment (Vala.EnumValue vev) {
Api.EnumValue ev = resolver.resolve (vev) as Api.EnumValue;
return translate (ev.documentation);
}
protected override string? get_constant_comment (Vala.Constant vc) {
Constant c = resolver.resolve (vc) as Constant;
return translate (c.documentation);
}
protected override string? get_error_domain_comment (Vala.ErrorDomain vedomain) {
ErrorDomain edomain = resolver.resolve (vedomain) as ErrorDomain;
return translate (edomain.documentation);
}
protected override string? get_field_comment (Vala.Field vf) {
Field f = resolver.resolve (vf) as Field;
return translate (f.documentation);
}
protected override string? get_delegate_comment (Vala.Delegate vcb) {
Delegate cb = resolver.resolve (vcb) as Delegate;
return translate (cb.documentation);
}
protected override string? get_method_comment (Vala.Method vm) {
Method m = resolver.resolve (vm) as Method;
return translate (m.documentation);
}
protected override string? get_property_comment (Vala.Property vprop) {
Property prop = resolver.resolve (vprop) as Property;
return translate (prop.documentation);
}
protected override string? get_delegate_return_comment (Vala.Delegate vcb) {
Delegate cb = resolver.resolve (vcb) as Delegate;
if (cb == null) {
return null;
}
Content.Comment? documentation = cb.documentation;
if (documentation == null) {
return null;
}
Vala.List<Content.Taglet> taglets = documentation.find_taglets (cb, typeof(Taglets.Return));
foreach (Content.Taglet taglet in taglets) {
return translate_taglet (taglet);
}
return null;
}
protected override string? get_signal_return_comment (Vala.Signal vsig) {
Api.Signal sig = resolver.resolve (vsig) as Api.Signal;
if (sig == null) {
return null;
}
Content.Comment? documentation = sig.documentation;
if (documentation == null) {
return null;
}
Vala.List<Content.Taglet> taglets = documentation.find_taglets (sig, typeof(Taglets.Return));
foreach (Content.Taglet taglet in taglets) {
return translate_taglet (taglet);
}
return null;
}
protected override string? get_method_return_comment (Vala.Method vm) {
Method m = resolver.resolve (vm) as Method;
if (m == null) {
return null;
}
Content.Comment? documentation = m.documentation;
if (documentation == null) {
return null;
}
Vala.List<Content.Taglet> taglets = documentation.find_taglets (m, typeof(Taglets.Return));
foreach (Content.Taglet taglet in taglets) {
return translate_taglet (taglet);
}
return null;
}
protected override string? get_signal_comment (Vala.Signal vsig) {
Api.Signal sig = resolver.resolve (vsig) as Api.Signal;
return translate (sig.documentation);
}
protected override string? get_parameter_comment (Vala.Parameter param) {
Api.Symbol symbol = resolver.resolve (((Vala.Symbol) param.parent_symbol));
if (symbol == null) {
return null;
}
Content.Comment? documentation = symbol.documentation;
if (documentation == null) {
return null;
}
Vala.List<Content.Taglet> taglets = documentation.find_taglets (symbol, typeof(Taglets.Param));
foreach (Content.Taglet _taglet in taglets) {
Taglets.Param taglet = (Taglets.Param) _taglet;
if (taglet.parameter_name == param.name) {
return translate_taglet (taglet);
}
}
return null;
}
}
|
