annotate Resources/Laaw/laaw/laaw.h @ 17:ae34bde412ae default tip

note
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 21 Dec 2016 11:05:16 +0100
parents 2e999f3e84b4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Laaw - Lightweight, Automated API Wrapper
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2010-2013 Jomago - Alain Mazy, Benjamin Golinvaux,
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Sebastien Jodogne
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "laaw-exports.h"
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include <stddef.h>
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include <string>
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #if (LAAW_PARSING == 1)
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 #define LAAW_API __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 #define LAAW_API_INTERNAL __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 #define LAAW_API_OVERLOAD(name) __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 #define LAAW_API_PROPERTY __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 #define LAAW_API_STATIC_CLASS __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 #define LAAW_API_CUSTOM(name, value) __attribute__((deprecated("")))
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 #else
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 #define LAAW_API
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 #define LAAW_API_INTERNAL
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 #define LAAW_API_OVERLOAD(name)
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 #define LAAW_API_PROPERTY
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 #define LAAW_API_STATIC_CLASS
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 #define LAAW_API_CUSTOM(name, value)
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 #endif
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 namespace Laaw
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 /**
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 * This is the base class from which all the public exceptions in
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 * the SDK should derive.
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 **/
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 class LaawException
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 private:
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 std::string what_;
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 public:
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 LaawException()
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 }
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 LaawException(const std::string& what) : what_(what)
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 }
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 LaawException(const char* what) : what_(what)
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 }
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 virtual const char* What() const
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 return what_.c_str();
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 };
ebc1e38ef615 initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 }