src/xmlpatterns/data/qbase64binary_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef Patternist_Base64Binary_H
  53 #define Patternist_Base64Binary_H
  54
  55 #include <private/qitem_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63
  64     /**
  65      * @short Implements the value instance of the @c xs:base64Binary type.
  66      *
  67      * @author Frans Englich <frans.englich@nokia.com>
  68      * @ingroup Patternist_xdm
  69      */
  70     class Base64Binary : public AtomicValue
  71     {
  72     public:
  73         friend class CommonValues;
  74
  75         typedef AtomicValue::Ptr Ptr;
  76
  77         /**
  78          * Creates an instance representing @p value.
  79          */
  80         static AtomicValue::Ptr fromLexical(const QString &value);
  81
  82         static Base64Binary::Ptr fromValue(const QByteArray &data);
  83
  84         virtual QString stringValue() const;
  85         virtual ItemType::Ptr type() const;
  86         inline const QByteArray &asByteArray() const
  87         {
  88             return m_value;
  89         }
  90
  91     protected:
  92         Base64Binary(const QByteArray &val);
  93
  94         const QByteArray m_value;
  95
  96     private:
  97         /**
  98          * @short Assumes @p in is a lexical representation of @c xs:base64Binary, and
  99          * converts it to the binary data set in @p out.
 100          *
 101          * If @p instr is invalid Base64 content, @p ok is set to
 102          * false, and the returned QByteArray has an undefined value.
 103          *
 104          *  We cannot use QByteArray::fromBase64() because it doesn't do the
 105          *  necessary validation that we need to properly implement W3C XML
 106          *  Schema's xs:base64Binary type.
 107          */
 108         static void base64Decode(const QByteArray &in, QByteArray &out, bool &ok);
 109
 110         static const char Base64DecMap[128];
 111     };
 112 }
 113
 114 QT_END_NAMESPACE
 115
 116 QT_END_HEADER
 117
 118 #endif