summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xml/sax/XFastTokenHandler.idl
blob: 52233922b38901e916ecdc2d07de9e9b7313bec7 (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_xml_sax_XFastTokenHandler_idl__
#define __com_sun_star_xml_sax_XFastTokenHandler_idl__

#include <com/sun/star/uno/XInterface.idl>


module com {  module sun {  module star {  module xml {  module sax {


/** interface to translate XML strings to integer tokens.

    <p>An instance of this interface can be registered at a XFastParser.
    It should be able to translate all XML names (element local names,
    attribute local names and constant attribute values) to integer tokens.

    A token value must be greater or equal to zero and less than
    FastToken::NAMESPACE. If a string identifier is not known
    to this instance, FastToken::DONTKNOW is returned.
 */
interface XFastTokenHandler: com::sun::star::uno::XInterface
{

    /** returns a integer token for the given string identifier.

        @returns
            a unique integer token for the given String or FastToken::DONTKNOW
            if the identifier is not known to this instance.
    */
    long getToken( [in] string Identifier );


    /** returns a string identifier for the given integer token.
    */
    string getIdentifier( [in] long Token );


    /** returns a integer token for the given string

        @param Identifier
            the string given as a byte sequence encoded in UTF-8

        @returns
            a unique integer token for the given String or FastToken::DONTKNOW
            if the identifier is not known to this instance.
    */
    long getTokenFromUTF8( [in] sequence< byte > Identifier );


    /** returns a identifier for the given integer token as a byte
          sequence encoded in UTF-8.
    */
    sequence< byte > getUTF8Identifier( [in] long Token );
};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */