c8a599ed4bf6c1bee49ca0c67c8a446ccc621cf2
[gpgme.git] / lang / cpp / src / data.h
1 /*
2   data.h - wraps a gpgme data object
3   Copyright (C) 2003,2004 Klarälvdalens Datakonsult AB
4
5   This file is part of GPGME++.
6
7   GPGME++ is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Library General Public
9   License as published by the Free Software Foundation; either
10   version 2 of the License, or (at your option) any later version.
11
12   GPGME++ is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU Library General Public License for more details.
16
17   You should have received a copy of the GNU Library General Public License
18   along with GPGME++; see the file COPYING.LIB.  If not, write to the
19   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20   Boston, MA 02110-1301, USA.
21 */
22
23 #ifndef __GPGMEPP_DATA_H__
24 #define __GPGMEPP_DATA_H__
25
26 #include "global.h"
27
28 #include <boost/shared_ptr.hpp>
29
30 #include <sys/types.h> // for size_t, off_t
31 #include <cstdio> // FILE
32 #include <algorithm>
33
34 namespace GpgME
35 {
36
37 class DataProvider;
38 class Error;
39
40 class GPGMEPP_EXPORT Data
41 {
42     struct Null {
43                 Null() {}
44         };
45 public:
46     /* implicit */ Data(const Null &);
47     Data();
48     explicit Data(gpgme_data_t data);
49
50     // Memory-Based Data Buffers:
51     Data(const char *buffer, size_t size, bool copy = true);
52     explicit Data(const char *filename);
53     Data(const char *filename, off_t offset, size_t length);
54     Data(std::FILE *fp, off_t offset, size_t length);
55     // File-Based Data Buffers:
56     explicit Data(std::FILE *fp);
57     explicit Data(int fd);
58     // Callback-Based Data Buffers:
59     explicit Data(DataProvider *provider);
60
61     static const Null null;
62
63     const Data &operator=(Data other)
64     {
65         swap(other);
66         return *this;
67     }
68
69     void swap(Data &other)
70     {
71         using std::swap;
72         swap(this->d, other.d);
73     }
74
75     bool isNull() const;
76
77     enum Encoding {
78         AutoEncoding,
79         BinaryEncoding,
80         Base64Encoding,
81         ArmorEncoding
82     };
83     Encoding encoding() const;
84     Error setEncoding(Encoding encoding);
85
86     char *fileName() const;
87     Error setFileName(const char *name);
88
89     ssize_t read(void *buffer, size_t length);
90     ssize_t write(const void *buffer, size_t length);
91     off_t seek(off_t offset, int whence);
92
93     class Private;
94     Private *impl()
95     {
96         return d.get();
97     }
98     const Private *impl() const
99     {
100         return d.get();
101     }
102 private:
103     boost::shared_ptr<Private> d;
104 };
105
106 }
107
108 GPGMEPP_MAKE_STD_SWAP_SPECIALIZATION(Data)
109
110 #endif // __GPGMEPP_DATA_H__