1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_XAtomServer_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_util_XAtomServer_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_AtomDescription_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/util/AtomDescription.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_util_AtomClassRequest_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/util/AtomClassRequest.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielskimodule com 40*b1cdbd2cSJim Jagielski{ 41*b1cdbd2cSJim Jagielskimodule sun 42*b1cdbd2cSJim Jagielski{ 43*b1cdbd2cSJim Jagielskimodule star 44*b1cdbd2cSJim Jagielski{ 45*b1cdbd2cSJim Jagielskimodule util 46*b1cdbd2cSJim Jagielski{ 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski/** an interface to map between <i>string</i>s and <i>id</i>s 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski <p>a note on atoms:<br> 51*b1cdbd2cSJim Jagielski Atoms are abbreviations for strings. 52*b1cdbd2cSJim Jagielski When a string gets registered, it is assigned a numeric id 53*b1cdbd2cSJim Jagielski so that said string can always be referred to by this id. 54*b1cdbd2cSJim Jagielski This way strings have to be transported only once over remote connections. 55*b1cdbd2cSJim Jagielski Valid ids are (in this implementation) non zero, signed 32 bit values. 56*b1cdbd2cSJim Jagielski An atom of 0 means that the string in question is not registered</p> 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski <p>Additionally there is the abstraction of atom class:<br> 59*b1cdbd2cSJim Jagielski Atoms are grouped into classes, so that an id can be assigned 60*b1cdbd2cSJim Jagielski to multiple strings, depending on the class context. The main 61*b1cdbd2cSJim Jagielski advantage of this is that atoms in one class may be kept 62*b1cdbd2cSJim Jagielski to small numbers, so that bandwidth can be reduced by sending 63*b1cdbd2cSJim Jagielski the atoms only as 16 bit values. Note that it is up to the user in this 64*b1cdbd2cSJim Jagielski case to handle overflows.</p> 65*b1cdbd2cSJim Jagielski*/ 66*b1cdbd2cSJim Jagielski 67*b1cdbd2cSJim Jagielskipublished interface XAtomServer : com::sun::star::uno::XInterface 68*b1cdbd2cSJim Jagielski{ 69*b1cdbd2cSJim Jagielski /** returns a whole atom class 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski @param atomClass 72*b1cdbd2cSJim Jagielski which class to return 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski @returns 75*b1cdbd2cSJim Jagielski the descriptions for all atoms of class <code>atomClass</code> 76*b1cdbd2cSJim Jagielski */ 77*b1cdbd2cSJim Jagielski sequence< AtomDescription > getClass( [in] long atomClass ); 78*b1cdbd2cSJim Jagielski /** returns mutltiple atom classes 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @param atomClasses 81*b1cdbd2cSJim Jagielski which classes to return 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @returns 84*b1cdbd2cSJim Jagielski the descriptions for all atoms of the requested classes 85*b1cdbd2cSJim Jagielski */ 86*b1cdbd2cSJim Jagielski sequence< sequence< AtomDescription > > getClasses( [in] sequence< long > atomClasses ); 87*b1cdbd2cSJim Jagielski /** returns the strings for an arbitrary amount of atoms of multiple classes 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski @param atoms 90*b1cdbd2cSJim Jagielski describes which strings to return 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @returns 93*b1cdbd2cSJim Jagielski the strings for the requested atoms 94*b1cdbd2cSJim Jagielski */ 95*b1cdbd2cSJim Jagielski sequence< string > getAtomDescriptions( [in] sequence< AtomClassRequest > atoms ); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski //----------------------------------------------------------------------- 98*b1cdbd2cSJim Jagielski /** returns the atoms that have been registered to a class after an 99*b1cdbd2cSJim Jagielski already known atom 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski <p>Hint to implementor: using ascending atoms is the easiest way 102*b1cdbd2cSJim Jagielski to decide, which atoms are recent.</p> 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski @param atomClass 105*b1cdbd2cSJim Jagielski the class in question 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski @param atom 108*b1cdbd2cSJim Jagielski the last known atom 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski @returns 111*b1cdbd2cSJim Jagielski all atom description that have been added to class 112*b1cdbd2cSJim Jagielski <code>atomClass</code> after <code>atom</code> 113*b1cdbd2cSJim Jagielski */ 114*b1cdbd2cSJim Jagielski sequence< AtomDescription > getRecentAtoms( [in] long atomClass, [in] long atom ); 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski //----------------------------------------------------------------------- 117*b1cdbd2cSJim Jagielski /** registers or searches for a string 118*b1cdbd2cSJim Jagielski 119*b1cdbd2cSJim Jagielski @param atomClass 120*b1cdbd2cSJim Jagielski the class of atoms in question 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski @param description 123*b1cdbd2cSJim Jagielski the string in question 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski @param create 126*b1cdbd2cSJim Jagielski if true a new atom will be created for an unknown string 127*b1cdbd2cSJim Jagielski else the invalid atom (0) will be returned for an unknown string 128*b1cdbd2cSJim Jagielski 129*b1cdbd2cSJim Jagielski @returns 130*b1cdbd2cSJim Jagielski the atom for the string <code>description</code> 131*b1cdbd2cSJim Jagielski */ 132*b1cdbd2cSJim Jagielski long getAtom( [in] long atomClass, [in] string description, [in] boolean create ); 133*b1cdbd2cSJim Jagielski}; 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski}; // module util 137*b1cdbd2cSJim Jagielski}; // module star 138*b1cdbd2cSJim Jagielski}; // module sun 139*b1cdbd2cSJim Jagielski}; // module com 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski#endif 143