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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_i18n_KParseTokens_idl__
  20 #define __com_sun_star_i18n_KParseTokens_idl__
  21
  22
  23 module com {  module sun {  module star {  module i18n {
  24
  25
  26 /**
  27     These constants specify the characters a name or identifier token to
  28     be parsed can have.
  29
  30     <p> They are passed to
  31     XCharacterClassification::parseAnyToken() and
  32     XCharacterClassification::parsePredefinedToken().
  33     They are also set in the ParseResult::StartFlags
  34     and ParseResult::ContFlags. </p>
  35  */
  36
  37 published constants KParseTokens
  38 {
  39     /// ASCII A-Z upper alpha
  40     const long ASC_UPALPHA          = 0x00000001;
  41
  42     /// ASCII a-z lower alpha
  43     const long ASC_LOALPHA          = 0x00000002;
  44
  45     /// ASCII 0-9 digit
  46     const long ASC_DIGIT            = 0x00000004;
  47
  48     /// ASCII '_' underscore
  49     const long ASC_UNDERSCORE       = 0x00000008;
  50
  51     /// ASCII '$' dollar
  52     const long ASC_DOLLAR           = 0x00000010;
  53
  54     /// ASCII '.' dot/point
  55     const long ASC_DOT              = 0x00000020;
  56
  57     /// ASCII ':' colon
  58     const long ASC_COLON            = 0x00000040;
  59
  60     /// Special value to allow control characters (0x00 &lt; char &lt; 0x20)
  61     const long ASC_CONTROL          = 0x00000200;
  62
  63     /** Special value to allow anything below 128 except control
  64         characters. <strong>Not</strong> set in
  65         ParseResult. */
  66     const long ASC_ANY_BUT_CONTROL  = 0x00000400;
  67
  68     /** Additional flag set in ParseResult::StartFlags
  69         or ParseResult::ContFlags. Set if none of the
  70         above ASC_... (except ASC_ANY_...) single values match an ASCII
  71         character parsed. */
  72     const long ASC_OTHER            = 0x00000800;
  73
  74     /// Unicode (above 127) upper case letter
  75     const long UNI_UPALPHA          = 0x00001000;
  76
  77     /// Unicode (above 127) lower case letter
  78     const long UNI_LOALPHA          = 0x00002000;
  79
  80     /// Unicode (above 127) decimal digit number
  81     const long UNI_DIGIT            = 0x00004000;
  82
  83     /// Unicode (above 127) title case letter
  84     const long UNI_TITLE_ALPHA      = 0x00008000;
  85
  86     /// Unicode (above 127) modifier letter
  87     const long UNI_MODIFIER_LETTER  = 0x00010000;
  88
  89     /// Unicode (above 127) other letter
  90     const long UNI_OTHER_LETTER     = 0x00020000;
  91
  92     /// Unicode (above 127) letter number
  93     const long UNI_LETTER_NUMBER    = 0x00040000;
  94
  95     /// Unicode (above 127) other number
  96     const long UNI_OTHER_NUMBER     = 0x00080000;
  97
  98     /** If this bit is set in <em>nContCharFlags</em> parameters and a
  99         string enclosed in double quotes is parsed and two consecutive
 100         double quotes are encountered, the string is ended. If this bit
 101         is not set, the two double quotes are parsed as one escaped
 102         double quote and string parsing continues. The bit is ignored in
 103         <em>nStartCharFlags</em> parameters.
 104
 105         <p> Example: <br/>
 106         "abc""def"  -->  bit not set  =>  abc"def <br/>
 107         "abc""def"  -->  bit set  =>  abc </p>
 108       */
 109     const long TWO_DOUBLE_QUOTES_BREAK_STRING   = 0x10000000;
 110
 111     /** Additional flag set in ParseResult::StartFlags
 112         or ParseResult::ContFlags. Set if none of the
 113         above UNI_... single values match a Unicode character parsed. */
 114     const long UNI_OTHER            = 0x20000000;
 115
 116     /** Only valid for <em>nStartCharFlags</em> parameter to
 117         ChararacterClassification::parseAnyToken() and
 118         ChararacterClassification::parsePredefinedToken(),
 119         ignored on <em>nContCharFlags</em> parameter.
 120         <strong>Not</strong> set in ParseResult. */
 121     const long IGNORE_LEADING_WS    = 0x40000000;
 122
 123
 124     // useful combinations
 125
 126     /// ASCII a-zA-Z lower or upper alpha
 127     const long ASC_ALPHA            = ASC_UPALPHA | ASC_LOALPHA;
 128
 129     /// ASCII a-zA-Z0-9 alphanumeric
 130     const long ASC_ALNUM            = ASC_ALPHA | ASC_DIGIT;
 131
 132     /// Unicode (above 127) lower or upper or title case alpha
 133     const long UNI_ALPHA            = UNI_UPALPHA | UNI_LOALPHA | UNI_TITLE_ALPHA;
 134
 135     /// Unicode (above 127) alphanumeric
 136     const long UNI_ALNUM            = UNI_ALPHA | UNI_DIGIT;
 137
 138     /// Unicode (above 127) alpha or letter
 139     const long UNI_LETTER           = UNI_ALPHA | UNI_MODIFIER_LETTER |
 140                                         UNI_OTHER_LETTER;
 141
 142     /// Unicode (above 127) number
 143     const long UNI_NUMBER           = UNI_DIGIT | UNI_LETTER_NUMBER |
 144                                         UNI_OTHER_NUMBER;
 145
 146     /// any (ASCII or Unicode) alpha
 147     const long ANY_ALPHA            = ASC_ALPHA | UNI_ALPHA;
 148
 149     /// any (ASCII or Unicode) digit
 150     const long ANY_DIGIT            = ASC_DIGIT | UNI_DIGIT;
 151
 152     /// any (ASCII or Unicode) alphanumeric
 153     const long ANY_ALNUM            = ASC_ALNUM | UNI_ALNUM;
 154
 155     /// any (ASCII or Unicode) letter
 156     const long ANY_LETTER           = ASC_ALPHA | UNI_LETTER;
 157
 158     /// any (ASCII or Unicode) number
 159     const long ANY_NUMBER           = ASC_DIGIT | UNI_NUMBER;
 160
 161     /// any (ASCII or Unicode) letter or number
 162     const long ANY_LETTER_OR_NUMBER = ANY_LETTER | ANY_NUMBER;
 163 };
 164
 165 }; }; }; };
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */