blob: 6b17eb6ebac1b2a30792be69c451364bd351e324 (
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#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 = nullptr);
/**
* Returns a copy of the buffer data which should be free'd.
*
* If the \p pyObj is a non-contiguous buffer a Python error is set.
* nullptr is returned for empty buffers.
*/
LIBSHIBOKEN_API void *copyData(PyObject *pyObj, Py_ssize_t *size = nullptr);
} // namespace Buffer
} // namespace Shiboken
#endif
|
