source: icXML/icXML-devel/src/xercesc/util/HexBin.hpp @ 2722

Last change on this file since 2722 was 2722, checked in by cameron, 6 years ago

Original Xerces files with import mods for icxercesc

File size: 4.0 KB
Line 
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 932887 2010-04-11 13:04:59Z borisk $
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_HEXBIN_HPP)
23#define XERCESC_INCLUDE_GUARD_HEXBIN_HPP
24
25#include <icxercesc/util/PlatformUtils.hpp>
26
27XERCES_CPP_NAMESPACE_BEGIN
28
29class XMLUTIL_EXPORT HexBin
30{
31public :
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 deallocation
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 XMLByte
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     * Use the memory manager to release the returned buffer.
82     *
83     * @param hexData HexBinary data in XMLCh stream.
84     * @param manager client provided memory manager
85     * @return Decoded binary data in XMLByte stream,
86     *      or NULL if input data can not be decoded.
87     */
88    static XMLByte* decodeToXMLByte(
89                         const XMLCh*          const    hexData
90                       ,       MemoryManager*  const    manager = XMLPlatformUtils::fgMemoryManager
91                        );
92
93
94    //@}
95
96private :
97
98    // -----------------------------------------------------------------------
99    //  Helper methods
100    // -----------------------------------------------------------------------
101
102    static bool isHex(const XMLCh& octet);
103
104    // -----------------------------------------------------------------------
105    //  Unimplemented constructors and operators
106    // -----------------------------------------------------------------------
107    HexBin();
108    HexBin(const HexBin&);
109    HexBin& operator=(const HexBin&);
110
111    // -----------------------------------------------------------------------
112    //  Private data members
113    //
114    //  isInitialized
115    //
116    //     set once hexNumberTable is initialized.
117    //
118    //  hexNumberTable
119    //
120    //     arrany holding valid hexNumber character.
121    //
122    // -----------------------------------------------------------------------
123    static const XMLByte    hexNumberTable[];
124};
125
126XERCES_CPP_NAMESPACE_END
127
128#endif
Note: See TracBrowser for help on using the repository browser.