blob: 04a5b6dd051f90e3b80da836a72979b2cdd8e187 (
plain)
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
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt for Python.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef SHIBOKEN_BUFFER_H
#define SHIBOKEN_BUFFER_H
#include "sbkpython.h"
#include "shibokenmacros.h"
namespace Shiboken
{
namespace Buffer
{
enum Type {
ReadOnly,
WriteOnly,
ReadWrite
};
/**
* Creates a new Python buffer pointing to a contiguous memory block at
* \p memory of size \p size.
*/
LIBSHIBOKEN_API PyObject* newObject(void* memory, Py_ssize_t size, Type type);
/**
* Creates a new <b>read only</b> Python buffer pointing to a contiguous memory block at
* \p memory of size \p size.
*/
LIBSHIBOKEN_API PyObject* newObject(const void* memory, Py_ssize_t size);
/**
* Check if is ok to use \p pyObj as argument in all function under Shiboken::Buffer namespace.
*/
LIBSHIBOKEN_API bool checkType(PyObject* pyObj);
/**
* Returns a pointer to the memory pointed by the buffer \p pyObj, \p size is filled with the buffer
* size if not null.
*
* If the \p pyObj is a non-contiguous buffer a Python error is set.
*/
LIBSHIBOKEN_API void* getPointer(PyObject* pyObj, Py_ssize_t* size = 0);
} // namespace Buffer
} // namespace Shiboken
#endif
|
