2374cbba600c6a9f22300efd085868b4229e37b6
[gpgme.git] / lang / cpp / src / decryptionresult.h
1 /*
2   decryptionresult.h - wraps a gpgme keygen result
3   Copyright (C) 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_DECRYPTIONRESULT_H__
24 #define __GPGMEPP_DECRYPTIONRESULT_H__
25
26 #include "gpgmefw.h"
27 #include "result.h"
28 #include "gpgmepp_export.h"
29
30 #include <boost/shared_ptr.hpp>
31
32 #include <vector>
33 #include <algorithm>
34 #include <iosfwd>
35
36 namespace GpgME
37 {
38
39 class Error;
40
41 class GPGMEPP_EXPORT DecryptionResult : public Result
42 {
43 public:
44     DecryptionResult();
45     DecryptionResult(gpgme_ctx_t ctx, int error);
46     DecryptionResult(gpgme_ctx_t ctx, const Error &err);
47     explicit DecryptionResult(const Error &err);
48
49     const DecryptionResult &operator=(DecryptionResult other)
50     {
51         swap(other);
52         return *this;
53     }
54
55     void swap(DecryptionResult &other)
56     {
57         Result::swap(other);
58         using std::swap;
59         swap(this->d, other.d);
60     }
61
62     bool isNull() const;
63
64     GPGMEPP_DEPRECATED const char *unsupportedAlgortihm() const
65     {
66         return unsupportedAlgorithm();
67     }
68     const char *unsupportedAlgorithm() const;
69
70     GPGMEPP_DEPRECATED bool wrongKeyUsage() const
71     {
72         return isWrongKeyUsage();
73     }
74     bool isWrongKeyUsage() const;
75
76     const char *fileName() const;
77
78     class Recipient;
79
80     unsigned int numRecipients() const;
81     Recipient recipient(unsigned int idx) const;
82     std::vector<Recipient> recipients() const;
83
84 private:
85     class Private;
86     void init(gpgme_ctx_t ctx);
87     boost::shared_ptr<Private> d;
88 };
89
90 GPGMEPP_EXPORT std::ostream &operator<<(std::ostream &os, const DecryptionResult &result);
91
92 class GPGMEPP_EXPORT DecryptionResult::Recipient
93 {
94 public:
95     Recipient();
96     explicit Recipient(gpgme_recipient_t reci);
97
98     const Recipient &operator=(Recipient other)
99     {
100         swap(other);
101         return *this;
102     }
103
104     void swap(Recipient &other)
105     {
106         using std::swap;
107         swap(this->d, other.d);
108     }
109
110     bool isNull() const;
111
112     const char *keyID() const;
113     const char *shortKeyID() const;
114
115     unsigned int publicKeyAlgorithm() const;
116     const char *publicKeyAlgorithmAsString() const;
117
118     Error status() const;
119
120 private:
121     class Private;
122     boost::shared_ptr<Private> d;
123 };
124
125 GPGMEPP_EXPORT std::ostream &operator<<(std::ostream &os, const DecryptionResult::Recipient &reci);
126
127 }
128
129 GPGMEPP_MAKE_STD_SWAP_SPECIALIZATION(DecryptionResult)
130
131 #endif // __GPGMEPP_DECRYPTIONRESULT_H__