/usr/include/kolabxml/kolabformat.h is in libkolabxml-dev 1.0.1-0ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 | /*
* Copyright (C) 2011 Christian Mollekopf <mollekopf@kolabsys.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KOLABFORMAT_H
#define KOLABFORMAT_H
#include <string>
#include "kolabcontainers.h"
#include "kolabtodo.h"
#include "kolabevent.h"
#include "kolabjournal.h"
#include "kolabcontact.h"
#include "kolabnote.h"
#include "kolabconfiguration.h"
#include "kolabfreebusy.h"
#include "kolabfile.h"
#include "global_definitions.h"
/**
* Kolab Format v3 Implementation
*
* Note that this code is threadsafe, as it uses thread-local storage.
*
* Example:
*
* Kolab::Event event;
* event.setStart(Kolab::cDateTime("Europe/Zurich",2011,10,10,12,1,1));
* event.setEnd(Kolab::cDateTime("Europe/Zurich",2012,5,5,3,4,4));
* event.setLastModified(Kolab::cDateTime(2011,10,11,12,1,2,true));
* event.setCreated(Kolab::cDateTime(2011,10,11,12,1,3,true));
* std::string serialization = Kolab::writeEvent(ev, "Product ID");
* std::string serializedUID = Kolab::getSerializedUID(); //returns the UID of the just serialized event
* if (Kolab::error() != Kolab::NoError) {
* std::cout << "Error on write " << Kolab::errorMessage();
* }
* Kolab::Event e = Kolab::readEvent(serialization, false);
* if (Kolab::error() != Kolab::NoError) {
* std::cout << "Error on read " << Kolab::errorMessage();
* }
*
*/
namespace Kolab {
/**
* Check to see if serialization/deserialization was successful.
*
* Returns true if at least an Error occurred. Warning is not considered an error.
*/
bool errorOccurred();
/**
* Returns the highest severity of the errors which occured.
*
* Note that a Warning is not considered an error, use errorOccurred to check for errors.
*/
Kolab::ErrorSeverity error();
/**
* Returns the corresponding error message to the reported error.
*/
std::string errorMessage();
/**
* Returns productId string of the last deserialized object.
* Updated during deserialization of object.
*/
std::string productId();
/**
* Returns KolabFormat version of the last deserialized object.
* Updated during deserialization of object.
*/
std::string xKolabVersion();
/**
* Returns xCal version of the last deserialized xCal object.
* Updated during deserialization of object.
*/
std::string xCalVersion();
/**
* Returns the UID of the last serialized object.
* Updated during serialization of the object.
*/
std::string getSerializedUID();
/**
* Returns a generated uid.
*/
std::string generateUID();
/**
* Use this function to override the timestamp which is normally generated upon serialization from the system time.
* To override the timestamp call this function once. You will need to clear the timestamp manually by setting a default constructed cDateTime().
*
* The timestamp is used as lastModifiedDate on every write, and as creation-date on the first write (when there is no creation-date yet).
*
* The supplied timestamp must be in UTC format.
*
* This function exists primarily for testing purpose.
*/
void overrideTimestamp(const Kolab::cDateTime &dt);
/**
* Serializing functions for kolab objects.
*
* Check error() to see if the operation was successful.
*
* @param isUrl if true, the file with the url @param s is opened and read.
* @param productId Sets the productid on serialization. Note that the versionstring of libkolabxml will be appended to the productId.
*/
Kolab::Event readEvent(const std::string& s, bool isUrl);
std::string writeEvent(const Kolab::Event &, const std::string& productId = std::string());
Kolab::Todo readTodo(const std::string& s, bool isUrl);
std::string writeTodo(const Kolab::Todo &, const std::string& productId = std::string());
Kolab::Journal readJournal(const std::string& s, bool isUrl);
std::string writeJournal(const Kolab::Journal &, const std::string& productId = std::string());
Kolab::Freebusy readFreebusy(const std::string& s, bool isUrl);
std::string writeFreebusy(const Kolab::Freebusy &, const std::string& productId = std::string());
Kolab::Contact readContact(const std::string& s, bool isUrl);
std::string writeContact(const Kolab::Contact &, const std::string& productId = std::string());
Kolab::DistList readDistlist(const std::string& s, bool isUrl);
std::string writeDistlist(const Kolab::DistList &, const std::string& productId = std::string());
Kolab::Note readNote(const std::string& s, bool isUrl);
std::string writeNote(const Kolab::Note &, const std::string& productId = std::string());
Kolab::Configuration readConfiguration(const std::string& s, bool isUrl);
std::string writeConfiguration(const Kolab::Configuration &, const std::string& productId = std::string());
Kolab::File readFile(const std::string& s, bool isUrl);
std::string writeFile(const Kolab::File &, const std::string& productId = std::string());
}
#endif // KOLABFORMAT_H
|