Library of Assembled Shared Sources
 
Loading...
Searching...
No Matches
subscript.cpp
Go to the documentation of this file.
1/** @file
2 * @author Bram de Greve (bram@cocamware.com)
3 * @author Tom De Muer (tom@cocamware.com)
4 *
5 * *** BEGIN LICENSE INFORMATION ***
6 *
7 * The contents of this file are subject to the Common Public Attribution License
8 * Version 1.0 (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 * http://lass.sourceforge.net/cpal-license. The License is based on the
11 * Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover
12 * use of software over a computer network and provide for limited attribution for
13 * the Original Developer. In addition, Exhibit A has been modified to be consistent
14 * with Exhibit B.
15 *
16 * Software distributed under the License is distributed on an "AS IS" basis, WITHOUT
17 * WARRANTY OF ANY KIND, either express or implied. See the License for the specific
18 * language governing rights and limitations under the License.
19 *
20 * The Original Code is LASS - Library of Assembled Shared Sources.
21 *
22 * The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
23 * The Original Developer is the Initial Developer.
24 *
25 * All portions of the code written by the Initial Developer are:
26 * Copyright (C) 2026 the Initial Developer.
27 * All Rights Reserved.
28 *
29 * Contributor(s):
30 *
31 * Alternatively, the contents of this file may be used under the terms of the
32 * GNU General Public License Version 2 or later (the GPL), in which case the
33 * provisions of GPL are applicable instead of those above. If you wish to allow use
34 * of your version of this file only under the terms of the GPL and not to allow
35 * others to use your version of this file under the CPAL, indicate your decision by
36 * deleting the provisions above and replace them with the notice and other
37 * provisions required by the GPL License. If you do not delete the provisions above,
38 * a recipient may use your version of this file under either the CPAL or the GPL.
39 *
40 * *** END LICENSE INFORMATION ***
41 */
42
43#include "python_common.h"
44#include "subscript.h"
45#include "python_api.h"
46
47namespace lass::python
48{
49
50Py_ssize_t Slice::adjustIndices(Py_ssize_t sequenceLength)
51{
52 Py_ssize_t sliceLength = PySlice_AdjustIndices(sequenceLength, &start, &stop, step);
53 if (start < 0)
54 {
55 // This only happens for an empty slice with negative step.
56 // Normalize so that start is always a valid iterator index
57 // (but not necessarily a valid value index)
58 LASS_ASSERT(sliceLength == 0 && step < 0);
59 start = 0;
60 stop = 0;
61 }
62 LASS_ASSERT(start >= 0 && start <= sequenceLength);
63 LASS_ASSERT(stop >= -1 && stop <= sequenceLength);
64 return sliceLength;
65}
66
67
68
69bool adjustIndexEx(Py_ssize_t *index, Py_ssize_t sequenceLength)
70{
71 LASS_ASSERT(index);
72 LASS_ASSERT(sequenceLength >= 0);
73 Py_ssize_t i = *index;
74 if (i < 0)
75 {
76 i += sequenceLength;
77 }
78 if (i < 0 || i >= sequenceLength)
79 {
80 LockGIL lock;
81 PyErr_SetString(PyExc_IndexError, "index out of range");
82 return false;
83 }
84 *index = i;
85 return true;
86}
87
88
89
90Py_ssize_t adjustIndex(Py_ssize_t index, Py_ssize_t sequenceLength)
91{
92 if (!adjustIndexEx(&index, sequenceLength))
93 {
94 impl::fetchAndThrowPythonException(LASS_PRETTY_FUNCTION);
95 }
96 return index;
97}
98
99}
acquire the GIL for the current scope.
Definition gil.h:56
void fetchAndThrowPythonException(std::string loc)
Fetch the current Python exception and throw it as a C++ PythonException.
Py_ssize_t adjustIndex(Py_ssize_t index, Py_ssize_t sequenceLength)
Helper to adjust negative sequence indices.
Definition subscript.cpp:90
bool adjustIndexEx(Py_ssize_t *index, Py_ssize_t sequenceLength)
Helper to adjust negative sequence indices.
Definition subscript.cpp:69
Comprehensive C++ to Python binding library.
Py_ssize_t adjustIndices(Py_ssize_t sequenceLength)
Adjust start and stop for actual sequence length, returning slice length.
Definition subscript.cpp:50
Py_ssize_t step
step size of slice.
Definition subscript.h:196
Py_ssize_t start
start index of slice. Always the index of a valid iterator after calling adjustIndices()
Definition subscript.h:194
Py_ssize_t stop
stop index of slice. Can be -1 if step < 0! It's not guaranteed that stop == start + sliceLength * st...
Definition subscript.h:195