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
|
<refentry id="libbonobo-bonobo-moniker-extender">
<refmeta>
<refentrytitle role="top_of_page">BonoboMonikerExtender</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBBONOBO Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>BonoboMonikerExtender</refname>
<refpurpose>A way to extend arbitary monikers</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="BonoboMonikerExtender"/>
<synopsis>
<link linkend="BonoboMonikerExtender-struct">BonoboMonikerExtender</link>;
<link linkend="BonoboMonikerExtenderClass">BonoboMonikerExtenderClass</link>;
<link linkend="Bonobo-Unknown">Bonobo_Unknown</link> (<link linkend="BonoboMonikerExtenderFn">*BonoboMonikerExtenderFn</link>) (<link linkend="BonoboMonikerExtender">BonoboMonikerExtender</link> *extender,
const <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
const <link linkend="Bonobo-ResolveOptions">Bonobo_ResolveOptions</link> *options,
const <link linkend="CORBA-char">CORBA_char</link> *display_name,
const <link linkend="CORBA-char">CORBA_char</link> *requested_interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *ev);
<link linkend="BonoboMonikerExtender">BonoboMonikerExtender</link>* <link linkend="bonobo-moniker-extender-new">bonobo_moniker_extender_new</link> (<link linkend="BonoboMonikerExtenderFn">BonoboMonikerExtenderFn</link> resolve,
<link linkend="gpointer">gpointer</link> data);
<link linkend="Bonobo-MonikerExtender">Bonobo_MonikerExtender</link> <link linkend="bonobo-moniker-find-extender">bonobo_moniker_find_extender</link> (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
<link linkend="Bonobo-Unknown">Bonobo_Unknown</link> <link linkend="bonobo-moniker-use-extender">bonobo_moniker_use_extender</link> (const <link linkend="gchar">gchar</link> *extender_oafiid,
<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
const <link linkend="Bonobo-ResolveOptions">Bonobo_ResolveOptions</link> *options,
const <link linkend="CORBA-char">CORBA_char</link> *requested_interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="BonoboObject">BonoboObject</link>
+----BonoboMonikerExtender
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A moniker extender is used to extend the functionality of a moniker.
There are two standard moniker extenders that cannot be system wide,
since they use the oaf database to expand the scope of a moniker to
arbitrarily many interfaces. These are invoked explicitely by monikers
implementing the stream interface in the following way:
<example>
<title>Explicit Stream extender usage example</title>
<programlisting>
Bonobo_Unknown
example_moniker_resolve (BonoboMoniker *moniker,
const Bonobo_ResolveOptions *options,
const CORBA_char *requested_interface,
CORBA_Environment *ev)
{
if (!strcmp (requested_interface, "IDL:Bonobo/Stream:1.0"))
return handle_stream (moniker, options, ev);
else
return bonobo_moniker_use_extender (
"OAFIID:Bonobo_MonikerExtender_stream",
moniker, options, requested_interface, ev);
}
</programlisting>
</example>
The moniker extender essentialy resolves 'moniker' against stream
and by some means ( not known when the moniker was written ) converts
this to a new exotic interface - via. the PersistStream interface.
</para>
<para>
All standard moniker extenders are registered by adding a fragment
like this:
<example>
<title>Oaf information for an extender</title>
<programlisting>
<oaf_attribute name="bonobo:moniker_extender" type="stringv">
<item value="file:"/>
</oaf_attribute>
</programlisting>
</example>
to the .oaf file. This registers the extender with the system, such
that when a moniker resolve fails an extender can be found for any
of the monikers with prefix specified in the "bonobo:moniker_extender"
stringv.
</para>
<para>
Implementing your own extender is extremely simple, much like
<link linkend="BonoboMonikerSimple"><type>BonoboMonikerSimple</type></link>.
<example>
<title>Oaf information for an extender</title>
<programlisting>
Bonobo_Unknown
example_extender_resolve (BonoboMonikerExtender *extender,
const Bonobo_Moniker m,
const Bonobo_ResolveOptions *options,
const CORBA_char *display_name,
const CORBA_char *requested_interface,
CORBA_Environment *ev)
{
... resolve 'm' against an interface we know it supports ...
... then use that interface to provide requested_interface ...
}
</programlisting>
</example>
It is registered again in much the same way in your factory:
<example>
<title>Creating a new simple moniker</title>
<programlisting>
static BonoboObject *
bonobo_std_moniker_factory (BonoboGenericFactory *this,
const char *object_id,
void *data)
{
g_return_val_if_fail (object_id != NULL, NULL);
if (!strcmp (object_id, "OAFIID:Bonobo_MonikerExtender_file"))
return BONOBO_OBJECT (bonobo_moniker_extender_new (
example_extender_resolve, NULL));
else
return NULL;
}
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="BonoboMonikerExtender-struct" role="struct"/>BonoboMonikerExtender</title>
<indexterm><primary>BonoboMonikerExtender</primary></indexterm><programlisting>typedef struct _BonoboMonikerExtender BonoboMonikerExtender;</programlisting>
<para>
Implements a moniker extender: Bonobo::MonikerExtender.
</para></refsect2>
<refsect2>
<title><anchor id="BonoboMonikerExtenderClass" role="struct"/>BonoboMonikerExtenderClass</title>
<indexterm><primary>BonoboMonikerExtenderClass</primary></indexterm><programlisting>typedef struct {
BonoboObjectClass parent_class;
POA_Bonobo_MonikerExtender__epv epv;
BonoboMonikerExtenderFn resolve;
} BonoboMonikerExtenderClass;
</programlisting>
<para>
BonoboMonikerExtender's class.
</para></refsect2>
<refsect2>
<title><anchor id="BonoboMonikerExtenderFn" role="function"/>BonoboMonikerExtenderFn ()</title>
<indexterm><primary>BonoboMonikerExtenderFn</primary></indexterm><programlisting><link linkend="Bonobo-Unknown">Bonobo_Unknown</link> (*BonoboMonikerExtenderFn) (<link linkend="BonoboMonikerExtender">BonoboMonikerExtender</link> *extender,
const <link linkend="Bonobo-Moniker">Bonobo_Moniker</link> parent,
const <link linkend="Bonobo-ResolveOptions">Bonobo_ResolveOptions</link> *options,
const <link linkend="CORBA-char">CORBA_char</link> *display_name,
const <link linkend="CORBA-char">CORBA_char</link> *requested_interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *ev);</programlisting>
<para>
Moniker resolution callback function.
</para><variablelist role="params">
<varlistentry><term><parameter>extender</parameter> :</term>
<listitem><simpara>extender (self)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>parent</parameter> :</term>
<listitem><simpara>parent moniker
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>options</parameter> :</term>
<listitem><simpara>resolve options
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>display_name</parameter> :</term>
<listitem><simpara>? FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested_interface</parameter> :</term>
<listitem><simpara>? FIXME
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ev</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>the resolution resulting object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="bonobo-moniker-extender-new" role="function"/>bonobo_moniker_extender_new ()</title>
<indexterm><primary>bonobo_moniker_extender_new</primary></indexterm><programlisting><link linkend="BonoboMonikerExtender">BonoboMonikerExtender</link>* bonobo_moniker_extender_new (<link linkend="BonoboMonikerExtenderFn">BonoboMonikerExtenderFn</link> resolve,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
This creates a new moniker extender.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>resolve</parameter> :</term>
<listitem><simpara> the resolve function that will be used to do the extension
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> user data to be passed back to the resolve function.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the extender object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="bonobo-moniker-find-extender" role="function"/>bonobo_moniker_find_extender ()</title>
<indexterm><primary>bonobo_moniker_find_extender</primary></indexterm><programlisting><link linkend="Bonobo-MonikerExtender">Bonobo_MonikerExtender</link> bonobo_moniker_find_extender (const <link linkend="gchar">gchar</link> *name,
const <link linkend="gchar">gchar</link> *interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
<para>
This routine tries to locate an extender for our moniker
by examining a registry of extenders that map new interfaces
to certain moniker names.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> the name of the moniker we want to extend eg. 'file:'
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>interface</parameter> :</term>
<listitem><simpara> the interface we want to resolve to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opt_ev</parameter> :</term>
<listitem><simpara> an optional corba exception environment.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an appropriate extender or CORBA_OBJECT_NIL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="bonobo-moniker-use-extender" role="function"/>bonobo_moniker_use_extender ()</title>
<indexterm><primary>bonobo_moniker_use_extender</primary></indexterm><programlisting><link linkend="Bonobo-Unknown">Bonobo_Unknown</link> bonobo_moniker_use_extender (const <link linkend="gchar">gchar</link> *extender_oafiid,
<link linkend="BonoboMoniker">BonoboMoniker</link> *moniker,
const <link linkend="Bonobo-ResolveOptions">Bonobo_ResolveOptions</link> *options,
const <link linkend="CORBA-char">CORBA_char</link> *requested_interface,
<link linkend="CORBA-Environment">CORBA_Environment</link> *opt_ev);</programlisting>
<para>
Locates a known extender via. OAFIID; eg.
OAFIID:Bonobo_Moniker_Extender_file</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>extender_oafiid</parameter> :</term>
<listitem><simpara> The IID of the extender to use
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>moniker</parameter> :</term>
<listitem><simpara> the moniker to extend
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>options</parameter> :</term>
<listitem><simpara> resolve options
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>requested_interface</parameter> :</term>
<listitem><simpara> the requested interface
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>opt_ev</parameter> :</term>
<listitem><simpara> optional corba environment
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the resolved result or CORBA_OBJECT_NIL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|