include/archiver/archiver.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2007 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: archiver.h,v $ $Revision: 1.11 $ $State: Exp $
*******************************************************************************/


#ifndef DTARCHIVER_H_
#define DTARCHIVER_H_

#include "archiver/archiverDefines.h"
#include "archiver/archivableObject.h"

#include "ngutil/dtqlist.h"
#include "archiver/archiverDefines.h"
#include "archiver/archivableDictionaryObject.h"

#include <QtCore/QObject>
#include <QtCore/QRect>
#include <QtGui/QColor>
#include <QtCore/QString>
#include <QtCore/QTextStream>
#include <QtCore/QLinkedList>
#include <QtCore/QList>
#include <QtCore/QHash>

class DtArchiveObject;
class DtArchivableObject;

class QPen;
class QString;
class QPoint;
class QStringList;
class QColor;
class QPointF;
class QTextStream;


class DtArchivableCreatorInfo;

typedef void (*DtArchiverFunction)(QTextStream& ts, DtArchiveObject* obj);

class DT_DLL_archiver DtArchiver : public QObject
{
public:
   DtArchiver(QString name);
   virtual ~DtArchiver();

public:
   virtual void add(QString value, int* toWrite);
   virtual void add(QString value, short* toWrite);
   virtual void add(QString value, DtArchivableObject* toWrite);
   virtual void add(QString value, QPen* toWrite);
   virtual void add(QString value, QColor* toWrite);
   virtual void add(QString value, double* toWrite);
   virtual void add(QString value, bool* toWrite);
   virtual void add(QString value, float* toWrite);
   virtual void add(QString value, QString* toWrite);
   virtual void add(QString value, char* toWrite);
   virtual void add(QString value, QPoint* toWrite);
   virtual void add(QString value, QPointF* toWrite);

   virtual void add(QString value, QRect* toWrite);

   virtual void add(QString value, QStringList* toWrite);

   virtual void add(QString value, void* toWrite,
      DtArchiverFunction write, DtArchiverFunction read, bool writeLevel = false);

   template <typename Key, typename Value> void add(QString value, 
      QHash<Key, Value>* toWrite);

   template <typename T> void add(QString value, QList<T>* toWrite);
   template <typename T> void add(QString value, QLinkedList<T>* toWrite);
   template <typename T> void add(QString value, QVector<T>* toWrite);

   virtual void remove(void* toWrite);

   virtual void setLevel(int iLevel);
   virtual int level() const;

   virtual void setName(QString name);
   virtual QString name() const;

   static void addCreator(const QString& name, DtArchivableObjectCreator fnc);
   static bool hasCreatorFor(DtArchivableObject* obj);
   static DtArchivableCreatorInfo* creatorFor(const QString& name);
   static DtArchivableObject* createObject(const QString& name);
  
   static void cleanupCreators();

public:
   virtual void read(QTextStream& ts);
   virtual void write(QTextStream& ts);
   virtual void writeObject(QTextStream& ts, int level, DtArchiveObject* obj);
   virtual void readObject(DtArchiveObject* obj);

protected:
   virtual void writeLevel(QTextStream& ts, int iLevel);

   virtual void parseBlock(QTextStream& ts);

   virtual QString readBlock(QTextStream& ts);

   virtual QString readNamedBlock(QString& name, QTextStream& ts);

   virtual void buildArchiveDictionary(QTextStream& block);

protected:
   DtPtrQList<DtArchiveObject*> myArchivableObjects;
   QHash<QString, QString> myArchiveBlocks;
   static QHash<QString, DtArchivableCreatorInfo>* myObjectCreators;

   int myLevel;
   QString myName;
};

class DT_DLL_archiver DtArchivableCreatorInfo
{
public:
   DtArchivableCreatorInfo(DtArchivableObjectCreator fcn);
   DtArchivableCreatorInfo(const DtArchivableCreatorInfo& orig) : myCreator(orig.myCreator) {};

   virtual DtArchivableObjectCreator creator();
   virtual void setCreator(DtArchivableObjectCreator fcn);

protected:
   DtArchivableObjectCreator myCreator;
};

DT_DLL_archiver QTextStream& operator<<(QTextStream& ts, DtArchiver& archive);
DT_DLL_archiver QTextStream& operator>>(QTextStream& ts, DtArchiver& archive);








class DT_DLL_archiver DtArchiveObject
{
public:
   DtArchiveObject(QString name, void* toArchive,
      DtArchiverFunction archiveWriter, DtArchiverFunction archiveReader);

   DtArchiveObject(const DtArchiveObject& orig);

   virtual ~DtArchiveObject();
   
public:
   virtual void write(QTextStream& ts);
   virtual void read(QTextStream& ts);

   virtual QString name() const;
   virtual void* toWrite();

   virtual void setLevel(int i);
   virtual int level() const;

   virtual void setWriteLevel(bool b);
   virtual bool writeLevel() const;

public:

   static void writeInt(QTextStream& ts, DtArchiveObject* obj);
   static void readInt(QTextStream& ts, DtArchiveObject* obj);

   static void writeShort(QTextStream& ts, DtArchiveObject* obj);
   static void readShort(QTextStream& ts, DtArchiveObject* obj);

   static void writeRect(QTextStream& ts, DtArchiveObject* obj);
   static void readRect(QTextStream& ts, DtArchiveObject* obj);

   static void writeArchivableObject(QTextStream& ts, DtArchiveObject* obj);
   static void readArchivableObject(QTextStream& ts, DtArchiveObject* obj);

   static void writePen(QTextStream& ts, DtArchiveObject* obj);
   static void readPen(QTextStream& ts, DtArchiveObject* obj);

   static void writeColor(QTextStream& ts, DtArchiveObject* obj);
   static void readColor(QTextStream& ts, DtArchiveObject* obj);

   static void writeDouble(QTextStream& ts, DtArchiveObject* obj);
   static void readDouble(QTextStream& ts, DtArchiveObject* obj);

   static void writeBool(QTextStream& ts, DtArchiveObject* obj);
   static void readBool(QTextStream& ts, DtArchiveObject* obj);

   static void writeFloat(QTextStream& ts, DtArchiveObject* obj);
   static void readFloat(QTextStream& ts, DtArchiveObject* obj);

   static void writeString(QTextStream& ts, DtArchiveObject* obj);
   static void readString(QTextStream& ts, DtArchiveObject* obj);

   static void writeCharStar(QTextStream& ts, DtArchiveObject* obj);
   static void readCharStar(QTextStream& ts, DtArchiveObject* obj);

   static void writePoint(QTextStream& ts, DtArchiveObject* obj);
   static void readPoint(QTextStream& ts, DtArchiveObject* obj);

   static void writePointF(QTextStream& ts, DtArchiveObject* obj);
   static void readPointF(QTextStream& ts, DtArchiveObject* obj);

   template <typename T> static void writeCollection(
      QTextStream& ts, DtArchiveObject* obj);

   template <typename T> static void readCollection(
      QTextStream& ts, DtArchiveObject* obj);

   template <typename T> static void writeList(
      QTextStream& ts, DtArchiveObject* obj);
      
   template <typename T> static void readList(QTextStream& ts, 
      DtArchiveObject* obj);
      
   template <typename T> static void writeVectorList(
      QTextStream& ts, DtArchiveObject* obj);
      
   template <typename T> static void readVectorList(QTextStream& ts, 
      DtArchiveObject* obj);
      
   template <typename Key, typename Value> static void writeDictionary(
      QTextStream& ts, DtArchiveObject* obj);

   template <typename Key, typename Value> static void readDictionary(
      QTextStream& ts, DtArchiveObject* obj);

   static void writeStringList(QTextStream& ts, DtArchiveObject* obj);
   static void readStringList(QTextStream& ts, DtArchiveObject* obj);

protected:
   virtual void writeLevel(QTextStream& ts, int iLevel);

protected:
   DtArchiverFunction myWriter;
   DtArchiverFunction myReader;
   void* myValue;
   QString myName;
   int myLevel;
   bool myWriteLevel;
};

QTextStream& operator<<(QTextStream& ts, DtArchiveObject& obj);
QTextStream& operator>>(QTextStream& ts, DtArchiveObject& obj);

#include "archiver/archiver.inl"

#endif