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-2008, 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 class BXEXPORT Folder
  35 {
  36 public:
  37         typedef std::vector<UnknownField>                       UnknownsType;
  38         uint8_t RecType;
  39         uint32_t RecordId;
  40
  41         std::string FolderName;
  42         uint16_t        FolderNumber;   // Not unique, used for ordering of subfolders - NOT level
  43         uint16_t        FolderLevel;    // From parent
  44
  45         enum FolderTypeEnum {
  46                 FolderSubtree = 0,
  47                 FolderDeleted,
  48                 FolderInbox,
  49                 FolderOutbox,
  50                 FolderSent,
  51                 FolderOther,
  52                 FolderDraft = 0x0a
  53         };
  54         FolderTypeEnum FolderType;
  55
  56         enum FolderStatusType {
  57                 FolderOrphan = 0x50,
  58                 FolderUnfiled,
  59                 FolderFiled
  60         };
  61
  62         UnknownsType Unknowns;
  63
  64 public:
  65         Folder();
  66         ~Folder();
  67
  68         const unsigned char* ParseField(const unsigned char *begin,
  69                 const unsigned char *end);
  70         uint8_t GetRecType() const { return RecType; }
  71         uint32_t GetUniqueId() const { return RecordId; }
  72         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  73         void ParseHeader(const Data &data, size_t &offset);
  74         void ParseFields(const Data &data, size_t &offset);
  75         void BuildHeader(Data &data, size_t &offset) const;
  76
  77         void Clear();
  78
  79         void Dump(std::ostream &os) const;
  80         bool operator<(const Folder &other) const { return FolderName < other.FolderName; }
  81
  82         // database name
  83         static const char * GetDBName() { return "Folders"; }
  84         static uint8_t GetDefaultRecType() { return 0; }
  85
  86 };
  87
  88 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Folder &msg) {
  89         msg.Dump(os);
  90         return os;
  91 }
  92
  93 } // namespace Barry
  94
  95 #endif  // __BARRY_RECORD_FOLDER_H__
  96
  97