1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_xml_sax_XFastTokenHandler_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir//============================================================================= 35*cdf0e10cSrcweir 36*cdf0e10cSrcweirmodule com { module sun { module star { module xml { module sax { 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================ 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir/** interface to translate xml strings to integer tokens. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir <p>An instance of this interface can be registered at a <type>XFastParser</type>. 43*cdf0e10cSrcweir It should be able to translate all xml names (element local names, 44*cdf0e10cSrcweir attribute local names and constant attribute values) to integer tokens. 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir A token value must be greater or equal to zero and less than 47*cdf0e10cSrcweir <const>FastToken::NAMESPACE</const>. If a string identifier is not known 48*cdf0e10cSrcweir to this instance, <const>FastToken::DONTKNOW</const> is returned. 49*cdf0e10cSrcweir */ 50*cdf0e10cSrcweirinterface XFastTokenHandler: com::sun::star::uno::XInterface 51*cdf0e10cSrcweir{ 52*cdf0e10cSrcweir //------------------------------------------------------------------------- 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /** returns a integer token for the given string identifier. 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir @returns 57*cdf0e10cSrcweir a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 58*cdf0e10cSrcweir if the identifier is not known to this instance. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir long getToken( [in] string Identifier ); 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir //------------------------------------------------------------------------- 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir /** returns a string identifier for the given integer token. 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir string getIdentifier( [in] long Token ); 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir //------------------------------------------------------------------------- 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir /** returns a integer token for the given string 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir @param Identifier 73*cdf0e10cSrcweir the string given as a byte sequence encoded in UTF8 74*cdf0e10cSrcweir 75*cdf0e10cSrcweir @returns 76*cdf0e10cSrcweir a unique integer token for the given String or <const>FastToken::DONTKNOW</const> 77*cdf0e10cSrcweir if the identifier is not known to this instance. 78*cdf0e10cSrcweir */ 79*cdf0e10cSrcweir long getTokenFromUTF8( [in] sequence< byte > Identifier ); 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir //------------------------------------------------------------------------- 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir /** returns a identifier for the given integer token as a byte 84*cdf0e10cSrcweir sequence encoded in UTF8. 85*cdf0e10cSrcweir */ 86*cdf0e10cSrcweir sequence< byte > getUTF8Identifier( [in] long Token ); 87*cdf0e10cSrcweir}; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir//============================================================================ 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir}; }; }; }; }; 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir#endif 94