marshal.h File Reference

#include <qlist.h>
#include <qfile.h>
#include "sortdict.h"
#include "store.h"

Go to the source code of this file.

Classes

class  FileStorage
class  StreamStorage

Defines

#define NULL_LIST   0xffffffff

Functions

void marshalInt (StorageIntf *s, int v)
void marshalUInt (StorageIntf *s, uint 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)
int unmarshalInt (StorageIntf *s)
uint unmarshalUInt (StorageIntf *s)
bool unmarshalBool (StorageIntf *s)
QCString unmarshalQCString (StorageIntf *s)
QGString unmarshalQGString (StorageIntf *s)
ArgumentListunmarshalArgumentList (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)
SectionDictunmarshalSectionDict (StorageIntf *s)
MemberSDictunmarshalMemberSDict (StorageIntf *s)
DocInfounmarshalDocInfo (StorageIntf *s)
BriefInfounmarshalBriefInfo (StorageIntf *s)
BodyInfounmarshalBodyInfo (StorageIntf *s)
GroupListunmarshalGroupList (StorageIntf *s)
MemberListunmarshalMemberList (StorageIntf *s)
ExampleSDictunmarshalExampleSDict (StorageIntf *s)
SDict< MemberList > * unmarshalMemberLists (StorageIntf *s)
EntryunmarshalEntry (StorageIntf *s)
EntryunmarshalEntryTree (StorageIntf *s)


Define Documentation

#define NULL_LIST   0xffffffff

Definition at line 26 of file marshal.h.

Referenced by MemberList::marshal(), marshalArgumentList(), marshalArgumentLists(), marshalBaseInfoList(), marshalBodyInfo(), marshalBriefInfo(), marshalDocInfo(), marshalExampleSDict(), marshalGroupingList(), marshalGroupList(), marshalItemInfoList(), marshalMemberList(), marshalMemberLists(), marshalMemberSDict(), marshalSectionDict(), marshalSectionInfoList(), MemberList::unmarshal(), unmarshalArgumentList(), unmarshalArgumentLists(), unmarshalBaseInfoList(), unmarshalBodyInfo(), unmarshalBriefInfo(), unmarshalDocInfo(), unmarshalExampleSDict(), unmarshalGroupingList(), unmarshalGroupList(), unmarshalItemInfoList(), unmarshalMemberList(), unmarshalMemberLists(), unmarshalMemberSDict(), unmarshalSectionDict(), and unmarshalSectionInfoList().


Function Documentation

void marshalArgumentList ( StorageIntf s,
ArgumentList argList 
)

Definition at line 55 of file marshal.cpp.

References Argument::array, Argument::attrib, Argument::canType, ArgumentList::constSpecifier, Argument::defval, Argument::docs, marshalBool(), marshalQCString(), marshalUInt(), Argument::name, NULL_LIST, ArgumentList::pureSpecifier, Argument::type, and ArgumentList::volatileSpecifier.

Referenced by MemberDef::flushToDisk(), marshalArgumentLists(), and marshalEntry().

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

Definition at line 85 of file marshal.cpp.

References marshalArgumentList(), marshalUInt(), and NULL_LIST.

Referenced by MemberDef::flushToDisk(), and marshalEntry().

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

Definition at line 103 of file marshal.cpp.

References marshalInt(), marshalQCString(), marshalUInt(), BaseInfo::name, NULL_LIST, BaseInfo::prot, and BaseInfo::virt.

Referenced by marshalEntry().

void marshalBodyInfo ( StorageIntf s,
BodyInfo bodyInfo 
)

Definition at line 263 of file marshal.cpp.

References BodyInfo::endLine, BodyInfo::fileDef, marshalInt(), marshalObjPointer(), marshalUInt(), NULL_LIST, and BodyInfo::startLine.

Referenced by Definition::flushToDisk().

void marshalBool ( StorageIntf s,
bool  b 
)

Definition at line 35 of file marshal.cpp.

References StorageIntf::write().

Referenced by Definition::flushToDisk(), MemberDef::flushToDisk(), MemberGroup::marshal(), MemberList::marshal(), marshalArgumentList(), and marshalEntry().

void marshalBriefInfo ( StorageIntf s,
BriefInfo briefInfo 
)

Definition at line 247 of file marshal.cpp.

References BriefInfo::doc, BriefInfo::file, BriefInfo::line, marshalInt(), marshalQCString(), marshalUInt(), NULL_LIST, and BriefInfo::tooltip.

Referenced by Definition::flushToDisk().

void marshalDocInfo ( StorageIntf s,
DocInfo docInfo 
)

Definition at line 232 of file marshal.cpp.

References DocInfo::doc, DocInfo::file, DocInfo::line, marshalInt(), marshalQCString(), marshalUInt(), and NULL_LIST.

Referenced by Definition::flushToDisk().

void marshalEntry ( StorageIntf s,
Entry e 
)

Definition at line 363 of file marshal.cpp.

References Entry::anchors, Entry::argList, Entry::args, Entry::artificial, Entry::bitfields, Entry::bodyLine, Entry::brief, Entry::briefFile, Entry::briefLine, Entry::callerGraph, Entry::callGraph, Entry::doc, Entry::docFile, Entry::docLine, Entry::endBodyLine, Entry::exception, Entry::explicitExternal, Entry::extends, Entry::fileName, Entry::groupDocType, Entry::groups, HEADER, Entry::hidden, Entry::inbodyDocs, Entry::inbodyFile, Entry::inbodyLine, Entry::includeFile, Entry::includeName, Entry::initializer, Entry::initLines, Entry::inside, marshalArgumentList(), marshalArgumentLists(), marshalBaseInfoList(), marshalBool(), marshalGroupingList(), marshalInt(), marshalItemInfoList(), marshalQCString(), marshalQGString(), marshalSectionInfoList(), marshalUInt(), Entry::mGrpId, Entry::mtype, Entry::name, Entry::objc, Entry::program, Entry::protection, Entry::proto, Entry::read, Entry::relates, Entry::relatesDup, Entry::section, Entry::sli, Entry::spec, Entry::startLine, Entry::stat, Entry::subGrouping, Entry::tArgLists, Entry::type, Entry::typeConstr, Entry::virt, and Entry::write.

Referenced by marshalEntryTree(), and EntryNav::saveEntry().

void marshalEntryTree ( StorageIntf s,
Entry e 
)

Definition at line 419 of file marshal.cpp.

References Entry::children(), marshalEntry(), marshalEntryTree(), and marshalUInt().

Referenced by marshalEntryTree().

void marshalExampleSDict ( StorageIntf s,
ExampleSDict ed 
)

Definition at line 319 of file marshal.cpp.

References Example::anchor, SDict< T >::count(), Example::file, marshalQCString(), marshalUInt(), Example::name, and NULL_LIST.

Referenced by MemberDef::flushToDisk().

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

Definition at line 123 of file marshal.cpp.

References Grouping::groupname, marshalInt(), marshalQCString(), marshalUInt(), NULL_LIST, and Grouping::pri.

Referenced by marshalEntry().

void marshalGroupList ( StorageIntf s,
GroupList groupList 
)

Definition at line 278 of file marshal.cpp.

References marshalObjPointer(), marshalUInt(), and NULL_LIST.

Referenced by Definition::flushToDisk().

void marshalInt ( StorageIntf s,
int  v 
)

Definition at line 15 of file marshal.cpp.

References StorageIntf::write().

Referenced by Definition::flushToDisk(), MemberDef::flushToDisk(), MemberGroup::marshal(), MemberList::marshal(), marshalBaseInfoList(), marshalBodyInfo(), marshalBriefInfo(), marshalDocInfo(), marshalEntry(), marshalGroupingList(), marshalItemInfoList(), and marshalSectionInfoList().

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

Definition at line 164 of file marshal.cpp.

References ListItemInfo::itemId, marshalInt(), marshalQCString(), marshalUInt(), NULL_LIST, and ListItemInfo::type.

Referenced by Definition::flushToDisk(), and marshalEntry().

void marshalMemberList ( StorageIntf s,
MemberList ml 
)

Definition at line 296 of file marshal.cpp.

References MemberList::marshal(), marshalObjPointer(), marshalUInt(), and NULL_LIST.

Referenced by MemberDef::flushToDisk(), and MemberGroup::marshal().

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

Definition at line 342 of file marshal.cpp.

References SDict< T >::count(), marshalObjPointer(), marshalQCString(), marshalUInt(), and NULL_LIST.

Referenced by MemberDef::flushToDisk().

void marshalMemberSDict ( StorageIntf s,
MemberSDict memberSDict 
)

Definition at line 208 of file marshal.cpp.

References SDict< T >::count(), marshalObjPointer(), marshalQCString(), marshalUInt(), and NULL_LIST.

Referenced by Definition::flushToDisk().

void marshalObjPointer ( StorageIntf s,
void *  obj 
)

Definition at line 183 of file marshal.cpp.

References StorageIntf::write().

Referenced by Definition::flushToDisk(), MemberDef::flushToDisk(), MemberGroup::marshal(), marshalBodyInfo(), marshalGroupList(), marshalMemberList(), marshalMemberLists(), marshalMemberSDict(), and marshalSectionDict().

void marshalQCString ( StorageIntf s,
const QCString &  str 
)

Definition at line 41 of file marshal.cpp.

References marshalUInt(), and StorageIntf::write().

Referenced by Definition::flushToDisk(), MemberDef::flushToDisk(), MemberGroup::marshal(), marshalArgumentList(), marshalBaseInfoList(), marshalBriefInfo(), marshalDocInfo(), marshalEntry(), marshalExampleSDict(), marshalGroupingList(), marshalItemInfoList(), marshalMemberLists(), marshalMemberSDict(), marshalSectionDict(), and marshalSectionInfoList().

void marshalQGString ( StorageIntf s,
const QGString &  str 
)

Definition at line 48 of file marshal.cpp.

References marshalUInt(), and StorageIntf::write().

Referenced by marshalEntry().

void marshalSectionDict ( StorageIntf s,
SectionDict sections 
)

Definition at line 189 of file marshal.cpp.

References marshalObjPointer(), marshalQCString(), marshalUInt(), and NULL_LIST.

Referenced by Definition::flushToDisk().

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

Definition at line 142 of file marshal.cpp.

References SectionInfo::fileName, SectionInfo::label, marshalInt(), marshalQCString(), marshalUInt(), NULL_LIST, SectionInfo::ref, SectionInfo::title, and SectionInfo::type.

Referenced by marshalEntry().

void marshalUInt ( StorageIntf s,
uint  v 
)

Definition at line 25 of file marshal.cpp.

References StorageIntf::write().

Referenced by Definition::flushToDisk(), MemberDef::flushToDisk(), MemberList::marshal(), marshalArgumentList(), marshalArgumentLists(), marshalBaseInfoList(), marshalBodyInfo(), marshalBriefInfo(), marshalDocInfo(), marshalEntry(), marshalEntryTree(), marshalExampleSDict(), marshalGroupingList(), marshalGroupList(), marshalItemInfoList(), marshalMemberList(), marshalMemberLists(), marshalMemberSDict(), marshalQCString(), marshalQGString(), marshalSectionDict(), and marshalSectionInfoList().

ArgumentList* unmarshalArgumentList ( StorageIntf s  ) 

Definition at line 487 of file marshal.cpp.

References ArgumentList::constSpecifier, NULL_LIST, ArgumentList::pureSpecifier, unmarshalBool(), unmarshalQCString(), unmarshalUInt(), and ArgumentList::volatileSpecifier.

Referenced by MemberDef::loadFromDisk(), unmarshalArgumentLists(), and unmarshalEntry().

QList<ArgumentList>* unmarshalArgumentLists ( StorageIntf s  ) 

Definition at line 513 of file marshal.cpp.

References NULL_LIST, unmarshalArgumentList(), and unmarshalUInt().

Referenced by MemberDef::loadFromDisk(), and unmarshalEntry().

QList<BaseInfo>* unmarshalBaseInfoList ( StorageIntf s  ) 

Definition at line 529 of file marshal.cpp.

References NULL_LIST, QCString, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by unmarshalEntry().

BodyInfo* unmarshalBodyInfo ( StorageIntf s  ) 

Definition at line 676 of file marshal.cpp.

References BodyInfo::endLine, BodyInfo::fileDef, NULL_LIST, BodyInfo::startLine, unmarshalInt(), unmarshalObjPointer(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

bool unmarshalBool ( StorageIntf s  ) 

Definition at line 451 of file marshal.cpp.

References StorageIntf::read().

Referenced by Definition::loadFromDisk(), MemberDef::loadFromDisk(), MemberGroup::unmarshal(), MemberList::unmarshal(), unmarshalArgumentList(), and unmarshalEntry().

BriefInfo* unmarshalBriefInfo ( StorageIntf s  ) 

Definition at line 664 of file marshal.cpp.

References BriefInfo::doc, BriefInfo::file, BriefInfo::line, NULL_LIST, BriefInfo::tooltip, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

DocInfo* unmarshalDocInfo ( StorageIntf s  ) 

Definition at line 653 of file marshal.cpp.

References DocInfo::doc, DocInfo::file, DocInfo::line, NULL_LIST, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

Entry* unmarshalEntry ( StorageIntf s  ) 

Definition at line 753 of file marshal.cpp.

References Entry::anchors, Entry::argList, Entry::args, Entry::artificial, Entry::bitfields, Entry::bodyLine, Entry::brief, Entry::briefFile, Entry::briefLine, Entry::callerGraph, Entry::callGraph, Entry::doc, Entry::docFile, Entry::docLine, Entry::endBodyLine, Entry::exception, Entry::explicitExternal, Entry::extends, Entry::fileName, Entry::groupDocType, Entry::groups, HEADER, Entry::hidden, Entry::inbodyDocs, Entry::inbodyFile, Entry::inbodyLine, Entry::includeFile, Entry::includeName, Entry::initializer, Entry::initLines, Entry::inside, Entry::mGrpId, Entry::mtype, Entry::name, Entry::objc, Entry::program, Entry::protection, Entry::proto, Entry::read, Entry::relates, Entry::relatesDup, Entry::section, Entry::sli, Entry::spec, Entry::startLine, Entry::stat, Entry::subGrouping, Entry::tArgLists, Entry::type, Entry::typeConstr, unmarshalArgumentList(), unmarshalArgumentLists(), unmarshalBaseInfoList(), unmarshalBool(), unmarshalGroupingList(), unmarshalInt(), unmarshalItemInfoList(), unmarshalQCString(), unmarshalQGString(), unmarshalSectionInfoList(), unmarshalUInt(), Entry::virt, and Entry::write.

Referenced by EntryNav::loadEntry(), and unmarshalEntryTree().

Entry* unmarshalEntryTree ( StorageIntf s  ) 

Definition at line 816 of file marshal.cpp.

References Entry::addSubEntry(), unmarshalEntry(), unmarshalEntryTree(), and unmarshalUInt().

Referenced by unmarshalEntryTree().

ExampleSDict* unmarshalExampleSDict ( StorageIntf s  ) 

Definition at line 718 of file marshal.cpp.

References Example::anchor, Example::file, SDict< T >::inSort(), Example::name, NULL_LIST, QCString, unmarshalQCString(), and unmarshalUInt().

Referenced by MemberDef::loadFromDisk().

QList<Grouping>* unmarshalGroupingList ( StorageIntf s  ) 

Definition at line 547 of file marshal.cpp.

References NULL_LIST, QCString, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by unmarshalEntry().

GroupList* unmarshalGroupList ( StorageIntf s  ) 

Definition at line 687 of file marshal.cpp.

References NULL_LIST, unmarshalObjPointer(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

int unmarshalInt ( StorageIntf s  ) 

Definition at line 433 of file marshal.cpp.

References StorageIntf::read().

Referenced by Definition::loadFromDisk(), MemberDef::loadFromDisk(), MemberGroup::unmarshal(), MemberList::unmarshal(), unmarshalBaseInfoList(), unmarshalBodyInfo(), unmarshalBriefInfo(), unmarshalDocInfo(), unmarshalEntry(), unmarshalGroupingList(), unmarshalItemInfoList(), and unmarshalSectionInfoList().

QList<ListItemInfo>* unmarshalItemInfoList ( StorageIntf s  ) 

Definition at line 584 of file marshal.cpp.

References NULL_LIST, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by Definition::loadFromDisk(), and unmarshalEntry().

MemberList* unmarshalMemberList ( StorageIntf s  ) 

Definition at line 702 of file marshal.cpp.

References MemberList::append(), NULL_LIST, MemberList::unmarshal(), unmarshalObjPointer(), and unmarshalUInt().

Referenced by MemberDef::loadFromDisk(), and MemberGroup::unmarshal().

SDict<MemberList>* unmarshalMemberLists ( StorageIntf s  ) 

Definition at line 737 of file marshal.cpp.

References SDict< T >::append(), NULL_LIST, QCString, unmarshalObjPointer(), unmarshalQCString(), and unmarshalUInt().

Referenced by MemberDef::loadFromDisk().

MemberSDict* unmarshalMemberSDict ( StorageIntf s  ) 

Definition at line 627 of file marshal.cpp.

References SDict< T >::inSort(), NULL_LIST, QCString, unmarshalObjPointer(), unmarshalQCString(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

void* unmarshalObjPointer ( StorageIntf s  ) 

Definition at line 602 of file marshal.cpp.

References StorageIntf::read().

Referenced by Definition::loadFromDisk(), MemberDef::loadFromDisk(), MemberGroup::unmarshal(), unmarshalBodyInfo(), unmarshalGroupList(), unmarshalMemberList(), unmarshalMemberLists(), unmarshalMemberSDict(), and unmarshalSectionDict().

QCString unmarshalQCString ( StorageIntf s  ) 

Definition at line 459 of file marshal.cpp.

References QCString, StorageIntf::read(), and unmarshalUInt().

Referenced by Definition::loadFromDisk(), MemberDef::loadFromDisk(), MemberGroup::unmarshal(), unmarshalArgumentList(), unmarshalBaseInfoList(), unmarshalBriefInfo(), unmarshalDocInfo(), unmarshalEntry(), unmarshalExampleSDict(), unmarshalGroupingList(), unmarshalItemInfoList(), unmarshalMemberLists(), unmarshalMemberSDict(), unmarshalSectionDict(), and unmarshalSectionInfoList().

QGString unmarshalQGString ( StorageIntf s  ) 

Definition at line 473 of file marshal.cpp.

References StorageIntf::read(), and unmarshalUInt().

Referenced by unmarshalEntry().

SectionDict* unmarshalSectionDict ( StorageIntf s  ) 

Definition at line 609 of file marshal.cpp.

References NULL_LIST, QCString, unmarshalObjPointer(), unmarshalQCString(), and unmarshalUInt().

Referenced by Definition::loadFromDisk().

QList<SectionInfo>* unmarshalSectionInfoList ( StorageIntf s  ) 

Definition at line 564 of file marshal.cpp.

References NULL_LIST, QCString, unmarshalInt(), unmarshalQCString(), and unmarshalUInt().

Referenced by unmarshalEntry().

uint unmarshalUInt ( StorageIntf s  ) 

Definition at line 442 of file marshal.cpp.

References StorageIntf::read().

Referenced by Definition::loadFromDisk(), MemberDef::loadFromDisk(), MemberList::unmarshal(), unmarshalArgumentList(), unmarshalArgumentLists(), unmarshalBaseInfoList(), unmarshalBodyInfo(), unmarshalBriefInfo(), unmarshalDocInfo(), unmarshalEntry(), unmarshalEntryTree(), unmarshalExampleSDict(), unmarshalGroupingList(), unmarshalGroupList(), unmarshalItemInfoList(), unmarshalMemberList(), unmarshalMemberLists(), unmarshalMemberSDict(), unmarshalQCString(), unmarshalQGString(), unmarshalSectionDict(), and unmarshalSectionInfoList().



Generated on Mon Mar 31 10:58:53 2008 by  doxygen 1.5.1