154 lines
12 KiB
HTML
154 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<!-- Created by GNU Texinfo 7.1, https://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<!-- This manual documents Guile version 3.0.10.
|
|
|
|
Copyright (C) 1996-1997, 2000-2005, 2009-2023 Free Software Foundation,
|
|
Inc.
|
|
|
|
Copyright (C) 2021 Maxime Devos
|
|
|
|
Copyright (C) 2024 Tomas Volf
|
|
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
|
|
copy of the license is included in the section entitled "GNU Free
|
|
Documentation License." -->
|
|
<title>Frames (Guile Reference Manual)</title>
|
|
|
|
<meta name="description" content="Frames (Guile Reference Manual)">
|
|
<meta name="keywords" content="Frames (Guile Reference Manual)">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content=".texi2any-real">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<link href="index.html" rel="start" title="Top">
|
|
<link href="Concept-Index.html" rel="index" title="Concept Index">
|
|
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
|
|
<link href="Evaluation-Model.html" rel="up" title="Evaluation Model">
|
|
<link href="Stacks.html" rel="prev" title="Stacks">
|
|
<style type="text/css">
|
|
<!--
|
|
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
|
|
span:hover a.copiable-link {visibility: visible}
|
|
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
|
|
-->
|
|
</style>
|
|
<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css">
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<div class="subsubsection-level-extent" id="Frames">
|
|
<div class="nav-panel">
|
|
<p>
|
|
Previous: <a href="Stacks.html" accesskey="p" rel="prev">Stacks</a>, Up: <a href="Evaluation-Model.html" accesskey="u" rel="up">Evaluation and the Scheme Stack</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<h4 class="subsubsection" id="Frames-1"><span>6.26.1.3 Frames<a class="copiable-link" href="#Frames-1"> ¶</a></span></h4>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_003f"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame?</strong> <var class="def-var-arguments">obj</var><a class="copiable-link" href="#index-frame_003f"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005fframe_005fp"><span class="category-def">C Function: </span><span><strong class="def-name">scm_frame_p</strong> <var class="def-var-arguments">(obj)</var><a class="copiable-link" href="#index-scm_005fframe_005fp"> ¶</a></span></dt>
|
|
<dd><p>Return <code class="code">#t</code> if <var class="var">obj</var> is a stack frame.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002dprevious"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-previous</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dprevious"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005fframe_005fprevious"><span class="category-def">C Function: </span><span><strong class="def-name">scm_frame_previous</strong> <var class="def-var-arguments">(frame)</var><a class="copiable-link" href="#index-scm_005fframe_005fprevious"> ¶</a></span></dt>
|
|
<dd><p>Return the previous frame of <var class="var">frame</var>, or <code class="code">#f</code> if
|
|
<var class="var">frame</var> is the first frame in its stack.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002dprocedure_002dname"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-procedure-name</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dprocedure_002dname"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005fframe_005fprocedure_005fname"><span class="category-def">C Function: </span><span><strong class="def-name">scm_frame_procedure_name</strong> <var class="def-var-arguments">(frame)</var><a class="copiable-link" href="#index-scm_005fframe_005fprocedure_005fname"> ¶</a></span></dt>
|
|
<dd><p>Return the name of the procedure being applied in <var class="var">frame</var>, as a
|
|
symbol, or <code class="code">#f</code> if the procedure has no name.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002darguments"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-arguments</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002darguments"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005fframe_005farguments"><span class="category-def">C Function: </span><span><strong class="def-name">scm_frame_arguments</strong> <var class="def-var-arguments">(frame)</var><a class="copiable-link" href="#index-scm_005fframe_005farguments"> ¶</a></span></dt>
|
|
<dd><p>Return the arguments of <var class="var">frame</var>.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002daddress"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-address</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002daddress"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-frame_002dinstruction_002dpointer"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-instruction-pointer</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dinstruction_002dpointer"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-frame_002dstack_002dpointer"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-stack-pointer</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dstack_002dpointer"> ¶</a></span></dt>
|
|
<dd><p>Accessors for the three VM registers associated with this frame: the
|
|
frame pointer (fp), instruction pointer (ip), and stack pointer (sp),
|
|
respectively. See <a class="xref" href="VM-Concepts.html">VM Concepts</a>, for more information.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002ddynamic_002dlink"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-dynamic-link</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002ddynamic_002dlink"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-frame_002dreturn_002daddress"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-return-address</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dreturn_002daddress"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-frame_002dmv_002dreturn_002daddress"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-mv-return-address</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dmv_002dreturn_002daddress"> ¶</a></span></dt>
|
|
<dd><p>Accessors for the three saved VM registers in a frame: the previous
|
|
frame pointer, the single-value return address, and the multiple-value
|
|
return address. See <a class="xref" href="Stack-Layout.html">Stack Layout</a>, for more information.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002dbindings"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-bindings</strong> <var class="def-var-arguments">frame</var><a class="copiable-link" href="#index-frame_002dbindings"> ¶</a></span></dt>
|
|
<dd><p>Return a list of binding records indicating the local variables that are
|
|
live in a frame.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-frame_002dlookup_002dbinding"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">frame-lookup-binding</strong> <var class="def-var-arguments">frame var</var><a class="copiable-link" href="#index-frame_002dlookup_002dbinding"> ¶</a></span></dt>
|
|
<dd><p>Fetch the bindings in <var class="var">frame</var>, and return the first one whose name
|
|
is <var class="var">var</var>, or <code class="code">#f</code> otherwise.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-binding_002dindex"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-index</strong> <var class="def-var-arguments">binding</var><a class="copiable-link" href="#index-binding_002dindex"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-binding_002dname"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-name</strong> <var class="def-var-arguments">binding</var><a class="copiable-link" href="#index-binding_002dname"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-binding_002dslot"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-slot</strong> <var class="def-var-arguments">binding</var><a class="copiable-link" href="#index-binding_002dslot"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-binding_002drepresentation"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-representation</strong> <var class="def-var-arguments">binding</var><a class="copiable-link" href="#index-binding_002drepresentation"> ¶</a></span></dt>
|
|
<dd><p>Accessors for the various fields in a binding. The implicit “callee”
|
|
argument is index 0, the first argument is index 1, and so on to the end
|
|
of the arguments. After that are temporary variables. Note that if a
|
|
variable is dead, it might not be available.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-binding_002dref"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-ref</strong> <var class="def-var-arguments">binding</var><a class="copiable-link" href="#index-binding_002dref"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-binding_002dset_0021"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">binding-set!</strong> <var class="def-var-arguments">binding val</var><a class="copiable-link" href="#index-binding_002dset_0021"> ¶</a></span></dt>
|
|
<dd><p>Accessors for the values of local variables in a frame.
|
|
</p></dd></dl>
|
|
|
|
<dl class="first-deffn">
|
|
<dt class="deffn" id="index-display_002dapplication"><span class="category-def">Scheme Procedure: </span><span><strong class="def-name">display-application</strong> <var class="def-var-arguments">frame [port [indent]]</var><a class="copiable-link" href="#index-display_002dapplication"> ¶</a></span></dt>
|
|
<dt class="deffnx def-cmd-deffn" id="index-scm_005fdisplay_005fapplication"><span class="category-def">C Function: </span><span><strong class="def-name">scm_display_application</strong> <var class="def-var-arguments">(frame, port, indent)</var><a class="copiable-link" href="#index-scm_005fdisplay_005fapplication"> ¶</a></span></dt>
|
|
<dd><p>Display a procedure application <var class="var">frame</var> to the output port
|
|
<var class="var">port</var>. <var class="var">indent</var> specifies the indentation of the
|
|
output.
|
|
</p></dd></dl>
|
|
|
|
<p>Additionally, the <code class="code">(system vm frame)</code> module defines a number of
|
|
higher-level introspective procedures, for example to retrieve the names
|
|
of local variables, and the source location to correspond to a
|
|
frame. See its source code for more details.
|
|
</p>
|
|
|
|
</div>
|
|
<hr>
|
|
<div class="nav-panel">
|
|
<p>
|
|
Previous: <a href="Stacks.html">Stacks</a>, Up: <a href="Evaluation-Model.html">Evaluation and the Scheme Stack</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|