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-2012, 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 Barry::UnknownsType                     UnknownsType;
  41
  42         uint8_t RecType;
  43         uint32_t RecordId;
  44
  45         std::string Name;
  46         uint16_t Number;        // Not unique, used for ordering of subfolders - NOT level
  47         uint16_t Level; // From parent
  48
  49         enum FolderType {
  50                 FolderSubtree = 0,
  51                 FolderDeleted,
  52                 FolderInbox,
  53                 FolderOutbox,
  54                 FolderSent,
  55                 FolderOther,
  56                 FolderDraft = 0x0a
  57         };
  58         FolderType Type;
  59
  60         enum FolderStatusType {
  61                 FolderOrphan = 0x50,
  62                 FolderUnfiled,
  63                 FolderFiled
  64         };
  65
  66         UnknownsType Unknowns;
  67
  68 protected:
  69         static FolderType TypeProto2Rec(uint8_t t);
  70         static uint8_t TypeRec2Proto(FolderType t);
  71
  72 public:
  73         Folder();
  74         ~Folder();
  75
  76         // Parser / Builder API (see parser.h / builder.h)
  77         void Validate() const;
  78         const unsigned char* ParseField(const unsigned char *begin,
  79                 const unsigned char *end, const IConverter *ic = 0);
  80         uint8_t GetRecType() const { return RecType; }
  81         uint32_t GetUniqueId() const { return RecordId; }
  82         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  83         void ParseHeader(const Data &data, size_t &offset);
  84         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
  85         void BuildHeader(Data &data, size_t &offset) const;
  86         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
  87
  88         // operations (common among record classes)
  89         void Clear();
  90         void Dump(std::ostream &os) const;
  91         std::string GetDescription() const;
  92
  93         bool operator<(const Folder &other) const { return Name < other.Name; }
  94
  95         // database name
  96         static const char * GetDBName() { return "Folders"; }
  97         static uint8_t GetDefaultRecType() { return 0; }
  98
  99         // Generic Field Handle support
 100         static const FieldHandle<Folder>::ListT& GetFieldHandles();
 101 };
 102
 103 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Folder &msg) {
 104         msg.Dump(os);
 105         return os;
 106 }
 107
 108 } // namespace Barry
 109
 110 #endif  // __BARRY_RECORD_FOLDER_H__
 111
 112