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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<refentry id="gmime-gmime-filter" revision="24 Sep 2001">
<refmeta>
<refentrytitle>gmime-filter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GMIME Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gmime-filter</refname><refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
struct <link linkend="GMimeFilter">GMimeFilter</link>;
#define <link linkend="GMIME-FILTER-CAPS">GMIME_FILTER</link> (filter)
void <link linkend="g-mime-filter-construct">g_mime_filter_construct</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
<link linkend="GMimeFilter">GMimeFilter</link> *template);
void <link linkend="g-mime-filter-destroy">g_mime_filter_destroy</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter);
<link linkend="GMimeFilter">GMimeFilter</link>* <link linkend="g-mime-filter-copy">g_mime_filter_copy</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter);
void <link linkend="g-mime-filter-filter">g_mime_filter_filter</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
char *in,
<link linkend="size-t">size_t</link> len,
<link linkend="size-t">size_t</link> prespace,
char **out,
<link linkend="size-t">size_t</link> *outlen,
<link linkend="size-t">size_t</link> *outprespace);
void <link linkend="g-mime-filter-complete">g_mime_filter_complete</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
char *in,
<link linkend="size-t">size_t</link> len,
<link linkend="size-t">size_t</link> prespace,
char **out,
<link linkend="size-t">size_t</link> *outlen,
<link linkend="size-t">size_t</link> *outprespace);
void <link linkend="g-mime-filter-reset">g_mime_filter_reset</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter);
void <link linkend="g-mime-filter-backup">g_mime_filter_backup</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
const char *data,
<link linkend="size-t">size_t</link> length);
void <link linkend="g-mime-filter-set-size">g_mime_filter_set_size</link> (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
<link linkend="size-t">size_t</link> size,
int keep);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GMimeFilter">struct GMimeFilter</title>
<programlisting>struct GMimeFilter {
struct _GMimeFilterPrivate *priv;
char *outreal; /* real malloc'd buffer */
char *outbuf; /* first 'writable' position allowed (outreal + outpre) */
char *outptr;
int outsize;
int outpre; /* prespace of this buffer */
char *backbuf;
int backsize;
int backlen; /* significant data there */
/* virtual functions */
void (*destroy) (GMimeFilter *filter);
GMimeFilter *(*copy) (GMimeFilter *filter);
void (*filter) (GMimeFilter *filter,
char *in, size_t len, size_t prespace,
char **out, size_t *outlen, size_t *outprespace);
void (*complete) (GMimeFilter *filter,
char *in, size_t len, size_t prespace,
char **out, size_t *outlen, size_t *outprespace);
void (*reset) (GMimeFilter *filter);
};
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GMIME-FILTER-CAPS">GMIME_FILTER()</title>
<programlisting>#define GMIME_FILTER(filter) ((GMimeFilter *) filter)
</programlisting>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-construct">g_mime_filter_construct ()</title>
<programlisting>void g_mime_filter_construct (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
<link linkend="GMimeFilter">GMimeFilter</link> *template);</programlisting>
<para>
Initializes a filter object using the virtual methods in <parameter>template</parameter>.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><parameter>template</parameter> :</entry>
<entry> filter template
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-destroy">g_mime_filter_destroy ()</title>
<programlisting>void g_mime_filter_destroy (<link linkend="GMimeFilter">GMimeFilter</link> *filter);</programlisting>
<para>
Destroys <parameter>filter</parameter> and releases the memory to the system.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-copy">g_mime_filter_copy ()</title>
<programlisting><link linkend="GMimeFilter">GMimeFilter</link>* g_mime_filter_copy (<link linkend="GMimeFilter">GMimeFilter</link> *filter);</programlisting>
<para>
</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>a duplicate of <parameter>filter</parameter>.
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-filter">g_mime_filter_filter ()</title>
<programlisting>void g_mime_filter_filter (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
char *in,
<link linkend="size-t">size_t</link> len,
<link linkend="size-t">size_t</link> prespace,
char **out,
<link linkend="size-t">size_t</link> *outlen,
<link linkend="size-t">size_t</link> *outprespace);</programlisting>
<para>
Filters the input data and writes it to <parameter>out</parameter>.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><parameter>in</parameter> :</entry>
<entry> input buffer
</entry></row>
<row><entry align="right"><parameter>len</parameter> :</entry>
<entry> input buffer length
</entry></row>
<row><entry align="right"><parameter>prespace</parameter> :</entry>
<entry> prespace buffer length
</entry></row>
<row><entry align="right"><parameter>out</parameter> :</entry>
<entry> pointer to output buffer
</entry></row>
<row><entry align="right"><parameter>outlen</parameter> :</entry>
<entry> pointer to output length
</entry></row>
<row><entry align="right"><parameter>outprespace</parameter> :</entry>
<entry> pointer to output prespace buffer length
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-complete">g_mime_filter_complete ()</title>
<programlisting>void g_mime_filter_complete (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
char *in,
<link linkend="size-t">size_t</link> len,
<link linkend="size-t">size_t</link> prespace,
char **out,
<link linkend="size-t">size_t</link> *outlen,
<link linkend="size-t">size_t</link> *outprespace);</programlisting>
<para>
Completes the filtering.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><parameter>in</parameter> :</entry>
<entry> input buffer
</entry></row>
<row><entry align="right"><parameter>len</parameter> :</entry>
<entry> input length
</entry></row>
<row><entry align="right"><parameter>prespace</parameter> :</entry>
<entry> prespace buffer length
</entry></row>
<row><entry align="right"><parameter>out</parameter> :</entry>
<entry> pointer to output buffer
</entry></row>
<row><entry align="right"><parameter>outlen</parameter> :</entry>
<entry> pointer to output length
</entry></row>
<row><entry align="right"><parameter>outprespace</parameter> :</entry>
<entry> pointer to output prespace buffer length
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-reset">g_mime_filter_reset ()</title>
<programlisting>void g_mime_filter_reset (<link linkend="GMimeFilter">GMimeFilter</link> *filter);</programlisting>
<para>
Resets the filter.</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-backup">g_mime_filter_backup ()</title>
<programlisting>void g_mime_filter_backup (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
const char *data,
<link linkend="size-t">size_t</link> length);</programlisting>
<para>
Sets number of bytes backed up on the input, new calls replace
previous ones</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><parameter>data</parameter> :</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>length</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-mime-filter-set-size">g_mime_filter_set_size ()</title>
<programlisting>void g_mime_filter_set_size (<link linkend="GMimeFilter">GMimeFilter</link> *filter,
<link linkend="size-t">size_t</link> size,
int keep);</programlisting>
<para>
Ensure this much size available for filter output (if required)</para>
<para>
</para><informaltable pgwide=1 frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>filter</parameter> :</entry>
<entry> filter
</entry></row>
<row><entry align="right"><parameter>size</parameter> :</entry>
<entry>
</entry></row>
<row><entry align="right"><parameter>keep</parameter> :</entry>
<entry>
</entry></row>
</tbody></tgroup></informaltable></refsect2>
</refsect1>
</refentry>
|
