xref: /trunk/main/offapi/com/sun/star/i18n/ParseResult.idl (revision d1766043)
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_i18n_ParseResult_idl__
24cdf0e10cSrcweir#define __com_sun_star_i18n_ParseResult_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir//============================================================================
27cdf0e10cSrcweir
28cdf0e10cSrcweirmodule com {  module sun {  module star {  module i18n {
29cdf0e10cSrcweir
30cdf0e10cSrcweir//============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir/**
33cdf0e10cSrcweir    Parser results returned by
34cdf0e10cSrcweir    <member>XCharacterClassification::parseAnyToken()</member> and
35cdf0e10cSrcweir    <member>XCharacterClassification::parsePredefinedToken()</member>.
36cdf0e10cSrcweir */
37cdf0e10cSrcweir
38cdf0e10cSrcweirpublished struct ParseResult
39cdf0e10cSrcweir{
40cdf0e10cSrcweir    /** Count of ignored leading whitespace, in code points, not
41cdf0e10cSrcweir        characters. */
42cdf0e10cSrcweir    long    LeadingWhiteSpace;
43cdf0e10cSrcweir
44cdf0e10cSrcweir    /** Code point index of first unprocessed character. */
45cdf0e10cSrcweir    long    EndPos;
46cdf0e10cSrcweir
47cdf0e10cSrcweir    /** Number of characters (not code points) of the parsed token, not
48cdf0e10cSrcweir        including leading whitespace. */
49cdf0e10cSrcweir    long    CharLen;
50cdf0e10cSrcweir
51cdf0e10cSrcweir    /** Value of token in case of numeric. */
52cdf0e10cSrcweir    double  Value;
53cdf0e10cSrcweir
54cdf0e10cSrcweir    /** <type>KParseType</type> token type like
55cdf0e10cSrcweir        <const>KParseType::IDENTNAME</const>. */
56cdf0e10cSrcweir    long    TokenType;
57cdf0e10cSrcweir
58cdf0e10cSrcweir    /** <type>KParseTokens</type> flags of first character of actual
59cdf0e10cSrcweir        token matched. If <em>TokenType</em> is a
60cdf0e10cSrcweir        <const>KParseType::SINGLE_QUOTE_NAME</const> or a
61cdf0e10cSrcweir        <const>KParseType::DOUBLE_QUOTE_STRING</const> the first
62cdf0e10cSrcweir        character is the first character inside the quotes, not the
63cdf0e10cSrcweir        quote itself. */
64cdf0e10cSrcweir    long    StartFlags;
65cdf0e10cSrcweir
66cdf0e10cSrcweir    /** <type>KParseTokens</type> flags of remaining characters of
67cdf0e10cSrcweir        actual token matched. */
68cdf0e10cSrcweir    long    ContFlags;
69cdf0e10cSrcweir
70cdf0e10cSrcweir    /** If a quoted name or string is encountered the dequoted result
71cdf0e10cSrcweir        goes here. */
72cdf0e10cSrcweir    string  DequotedNameOrString;
73cdf0e10cSrcweir
74cdf0e10cSrcweir};
75cdf0e10cSrcweir
76cdf0e10cSrcweir//============================================================================
77cdf0e10cSrcweir}; }; }; };
78cdf0e10cSrcweir
79cdf0e10cSrcweir#endif
80