XdlOrm/include/QxSerialize/QxSerializeQDataStream.h

/****************************************************************************
**
** https://www.qxorm.com/
** Copyright (C) 2013 XDL Team (ic-east.com)
**
** This file is part of the QxOrm library
**
** This software is provided 'as-is', without any express or implied
** warranty. In no event will the authors be held liable for any
** damages arising from the use of this software
**
** Commercial Usage
** Licensees holding valid commercial QxOrm licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and XDL Team
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file 'license.gpl3.txt' included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met : http://www.gnu.org/copyleft/gpl.html
**
** If you are unsure which license is appropriate for your use, or
** if you have questions regarding the use of this file, please contact :
** ic-east.com
**
****************************************************************************/

#ifndef _QX_SERIALIZE_QDATASTREAM_H_
#define _QX_SERIALIZE_QDATASTREAM_H_

#ifdef _MSC_VER
#pragma once
#endif

/*!
 * \file QxSerializeQDataStream.h
 * \author XDL Team
 * \ingroup QxSerialize
 * \brief Used when _QX_ENABLE_BOOST_SERIALIZATION compilation option is not defined to provide serialization engine with Qt QDataStream class
 */

#include <exception>

#include <QtCore/qdatastream.h>
#include <QtCore/qfile.h>

#include <QxCommon/QxBool.h>

namespace qx
{
   namespace serialization
   {

      /*!
       * \ingroup QxSerialize
       * \brief serialize a class registered into QxOrm context using Qt QDataStream serialization engine
       */
      namespace qt
      {

         template <class T>
         inline QByteArray to_byte_array(const T &obj, void *owner = NULL, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            Q_UNUSED(flags);
            Q_UNUSED(owner);
            QByteArray ba;
            QString err;
            QDataStream stream((&ba), QIODevice::WriteOnly);
            stream << (quint32)(9438);
            try
            {
               stream << obj;
            }
            catch (const std::exception &e)
            {
               err = QString("serialization error '%ERR%'").replace("%ERR%", e.what());
            }
            catch (...)
            {
               err = QString("serialization error '%ERR%'").replace("%ERR%", "unknown error");
            }
            if (!err.isEmpty())
            {
               qDebug("[QxOrm] qx::serialization::qt::to_byte_array() : %s", qPrintable(err));
               ba.clear();
            }
            return ba;
         }

         template <class T>
         inline qx_bool from_byte_array(T &obj, const QByteArray &data, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            Q_UNUSED(flags);
            qx_bool result = false;
            if (data.isEmpty())
            {
               return qx_bool(false, "input binary data is empty");
            }
            QDataStream stream(data);
            quint32 magic = 0;
            stream >> magic;
            if (magic != 9438)
            {
               return qx_bool(false, "input binary data is not valid");
            }
            try
            {
               stream >> obj;
               result = true;
            }
            catch (const std::exception &e)
            {
               result.setDesc(QString("deserialization error '%ERR%'").replace("%ERR%", e.what()));
            }
            catch (...)
            {
               result.setDesc(QString("deserialization error '%ERR%'").replace("%ERR%", "unknown error"));
            }
            if (!result.getDesc().isEmpty())
            {
               QString msg = result.getDesc();
               qDebug("[QxOrm] qx::serialization::qt::from_byte_array() : %s", qPrintable(msg));
            }
            return result;
         }

         template <class T>
         inline QString to_string(const T &obj, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            return qx::serialization::qt::to_byte_array(obj, NULL, flags).toBase64();
         }

         template <class T>
         inline qx_bool from_string(T &obj, const QString &sString, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            QByteArray data = QByteArray::fromBase64(sString.toLatin1());
            return qx::serialization::qt::from_byte_array(obj, data, flags);
         }

         template <class T>
         inline qx_bool to_file(const T &obj, const QString &sFileName, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            QByteArray data = qx::serialization::qt::to_byte_array(obj, NULL, flags);
            QFile file(sFileName);
            if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate))
            {
               return qx_bool(false, "cannot open file : " + sFileName);
            }
            file.write(data);
            file.close();
            return qx_bool(true);
         }

         template <class T>
         inline qx_bool from_file(T &obj, const QString &sFileName, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            QFile file(sFileName);
            if (!file.open(QIODevice::ReadOnly))
            {
               return qx_bool(false, "cannot open file : " + sFileName);
            }
            QByteArray data = file.readAll();
            file.close();
            return qx::serialization::qt::from_byte_array(obj, data, flags);
         }

         template <class T>
         inline qx_bool to_file_compressed(const T &obj, const QString &sFileName, unsigned int flags = 1 /* boost::archive::no_header */, int iCompressionLevel = -1)
         {
            QByteArray data = qx::serialization::qt::to_byte_array(obj, NULL, flags);
            QByteArray compressed = qCompress(data, iCompressionLevel);
            QFile file(sFileName);
            if (!file.open(QIODevice::WriteOnly | QIODevice::Truncate))
            {
               return qx_bool(false, "cannot open file : " + sFileName);
            }
            file.write(compressed);
            file.close();
            return qx_bool(true);
         }

         template <class T>
         inline qx_bool from_file_compressed(T &obj, const QString &sFileName, unsigned int flags = 1 /* boost::archive::no_header */)
         {
            QFile file(sFileName);
            if (!file.open(QIODevice::ReadOnly))
            {
               return qx_bool(false, "cannot open file : " + sFileName);
            }
            QByteArray data = file.readAll();
            file.close();
            QByteArray uncompressed = qUncompress(data);
            return qx::serialization::qt::from_byte_array(obj, uncompressed, flags);
         }

      } // namespace qt
   } // namespace serialization
} // namespace qx

#endif // _QX_SERIALIZE_QDATASTREAM_H_