src/r_task.h

   1 ///
   2 /// \file       r_task.h
   3 ///             Record parsing class for the task 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_TASK_H__
  24 #define __BARRY_RECORD_TASK_H__
  25
  26 #include "dll.h"
  27 #include "record.h"
  28 #include "r_recur_base.h"
  29 #include <vector>
  30 #include <string>
  31 #include <stdint.h>
  32
  33 namespace Barry {
  34
  35 // forward declarations
  36 class IConverter;
  37
  38 class BXEXPORT Task : public RecurBase
  39 {
  40 public:
  41         typedef Barry::UnknownsType                     UnknownsType;
  42
  43         uint8_t RecType;
  44         uint32_t RecordId;
  45
  46         std::string Summary;
  47         std::string Notes;
  48         CategoryList Categories;
  49         std::string UID;
  50
  51         Barry::TimeT StartTime;
  52         Barry::TimeT DueTime;
  53         Barry::TimeT AlarmTime;
  54         uint16_t TimeZoneCode;
  55         bool TimeZoneValid;             // true if the record contained a
  56                                         // time zone code
  57
  58         enum AlarmFlagType
  59         {
  60                 Date = 1,
  61                 Relative
  62         };
  63         AlarmFlagType AlarmType;
  64
  65         enum PriorityFlagType
  66         {
  67                 High = 0,
  68                 Normal,
  69                 Low
  70         };
  71         PriorityFlagType PriorityFlag;
  72
  73         enum StatusFlagType
  74         {
  75                 NotStarted = 0,
  76                 InProgress,
  77                 Completed,
  78                 Waiting,
  79                 Deferred
  80         };
  81         StatusFlagType StatusFlag;
  82
  83         bool DueDateFlag;       // true if due date is set
  84
  85         // unknown
  86         UnknownsType Unknowns;
  87
  88 protected:
  89         static AlarmFlagType AlarmProto2Rec(uint8_t a);
  90         static uint8_t AlarmRec2Proto(AlarmFlagType a);
  91
  92         static PriorityFlagType PriorityProto2Rec(uint8_t p);
  93         static uint8_t PriorityRec2Proto(PriorityFlagType p);
  94
  95         static StatusFlagType StatusProto2Rec(uint8_t s);
  96         static uint8_t StatusRec2Proto(StatusFlagType s);
  97
  98 public:
  99         Task();
 100         ~Task();
 101
 102         // Parser / Builder API (see parser.h / builder.h)
 103         void Validate() const;
 104         const unsigned char* ParseField(const unsigned char *begin,
 105                 const unsigned char *end, const IConverter *ic = 0);
 106         uint8_t GetRecType() const { return RecType; }
 107         uint32_t GetUniqueId() const { return RecordId; }
 108         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 109         void ParseHeader(const Data &data, size_t &offset);
 110         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 111         void BuildHeader(Data &data, size_t &offset) const;
 112         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 113
 114         // operations (common among record classes)
 115         void Clear();
 116         void Dump(std::ostream &os) const;
 117         std::string GetDescription() const;
 118
 119         bool operator<(const Task &other) const;
 120
 121         // database name
 122         static const char * GetDBName() { return "Tasks"; }
 123         static uint8_t GetDefaultRecType() { return 2; }
 124
 125         // Generic Field Handle support
 126         static const FieldHandle<Task>::ListT& GetFieldHandles();
 127 };
 128
 129 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 130         msg.Dump(os);
 131         return os;
 132 }
 133
 134 } // namespace Barry
 135
 136 #endif
 137