urbit/base/pub/doc/hoon/library/2ef.md

section 2eF, parsing (ascii)
============================

<h3 id="++ace"><code>++ace</code></h3>

Parse space

    ++  ace  (just ' ')

Parses ASCII character 32, space.

    ~zod/try=> (scan " " ace)
    ~~. 
    ~zod/try=> `cord`(scan " " ace)
    ' '
    ~zod/try=> (ace [[1 1] " "])
    [p=[p=1 q=2] q=[~ [p=~~. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (ace [[1 1] " abc "])
    [p=[p=1 q=2] q=[~ [p=~~. q=[p=[p=1 q=2] q="abc "]]]]

------------------------------------------------------------------------

<h3 id="++bar"><code>++bar</code></h3>

Parse vertical bar

    ++  bar  (just '|')

Parses ASCII character 124, the vertical bar.

    ~zod/try=> (scan "|" bar)
    ~~~7c. 
    ~zod/try=> `cord`(scan "|" bar)
    '|'
    ~zod/try=> (bar [[1 1] "|"])
    [p=[p=1 q=2] q=[~ [p=~~~7c. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (bar [[1 1] "|="])
    [p=[p=1 q=2] q=[~ [p=~~~7c. q=[p=[p=1 q=2] q="="]]]]

------------------------------------------------------------------------

<h3 id="++bas"><code>++bas</code></h3>

Parse backslash

    ++  bas  (just '\\')

Parses ASCII character 92, the backslash. Note the extra `\` in the slam
of `bas` with [`++just`](/doc/hoon/library/2ec#++just) is to escape the escape character, `\`.

    ~zod/try=> (scan "\\" bas)
    ~~~5c.
    ~zod/try=> `cord`(scan "\\" bas)
    '\'
    ~zod/try=> (bas [[1 1] "\"])
    ~ <syntax error at [1 18]>
    ~zod/try=> (bas [[1 1] "\\"])
    [p=[p=1 q=2] q=[~ [p=~~~5c. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (bas [[1 1] "\""])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++buc"><code>++buc</code></h3>

Parse dollar sign

    ++  buc  (just '$')

Parses ASCII character 36, the dollar sign.

    ~zod/try=> (scan "$" buc)
    ~~~24.
    ~zod/try=> `cord`(scan "$" buc)
    '$'
    ~zod/try=> (buc [[1 1] "$"])
    [p=[p=1 q=2] q=[~ [p=~~~24. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (buc [[1 1] "$%"])
    [p=[p=1 q=2] q=[~ [p=~~~24. q=[p=[p=1 q=2] q="%"]]]]

------------------------------------------------------------------------

<h3 id="++cab"><code>++cab</code></h3>

Parse underscore

    ++  cab  (just '_')

Parses ASCII character 95, the underscore.

    ~zod/try=> (scan "_" cab)
    ~~~5f.
    ~zod/try=> `cord`(scan "_" cab)
    '_'
    ~zod/try=> (cab [[1 1] "_"])
    [p=[p=1 q=2] q=[~ [p=~~~5f. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (cab [[1 1] "|_"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++cen"><code>++cen</code></h3>

Parses percent sign

    ++  cen  (just '%')

Parses ASCII character 37, the percent sign.

    ~zod/try=> (scan "%" cen)
    ~~~25.
    ~zod/try=> `cord`(scan "%" cen)
    '%'
    ~zod/try=> (cen [[1 1] "%"])
    [p=[p=1 q=2] q=[~ [p=~~~25. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (cen [[1 1] "%^"])
    [p=[p=1 q=2] q=[~ [p=~~~25. q=[p=[p=1 q=2] q="^"]]]] 

------------------------------------------------------------------------

<h3 id="++col"><code>++col</code></h3>

Parse colon

    ++  col  (just ':')

Parses ASCII character 58, the colon

    ~zod/try=> (scan ":" col)
    ~~~3a.
    ~zod/try=> `cord`(scan ":" col)
    ':'
    ~zod/try=> (col [[1 1] ":"])
    [p=[p=1 q=2] q=[~ [p=~~~3a. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (col [[1 1] ":-"])
    [p=[p=1 q=2] q=[~ [p=~~~3a. q=[p=[p=1 q=2] q="-"]]]]

------------------------------------------------------------------------

<h3 id="++com"><code>++com</code></h3>

Parse comma

    ++  com  (just ',')

Parses ASCII character 44, the comma.

    ~zod/try=> (scan "," com)
    ~~~2c.
    ~zod/try=> `cord`(scan "," com)
    ','
    ~zod/try=> (com [[1 1] ","])
    [p=[p=1 q=2] q=[~ [p=~~~2c. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (com [[1 1] "not com"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++doq"><code>++doq</code></h3>

Parse double quote

    ++  doq  (just '"')

Parses ASCII character 34, the double quote.

    ~tadbyl-hilbel/try=> (scan "\"" doq)
    ~~~22.
    ~tadbyl-hilbel/try=> `cord`(scan "\"" doq)
    '"'
    ~tadbyl-hilbel/try=> (doq [[1 1] "\""])
    [p=[p=1 q=2] q=[~ [p=~~~22. q=[p=[p=1 q=2] q=""]]]]
    ~tadbyl-hilbel/try=> (doq [[1 1] "not successfully parsed"])
    [p=[p=1 q=1] q=~]
    ~tadbyl-hilbel/try=> (scan "see?" doq)
    ! {1 1}
    ! 'syntax-error'
    ! exit 

------------------------------------------------------------------------

<h3 id="++dot"><code>++dot</code></h3>

Parse period

    ++  dot  (just '.')

Parses ASCII character 46, the period.

    ~zod/try=> (scan "." dot)
    ~~~.
    ~zod/try=> `cord`(scan "." dot)
    '.'
    ~zod/try=> (dot [[1 1] "."])
    [p=[p=1 q=2] q=[~ [p=~~~. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (dot [[1 1] ".^"])
    [p=[p=1 q=2] q=[~ [p=~~~. q=[p=[p=1 q=2] q="^"]]]]

------------------------------------------------------------------------

<h3 id="++fas"><code>++fas</code></h3>

Parse forward slash

    ++  fas  (just '/')

Parses ASCII character 47, the forward slash.

    ~zod/try=> (scan "/" fas)
    ~~~2f.
    ~zod/try=> `cord`(scan "/" fas)
    '/'
    ~zod/try=> (fas [[1 1] "/"])
    [p=[p=1 q=2] q=[~ [p=~~~2f. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (fas [[1 1] "|/"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++gal"><code>++gal</code></h3>

Parse less-than sign

    ++  gal  (just '<')

Parses ASCII character 60, the less-than sign.

    ~zod/try=> (scan "<" gal)
    ~~~3c.
    ~zod/try=> `cord`(scan "<" gal)
    '<'
    ~zod/try=> (gal [[1 1] "<"])
    [p=[p=1 q=2] q=[~ [p=~~~3c. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (gal [[1 1] "<+"])
    [p=[p=1 q=2] q=[~ [p=~~~3c. q=[p=[p=1 q=2] q="+"]]]]
    ~zod/try=> (gal [[1 1] "+<"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++gar"><code>++gar</code></h3>

Parse greater-than sign

    ++  gar  (just '>')

Parses ASCII character 62, the greater-than sign.

    ~zod/try=> (scan ">" gar)
    ~~~3e.
    ~zod/try=> `cord`(scan ">" gar)
    '>'
    ~zod/try=> (gar [[1 1] ">"])
    [p=[p=1 q=2] q=[~ [p=~~~3e. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (gar [[1 1] "=>"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++hax"><code>++hax</code></h3>

Parse number sign

    ++  hax  (just '#')

Parses ASCII character 35, the number sign.

    ~zod/try=> (scan "#" hax)
    ~~~23.
    ~zod/try=> `cord`(scan "#" hax)
    '#'
    ~zod/try=> (hax [[1 1] "#"])
    [p=[p=1 q=2] q=[~ [p=~~~23. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (hax [[1 1] "#!"])
    [p=[p=1 q=2] q=[~ [p=~~~23. q=[p=[p=1 q=2] q="!"]]]]

------------------------------------------------------------------------

<h3 id="++kel"><code>++kel</code></h3>

Parse left curley bracket

    ++  kel  (just '{')

Parses ASCII character 123, the left curly bracket. Note that `{`
(`kel`) and `}` (`ker`) open and close a Hoon expression for Hoon string
interpolation. To parse either of them, they must be escaped.

    ~zod/try=> (scan "\{" kel)
    ~~~7b.
    ~zod/try=> `cord`(scan "\{" kel)
    '{'
    ~zod/try=> (kel [[1 1] "\{"])
    [p=[p=1 q=2] q=[~ [p=~~~7b. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (kel [[1 1] " \{"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++ker"><code>++ker</code></h3>

Parse right curley bracket

    ++  ker  (just '}')

Parses ASCII character 125, the right curly bracket. Note that `{`
(`kel`) and `}` (`ker`) open and close a Hoon expression for Hoon string
interpolation. To parse either of them, they must be escaped.

    ~zod/try=> (scan "}" ker)
    ~~~7d.
    ~zod/try=> `cord`(scan "}" ker)
    '}'
    ~zod/try=> (ker [[1 1] "}"])
    [p=[p=1 q=2] q=[~ [p=~~~7d. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (ker [[1 1] "\{}"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++ket"><code>++ket</code></h3>

Parse caret

    ++  ket  (just '^')

Parses ASCII character 94, the caret.

    ~zod/try=> (scan "^" ket)
    ~~~5e.
    ~zod/try=> `cord`(scan "^" ket)
    '^'
    ~zod/try=> (ket [[1 1] "^"])
    [p=[p=1 q=2] q=[~ [p=~~~5e. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (ket [[1 1] ".^"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++lus"><code>++lus</code></h3>

Parse plus sign

    ++  lus  (just '+')

Parses ASCII character 43, the plus sign.

        ~zod/try=> (scan "+" lus)
        ~~~2b.
        ~zod/try=> `cord`(scan "+" lus)
        '+'
        ~zod/try=> (lus [[1 1] "+"])
        [p=[p=1 q=2] q=[~ [p=~~~2b. q=[p=[p=1 q=2] q=""]]]]
        ~zod/try=> (lus [[1 1] ".+"])
        [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++hep"><code>++hep</code></h3>

Parse hyphen

    ++  hep  (just '-')

Parses ASCII character 45, the hyphen.

    ~zod/try=> (scan "-" hep)
    ~~-
    ~zod/try=> `cord`(scan "-" hep)
    '-'
    ~zod/try=> (hep [[1 1] "-"])
    [p=[p=1 q=2] q=[~ [p=~~- q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (hep [[1 1] ":-"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++pel"><code>++pel</code></h3>

Parse left parenthesis

    ++  pel  (just '(')

Parses ASCII character 40, the left parenthesis.

    ~zod/try=> (scan "(" pel)
    ~~~28.
    ~zod/try=> `cord`(scan "(" pel)
    '('
    ~zod/try=> (pel [[1 1] "("])
    [p=[p=1 q=2] q=[~ [p=~~~28. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (pel [[1 1] ";("])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++pam"><code>++pam</code></h3>

Parse ampersand

    ++  pam  (just '&')

Parses ASCII character 38, the ampersand.

    ~zod/try=> (scan "&" pam)
    ~~~26.
    ~zod/try=> `cord`(scan "&" pam)
    '&'
    ~zod/try=> (pam [[1 1] "&"])
    [p=[p=1 q=2] q=[~ [p=~~~26. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (pam [[1 1] "?&"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++per"><code>++per</code></h3>

Parse right parenthesis

    ++  per  (just ')')

Parses ASCII character 41, the right parenthesis.

    ~zod/try=> (scan ")" per)
    ~~~29.
    ~zod/try=> `cord`(scan ")" per)
    ')'
    ~zod/try=> (per [[1 1] ")"])
    [p=[p=1 q=2] q=[~ [p=~~~29. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (per [[1 1] " )"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++pat"><code>++pat</code></h3>

Parse "at" sign

    ++  pat  (just '@')

Parses ASCII character 64, the "at" sign.

    ~zod/try=> (scan "@" pat)
    ~~~4.
    ~zod/try=> `cord`(scan "@" pat)
    '@'
    ~zod/try=> (pat [[1 1] "@"])
    [p=[p=1 q=2] q=[~ [p=~~~4. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (pat [[1 1] "?@"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++sel"><code>++sel</code></h3>

Parse left square bracket

Left square bracket

    ++  sel  (just '[')

Parses ASCII character 91, the left square bracket.

        ~zod/try=> (scan "[" sel)
        ~~~5b.
        ~zod/try=> `cord`(scan "[" sel)
        '['
        ~zod/try=> (sel [[1 1] "["])
        [p=[p=1 q=2] q=[~ [p=~~~5b. q=[p=[p=1 q=2] q=""]]]]
        ~zod/try=> (sel [[1 1] "-["])
        [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++sem"><code>++sem</code></h3>

Parse semicolon

    ++  sem  (just ';')

Parses ASCII character 59, the semicolon.

<h3 id="Examples"><code>Examples</code></h3>

    ~zod/try=> (scan ";" sem)
    ~~~3b.
    ~zod/try=> `cord`(scan ";" sem)
    ';'
    ~zod/try=> (sem [[1 1] ";"])
    [p=[p=1 q=2] q=[~ [p=~~~3b. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (sem [[1 1] " ;"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++ser"><code>++ser</code></h3>

Parse right square bracket

    ++  ser  (just ']')

Parses ASCII character 93, the right square bracket.

    ~zod/try=> (scan "]" ser)
    ~~~5d.
    ~zod/try=> `cord`(scan "]" ser)
    ']'
    ~zod/try=> (ser [[1 1] "]"])
    [p=[p=1 q=2] q=[~ [p=~~~5d. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (ser [[1 1] "[ ]"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++sig"><code>++sig</code></h3>

Parse tilde

    ++  sig  (just '~')

Parses ASCII character 126, the tilde.

    ~zod/try=> (scan "~" sig)
    ~~~~
    ~zod/try=> `cord`(scan "~" sig)
    '~'
    ~zod/try=> (sig [[1 1] "~"])
    [p=[p=1 q=2] q=[~ [p=~~~~ q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (sig [[1 1] "?~"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++soq"><code>++soq</code></h3>

Parse single quote

    ++  soq  (just '\'')

Parses ASCII character 39, soq. Note the extra '' is to escape the first
`soq` because soq delimits a cord.

    ~zod/try=> (scan "'" soq)
    ~~~27.
    ~zod/try=> `cord`(scan "'" soq)
    '''
    ~zod/try=> (soq [[1 1] "'"])
    [p=[p=1 q=2] q=[~ [p=~~~27. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (soq [[1 1] ">'"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++tar"><code>++tar</code></h3>

Parse asterisk

    ++  tar  (just '*')

Parses ASCII character 42, the asterisk.

    ~zod/try=> (scan "*" tar)
    ~~~2a.
    ~zod/try=> `cord`(scan "*" tar)
    '*'
    ~zod/try=> (tar [[1 1] "*"])
    [p=[p=1 q=2] q=[~ [p=~~~2a. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (tar [[1 1] ".*"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++tec"><code>++tec</code></h3>

Parse backtick

    ++  tec  (just '`')                                     ::  backTiCk

Parses ASCII character 96, the backtick (also known as the "grave
accent".

    ~zod/try=> (scan "`" tec)
    ~~~6.
    ~zod/try=> `cord`(scan "`" tec)
    '`'
    ~zod/try=> (tec [[1 1] "`"])
    [p=[p=1 q=2] q=[~ [p=~~~6. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (tec [[1 1] " `"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++tis"><code>++tis</code></h3>

Parse equals sign

    ++  tis  (just '=')

Parses ASCII character 61, the equals sign.

    ~zod/try=> (scan "=" tis)
    ~~~3d.
    ~zod/try=> `cord`(scan "=" tis)
    '='
    ~zod/try=> (tis [[1 1] "="])
    [p=[p=1 q=2] q=[~ [p=~~~3d. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (tis [[1 1] "|="])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++wut"><code>++wut</code></h3>

Parses question mark

    ++  wut  (just '?')

Parses ASCII character 63, wut.

    ~zod/try=> (scan "?" wut)
    ~~~3f.
    ~zod/try=> `cord`(scan "?" wut)
    '?'
    ~zod/try=> (wut [[1 1] "?"])
    [p=[p=1 q=2] q=[~ [p=~~~3f. q=[p=[p=1 q=2] q=""]]]]
    ~zod/try=> (wut [[1 1] ".?"])
    [p=[p=1 q=1] q=~]

------------------------------------------------------------------------

<h3 id="++zap"><code>++zap</code></h3>

Exclamation point

    ++  zap  (just '!')

Parses ASCII character 33, the exclamation point zap.

        ~zod/try=> (scan "!" zap)
        ~~~21.
        ~zod/try=> `cord`(scan "!" zap)
        '!'
        ~zod/try=> (zap [[1 1] "!"])
        [p=[p=1 q=2] q=[~ [p=~~~21. q=[p=[p=1 q=2] q=""]]]]
        ~zod/try=> (zap [[1 1] "?!"])
        [p=[p=1 q=1] q=~]

------------------------------------------------------------------------