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-2007, 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 "record.h"
  27 #include <vector>
  28 #include <string>
  29 #include <stdint.h>
  30
  31 namespace Barry {
  32
  33 class Memo
  34 {
  35 public:
  36         typedef std::vector<UnknownField>       UnknownsType;
  37
  38         uint8_t RecType;
  39         uint32_t RecordId;
  40
  41         uint8_t MemoType;
  42         std::string Title;
  43         std::string Body;
  44         std::string Category;
  45
  46         UnknownsType Unknowns;
  47
  48 public:
  49         const unsigned char* ParseField(const unsigned char *begin,
  50                 const unsigned char *end);
  51
  52 public:
  53         Memo();
  54         ~Memo();
  55
  56         // Parser / Builder API (see parser.h / builder.h)
  57         uint8_t GetRecType() const { return RecType; }
  58         uint32_t GetUniqueId() const { return RecordId; }
  59         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
  60         void ParseHeader(const Data &data, size_t &offset);
  61         void ParseFields(const Data &data, size_t &offset);
  62         void BuildHeader(Data &data, size_t &offset) const;
  63
  64         void Clear();
  65
  66         void Dump(std::ostream &os) const;
  67
  68         bool operator<(const Memo &other) const { return Title < other.Title; }
  69         // database name
  70         static const char * GetDBName() { return "Memos"; }
  71         static uint8_t GetDefaultRecType() { return 0; }    // or 0?
  72 };
  73
  74 inline std::ostream& operator<<(std::ostream &os, const Memo &msg) {
  75         msg.Dump(os);
  76         return os;
  77 }
  78
  79 } // namespace Barry
  80
  81 #endif
  82