annotate Sources/PythonBytes.h @ 219:3678a028f1f6

making the project REUSE-compliant
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 03 Jul 2024 18:05:11 +0200
parents 6fada29b6759
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
219
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
1 /**
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
2 * SPDX-FileCopyrightText: 2020-2023 Osimis S.A., 2024-2024 Orthanc Team SRL, 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
3 * SPDX-License-Identifier: AGPL-3.0-or-later
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
4 */
3678a028f1f6 making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 166
diff changeset
5
122
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 /**
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * Python plugin for Orthanc
166
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
8 * Copyright (C) 2020-2023 Osimis S.A., Belgium
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
9 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
6fada29b6759 updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 122
diff changeset
10 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
122
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is free software: you can redistribute it and/or
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * modify it under the terms of the GNU Affero General Public License
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * as published by the Free Software Foundation, either version 3 of
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the License, or (at your option) any later version.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * This program is distributed in the hope that it will be useful, but
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * Affero General Public License for more details.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 *
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * You should have received a copy of the GNU Affero General Public License
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 **/
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #pragma once
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include "PythonObject.h"
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 #include <Compatibility.h> // For std::unique_ptr
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 // A Python string is always valid, or an exception was thrown on its creation
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 class PythonBytes : public boost::noncopyable
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 private:
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 std::unique_ptr<PythonObject> bytes_;
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 void SanityCheck();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 public:
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 PythonBytes(PythonLock& lock,
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 const void* data,
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 size_t size);
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 PyObject* GetPyObject() const
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 return bytes_->GetPyObject();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 }
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 PyObject* Release()
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 {
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 return bytes_->Release();
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 }
45722358d459 added PythonBytes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 };