Home | History | Annotate | Download | only in Include
      1 #ifndef Py_SLICEOBJECT_H
      2 #define Py_SLICEOBJECT_H
      3 #ifdef __cplusplus
      4 extern "C" {
      5 #endif
      6 
      7 /* The unique ellipsis object "..." */
      8 
      9 PyAPI_DATA(PyObject) _Py_EllipsisObject; /* Don't use this directly */
     10 
     11 #define Py_Ellipsis (&_Py_EllipsisObject)
     12 
     13 /* Slice object interface */
     14 
     15 /*
     16 
     17 A slice object containing start, stop, and step data members (the
     18 names are from range).  After much talk with Guido, it was decided to
     19 let these be any arbitrary python type.  Py_None stands for omitted values.
     20 */
     21 #ifndef Py_LIMITED_API
     22 typedef struct {
     23     PyObject_HEAD
     24     PyObject *start, *stop, *step;	/* not NULL */
     25 } PySliceObject;
     26 #endif
     27 
     28 PyAPI_DATA(PyTypeObject) PySlice_Type;
     29 PyAPI_DATA(PyTypeObject) PyEllipsis_Type;
     30 
     31 #define PySlice_Check(op) (Py_TYPE(op) == &PySlice_Type)
     32 
     33 PyAPI_FUNC(PyObject *) PySlice_New(PyObject* start, PyObject* stop,
     34                                   PyObject* step);
     35 #ifndef Py_LIMITED_API
     36 PyAPI_FUNC(PyObject *) _PySlice_FromIndices(Py_ssize_t start, Py_ssize_t stop);
     37 PyAPI_FUNC(int) _PySlice_GetLongIndices(PySliceObject *self, PyObject *length,
     38                                  PyObject **start_ptr, PyObject **stop_ptr,
     39                                  PyObject **step_ptr);
     40 #endif
     41 PyAPI_FUNC(int) PySlice_GetIndices(PyObject *r, Py_ssize_t length,
     42                                   Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step);
     43 PyAPI_FUNC(int) PySlice_GetIndicesEx(PyObject *r, Py_ssize_t length,
     44                                      Py_ssize_t *start, Py_ssize_t *stop,
     45                                      Py_ssize_t *step, Py_ssize_t *slicelength);
     46 
     47 #if !defined(Py_LIMITED_API) || (Py_LIMITED_API+0 >= 0x03050400 && Py_LIMITED_API+0 < 0x03060000) || Py_LIMITED_API+0 >= 0x03060100
     48 #define PySlice_GetIndicesEx(slice, length, start, stop, step, slicelen) (  \
     49     PySlice_Unpack((slice), (start), (stop), (step)) < 0 ?                  \
     50     ((*(slicelen) = 0), -1) :                                               \
     51     ((*(slicelen) = PySlice_AdjustIndices((length), (start), (stop), *(step))), \
     52      0))
     53 PyAPI_FUNC(int) PySlice_Unpack(PyObject *slice,
     54                                Py_ssize_t *start, Py_ssize_t *stop, Py_ssize_t *step);
     55 PyAPI_FUNC(Py_ssize_t) PySlice_AdjustIndices(Py_ssize_t length,
     56                                              Py_ssize_t *start, Py_ssize_t *stop,
     57                                              Py_ssize_t step);
     58 #endif
     59 
     60 #ifdef __cplusplus
     61 }
     62 #endif
     63 #endif /* !Py_SLICEOBJECT_H */
     64