src/r_folder.h

   1 ///
   2 /// \file       r_folder.h
   3 ///             Record parsing class for the Folder database.
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
   8     Copyright (C) 2007, Brian Edginton
   9
  10     This program is free software; you can redistribute it and/or modify
  11     it under the terms of the GNU General Public License as published by
  12     the Free Software Foundation; either version 2 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18
  19     See the GNU General Public License in the COPYING file at the
  20     root directory of this project for more details.
  21 */
  22
  23 #ifndef __BARRY_RECORD_FOLDER_H__
  24 #define __BARRY_RECORD_FOLDER_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include <vector>
  29 #include <string>
  30 #include <stdint.h>
  31
  32 namespace Barry {
  33
  34 // forward declarations
  35 class IConverter;
  36
  37 class BXEXPORT Folder
  38 {
  39 public:
  40         typedef std::vector<UnknownField>                       UnknownsType;
  41         uint8_t RecType;
  42         uint32_t RecordId;
  43
  44         std::string FolderName;
  45         uint16_t        FolderNumber;   // Not unique, used for ordering of subfolders - NOT level
  46         uint16_t        FolderLevel;    // From parent
  47
  48         enum FolderTypeEnum {
  49                 FolderSubtree = 0,
  50                 FolderDeleted,
  51                 FolderInbox,
  52                 FolderOutbox,
  53                 FolderSent,
  54                 FolderOther,
  55                 FolderDraft = 0x0a
  56         };
  57         FolderTypeEnum FolderType;
  58
  59         enum FolderStatusType {
  60                 FolderOrphan = 0x50,
  61                 FolderUnfiled,
  62                 FolderFiled
  63         };
  64
  65         UnknownsType Unknowns;
  66
  67 public:
  68         Folder();
  69         ~Folder();
  70
  71         const unsigned char* ParseField(const unsigned char *begin,
  72                 const unsigned char *end, const IConverter *ic = 0);
  73         uint8_t GetRecType() const { return RecType; }
  74         uint32_t GetUniqueId() const { return RecordId; }
  75         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  76         void ParseHeader(const Data &data, size_t &offset);
  77         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
  78         void BuildHeader(Data &data, size_t &offset) const;
  79
  80         void Clear();
  81
  82         void Dump(std::ostream &os) const;
  83         bool operator<(const Folder &other) const { return FolderName < other.FolderName; }
  84
  85         // database name
  86         static const char * GetDBName() { return "Folders"; }
  87         static uint8_t GetDefaultRecType() { return 0; }
  88
  89 };
  90
  91 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Folder &msg) {
  92         msg.Dump(os);
  93         return os;
  94 }
  95
  96 } // namespace Barry
  97
  98 #endif  // __BARRY_RECORD_FOLDER_H__
  99
 100