# r_folder.h

Go to the documentation of this file.

    00001 ///
    00002 /// \file       r_folder.h
    00003 ///             Record parsing class for the Folder database.
    00004 ///
    00005
    00006 /*
    00007     Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)
    00008     Copyright (C) 2007, Brian Edginton
    00009
    00010     This program is free software; you can redistribute it and/or modify
    00011     it under the terms of the GNU General Public License as published by
    00012     the Free Software Foundation; either version 2 of the License, or
    00013     (at your option) any later version.
    00014
    00015     This program is distributed in the hope that it will be useful,
    00016     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00017     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    00018
    00019     See the GNU General Public License in the COPYING file at the
    00020     root directory of this project for more details.
    00021 */
    00022
    00023 #ifndef __BARRY_RECORD_FOLDER_H__
    00024 #define __BARRY_RECORD_FOLDER_H__
    00025
    00026 #include "dll.h"
    00027 #include "record.h"
    00028 #include <vector>
    00029 #include <string>
    00030 #include <stdint.h>
    00031
    00032 namespace Barry {
    00033
    00034 // forward declarations
    00035 class IConverter;
    00036
    00037 class BXEXPORT Folder
    00038 {
    00039 public:
    00040         typedef Barry::UnknownsType                     UnknownsType;
    00041
    00042         uint8_t RecType;
    00043         uint32_t RecordId;
    00044
    00045         std::string Name;
    00046         uint16_t Number;        // Not unique, used for ordering of subfolders - NOT level
    00047         uint16_t Level; // From parent
    00048
    00049         enum FolderType {
    00050                 FolderSubtree = 0,
    00051                 FolderDeleted,
    00052                 FolderInbox,
    00053                 FolderOutbox,
    00054                 FolderSent,
    00055                 FolderOther,
    00056                 FolderDraft = 0x0a
    00057         };
    00058         FolderType Type;
    00059
    00060         enum FolderStatusType {
    00061                 FolderOrphan = 0x50,
    00062                 FolderUnfiled,
    00063                 FolderFiled
    00064         };
    00065
    00066         UnknownsType Unknowns;
    00067
    00068 protected:
    00069         static FolderType TypeProto2Rec(uint8_t t);
    00070         static uint8_t TypeRec2Proto(FolderType t);
    00071
    00072 public:
    00073         Folder();
    00074         ~Folder();
    00075
    00076         const unsigned char* ParseField(const unsigned char *begin,
    00077                 const unsigned char *end, const IConverter *ic = 0);
    00078         uint8_t GetRecType() const { return RecType; }
    00079         uint32_t GetUniqueId() const { return RecordId; }
    00080         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
    00081         void ParseHeader(const Data &data, size_t &offset);
    00082         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
    00083         void BuildHeader(Data &data, size_t &offset) const;
    00084         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
    00085
    00086         // operations (common among record classes)
    00087         void Clear();
    00088         void Dump(std::ostream &os) const;
    00089         std::string GetDescription() const;
    00090
    00091         bool operator<(const Folder &other) const { return Name < other.Name; }
    00092
    00093         // database name
    00094         static const char * GetDBName() { return "Folders"; }
    00095         static uint8_t GetDefaultRecType() { return 0; }
    00096
    00097 };
    00098
    00099 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Folder &msg) {
    00100         msg.Dump(os);
    00101         return os;
    00102 }
    00103
    00104 } // namespace Barry
    00105
    00106 #endif  // __BARRY_RECORD_FOLDER_H__
    00107
    00108