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

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