Mercurial > hgrepos > Python > libs > ConfigMix

annotate configmix/_py_helper.h @ 560:81238ea2dbe3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Implement and use more helper functions. Improve comments.
author Franz Glasner <fzglas.hg@dom66.de>
date Thu, 06 Jan 2022 19:37:03 +0100
parents bb160a1e67d7
children f75c5b13a1d7
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
559
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 /* -*- coding: utf-8 -*- */
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2 /*
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 * Some Python helper for C.
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 *
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5 * Also contains some interesting backports from later Python versions.
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 *
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 * :Copyright: (c) 2021, Franz Glasner. All rights reserved.
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8 * :License: BSD-3-Clause. See LICENSE.txt for details.
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 */
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 #if !defined(_PY_HELPER_H_d9df407295df4884a88e56699f6c6d8d)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12 #define _PY_HELPER_H_d9df407295df4884a88e56699f6c6d8d
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 #if PY_VERSION_HEX < 0x030A0000
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15
560
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
16 /*
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
17 * Return a new owned reference to an object
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
18 */
559
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 static inline
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 PyObject *
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 Py_NewRef(PyObject *obj)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23 Py_INCREF(obj);
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 return obj;
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27
560
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
28 /*
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
29 * Return a new owned reference to an object when the input can be NULL
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
30 */
559
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31 static inline
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 PyObject *
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33 Py_XNewRef(PyObject *obj)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35 Py_XINCREF(obj);
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 return obj;
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39 #endif /* PY_VERSION_HEX < 0x030A0000 */
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 static inline
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43 void
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 py_clear_ref(PyObject **obj)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45 {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 PyObject *tmp;
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 if ((tmp = *obj) != NULL) {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49 *obj = NULL;
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 Py_DECREF(tmp);
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55 /*
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 * NOTE: This implementation is valid for CPython only!
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57 */
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 static inline
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59 int
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 py_object_is(PyObject *obj1, PyObject *obj2)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
61 {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
62 return (obj1 == obj2);
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
65
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
66 /*
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67 * NOTE: This implementation is valid for CPython only!
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68 */
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69 static inline
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70 int
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 py_object_isnot(PyObject *obj1, PyObject *obj2)
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72 {
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73 return (obj1 != obj2);
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74 }
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
75
560
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
76
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
77 /**
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
78 * Copy from source to destination and make an owned reference.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
79 * Also safely clear the destination before.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
80 */
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
81 static inline
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
82 void
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
83 py_assign(PyObject **dest, PyObject *src)
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
84 {
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
85 Py_XDECREF(*dest);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
86 *dest = Py_NewRef(src);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
87 }
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
88
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
89
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
90 /**
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
91 * Copy from source to destination and make an owned reference.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
92 * Also safely clear the destination before. The source object may be NULL.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
93 */
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
94 static inline
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
95 void
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
96 py_assign_x(PyObject **dest, PyObject *src)
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
97 {
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
98 Py_XDECREF(*dest);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
99 *dest = Py_XNewRef(src);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
100 }
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
101
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
102
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
103 /*
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
104 * Transfer from a borrowed reference to an owned one and clear the source.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
105 * Also safely clear the destination before.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
106 */
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
107 static inline
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
108 void
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
109 py_transfer_borrowed(PyObject **dest, PyObject **src)
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
110 {
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
111 Py_XDECREF(*dest);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
112 *dest = Py_NewRef(*src);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
113 *src = NULL;
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
114 }
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
115
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
116
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
117 /*
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
118 * Transfer from a borrowed reference to an owned one and clear the source.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
119 * Also safely clear the destination before. The source object may be NULL.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
120 */
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
121 static inline
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
122 void
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
123 py_transfer_x_borrowed(PyObject **dest, PyObject **src)
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
124 {
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
125 Py_XDECREF(*dest);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
126 *dest = Py_XNewRef(*src);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
127 *src = NULL;
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
128 }
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
129
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
130
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
131 /*
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
132 * Transfer ownership from a owned reference to an owned one and clear the
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
133 * source.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
134 * Also safely clear the destination before.
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
135 */
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
136 static inline
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
137 void
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
138 py_transfer_owned(PyObject **dest, PyObject **src)
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
139 {
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
140 Py_XDECREF(*dest);
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
141 *dest = *src;
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
142 *src = NULL;
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
143 }
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
144
81238ea2dbe3 Implement and use more helper functions.
Franz Glasner <fzglas.hg@dom66.de>
parents: 559
diff changeset
145
559
bb160a1e67d7 A simple helper include file with some conveniente functions.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
146 #endif