/******************************************************************************

 *

 * Copyright (C) 1997-2015 by Dimitri van Heesch.

 *

 * Permission to use, copy, modify, and distribute this software and its

 * documentation under the terms of the GNU General Public License is hereby 

 * granted. No representations are made about the suitability of this software 

 * for any purpose. It is provided "as is" without express or implied warranty.

 * See the GNU General Public License for more details.

 *

 * Documents produced by Doxygen are derivative works derived from the

 * input used in their production; they are not affected by this license.

 *

 */

#ifndef MARSHAL_H

#define MARSHAL_H

#include <qlist.h>

#include <qfile.h>

#include "sortdict.h"

#include "store.h"

class ArgumentList;

struct BaseInfo;

struct Grouping;

struct SectionInfo;

struct ListItemInfo;

class QCString;

class QGString;

class SectionDict;

class MemberSDict;

class GroupList;

class MemberList;

struct BodyInfo;

struct DocInfo;

struct BriefInfo;

class ExampleSDict;

class Entry;

#define NULL_LIST 0xffffffff

//----- marshaling function: datatype -> byte stream --------------------

void marshalInt(StorageIntf *s,int v);

void marshalUInt(StorageIntf *s,uint v);

void marshalUInt64(StorageIntf *s,uint64 v);

void marshalBool(StorageIntf *s,bool b);

void marshalQCString(StorageIntf *s,const QCString &str);

void marshalQGString(StorageIntf *s,const QGString &str);

void marshalArgumentList(StorageIntf *s,ArgumentList *argList);

void marshalArgumentLists(StorageIntf *s,QList<ArgumentList> *argLists);

void marshalBaseInfoList(StorageIntf *s, QList<BaseInfo> *baseList);

void marshalGroupingList(StorageIntf *s, QList<Grouping> *groups);

void marshalSectionInfoList(StorageIntf *s, QList<SectionInfo> *anchors);

void marshalItemInfoList(StorageIntf *s, QList<ListItemInfo> *sli);

void marshalObjPointer(StorageIntf *s,void *obj);

void marshalSectionDict(StorageIntf *s,SectionDict *sections);

void marshalMemberSDict(StorageIntf *s,MemberSDict *memberSDict);

void marshalDocInfo(StorageIntf *s,DocInfo *docInfo);

void marshalBriefInfo(StorageIntf *s,BriefInfo *briefInfo);

void marshalBodyInfo(StorageIntf *s,BodyInfo *bodyInfo);

void marshalGroupList(StorageIntf *s,GroupList *groupList);

void marshalMemberList(StorageIntf *s,MemberList *ml);

void marshalExampleSDict(StorageIntf *s,ExampleSDict *ed);

void marshalMemberLists(StorageIntf *s,SDict<MemberList> *mls);

void marshalEntry(StorageIntf *s,Entry *e);

void marshalEntryTree(StorageIntf *s,Entry *e);

//----- unmarshaling function: byte stream -> datatype ------------------

int                  unmarshalInt(StorageIntf *s);

uint                 unmarshalUInt(StorageIntf *s);

uint64               unmarshalUInt64(StorageIntf *s);

bool                 unmarshalBool(StorageIntf *s);

QCString             unmarshalQCString(StorageIntf *s);

QGString             unmarshalQGString(StorageIntf *s);

ArgumentList *       unmarshalArgumentList(StorageIntf *s);

QList<ArgumentList> *unmarshalArgumentLists(StorageIntf *s);

QList<BaseInfo> *    unmarshalBaseInfoList(StorageIntf *s);

QList<Grouping> *    unmarshalGroupingList(StorageIntf *s);

QList<SectionInfo> * unmarshalSectionInfoList(StorageIntf *s);

QList<ListItemInfo> *unmarshalItemInfoList(StorageIntf *s);

void *               unmarshalObjPointer(StorageIntf *s);

SectionDict *        unmarshalSectionDict(StorageIntf *s);

MemberSDict *        unmarshalMemberSDict(StorageIntf *s);

DocInfo *            unmarshalDocInfo(StorageIntf *s);

BriefInfo *          unmarshalBriefInfo(StorageIntf *s);

BodyInfo *           unmarshalBodyInfo(StorageIntf *s);

GroupList *          unmarshalGroupList(StorageIntf *s);

MemberList *         unmarshalMemberList(StorageIntf *s);

ExampleSDict *       unmarshalExampleSDict(StorageIntf *s);

SDict<MemberList> *  unmarshalMemberLists(StorageIntf *s);

Entry *              unmarshalEntry(StorageIntf *s);

Entry *              unmarshalEntryTree(StorageIntf *s);

#endif