1
0
Fork 0
cl-sites/guile.html_node/Hook-Example.html

123 lines
4.5 KiB
HTML
Raw Normal View History

2024-12-17 12:49:28 +01:00
<!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>Hook Example (Guile Reference Manual)</title>
<meta name="description" content="Hook Example (Guile Reference Manual)">
<meta name="keywords" content="Hook Example (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="Hooks.html" rel="up" title="Hooks">
<link href="Hook-Reference.html" rel="next" title="Hook Reference">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span.r {font-family: initial; font-weight: normal; font-style: normal}
span:hover a.copiable-link {visibility: visible}
-->
</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="Hook-Example">
<div class="nav-panel">
<p>
Next: <a href="Hook-Reference.html" accesskey="n" rel="next">Hook Reference</a>, Up: <a href="Hooks.html" accesskey="u" rel="up">Hooks</a> &nbsp; [<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="Hook-Usage-by-Example"><span>6.9.6.1 Hook Usage by Example<a class="copiable-link" href="#Hook-Usage-by-Example"> &para;</a></span></h4>
<p>Hook usage is shown by some examples in this section. First, we will
define a hook of arity 2 &mdash; that is, the procedures stored in the hook
will have to accept two arguments.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(define hook (make-hook 2))
hook
&rArr; #&lt;hook 2 40286c90&gt;
</pre></div>
<p>Now we are ready to add some procedures to the newly created hook with
<code class="code">add-hook!</code>. In the following example, two procedures are added,
which print different messages and do different things with their
arguments.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(add-hook! hook (lambda (x y)
(display &quot;Foo: &quot;)
(display (+ x y))
(newline)))
(add-hook! hook (lambda (x y)
(display &quot;Bar: &quot;)
(display (* x y))
(newline)))
</pre></div>
<p>Once the procedures have been added, we can invoke the hook using
<code class="code">run-hook</code>.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(run-hook hook 3 4)
-| Bar: 12
-| Foo: 7
</pre></div>
<p>Note that the procedures are called in the reverse of the order with
which they were added. This is because the default behavior of
<code class="code">add-hook!</code> is to add its procedure to the <em class="emph">front</em> of the
hook&rsquo;s procedure list. You can force <code class="code">add-hook!</code> to add its
procedure to the <em class="emph">end</em> of the list instead by providing a third
<code class="code">#t</code> argument on the second call to <code class="code">add-hook!</code>.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(add-hook! hook (lambda (x y)
(display &quot;Foo: &quot;)
(display (+ x y))
(newline)))
(add-hook! hook (lambda (x y)
(display &quot;Bar: &quot;)
(display (* x y))
(newline))
#t) ; <span class="r">&lt;- Change here!</span>
(run-hook hook 3 4)
-| Foo: 7
-| Bar: 12
</pre></div>
</div>
</body>
</html>