[2674] | 1 | /* |
---|
| 2 | * Licensed to the Apache Software Foundation (ASF) under one or more |
---|
| 3 | * contributor license agreements. See the NOTICE file distributed with |
---|
| 4 | * this work for additional information regarding copyright ownership. |
---|
| 5 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
---|
| 6 | * (the "License"); you may not use this file except in compliance with |
---|
| 7 | * the License. You may obtain a copy of the License at |
---|
| 8 | * |
---|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
---|
| 10 | * |
---|
| 11 | * Unless required by applicable law or agreed to in writing, software |
---|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
---|
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
---|
| 14 | * See the License for the specific language governing permissions and |
---|
| 15 | * limitations under the License. |
---|
| 16 | */ |
---|
| 17 | |
---|
| 18 | /* |
---|
| 19 | * $Id: HexBin.hpp 568078 2007-08-21 11:43:25Z amassari $ |
---|
| 20 | */ |
---|
| 21 | |
---|
| 22 | #ifndef HEXBIN_HPP |
---|
| 23 | #define HEXBIN_HPP |
---|
| 24 | |
---|
| 25 | #include <xercesc/util/PlatformUtils.hpp> |
---|
| 26 | |
---|
| 27 | XERCES_CPP_NAMESPACE_BEGIN |
---|
| 28 | |
---|
| 29 | class XMLUTIL_EXPORT HexBin |
---|
| 30 | { |
---|
| 31 | public : |
---|
| 32 | //@{ |
---|
| 33 | |
---|
| 34 | /** |
---|
| 35 | * return the length of hexData in terms of HexBinary. |
---|
| 36 | * |
---|
| 37 | * @param hexData A string containing the HexBinary |
---|
| 38 | * |
---|
| 39 | * return: -1 if it contains any invalid HexBinary |
---|
| 40 | * the length of the HexNumber otherwise. |
---|
| 41 | */ |
---|
| 42 | |
---|
| 43 | static int getDataLength(const XMLCh* const hexData); |
---|
| 44 | |
---|
| 45 | /** |
---|
| 46 | * check an array of data against the Hex table. |
---|
| 47 | * |
---|
| 48 | * @param hexData A string containing the HexBinary |
---|
| 49 | * |
---|
| 50 | * return: false if it contains any invalid HexBinary |
---|
| 51 | * true otherwise. |
---|
| 52 | */ |
---|
| 53 | |
---|
| 54 | static bool isArrayByteHex(const XMLCh* const hexData); |
---|
| 55 | |
---|
| 56 | /** |
---|
| 57 | * get canonical representation |
---|
| 58 | * |
---|
| 59 | * Caller is responsible for the proper deallcation |
---|
| 60 | * of the string returned. |
---|
| 61 | * |
---|
| 62 | * @param hexData A string containing the HexBinary |
---|
| 63 | * @param manager The MemoryManager to use to allocate the string |
---|
| 64 | * |
---|
| 65 | * return: the canonical representation of the HexBinary |
---|
| 66 | * if it is a valid HexBinary, |
---|
| 67 | * 0 otherwise |
---|
| 68 | */ |
---|
| 69 | |
---|
| 70 | static XMLCh* getCanonicalRepresentation |
---|
| 71 | ( |
---|
| 72 | const XMLCh* const hexData |
---|
| 73 | , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager |
---|
| 74 | ); |
---|
| 75 | |
---|
| 76 | /** |
---|
| 77 | * Decodes HexBinary data into XMLCh |
---|
| 78 | * |
---|
| 79 | * NOTE: The returned buffer is dynamically allocated and is the |
---|
| 80 | * responsibility of the caller to delete it when not longer needed. |
---|
| 81 | * You can call XMLString::release to release this returned buffer. |
---|
| 82 | * |
---|
| 83 | * If a memory manager is provided, ask the memory manager to de-allocate |
---|
| 84 | * the returned buffer. |
---|
| 85 | * |
---|
| 86 | * @param hexData HexBinary data in XMLCh stream. |
---|
| 87 | * @param manager client provided memory manager |
---|
| 88 | * @return Decoded binary data in XMLCh stream, |
---|
| 89 | * or NULL if input data can not be decoded. |
---|
| 90 | * @see XMLString::release(XMLCh**) |
---|
| 91 | * @deprecated use decodeToXMLByte instead. |
---|
| 92 | */ |
---|
| 93 | |
---|
| 94 | static XMLCh* decode( |
---|
| 95 | const XMLCh* const hexData |
---|
| 96 | , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager |
---|
| 97 | ); |
---|
| 98 | |
---|
| 99 | /** |
---|
| 100 | * Decodes HexBinary data into XMLByte |
---|
| 101 | * |
---|
| 102 | * NOTE: The returned buffer is dynamically allocated and is the |
---|
| 103 | * responsibility of the caller to delete it when not longer needed. |
---|
| 104 | * You can call XMLString::release to release this returned buffer. |
---|
| 105 | * |
---|
| 106 | * If a memory manager is provided, ask the memory manager to de-allocate |
---|
| 107 | * the returned buffer. |
---|
| 108 | * |
---|
| 109 | * @param hexData HexBinary data in XMLCh stream. |
---|
| 110 | * @param manager client provided memory manager |
---|
| 111 | * @return Decoded binary data in XMLByte stream, |
---|
| 112 | * or NULL if input data can not be decoded. |
---|
| 113 | * @see XMLString::release(XMLByte**) |
---|
| 114 | */ |
---|
| 115 | static XMLByte* decodeToXMLByte( |
---|
| 116 | const XMLCh* const hexData |
---|
| 117 | , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager |
---|
| 118 | ); |
---|
| 119 | |
---|
| 120 | |
---|
| 121 | //@} |
---|
| 122 | |
---|
| 123 | private : |
---|
| 124 | |
---|
| 125 | // ----------------------------------------------------------------------- |
---|
| 126 | // Helper methods |
---|
| 127 | // ----------------------------------------------------------------------- |
---|
| 128 | |
---|
| 129 | static void init(); |
---|
| 130 | |
---|
| 131 | static bool isHex(const XMLCh& octect); |
---|
| 132 | |
---|
| 133 | // ----------------------------------------------------------------------- |
---|
| 134 | // Unimplemented constructors and operators |
---|
| 135 | // ----------------------------------------------------------------------- |
---|
| 136 | HexBin(); |
---|
| 137 | HexBin(const HexBin&); |
---|
| 138 | HexBin& operator=(const HexBin&); |
---|
| 139 | |
---|
| 140 | // ----------------------------------------------------------------------- |
---|
| 141 | // Private data members |
---|
| 142 | // |
---|
| 143 | // isInitialized |
---|
| 144 | // |
---|
| 145 | // set once hexNumberTable is initalized. |
---|
| 146 | // |
---|
| 147 | // hexNumberTable |
---|
| 148 | // |
---|
| 149 | // arrany holding valid hexNumber character. |
---|
| 150 | // |
---|
| 151 | // ----------------------------------------------------------------------- |
---|
| 152 | static bool isInitialized; |
---|
| 153 | static XMLByte hexNumberTable[]; |
---|
| 154 | }; |
---|
| 155 | |
---|
| 156 | XERCES_CPP_NAMESPACE_END |
---|
| 157 | |
---|
| 158 | #endif |
---|