# frameobject.rs - source
Source of the Rust file `/home/runner/.cargo/registry/src/github.com-1ecc6299db9ec823/pyo3-0.13.2/src/ffi/cpython/frameobject.rs`.
Keywords: rust, rustlang, rust-lang

     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
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88

    use crate::ffi::cpython::code::{PyCodeObject, CO_MAXBLOCKS};
    use crate::ffi::object::*;
    use crate::ffi::pystate::PyThreadState;
    use std::os::raw::{c_char, c_int};

    // skipped _framestate
    // skipped PyFrameState

    #[repr(C)]
    #[derive(Copy, Clone)]
    pub struct PyTryBlock {
        pub b_type: c_int,
        pub b_handler: c_int,
        pub b_level: c_int,
    }

    /// struct _frame as typedef'ed in pyframe.h
    #[repr(C)]
    #[derive(Copy, Clone)]
    pub struct PyFrameObject {
        pub ob_base: PyVarObject,
        pub f_back: *mut PyFrameObject,       /* previous frame, or NULL */
        pub f_code: *mut PyCodeObject,        /* code segment */
        pub f_builtins: *mut PyObject,        /* builtin symbol table (PyDictObject) */
        pub f_globals: *mut PyObject,         /* global symbol table (PyDictObject) */
        pub f_locals: *mut PyObject,          /* local symbol table (any mapping) */
        pub f_valuestack: *mut *mut PyObject, /* points after the last local */
        /* Next free slot in f_valuestack.  Frame creation sets to f_valuestack.
        Frame evaluation usually NULLs it, but a frame that yields sets it
        to the current stack top. */
        pub f_stacktop: *mut *mut PyObject,
        pub f_trace: *mut PyObject, /* Trace function */

        pub f_exc_type: *mut PyObject,
        pub f_exc_value: *mut PyObject,
        pub f_exc_traceback: *mut PyObject,
        pub f_gen: *mut PyObject,

        pub f_lasti: c_int, /* Last instruction if called */
        /* Call PyFrame_GetLineNumber() instead of reading this field
         directly.  As of 2.3 f_lineno is only valid when tracing is
         active (i.e. when f_trace is set).  At other times we use
         PyCode_Addr2Line to calculate the line from the current
        bytecode index. */
        pub f_lineno: c_int,                          /* Current line number */
        pub f_iblock: c_int,                          /* index in f_blockstack */
        pub f_executing: c_char,                      /* whether the frame is still executing */
        pub f_blockstack: [PyTryBlock; CO_MAXBLOCKS], /* for try and loop blocks */
        pub f_localsplus: [*mut PyObject; 1],         /* locals+stack, dynamically sized */
    }

    // skipped _PyFrame_IsRunnable
    // skipped _PyFrame_IsExecuting
    // skipped _PyFrameHasCompleted

    #[cfg_attr(windows, link(name = "pythonXY"))]
    extern "C" {
        pub static mut PyFrame_Type: PyTypeObject;
    }

    #[inline]
    pub unsafe fn PyFrame_Check(op: *mut PyObject) -> c_int {
        (Py_TYPE(op) == &mut PyFrame_Type) as c_int
    }

    extern "C" {
        #[cfg_attr(PyPy, link_name = "PyPyFrame_New")]
        pub fn PyFrame_New(
            tstate: *mut PyThreadState,
            code: *mut PyCodeObject,
            globals: *mut PyObject,
            locals: *mut PyObject,
        ) -> *mut PyFrameObject;
        // skipped _PyFrame_New_NoTrack

        pub fn PyFrame_BlockSetup(f: *mut PyFrameObject, _type: c_int, handler: c_int, level: c_int);
        pub fn PyFrame_BlockPop(f: *mut PyFrameObject) -> *mut PyTryBlock;

        pub fn PyFrame_LocalsToFast(f: *mut PyFrameObject, clear: c_int);
        pub fn PyFrame_FastToLocalsWithError(f: *mut PyFrameObject) -> c_int;
        pub fn PyFrame_FastToLocals(f: *mut PyFrameObject);

        // skipped _PyFrame_DebugMallocStats
        // skipped PyFrame_GetBack

        #[cfg(not(Py_3_9))]
        pub fn PyFrame_ClearFreeList() -> c_int;
    }