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