1 /*
2  * Copyright (c) 2009-2021, Google LLC
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Google LLC nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL Google LLC BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef PYUPB_PYTHON_H__
29 #define PYUPB_PYTHON_H__
30 
31 // We restrict ourselves to the limited API, so that a single build can be
32 // ABI-compatible with a wide range of Python versions.
33 //
34 // The build system will define Py_LIMITED_API as appropriate (see BUILD). We
35 // only want to define it for our distribution packages, since we can do some
36 // extra assertions when Py_LIMITED_API is not defined.  Also Py_LIMITED_API is
37 // incompatible with Py_DEBUG.
38 
39 // #define Py_LIMITED_API <val>  // Defined by build system when appropriate.
40 
41 #include "Python.h"
42 
43 // Ideally we could restrict ourselves to the limited API of 3.7, but this is
44 // a very important function that was not officially added to the limited API
45 // until 3.10.  Without this function, there is no way of getting data from a
46 // Python `str` object without a copy.
47 //
48 // While this function was not *officially* added to the limited API until
49 // Python 3.10, In practice it has been stable since Python 3.1.
50 //   https://bugs.python.org/issue41784
51 //
52 // On Linux/ELF and macOS/Mach-O, we can get away with using this function with
53 // the limited API prior to 3.10.
54 
55 #if (defined(__linux__) || defined(__APPLE__)) && defined(Py_LIMITED_API) && \
56     Py_LIMITED_API < 0x03100000
57 PyAPI_FUNC(const char*)
58     PyUnicode_AsUTF8AndSize(PyObject* unicode, Py_ssize_t* size);
59 #endif
60 
61 #endif  // PYUPB_PYTHON_H__
62