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-2007, 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 "record.h"
  27 #include <vector>
  28 #include <string>
  29 #include <stdint.h>
  30
  31 namespace Barry {
  32
  33 class Task
  34 {
  35 public:
  36         typedef std::vector<UnknownField>                       UnknownsType;
  37         uint8_t RecType;
  38         uint32_t RecordId;
  39
  40         uint8_t TaskType;
  41         std::string Summary;
  42         std::string Notes;
  43         std::string Categories;
  44         std::string UID;
  45
  46         time_t StartTime;
  47         time_t DueTime;
  48         time_t AlarmTime;
  49         int TimeZoneCode;
  50
  51         enum AlarmFlagType
  52         {
  53                 Date = 1,
  54                 Relative
  55         };
  56         AlarmFlagType AlarmType;
  57
  58         unsigned short Interval;
  59         enum RecurringCodeType {
  60                 Day = 1,                //< eg. every day
  61                                         //< set: nothing
  62                 MonthByDate = 3,        //< eg. every month on the 12th
  63                                         //< set: DayOfMonth
  64                 MonthByDay = 4,         //< eg. every month on 3rd Wed
  65                                         //< set: DayOfWeek and WeekOfMonth
  66                 YearByDate = 5,         //< eg. every year on March 5
  67                                         //< set: DayOfMonth and MonthOfYear
  68                 YearByDay = 6,          //< eg. every year on 3rd Wed of Jan
  69                                         //< set: DayOfWeek, WeekOfMonth, and
  70                                         //<      MonthOfYear
  71                 Week = 12               //< eg. every week on Mon and Fri
  72                                         //< set: WeekDays
  73         };
  74         RecurringCodeType RecurringType;
  75         time_t RecurringEndTime;
  76         unsigned short                  // recurring details, depending on type
  77                 DayOfWeek,              // 0-6
  78                 WeekOfMonth,            // 1-5
  79                 DayOfMonth,             // 1-31
  80                 MonthOfYear;            // 1-12
  81         unsigned char WeekDays;         // bitmask, bit 0 = sunday
  82
  83         int ClassType;
  84         enum PriorityFlagType
  85         {
  86                 High = 0,
  87                 Normal,
  88                 Low
  89         };
  90         PriorityFlagType PriorityFlag;
  91
  92         enum StatusFlagType
  93         {
  94                 NotStarted = 0,
  95                 InProgress,
  96                 Completed,
  97                 Waiting,
  98                 Deferred
  99         };
 100         StatusFlagType StatusFlag;
 101
 102         bool Recurring;
 103         bool Perpetual;
 104         bool DueDateFlag;       // true if due date is set
 105
 106         UnknownsType Unknowns;
 107
 108 public:
 109         Task();
 110         ~Task();
 111
 112         const unsigned char* ParseField(const unsigned char *begin,
 113                 const unsigned char *end);
 114         void ParseRecurrenceData(const void *data);
 115         void BuildRecurrenceData(void *data);
 116         uint8_t GetRecType() const { return RecType; }
 117         uint32_t GetUniqueId() const { return RecordId; }
 118         void SetIds(uint8_t Type, uint32_t Id) { RecType = Type; RecordId = Id; }
 119         void ParseHeader(const Data &data, size_t &offset);
 120         void ParseFields(const Data &data, size_t &offset);
 121         void BuildHeader(Data &data, size_t &offset) const;
 122
 123         void Clear();
 124
 125         void Dump(std::ostream &os) const;
 126         bool operator<(const Task &other) const { return Summary < other.Summary; }
 127
 128         // database name
 129         static const char * GetDBName() { return "Tasks"; }
 130         static uint8_t GetDefaultRecType() { return 2; }
 131
 132 };
 133
 134 inline std::ostream& operator<<(std::ostream &os, const Task &msg) {
 135         msg.Dump(os);
 136         return os;
 137 }
 138
 139 } // namespace Barry
 140
 141 #endif
 142