src/r_memo.h

   1 ///
   2 /// \file       r_memo.h
   3 ///             Record parsing class for the memo 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_MEMO_H__
  24 #define __BARRY_RECORD_MEMO_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 Memo
  38 {
  39 public:
  40         typedef Barry::UnknownsType                     UnknownsType;
  41
  42         uint8_t RecType;
  43         uint32_t RecordId;
  44
  45         std::string Title;
  46         std::string Body;
  47         CategoryList Categories;
  48
  49         UnknownsType Unknowns;
  50
  51 public:
  52         const unsigned char* ParseField(const unsigned char *begin,
  53                 const unsigned char *end, const IConverter *ic = 0);
  54
  55 public:
  56         Memo();
  57         ~Memo();
  58
  59         // Parser / Builder API (see parser.h / builder.h)
  60         void Validate() const;
  61         uint8_t GetRecType() const { return RecType; }
  62         uint32_t GetUniqueId() const { return RecordId; }
  63         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  64         void ParseHeader(const Data &data, size_t &offset);
  65         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
  66         void BuildHeader(Data &data, size_t &offset) const;
  67         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
  68
  69         // operations (common among record classes)
  70         void Clear();
  71         void Dump(std::ostream &os) const;
  72         std::string GetDescription() const;
  73
  74         bool operator<(const Memo &other) const;
  75
  76         // database name
  77         static const char * GetDBName() { return "Memos"; }
  78         static uint8_t GetDefaultRecType() { return 0; }    // or 0?
  79
  80         // Generic Field Handle support
  81         static const FieldHandle<Memo>::ListT& GetFieldHandles();
  82 };
  83
  84 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Memo &msg) {
  85         msg.Dump(os);
  86         return os;
  87 }
  88
  89 } // namespace Barry
  90
  91 #endif
  92