Documentation updates: git, tarball, bugs, contact
[barry/pauldeden.git] / opensync-plugin / src / vevent.h
blob35f72ad436c1b86f58dfeceab0ac2298bcddb008
1 //
2 // \file vevent.h
3 // Conversion routines for vevents (VCALENDAR, etc)
4 //
6 /*
7 Copyright (C) 2006-2008, Net Direct Inc. (http://www.netdirect.ca/)
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
22 #ifndef __BARRY_SYNC_VEVENT_H__
23 #define __BARRY_SYNC_VEVENT_H__
25 #include <barry/barry.h>
26 #include <stdint.h>
27 #include <string>
28 #include "vbase.h"
29 #include "vformat.h"
31 // forward declarations
32 class BarryEnvironment;
35 // vCalendar
37 /// Class for converting between RFC 2445 iCalendar data format,
38 /// and the Barry::Calendar class.
39 ///
40 class vCalendar : public vBase
42 // data to pass to external requests
43 char *m_gCalData; // dynamic memory returned by vformat()... can
44 // be used directly by the plugin, without
45 // overmuch allocation and freeing (see Extract())
46 std::string m_vCalData; // copy of m_gCalData, for C++ use
47 Barry::Calendar m_BarryCal;
49 static const char *WeekDays[7];
51 protected:
52 void RecurToVCal();
53 void RecurToBarryCal();
55 static unsigned short GetWeekDayIndex(const char *dayname);
56 bool HasMultipleVEvents() const;
58 public:
59 vCalendar();
60 ~vCalendar();
62 const std::string& ToVCal(const Barry::Calendar &cal);
63 const Barry::Calendar& ToBarry(const char *vcal, uint32_t RecordId);
65 const std::string& GetVCal() const { return m_vCalData; }
66 const Barry::Calendar& GetBarryCal() const { return m_BarryCal; }
68 char* ExtractVCal();
70 void Clear();
74 class VEventConverter
76 char *m_Data;
77 Barry::Calendar m_Cal;
78 uint32_t m_RecordId;
80 public:
81 VEventConverter();
82 explicit VEventConverter(uint32_t newRecordId);
83 ~VEventConverter();
85 // Transfers ownership of m_Data to the caller
86 char* ExtractData();
88 // Parses vevent data
89 bool ParseData(const char *data);
91 // Barry storage operator
92 void operator()(const Barry::Calendar &rec);
94 // Barry builder operator
95 bool operator()(Barry::Calendar &rec, unsigned int dbId);
97 // Handles calling of the Barry::Controller to fetch a specific
98 // record, indicated by index (into the RecordStateTable).
99 // Returns a g_malloc'd string of data containing the vevent20
100 // data. It is the responsibility of the caller to free it.
101 // This is intended to be passed into the GetChanges() function.
102 static char* GetRecordData(BarryEnvironment *env, unsigned int dbId,
103 Barry::RecordStateTable::IndexType index);
105 // Handles either adding or overwriting a calendar record,
106 // given vevent20 data in data, and the proper environmebnt,
107 // dbId, StateIndex. Set add to true if adding.
108 static bool CommitRecordData(BarryEnvironment *env, unsigned int dbId,
109 Barry::RecordStateTable::IndexType StateIndex, uint32_t recordId,
110 const char *data, bool add, std::string &errmsg);
114 #endif