deertree/stdlib.html

505 lines
18 KiB
HTML

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>GRU DeerTree standard library specifications</title>
<meta name="generator" content="Org Mode" />
<style>
#content { max-width: 60em; margin: auto; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #e6e6e6;
border-radius: 3px;
background-color: #f2f2f2;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: auto;
}
pre.src:before {
display: none;
position: absolute;
top: -8px;
right: 12px;
padding: 3px;
color: #555;
background-color: #f2f2f299;
}
pre.src:hover:before { display: inline; margin-top: 14px;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-authinfo::before { content: 'Authinfo'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.equation-container {
display: table;
text-align: center;
width: 100%;
}
.equation {
vertical-align: middle;
}
.equation-label {
display: table-cell;
text-align: right;
vertical-align: middle;
}
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
</style>
<link rel="stylesheet" type="text/css" href="style.css"/>
</head>
<body>
<div id="content" class="content">
<h1 class="title">GRU DeerTree standard library specifications</h1>
<div id="outline-container-org5c056f8" class="outline-2">
<h2 id="org5c056f8"><span class="todo TODO">TODO</span> Introduction</h2>
<div class="outline-text-2" id="text-org5c056f8">
<p>
{} - optional argument to function (FIXME: should be defined in main specfications)
</p>
</div>
</div>
<div id="outline-container-orgc6ec358" class="outline-2">
<h2 id="orgc6ec358"><span class="todo TODO">TODO</span> Buitlin syntax</h2>
</div>
<div id="outline-container-org1e52d2f" class="outline-2">
<h2 id="org1e52d2f"><span class="todo TODO">TODO</span> <code>&lt;def&gt;</code> header</h2>
<div class="outline-text-2" id="text-org1e52d2f">
<p>
FIXME: Like stddef.h in C, maybe more
</p>
</div>
<div id="outline-container-orge0a0b9a" class="outline-3">
<h3 id="orge0a0b9a">Types</h3>
<div class="outline-text-3" id="text-orge0a0b9a">
</div>
<div id="outline-container-orge184137" class="outline-4">
<h4 id="orge184137"><code>Size</code> - alias for unsigned long long</h4>
</div>
</div>
</div>
<div id="outline-container-org436400e" class="outline-2">
<h2 id="org436400e"><span class="todo TODO">TODO</span> <code>&lt;io&gt;</code> header</h2>
<div class="outline-text-2" id="text-org436400e">
</div>
<div id="outline-container-org9e8843f" class="outline-3">
<h3 id="org9e8843f">Types</h3>
<div class="outline-text-3" id="text-org9e8843f">
</div>
<div id="outline-container-org770cae1" class="outline-4">
<h4 id="org770cae1"><code>File</code> - an object type used for streams.</h4>
</div>
</div>
<div id="outline-container-orga2b675e" class="outline-3">
<h3 id="orga2b675e">Functions</h3>
<div class="outline-text-3" id="text-orga2b675e">
</div>
<div id="outline-container-org6007746" class="outline-4">
<h4 id="org6007746"><code>printf();</code> // C-like formatting</h4>
</div>
<div id="outline-container-org59399dd" class="outline-4">
<h4 id="org59399dd"><code>fprintf();</code></h4>
</div>
<div id="outline-container-org7d49c35" class="outline-4">
<h4 id="org7d49c35"><code>sprintf();</code></h4>
</div>
<div id="outline-container-org4aa202e" class="outline-4">
<h4 id="org4aa202e"><code>eprintf();</code></h4>
</div>
</div>
</div>
<div id="outline-container-org8d00b5d" class="outline-2">
<h2 id="org8d00b5d"><span class="todo TODO">TODO</span> <code>&lt;string&gt;</code> header</h2>
<div class="outline-text-2" id="text-org8d00b5d">
</div>
<div id="outline-container-org8f10c47" class="outline-3">
<h3 id="org8f10c47">Types</h3>
</div>
<div id="outline-container-org39f6f1b" class="outline-3">
<h3 id="org39f6f1b">Functions</h3>
<div class="outline-text-3" id="text-org39f6f1b">
</div>
<div id="outline-container-org7fe22ad" class="outline-4">
<h4 id="org7fe22ad"><code>isalnum()</code></h4>
</div>
<div id="outline-container-orgd567090" class="outline-4">
<h4 id="orgd567090"><code>isalpha()</code></h4>
</div>
<div id="outline-container-org125c5d0" class="outline-4">
<h4 id="org125c5d0"><code>isascii()</code></h4>
</div>
<div id="outline-container-org1665a58" class="outline-4">
<h4 id="org1665a58"><code>isblank()</code></h4>
</div>
<div id="outline-container-org1fc3621" class="outline-4">
<h4 id="org1fc3621"><code>iscntrl()</code> // FIXME: maybe not needed</h4>
</div>
<div id="outline-container-orgfd8a749" class="outline-4">
<h4 id="orgfd8a749"><code>isdigit()</code></h4>
</div>
<div id="outline-container-org4a55375" class="outline-4">
<h4 id="org4a55375"><code>isgraph()</code> // FIXME: maybe not needed</h4>
</div>
<div id="outline-container-org3a63abe" class="outline-4">
<h4 id="org3a63abe"><code>islower()</code></h4>
</div>
<div id="outline-container-org0150eb8" class="outline-4">
<h4 id="org0150eb8"><code>isprint()</code> // FIXME: maybe not needed</h4>
</div>
<div id="outline-container-orgf9ecf37" class="outline-4">
<h4 id="orgf9ecf37"><code>ispunct()</code></h4>
</div>
<div id="outline-container-orge8e9663" class="outline-4">
<h4 id="orge8e9663"><code>isspace()</code></h4>
</div>
<div id="outline-container-orgbb2880b" class="outline-4">
<h4 id="orgbb2880b"><code>isupper()</code></h4>
</div>
<div id="outline-container-orgcff8308" class="outline-4">
<h4 id="orgcff8308"><code>isxdigit()</code></h4>
</div>
<div id="outline-container-orga583838" class="outline-4">
<h4 id="orga583838"><code>toascii()</code> // FIXME: maybe not needed</h4>
</div>
<div id="outline-container-org2943fb8" class="outline-4">
<h4 id="org2943fb8"><code>tolower()</code></h4>
</div>
<div id="outline-container-org7574aa9" class="outline-4">
<h4 id="org7574aa9"><code>toupper()</code></h4>
</div>
</div>
</div>
<div id="outline-container-org8cb7e65" class="outline-2">
<h2 id="org8cb7e65"><span class="todo TODO">TODO</span> <code>&lt;mem&gt;</code> header</h2>
<div class="outline-text-2" id="text-org8cb7e65">
<p>
Functions for memory usage (FIXME: better description)
</p>
</div>
<div id="outline-container-org06e2d62" class="outline-3">
<h3 id="org06e2d62">Types</h3>
</div>
<div id="outline-container-org8c398be" class="outline-3">
<h3 id="org8c398be">Functions</h3>
<div class="outline-text-3" id="text-org8c398be">
</div>
<div id="outline-container-org2efbe6d" class="outline-4">
<h4 id="org2efbe6d">fn alloc(Size sz) (byte[]);</h4>
</div>
<div id="outline-container-orgf2b1244" class="outline-4">
<h4 id="orgf2b1244">fn free(byte[] ptr);</h4>
</div>
</div>
</div>
<div id="outline-container-org4377cae" class="outline-2">
<h2 id="org4377cae"><span class="todo TODO">TODO</span> <code>&lt;sys&gt;</code> header</h2>
<div class="outline-text-2" id="text-org4377cae">
</div>
<div id="outline-container-org9e32f46" class="outline-3">
<h3 id="org9e32f46">Types</h3>
<div class="outline-text-3" id="text-org9e32f46">
</div>
<div id="outline-container-org64d8817" class="outline-4">
<h4 id="org64d8817">Flag</h4>
</div>
</div>
<div id="outline-container-orgd77406c" class="outline-3">
<h3 id="orgd77406c">Functions</h3>
<div class="outline-text-3" id="text-orgd77406c">
</div>
<div id="outline-container-org4d31d31" class="outline-4">
<h4 id="org4d31d31">fn open(Path p, Flag flags) (File); // FIXME: should path be path<sub>t</sub> or string? should flags be flag<sub>t</sub> or string?</h4>
</div>
<div id="outline-container-org0be8e4c" class="outline-4">
<h4 id="org0be8e4c">fn read(File f, Size sz) (byte[]); // FIXME: maybe it should return something like byte[]</h4>
</div>
<div id="outline-container-org2c0e22d" class="outline-4">
<h4 id="org2c0e22d">fn write(File f, String str, {Size sz}) (Size);</h4>
</div>
<div id="outline-container-org573a1d7" class="outline-4">
<h4 id="org573a1d7">fn close(File f) (int);</h4>
</div>
</div>
<div id="outline-container-orgea33ee0" class="outline-3">
<h3 id="orgea33ee0"><span class="todo TODO">TODO</span> <code>&lt;sys/env&gt;</code> header</h3>
</div>
<div id="outline-container-org70b66fb" class="outline-3">
<h3 id="org70b66fb"><span class="todo TODO">TODO</span> <code>&lt;sys/signal&gt;</code> header</h3>
</div>
<div id="outline-container-orgb8f0693" class="outline-3">
<h3 id="orgb8f0693"><span class="todo TODO">TODO</span> <code>&lt;sys/path&gt;</code> header</h3>
</div>
<div id="outline-container-org5ea6a03" class="outline-3">
<h3 id="org5ea6a03"><span class="todo TODO">TODO</span> <code>&lt;sys/syscall&gt;</code> header</h3>
<div class="outline-text-3" id="text-org5ea6a03">
</div>
<div id="outline-container-orga96988a" class="outline-4">
<h4 id="orga96988a">Types</h4>
</div>
<div id="outline-container-org8256c7a" class="outline-4">
<h4 id="org8256c7a">Functions</h4>
<div class="outline-text-4" id="text-org8256c7a">
</div>
<ul class="org-ul">
<li><a id="orgbcd535c"></a>fn syscall(long number, {arguments}) (long); // FIXME<br /></li>
</ul>
</div>
</div>
</div>
<div id="outline-container-orgd0d0efb" class="outline-2">
<h2 id="orgd0d0efb"><span class="todo TODO">TODO</span> <code>&lt;time&gt;</code> header</h2>
</div>
<div id="outline-container-orgfd78cb0" class="outline-2">
<h2 id="orgfd78cb0"><span class="todo TODO">TODO</span> <code>&lt;random&gt;</code> header</h2>
</div>
<div id="outline-container-org663a9a8" class="outline-2">
<h2 id="org663a9a8"><span class="todo TODO">TODO</span> <code>&lt;regex&gt;</code> header</h2>
</div>
<div id="outline-container-org2f9b363" class="outline-2">
<h2 id="org2f9b363"><span class="todo TODO">TODO</span> <code>&lt;math&gt;</code> header</h2>
</div>
<div id="outline-container-org8700ac4" class="outline-2">
<h2 id="org8700ac4"><span class="todo TODO">TODO</span> <code>&lt;error&gt;</code> header</h2>
<div class="outline-text-2" id="text-org8700ac4">
</div>
<div id="outline-container-orgbf4763f" class="outline-3">
<h3 id="orgbf4763f">Types</h3>
<div class="outline-text-3" id="text-orgbf4763f">
</div>
<div id="outline-container-org06f5f4b" class="outline-4">
<h4 id="org06f5f4b">Err // FIXME: maybe move to builtins</h4>
</div>
</div>
<div id="outline-container-org837193d" class="outline-3">
<h3 id="org837193d">Functions</h3>
</div>
</div>
<div id="outline-container-org7ab734d" class="outline-2">
<h2 id="org7ab734d"><span class="todo TODO">TODO</span> <code>&lt;num&gt;</code> header (maybe other name would be better)</h2>
<div class="outline-text-2" id="text-org7ab734d">
<p>
For bigger integers and floats
</p>
</div>
<div id="outline-container-org6620ffb" class="outline-3">
<h3 id="org6620ffb">Types</h3>
<div class="outline-text-3" id="text-org6620ffb">
</div>
<div id="outline-container-orgebfeb79" class="outline-4">
<h4 id="orgebfeb79">int8</h4>
</div>
<div id="outline-container-org6cdd5dc" class="outline-4">
<h4 id="org6cdd5dc">int16</h4>
</div>
<div id="outline-container-org128b694" class="outline-4">
<h4 id="org128b694">int32</h4>
</div>
<div id="outline-container-org893f7fe" class="outline-4">
<h4 id="org893f7fe">int64</h4>
</div>
<div id="outline-container-orgb849d32" class="outline-4">
<h4 id="orgb849d32">uint8</h4>
</div>
<div id="outline-container-org88aa40f" class="outline-4">
<h4 id="org88aa40f">uint16</h4>
</div>
<div id="outline-container-orgaa22326" class="outline-4">
<h4 id="orgaa22326">uint32</h4>
</div>
<div id="outline-container-org198cea7" class="outline-4">
<h4 id="org198cea7">uint64</h4>
</div>
<div id="outline-container-orgb57516c" class="outline-4">
<h4 id="orgb57516c">float8</h4>
</div>
<div id="outline-container-orgbb4db72" class="outline-4">
<h4 id="orgbb4db72">float16</h4>
</div>
<div id="outline-container-org22caaf5" class="outline-4">
<h4 id="org22caaf5">float32</h4>
</div>
<div id="outline-container-org70cd4fa" class="outline-4">
<h4 id="org70cd4fa">float64</h4>
</div>
</div>
<div id="outline-container-org23af794" class="outline-3">
<h3 id="org23af794">Functions</h3>
</div>
</div>
<div id="outline-container-orge8b5d42" class="outline-2">
<h2 id="orge8b5d42"><span class="todo TODO">TODO</span> <code>&lt;net&gt;</code> header (maybe should be in other library)</h2>
</div>
</div>
</body>
</html>