XMLChar.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_XMLCHAR_HPP)
#define XERCESC_INCLUDE_GUARD_XMLCHAR_HPP
#include <xercesc/util/XMLUniDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
// ---------------------------------------------------------------------------
// This file defines Char and utility that conforms to XML 1.0 and XML 1.1
// ---------------------------------------------------------------------------
// Masks for the fgCharCharsTable1_0 array
const XMLByte gNCNameCharMask = 0x1;
const XMLByte gFirstNameCharMask = 0x2;
const XMLByte gNameCharMask = 0x4;
const XMLByte gPlainContentCharMask = 0x8;
const XMLByte gSpecialStartTagCharMask = 0x10;
const XMLByte gControlCharMask = 0x20;
const XMLByte gXMLCharMask = 0x40;
const XMLByte gWhitespaceCharMask = 0x80;
// ---------------------------------------------------------------------------
// This class is for XML 1.0
// ---------------------------------------------------------------------------
class XMLUTIL_EXPORT XMLChar1_0
{
public:
// -----------------------------------------------------------------------
// Public, static methods, check the string
// -----------------------------------------------------------------------
static bool isAllSpaces
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool containsWhiteSpace
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidNmtoken
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidName
(
const XMLCh* const toCheck
);
static bool isValidNCName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidQName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
// -----------------------------------------------------------------------
// Public, static methods, check the XMLCh
// surrogate pair is assumed if second parameter is not null
// -----------------------------------------------------------------------
static bool isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isXMLChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isWhitespace(const XMLCh toCheck);
static bool isWhitespace(const XMLCh toCheck, const XMLCh toCheck2);
static bool isControlChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isPublicIdChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
// -----------------------------------------------------------------------
// Special Non-conformant Public, static methods
// -----------------------------------------------------------------------
static bool isNELRecognized();
static void enableNELWS();
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
XMLChar1_0();
// -----------------------------------------------------------------------
// Static data members
//
// fgCharCharsTable1_0
// The character characteristics table. Bits in each byte, represent
// the characteristics of each character. It is generated via some
// code and then hard coded into the cpp file for speed.
//
// fNEL
// Flag to represents whether NEL and LSEP newline recognition is enabled
// or disabled
// -----------------------------------------------------------------------
static XMLByte fgCharCharsTable1_0[0x10000];
static bool enableNEL;
friend class XMLReader;
};
// ---------------------------------------------------------------------------
// XMLReader: Public, static methods
// ---------------------------------------------------------------------------
inline bool XMLChar1_0::isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2)
{
// An XML letter is a FirstNameChar minus ':' and '_'.
if (!toCheck2) {
return (((fgCharCharsTable1_0[toCheck] & gFirstNameCharMask) != 0)
&& (toCheck != chColon) && (toCheck != chUnderscore));
}
return false;
}
inline bool XMLChar1_0::isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gFirstNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2) {
return (((fgCharCharsTable1_0[toCheck] & gFirstNameCharMask) != 0) && (toCheck != chColon));
}
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gNCNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gPlainContentCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDBFF))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gSpecialStartTagCharMask) != 0);
return false;
}
inline bool XMLChar1_0::isXMLChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gXMLCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDBFF))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_0::isWhitespace(const XMLCh toCheck)
{
return ((fgCharCharsTable1_0[toCheck] & gWhitespaceCharMask) != 0);
}
inline bool XMLChar1_0::isWhitespace(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gWhitespaceCharMask) != 0);
return false;
}
inline bool XMLChar1_0::isControlChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_0[toCheck] & gControlCharMask) != 0);
return false;
}
inline bool XMLChar1_0::isNELRecognized() {
return enableNEL;
}
// ---------------------------------------------------------------------------
// This class is for XML 1.1
// ---------------------------------------------------------------------------
class XMLUTIL_EXPORT XMLChar1_1
{
public:
// -----------------------------------------------------------------------
// Public, static methods, check the string
// -----------------------------------------------------------------------
static bool isAllSpaces
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool containsWhiteSpace
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidNmtoken
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidName
(
const XMLCh* const toCheck
);
static bool isValidNCName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
static bool isValidQName
(
const XMLCh* const toCheck
, const XMLSize_t count
);
// -----------------------------------------------------------------------
// Public, static methods, check the XMLCh
// -----------------------------------------------------------------------
static bool isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isXMLChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isWhitespace(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isControlChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isPublicIdChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
static bool isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2 = 0);
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
XMLChar1_1();
// -----------------------------------------------------------------------
// Static data members
//
// fgCharCharsTable1_1
// The character characteristics table. Bits in each byte, represent
// the characteristics of each character. It is generated via some
// code and then hard coded into the cpp file for speed.
//
// -----------------------------------------------------------------------
static XMLByte fgCharCharsTable1_1[0x10000];
friend class XMLReader;
};
// ---------------------------------------------------------------------------
// XMLReader: Public, static methods
// ---------------------------------------------------------------------------
inline bool XMLChar1_1::isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2)
{
return XMLChar1_0::isXMLLetter(toCheck, toCheck2);
}
inline bool XMLChar1_1::isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gFirstNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2) {
return (((fgCharCharsTable1_1[toCheck] & gFirstNameCharMask) != 0) && (toCheck != chColon));
}
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gNCNameCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDB7F))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gPlainContentCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDBFF))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gSpecialStartTagCharMask) != 0);
return false;
}
inline bool XMLChar1_1::isXMLChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gXMLCharMask) != 0);
else {
if ((toCheck >= 0xD800) && (toCheck <= 0xDBFF))
if ((toCheck2 >= 0xDC00) && (toCheck2 <= 0xDFFF))
return true;
}
return false;
}
inline bool XMLChar1_1::isWhitespace(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gWhitespaceCharMask) != 0);
return false;
}
inline bool XMLChar1_1::isControlChar(const XMLCh toCheck, const XMLCh toCheck2)
{
if (!toCheck2)
return ((fgCharCharsTable1_1[toCheck] & gControlCharMask) != 0);
return false;
}
XERCES_CPP_NAMESPACE_END
#endif
gPlainContentCharMask
const XMLByte gPlainContentCharMask
Definition: XMLChar.hpp:36
gNameCharMask
const XMLByte gNameCharMask
Definition: XMLChar.hpp:35
gXMLCharMask
const XMLByte gXMLCharMask
Definition: XMLChar.hpp:39
gNCNameCharMask
XERCES_CPP_NAMESPACE_BEGIN const XMLByte gNCNameCharMask
Definition: XMLChar.hpp:33
gSpecialStartTagCharMask
const XMLByte gSpecialStartTagCharMask
Definition: XMLChar.hpp:37
gFirstNameCharMask
const XMLByte gFirstNameCharMask
Definition: XMLChar.hpp:34
gControlCharMask
const XMLByte gControlCharMask
Definition: XMLChar.hpp:38
gWhitespaceCharMask
const XMLByte gWhitespaceCharMask
Definition: XMLChar.hpp:40
XMLUniDefs.hpp
chUnderscore
const XMLCh chUnderscore
Definition: XMLUniDefs.hpp:76
chColon
const XMLCh chColon
Definition: XMLUniDefs.hpp:53
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition: XercesDefs.hpp:112
XMLByte
unsigned char XMLByte
Definition: XercesDefs.hpp:65
XMLUTIL_EXPORT
#define XMLUTIL_EXPORT
Definition: XercesDefs.hpp:162
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition: XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition: Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition: Xerces_autoconf_config.hpp:120
XMLChar1_0
Definition: XMLChar.hpp:46
XMLChar1_0::isValidName
static bool isValidName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isSpecialStartTagChar
static bool isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:223
XMLChar1_0::isValidQName
static bool isValidQName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isControlChar
static bool isControlChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:254
XMLChar1_0::isValidName
static bool isValidName(const XMLCh *const toCheck)
XMLChar1_0::isPlainContentChar
static bool isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:210
XMLChar1_0::isNameChar
static bool isNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:186
XMLChar1_0::isValidNCName
static bool isValidNCName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isValidNmtoken
static bool isValidNmtoken(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isXMLLetter
static bool isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:151
XMLChar1_0::containsWhiteSpace
static bool containsWhiteSpace(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isXMLChar
static bool isXMLChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:230
XMLChar1_0::isNCNameChar
static bool isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:198
XMLChar1_0::isWhitespace
static bool isWhitespace(const XMLCh toCheck)
Definition: XMLChar.hpp:242
XMLChar1_0::isPublicIdChar
static bool isPublicIdChar(const XMLCh toCheck, const XMLCh toCheck2=0)
XMLChar1_0::isNELRecognized
static bool isNELRecognized()
Return true if NEL (0x85) and LSEP (0x2028) to be treated as white space char.
Definition: XMLChar.hpp:261
XMLChar1_0::enableNELWS
static void enableNELWS()
Method to enable NEL (0x85) and LSEP (0x2028) to be treated as white space char.
XMLChar1_0::isAllSpaces
static bool isAllSpaces(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_0::isFirstNameChar
static bool isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:161
XMLChar1_0::isFirstNCNameChar
static bool isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:173
XMLChar1_1
Definition: XMLChar.hpp:271
XMLChar1_1::isValidQName
static bool isValidQName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isFirstNameChar
static bool isFirstNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:363
XMLChar1_1::isFirstNCNameChar
static bool isFirstNCNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:375
XMLChar1_1::isSpecialStartTagChar
static bool isSpecialStartTagChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:425
XMLChar1_1::isAllSpaces
static bool isAllSpaces(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isNCNameChar
static bool isNCNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:400
XMLChar1_1::isPublicIdChar
static bool isPublicIdChar(const XMLCh toCheck, const XMLCh toCheck2=0)
XMLChar1_1::isPlainContentChar
static bool isPlainContentChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:412
XMLChar1_1::isWhitespace
static bool isWhitespace(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:444
XMLChar1_1::isXMLChar
static bool isXMLChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:432
XMLChar1_1::containsWhiteSpace
static bool containsWhiteSpace(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isValidNmtoken
static bool isValidNmtoken(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isValidNCName
static bool isValidNCName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isControlChar
static bool isControlChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:451
XMLChar1_1::isValidName
static bool isValidName(const XMLCh *const toCheck, const XMLSize_t count)
XMLChar1_1::isNameChar
static bool isNameChar(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:388
XMLChar1_1::isXMLLetter
static bool isXMLLetter(const XMLCh toCheck, const XMLCh toCheck2=0)
Definition: XMLChar.hpp:357
XMLChar1_1::isValidName
static bool isValidName(const XMLCh *const toCheck)