offapi/com/sun/star/i18n/ParseResult.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_i18n_ParseResult_idl__
  28 #define __com_sun_star_i18n_ParseResult_idl__
  29
  30 //============================================================================
  31
  32 module com {  module sun {  module star {  module i18n {
  33
  34 //============================================================================
  35
  36 /**
  37     Parser results returned by
  38     <member>XCharacterClassification::parseAnyToken()</member> and
  39     <member>XCharacterClassification::parsePredefinedToken()</member>.
  40  */
  41
  42 published struct ParseResult
  43 {
  44     /** Count of ignored leading whitespace, in code points, not
  45         characters. */
  46     long    LeadingWhiteSpace;
  47
  48     /** Code point index of first unprocessed character. */
  49     long    EndPos;
  50
  51     /** Number of characters (not code points) of the parsed token, not
  52         including leading whitespace. */
  53     long    CharLen;
  54
  55     /** Value of token in case of numeric. */
  56     double  Value;
  57
  58     /** <type>KParseType</type> token type like
  59         <const>KParseType::IDENTNAME</const>. */
  60     long    TokenType;
  61
  62     /** <type>KParseTokens</type> flags of first character of actual
  63         token matched. If <em>TokenType</em> is a
  64         <const>KParseType::SINGLE_QUOTE_NAME</const> or a
  65         <const>KParseType::DOUBLE_QUOTE_STRING</const> the first
  66         character is the first character inside the quotes, not the
  67         quote itself. */
  68     long    StartFlags;
  69
  70     /** <type>KParseTokens</type> flags of remaining characters of
  71         actual token matched. */
  72     long    ContFlags;
  73
  74     /** If a quoted name or string is encountered the dequoted result
  75         goes here. */
  76     string  DequotedNameOrString;
  77
  78 };
  79
  80 //============================================================================
  81 }; }; }; };
  82
  83 #endif