1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__ 24cdf0e10cSrcweir#define __com_sun_star_xml_sax_XFastTokenHandler_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module xml { module sax { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================ 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** interface to translate xml strings to integer tokens. 37cdf0e10cSrcweir 38cdf0e10cSrcweir <p>An instance of this interface can be registered at a <type>XFastParser</type>. 39cdf0e10cSrcweir It should be able to translate all xml names (element local names, 40cdf0e10cSrcweir attribute local names and constant attribute values) to integer tokens. 41cdf0e10cSrcweir 42cdf0e10cSrcweir A token value must be greater or equal to zero and less than 43cdf0e10cSrcweir <const>FastToken::NAMESPACE</const>. If a string identifier is not known 44cdf0e10cSrcweir to this instance, <const>FastToken::DONTKNOW</const> is returned. 45cdf0e10cSrcweir */ 46cdf0e10cSrcweirinterface XFastTokenHandler: com::sun::star::uno::XInterface 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir //------------------------------------------------------------------------- 49cdf0e10cSrcweir 50cdf0e10cSrcweir /** returns a integer token for the given string identifier. 51cdf0e10cSrcweir 52cdf0e10cSrcweir @returns 53cdf0e10cSrcweir a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 54cdf0e10cSrcweir if the identifier is not known to this instance. 55cdf0e10cSrcweir */ 56cdf0e10cSrcweir long getToken( [in] string Identifier ); 57cdf0e10cSrcweir 58cdf0e10cSrcweir //------------------------------------------------------------------------- 59cdf0e10cSrcweir 60cdf0e10cSrcweir /** returns a string identifier for the given integer token. 61cdf0e10cSrcweir */ 62cdf0e10cSrcweir string getIdentifier( [in] long Token ); 63cdf0e10cSrcweir 64cdf0e10cSrcweir //------------------------------------------------------------------------- 65cdf0e10cSrcweir 66cdf0e10cSrcweir /** returns a integer token for the given string 67cdf0e10cSrcweir 68cdf0e10cSrcweir @param Identifier 69cdf0e10cSrcweir the string given as a byte sequence encoded in UTF8 70cdf0e10cSrcweir 71cdf0e10cSrcweir @returns 72cdf0e10cSrcweir a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 73cdf0e10cSrcweir if the identifier is not known to this instance. 74cdf0e10cSrcweir */ 75cdf0e10cSrcweir long getTokenFromUTF8( [in] sequence< byte > Identifier ); 76cdf0e10cSrcweir 77cdf0e10cSrcweir //------------------------------------------------------------------------- 78cdf0e10cSrcweir 79cdf0e10cSrcweir /** returns a identifier for the given integer token as a byte 80cdf0e10cSrcweir sequence encoded in UTF8. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir sequence< byte > getUTF8Identifier( [in] long Token ); 83cdf0e10cSrcweir}; 84cdf0e10cSrcweir 85cdf0e10cSrcweir//============================================================================ 86cdf0e10cSrcweir 87cdf0e10cSrcweir}; }; }; }; }; 88cdf0e10cSrcweir 89cdf0e10cSrcweir#endif 90