Headings contain runes, phonetics and tokens. Description contains a link to the docs and a short description of the rune. Both regular (R) and irregular (I) forms are given.
Ctrl-f to find out the meaning of something weird you saw? Search for
\=. It'll show you to the irregular forms that uses that symbol.
. dot (nock)
Anything Nock can do, Hoon can do also.
[%dtls p=atom]: increment an atom with Nock 4.
[%dtls p=hoon q=hoon]: test for equality with Nock 5.
; mic (make)
Miscellaneous useful macros.
[%smcl p=hoon q=(list hoon)]: call a binary function as an n-ary function.
: col (cells)
The cell runes.
[%clhp p=hoon q=hoon]: construct a cell (2-tuple).
[a b] ==> :-(a b) [a b c] ==> [a [b c]] a^b^c ==> [a b c] a/b ==> [%a b] `a ==> [~ a] ~[a b] ==> [a b ~] [a b]~ ==> [[a b] ~]
= tis (flow)
Flow hoons change the subject. All non-flow hoons (except cores) pass the subject down unchanged.
[%tsgl p=hoon q=hoon]: compose two hoons, inverted.
| bar (core)
docs \$ Core hoons are flow hoon.
Technically not irregular syntax, but worth mentioning.
The above runes produce a core with a single arm, named
$ ("buc"). We can recompute this arm with changes, useful for recursion among other things. Commonly used with the irregular syntax for
:make, like so:
% cen (call)
The invocation family of runes.
[%cnts p=wing q=(list (pair wing hoon))]: take a wing with changes.
%=(p a 1)
[%cnsg p=wing q=hoon r=hoon]: call with multi-armed door.
%~(p q r)
~(p q r)
[%cnhp p=hoon q=hoon]: call a gate (function).
=<($ p)), which behaves as you would expect (func call w/o args).
$ buc (mold)
A mold is a gate (function) that helps us build simple and rigorous data structures.
[%bcwt p=(list model)]: mold which normalizes a general union.
[%bccb p=value]: mold which normalizes to an example.
? wut (test)
Hoon has the usual branches and logical tests.
[%wtzp p=hoon]: logical not.
[%wtpm p=(list hoon)]: logical and.
[%wtbr p=(list hoon)]: logical or.
^ ket (cast)
Lets us adjust types without violating type constraints.
[%kthp p=model q=value]: typecast by mold.
[%ktts p=toga q=value]: name a value.
acan be an ((ir)regularly defined) atom or a symbol.
See %sand for other irregular definitions of atoms.
&nnth element of a list.
|ntail of list after nth element (i.e. n is the head).
[%limb p=(each @ud [p=@ud q=@tas])]: attribute of subject.
+15is slot 15
.is the whole subject (slot 1)
a"of a higher scope", i.e. "resolve variable a, ignoring the first one found".
^^peven higher, etc.
- 'Lark' syntax for slots / tree addressing:
+1 +2 - +3 + +4 -< +5 -> +6 +< +7 +> +8 -<- ...
[%wing p=(list limb)]; a limb search path.
a.b finds limb
a within limb
a within "var"
In our in-house examples throughout our documentation, we use irregular forms instead of regular for the sake of verbosity. But remember with irregular forms: everything is just runes! Like magic. In general, irregular forms (usually) read better, but of course regular forms provide more information about what you're doing by showing you the full rune. Of course, it's up to you, the Hoon programmer, as to whether or not you want to use these.