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

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