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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XAtomServer.idl,v $
* $Revision: 1.9 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org 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 version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_util_XAtomServer_idl__
#define __com_sun_star_util_XAtomServer_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_util_AtomDescription_idl__
#include <com/sun/star/util/AtomDescription.idl>
#endif
#ifndef __com_sun_star_util_AtomClassRequest_idl__
#include <com/sun/star/util/AtomClassRequest.idl>
#endif
module com
{
module sun
{
module star
{
module util
{
/** an interface to map between <i>string</i>s and <i>id</i>s
<p>a note on atoms:<br>
Atoms are abbreviations for strings.
When a string gets registered, it is assigned a numeric id
so that said string can always be referred to by this id.
This way strings have to be transported only once over remote connections.
Valid ids are (in this implementation) non zero, signed 32 bit values.
An atom of 0 means that the string in question is not registered</p>
<p>Additionally there is the abstraction of atom class:<br>
Atoms are grouped into classes, so that an id can be assigned
to multiple strings, depending on the class context. The main
advantage of this is that atoms in one class may be kept
to small numbers, so that bandwidth can be reduced by sending
the atoms only as 16 bit values. Note that it is up to the user in this
case to handle overflows.</p>
*/
published interface XAtomServer : com::sun::star::uno::XInterface
{
/** returns a whole atom class
@param atomClass
which class to return
@returns
the descriptions for all atoms of class <code>atomClass</code>
*/
sequence< AtomDescription > getClass( [in] long atomClass );
/** returns mutltiple atom classes
@param atomClasses
which classes to return
@returns
the descriptions for all atoms of the requested classes
*/
sequence< sequence< AtomDescription > > getClasses( [in] sequence< long > atomClasses );
/** returns the strings for an arbitrary amount of atoms of multiple classes
@param atoms
describes which strings to return
@returns
the strings for the requested atoms
*/
sequence< string > getAtomDescriptions( [in] sequence< AtomClassRequest > atoms );
//-----------------------------------------------------------------------
/** returns the atoms that have been registered to a class after an
already known atom
<p>Hint to implementor: using ascending atoms is the easiest way
to decide, which atoms are recent.</p>
@param atomClass
the class in question
@param atom
the last known atom
@returns
all atom description that have been added to class
<code>atomClass</code> after <code>atom</code>
*/
sequence< AtomDescription > getRecentAtoms( [in] long atomClass, [in] long atom );
//-----------------------------------------------------------------------
/** registers or searches for a string
@param atomClass
the class of atoms in question
@param description
the string in question
@param create
if true a new atom will be created for an unknown string
else the invalid atom (0) will be returned for an unknown string
@returns
the atom for the string <code>description</code>
*/
long getAtom( [in] long atomClass, [in] string description, [in] boolean create );
};
}; // module util
}; // module star
}; // module sun
}; // module com
#endif
|
