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-2009, 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 std::vector<UnknownField>               UnknownsType;
  42
  43         uint8_t RecType;
  44         uint32_t RecordId;
  45
  46         uint8_t TaskType;
  47         std::string Summary;
  48         std::string Notes;
  49         std::string Categories;
  50         std::string UID;
  51
  52         time_t StartTime;
  53         time_t DueTime;
  54         time_t AlarmTime;
  55         int TimeZoneCode;
  56
  57         enum AlarmFlagType
  58         {
  59                 Date = 1,
  60                 Relative
  61         };
  62         AlarmFlagType AlarmType;
  63
  64         enum PriorityFlagType
  65         {
  66                 High = 0,
  67                 Normal,
  68                 Low
  69         };
  70         PriorityFlagType PriorityFlag;
  71
  72         enum StatusFlagType
  73         {
  74                 NotStarted = 0,
  75                 InProgress,
  76                 Completed,
  77                 Waiting,
  78                 Deferred
  79         };
  80         StatusFlagType StatusFlag;
  81
  82         bool DueDateFlag;       // true if due date is set
  83
  84         // unknown
  85         UnknownsType Unknowns;
  86
  87 protected:
  88         static AlarmFlagType AlarmProto2Rec(uint8_t a);
  89         static uint8_t AlarmRec2Proto(AlarmFlagType a);
  90
  91         static PriorityFlagType PriorityProto2Rec(uint8_t p);
  92         static uint8_t PriorityRec2Proto(PriorityFlagType p);
  93
  94         static StatusFlagType StatusProto2Rec(uint8_t s);
  95         static uint8_t StatusRec2Proto(StatusFlagType s);
  96
  97 public:
  98         Task();
  99         ~Task();
 100
 101         const unsigned char* ParseField(const unsigned char *begin,
 102                 const unsigned char *end, const IConverter *ic = 0);
 103         uint8_t GetRecType() const { return RecType; }
 104         uint32_t GetUniqueId() const { return RecordId; }
 105         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 106         void ParseHeader(const Data &data, size_t &offset);
 107         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 108         void BuildHeader(Data &data, size_t &offset) const;
 109
 110         void Clear();
 111
 112         void Dump(std::ostream &os) const;
 113         bool operator<(const Task &other) const { return Summary < other.Summary; }
 114
 115         // database name
 116         static const char * GetDBName() { return "Tasks"; }
 117         static uint8_t GetDefaultRecType() { return 2; }
 118
 119 };
 120
 121 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 122         msg.Dump(os);
 123         return os;
 124 }
 125
 126 } // namespace Barry
 127
 128 #endif
 129