hg.stevelosh.com > docs.stevelosh.com

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title> API Reference / Bobbin</title>
        <link rel="stylesheet" href="../_dmedia/tango.css"/>
        <link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less"/>
        <script src="../_dmedia/less.js" type="text/javascript">
        </script>
    </head>
    <body class="content">
        <div class="wrap">
            <header><h1><a href="..">Bobbin</a></h1></header>
                <div class="markdown">
<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Bobbin.</p>
<p>If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.</p>
<p>Anything not listed here is subject to change at any time with no warning, so
don't touch it.</p>
<div class="toc">
<ul>
<li><a href="#package-bobbin">Package BOBBIN</a><ul>
<li><a href="#wrap-function">WRAP (function)</a></li>
</ul>
</li>
</ul></div>
<h2 id="package-bobbin">Package <code>BOBBIN</code></h2>
<h3 id="wrap-function"><code>WRAP</code> (function)</h3>
<div class="codehilite"><pre><span/>(WRAP STRING-OR-STRINGS WIDTH)
</pre></div>


<p>Wrap <code>string-or-strings</code> to <code>width</code>.</p>
<p><code>string-or-strings</code> can be a string or a list of strings.  A list of strings
  is treated as multiple lines.  In either case the string(s) may also contain
  newlines.  All of these linebreaks will be included in the output — wrapping
  will only add linebreaks, never remove them.</p>
<p>The result with be of the same type as the argument: either a single string
  (containing newlines) or a list of strings (not containing newlines).</p>
<p>Examples:</p>
<div class="codehilite"><pre><span/>(print (wrap (format nil "foo bar baz") 3))
foo
bar
baz

(print (wrap (format nil "foo bar baz") 7))
foo bar
baz

(print (wrap (format nil "foo~%bar baz") 7))
foo
bar baz

(print (wrap '("foo" "bar baz") 7))
("foo" "bar baz")

(print (wrap '("foo" "bar baz") 3))
("foo" "bar" "baz")
</pre></div>
                </div>
            <footer><p>Created by <a href="http://stevelosh.com">Steve Losh</a>.</p>
<p><br/><a id="rochester-made" href="https://rochestermade.com" title="Rochester Made"><img src="http://rochestermade.com/media/images/rochester-made-dark-on-light.png" alt="Rochester Made" title="Rochester Made"/></a></p></footer>
        </div>
    </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Thu, 13 Jun 2024 13:05:28 -0400
parents	dd80d93f061a
children	(none)