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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpproceduraldb">
<refmeta>
<refentrytitle role="top_of_page">gimpproceduraldb</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpproceduraldb</refname>
<refpurpose>Functions for querying and changing procedural database (PDB) entries.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gchar">gchar</link>* <link linkend="gimp-procedural-db-temp-name">gimp_procedural_db_temp_name</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-proc-info">gimp_procedural_db_proc_info</link> (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gchar">gchar</link> **blurb,
<link linkend="gchar">gchar</link> **help,
<link linkend="gchar">gchar</link> **author,
<link linkend="gchar">gchar</link> **copyright,
<link linkend="gchar">gchar</link> **date,
<link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
<link linkend="gint">gint</link> *num_args,
<link linkend="gint">gint</link> *num_values,
<link linkend="GimpParamDef">GimpParamDef</link> **args,
<link linkend="GimpParamDef">GimpParamDef</link> **return_vals);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-get-data">gimp_procedural_db_get_data</link> (const <link linkend="gchar">gchar</link> *identifier,
<link linkend="gpointer">gpointer</link> data);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-set-data">gimp_procedural_db_set_data</link> (const <link linkend="gchar">gchar</link> *identifier,
<link linkend="gpointer">gpointer</link> data,
<link linkend="guint32">guint32</link> bytes);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-dump">gimp_procedural_db_dump</link> (const <link linkend="gchar">gchar</link> *filename);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-query">gimp_procedural_db_query</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *blurb,
const <link linkend="gchar">gchar</link> *help,
const <link linkend="gchar">gchar</link> *author,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *date,
const <link linkend="gchar">gchar</link> *proc_type,
<link linkend="gint">gint</link> *num_matches,
<link linkend="gchar">gchar</link> ***procedure_names);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-proc-arg">gimp_procedural_db_proc_arg</link> (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gint">gint</link> arg_num,
<link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
<link linkend="gchar">gchar</link> **arg_name,
<link linkend="gchar">gchar</link> **arg_desc);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-procedural-db-proc-val">gimp_procedural_db_proc_val</link> (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gint">gint</link> val_num,
<link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
<link linkend="gchar">gchar</link> **val_name,
<link linkend="gchar">gchar</link> **val_desc);
<link linkend="gint">gint</link> <link linkend="gimp-procedural-db-get-data-size">gimp_procedural_db_get_data_size</link>
(const <link linkend="gchar">gchar</link> *identifier);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions for querying and changing procedural database (PDB) entries.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-procedural-db-temp-name" role="function"/>gimp_procedural_db_temp_name ()</title>
<indexterm><primary>gimp_procedural_db_temp_name</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_procedural_db_temp_name (void);</programlisting>
<para>
Generates a unique temporary PDB name.
</para>
<para>
This procedure generates a temporary PDB entry name that is
guaranteed to be unique. It is many used by the interactive popup
dialogs to generate a PDB entry name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A unique temporary name for a temporary PDB entry.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-proc-info" role="function"/>gimp_procedural_db_proc_info ()</title>
<indexterm><primary>gimp_procedural_db_proc_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_proc_info (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gchar">gchar</link> **blurb,
<link linkend="gchar">gchar</link> **help,
<link linkend="gchar">gchar</link> **author,
<link linkend="gchar">gchar</link> **copyright,
<link linkend="gchar">gchar</link> **date,
<link linkend="GimpPDBProcType">GimpPDBProcType</link> *proc_type,
<link linkend="gint">gint</link> *num_args,
<link linkend="gint">gint</link> *num_values,
<link linkend="GimpParamDef">GimpParamDef</link> **args,
<link linkend="GimpParamDef">GimpParamDef</link> **return_vals);</programlisting>
<para>
Queries the procedural database for information on the specified
procedure.
</para>
<para>
This procedure returns information on the specified procedure. A
short blurb, detailed help, author(s), copyright information,
procedure type, number of input, and number of return values are
returned. Additionally this function returns specific information
about each input argument and return value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>procedure</parameter> :</term>
<listitem><simpara> The procedure name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blurb</parameter> :</term>
<listitem><simpara> A short blurb.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help</parameter> :</term>
<listitem><simpara> Detailed procedure help.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>author</parameter> :</term>
<listitem><simpara> Author(s) of the procedure.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>copyright</parameter> :</term>
<listitem><simpara> The copyright.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>date</parameter> :</term>
<listitem><simpara> Copyright date.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>proc_type</parameter> :</term>
<listitem><simpara> The procedure type.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_args</parameter> :</term>
<listitem><simpara> The number of input arguments.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_values</parameter> :</term>
<listitem><simpara> The number of return values.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>args</parameter> :</term>
<listitem><simpara> The input arguments.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>return_vals</parameter> :</term>
<listitem><simpara> The return values.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-get-data" role="function"/>gimp_procedural_db_get_data ()</title>
<indexterm><primary>gimp_procedural_db_get_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_get_data (const <link linkend="gchar">gchar</link> *identifier,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Returns data associated with the specified identifier.
</para>
<para>
This procedure returns any data which may have been associated with
the specified identifier. The data is copied into the given memory
location.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>identifier</parameter> :</term>
<listitem><simpara> The identifier associated with data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> A byte array containing data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE if no data has been associated with
the identifier
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-set-data" role="function"/>gimp_procedural_db_set_data ()</title>
<indexterm><primary>gimp_procedural_db_set_data</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_set_data (const <link linkend="gchar">gchar</link> *identifier,
<link linkend="gpointer">gpointer</link> data,
<link linkend="guint32">guint32</link> bytes);</programlisting>
<para>
Associates the specified identifier with the supplied data.
</para>
<para>
This procedure associates the supplied data with the provided
identifier. The data may be subsequently retrieved by a call to
'procedural-db-get-data'.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>identifier</parameter> :</term>
<listitem><simpara> The identifier associated with data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> A byte array containing data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>bytes</parameter> :</term>
<listitem><simpara> The number of bytes in the data
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-dump" role="function"/>gimp_procedural_db_dump ()</title>
<indexterm><primary>gimp_procedural_db_dump</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_dump (const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
Dumps the current contents of the procedural database
</para>
<para>
This procedure dumps the contents of the procedural database to the
specified file. The file will contain all of the information
provided for each registered procedure. This file is in a format
appropriate for use with the supplied \"pdb_self_doc.el\" Elisp
script, which generates a texinfo document.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> The dump filename.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-query" role="function"/>gimp_procedural_db_query ()</title>
<indexterm><primary>gimp_procedural_db_query</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_query (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *blurb,
const <link linkend="gchar">gchar</link> *help,
const <link linkend="gchar">gchar</link> *author,
const <link linkend="gchar">gchar</link> *copyright,
const <link linkend="gchar">gchar</link> *date,
const <link linkend="gchar">gchar</link> *proc_type,
<link linkend="gint">gint</link> *num_matches,
<link linkend="gchar">gchar</link> ***procedure_names);</programlisting>
<para>
Queries the procedural database for its contents using regular
expression matching.
</para>
<para>
This procedure queries the contents of the procedural database. It
is supplied with seven arguments matching procedures on { name,
blurb, help, author, copyright, date, procedure type}. This is
accomplished using regular expression matching. For instance, to
find all procedures with \"jpeg\" listed in the blurb, all seven
arguments can be supplied as \".*\", except for the second, which
can be supplied as \".*jpeg.*\". There are two return arguments for
this procedure. The first is the number of procedures matching the
query. The second is a concatenated list of procedure names
corresponding to those matching the query. If no matching entries
are found, then the returned string is NULL and the number of
entries is 0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The regex for procedure name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>blurb</parameter> :</term>
<listitem><simpara> The regex for procedure blurb.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>help</parameter> :</term>
<listitem><simpara> The regex for procedure help.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>author</parameter> :</term>
<listitem><simpara> The regex for procedure author.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>copyright</parameter> :</term>
<listitem><simpara> The regex for procedure copyright.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>date</parameter> :</term>
<listitem><simpara> The regex for procedure date.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>proc_type</parameter> :</term>
<listitem><simpara> The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension' }.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_matches</parameter> :</term>
<listitem><simpara> The number of matching procedures.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>procedure_names</parameter> :</term>
<listitem><simpara> The list of procedure names.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-proc-arg" role="function"/>gimp_procedural_db_proc_arg ()</title>
<indexterm><primary>gimp_procedural_db_proc_arg</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_proc_arg (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gint">gint</link> arg_num,
<link linkend="GimpPDBArgType">GimpPDBArgType</link> *arg_type,
<link linkend="gchar">gchar</link> **arg_name,
<link linkend="gchar">gchar</link> **arg_desc);</programlisting>
<para>
Queries the procedural database for information on the specified
procedure's argument.
</para>
<para>
This procedure returns information on the specified procedure's
argument. The argument type, name, and a description are retrieved.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>procedure</parameter> :</term>
<listitem><simpara> The procedure name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_num</parameter> :</term>
<listitem><simpara> The argument number.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_type</parameter> :</term>
<listitem><simpara> The type of argument.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_name</parameter> :</term>
<listitem><simpara> The name of the argument.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg_desc</parameter> :</term>
<listitem><simpara> A description of the argument.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-proc-val" role="function"/>gimp_procedural_db_proc_val ()</title>
<indexterm><primary>gimp_procedural_db_proc_val</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_procedural_db_proc_val (const <link linkend="gchar">gchar</link> *procedure,
<link linkend="gint">gint</link> val_num,
<link linkend="GimpPDBArgType">GimpPDBArgType</link> *val_type,
<link linkend="gchar">gchar</link> **val_name,
<link linkend="gchar">gchar</link> **val_desc);</programlisting>
<para>
Queries the procedural database for information on the specified
procedure's return value.
</para>
<para>
This procedure returns information on the specified procedure's
return value. The return value type, name, and a description are
retrieved.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>procedure</parameter> :</term>
<listitem><simpara> The procedure name.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_num</parameter> :</term>
<listitem><simpara> The return value number.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_type</parameter> :</term>
<listitem><simpara> The type of return value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_name</parameter> :</term>
<listitem><simpara> The name of the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>val_desc</parameter> :</term>
<listitem><simpara> A description of the return value.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-procedural-db-get-data-size" role="function"/>gimp_procedural_db_get_data_size ()</title>
<indexterm><primary>gimp_procedural_db_get_data_size</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_procedural_db_get_data_size
(const <link linkend="gchar">gchar</link> *identifier);</programlisting>
<para>
Returns size of data associated with the specified identifier.
</para>
<para>
This procedure returns the size of any data which may have been
associated with the specified identifier. If no data has been
associated with the identifier, an error is returned.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>identifier</parameter> :</term>
<listitem><simpara> The identifier associated with data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The number of bytes in the data.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
