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;         // most devices set this the same as
  52                                         // DueTime
  53         Barry::TimeT DueTime;
  54         Barry::TimeT AlarmTime;
  55         uint16_t TimeZoneCode;
  56         bool TimeZoneValid;             // true if the record contained a
  57                                         // time zone code
  58
  59         enum AlarmFlagType
  60         {
  61                 Date = 1,
  62                 Relative
  63         };
  64         AlarmFlagType AlarmType;
  65
  66         enum PriorityFlagType
  67         {
  68                 High = 0,
  69                 Normal,
  70                 Low
  71         };
  72         PriorityFlagType PriorityFlag;
  73
  74         enum StatusFlagType
  75         {
  76                 NotStarted = 0,
  77                 InProgress,
  78                 Completed,
  79                 Waiting,
  80                 Deferred
  81         };
  82         StatusFlagType StatusFlag;
  83
  84         bool DueDateFlag;       // true if due date is set
  85         bool AlarmFlag;         // true if alarm/reminder is set
  86
  87         // unknown
  88         UnknownsType Unknowns;
  89
  90 protected:
  91         static AlarmFlagType AlarmProto2Rec(uint8_t a);
  92         static uint8_t AlarmRec2Proto(AlarmFlagType a);
  93
  94         static PriorityFlagType PriorityProto2Rec(uint8_t p);
  95         static uint8_t PriorityRec2Proto(PriorityFlagType p);
  96
  97         static StatusFlagType StatusProto2Rec(uint8_t s);
  98         static uint8_t StatusRec2Proto(StatusFlagType s);
  99
 100 public:
 101         Task();
 102         ~Task();
 103
 104         // Parser / Builder API (see parser.h / builder.h)
 105         void Validate() const;
 106         const unsigned char* ParseField(const unsigned char *begin,
 107                 const unsigned char *end, const IConverter *ic = 0);
 108         uint8_t GetRecType() const { return RecType; }
 109         uint32_t GetUniqueId() const { return RecordId; }
 110         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 111         void ParseHeader(const Data &data, size_t &offset);
 112         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 113         void BuildHeader(Data &data, size_t &offset) const;
 114         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 115
 116         // operations (common among record classes)
 117         void Clear();
 118         void Dump(std::ostream &os) const;
 119         std::string GetDescription() const;
 120
 121         bool operator<(const Task &other) const;
 122
 123         // database name
 124         static const char * GetDBName() { return "Tasks"; }
 125         static uint8_t GetDefaultRecType() { return 2; }
 126
 127         // Generic Field Handle support
 128         static const FieldHandle<Task>::ListT& GetFieldHandles();
 129 };
 130
 131 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 132         msg.Dump(os);
 133         return os;
 134 }
 135
 136 } // namespace Barry
 137
 138 #endif
 139