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-2013, 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 //
  39 // Task record class
  40 //
  41 /// Task record class.  Note that there is a bug in many device firmwares.
  42 ///
  43 /// If you extract a Tasks record, and then write it back via
  44 /// SetRecordByIndex(), on many devices that I tested, it ends up
  45 /// corrupting the record on the device, and the GUI on the device
  46 /// appears messed up.  (It shows the first few fields twice)
  47 /// Such a corrupt record also loses the due date.
  48 ///
  49 /// The workaround, when working with the Tasks database, is to
  50 /// first DeleteByIndex() and then AddRecord() via the Desktop mode class,
  51 /// using the same record ID.  This works, but is unfortunately
  52 /// cumbersome.
  53 ///
  54 /// See the Desktop GUI and the opensync plugins for examples of this
  55 /// workaround.
  56 ///
  57 /// Ideally, we should test a Tasks sync on Windows, and see how
  58 /// the Windows software handles this.  There may be some protocol
  59 /// changes that will be needed in future Barry versions.
  60 ///
  61 class BXEXPORT Task : public RecurBase
  62 {
  63 public:
  64         typedef Barry::UnknownsType                     UnknownsType;
  65
  66         uint8_t RecType;
  67         uint32_t RecordId;
  68
  69         std::string Summary;
  70         std::string Notes;
  71         CategoryList Categories;
  72         std::string UID;
  73
  74         Barry::TimeT StartTime;         // most devices set this the same as
  75                                         // DueTime... this is a read-only
  76                                         // variable.  By setting DueTime,
  77                                         // the library will write StartTime
  78                                         // for you automatically
  79         Barry::TimeT DueTime;
  80         Barry::TimeT AlarmTime;
  81         uint16_t TimeZoneCode;
  82         bool TimeZoneValid;             // true if the record contained a
  83                                         // time zone code
  84
  85         enum AlarmFlagType
  86         {
  87                 Date = 1,
  88                 Relative
  89         };
  90         AlarmFlagType AlarmType;
  91
  92         enum PriorityFlagType
  93         {
  94                 High = 0,
  95                 Normal,
  96                 Low
  97         };
  98         PriorityFlagType PriorityFlag;
  99
 100         enum StatusFlagType
 101         {
 102                 NotStarted = 0,
 103                 InProgress,
 104                 Completed,
 105                 Waiting,
 106                 Deferred
 107         };
 108         StatusFlagType StatusFlag;
 109
 110         // unknown
 111         UnknownsType Unknowns;
 112
 113 protected:
 114         static AlarmFlagType AlarmProto2Rec(uint8_t a);
 115         static uint8_t AlarmRec2Proto(AlarmFlagType a);
 116
 117         static PriorityFlagType PriorityProto2Rec(uint8_t p);
 118         static uint8_t PriorityRec2Proto(PriorityFlagType p);
 119
 120         static StatusFlagType StatusProto2Rec(uint8_t s);
 121         static uint8_t StatusRec2Proto(StatusFlagType s);
 122
 123 public:
 124         Task();
 125         ~Task();
 126
 127         // Parser / Builder API (see parser.h / builder.h)
 128         void Validate() const;
 129         const unsigned char* ParseField(const unsigned char *begin,
 130                 const unsigned char *end, const IConverter *ic = 0);
 131         uint8_t GetRecType() const { return RecType; }
 132         uint32_t GetUniqueId() const { return RecordId; }
 133         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 134         void ParseHeader(const Data &data, size_t &offset);
 135         void ParseFields(const Data &data, size_t &offset, const IConverter *ic = 0);
 136         void BuildHeader(Data &data, size_t &offset) const;
 137         void BuildFields(Data &data, size_t &offset, const IConverter *ic = 0) const;
 138
 139         // operations (common among record classes)
 140         void Clear();
 141         void Dump(std::ostream &os) const;
 142         std::string GetDescription() const;
 143
 144         bool operator<(const Task &other) const;
 145
 146         // database name
 147         static const char * GetDBName() { return "Tasks"; }
 148         static uint8_t GetDefaultRecType() { return 2; }
 149
 150         // Generic Field Handle support
 151         static const FieldHandle<Task>::ListT& GetFieldHandles();
 152 };
 153
 154 BXEXPORT inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 155         msg.Dump(os);
 156         return os;
 157 }
 158
 159 } // namespace Barry
 160
 161 #endif
 162