Liking cljdoc? Tell your friends :D

fr.jeremyschoffen.prose.alpha.reader.grammar

Prose's grammar, turn text into data that can be turned into clojure code.

Prose's grammar, turn text into data that can be turned into clojure code.
raw docstring

all-delimitorsclj/s


all-grammatical-rulesclj/s

Merging of the lexer rules and the grammatical rules.

Merging of the lexer rules and the grammatical rules.
raw docstring

any-charclj/s

Any character whatsoever.

Any character whatsoever.
raw docstring

anythingclj/s


bracesclj/s


bracketsclj/s


clojure-call-textclj/s

Clojure text found in clojure calls (enclosed in parens).

Clojure text found in clojure calls (enclosed in parens).
raw docstring

clojure-stringclj/s

Text found in clojure strings.

Text found in clojure strings.
raw docstring

close-braceclj/s


close-bracketclj/s


close-parenclj/s


complex-symbolclj/s


double-quoteclj/s


enclosed-gclj/s

Grammatical describing text enclosed in balanced marker: quotes, parenthesis..;

Grammatical describing text enclosed in balanced marker: quotes, parenthesis..;
raw docstring

escapeclj/s


escape-charclj/s

The escaping character

The escaping character
raw docstring

general-gclj/s

The general grammar, tying the lexer and the enclosed rules together with the top grammatical rules.

The general grammar, tying the lexer and the enclosed rules together with the top grammatical rules.
raw docstring

grammarclj/s

The proper grammar in map form.

It is an updated all-grammatical-rules in regards to hidden-tags hidden-results.

The proper grammar in map form.

It is an updated [[all-grammatical-rules]] in regards to [[hidden-tags]] [[hidden-results]].
raw docstring

hidden-resultsclj/s

Names of rules whose productions are completely hidden.

Names of rules whose productions are completely hidden.
raw docstring

hidden-tagsclj/s

Names of additional grammatical rules that have their tag hidden.

Names of additional grammatical rules that have their tag hidden.
raw docstring

lexerclj/s

The proper lexer, a version of lexer* where each rule has its tag hidden.

The proper lexer, a version of [[lexer*]] where each rule has its tag hidden.
raw docstring

lexer*clj/s

Our lexer, an incomplete instaparse grammar in map form containing only regex rules.

Our lexer, an incomplete instaparse grammar in map form containing only regex rules.
raw docstring

macro-reader-charclj/s


ns-endclj/s


open-braceclj/s


open-bracketclj/s


open-parenclj/s


parensclj/s


parserclj/s

Instaparse parser made from grammar

Instaparse parser made from [[grammar]]
raw docstring

pipeclj/s


pipe-charclj/s

The pipe character found between the special character and a symbol when directly using a symbol in text.

The pipe character found between the special character and a symbol when directly using a symbol in text.
raw docstring

plain-textclj/s

Text to be interpreted as plain text, neither clojure code, nor special blocks of text. Basically any character excluding diamond which have special meaning.

Text to be interpreted as plain text, neither clojure code, nor special blocks of text.
Basically any character excluding diamond which have special meaning.
raw docstring

simple-symbolclj/s

Regex for the ns name of a symbol, parses dot separated names until a final name.

Regex for the ns name of a symbol, parses dot separated names until
a final name.
raw docstring

specialclj/s


special-charclj/s

The special character that denotes embedded code.

The special character that denotes embedded code.
raw docstring

symbol-excluded-charsetclj/s


symbol-first-charclj/s

In the case of the first character of a symbol name, there are more forbidden chars:

  • digits aren't allowed as first character
  • the macro reader char # isn't allowed either.
In the case of the first character of a symbol name, there are more forbidden chars:
- digits aren't allowed as first character
- the macro reader char `#` isn't allowed either.
raw docstring

symbol-regular-charclj/s

Characters that are always forbidden in symbol names:

  • spaces
  • diamond char since it starts another grammatical rule
  • delimitors: parens, brackets, braces and double quotes.
  • / since it the special meaning of separating the namespace from the symbol name.
  • . since it has the special meaning of separating symbol names.
  • \ since it is reserved by clojure to identify a literal character.
Characters that are always forbidden in symbol names:
- spaces
- diamond char since it starts another grammatical rule
- delimitors: parens, brackets, braces  and double quotes.
- `/` since it the special meaning of separating the namespace from the symbol name.
- `.` since it has the special meaning of separating symbol names.
- `\` since it is reserved by clojure to identify a literal character.
raw docstring

symbol-textclj/s

Regex used when parsing a symbol.

Regex used when parsing a symbol.
raw docstring

tag-clj-arg-textclj/s

Clojure text found in clojure arguments to tag fns (enclosed in brackets).

Clojure text found in clojure arguments to tag fns (enclosed in brackets).
raw docstring

tag-spacesclj/s

Spaces found in-between tag args.

Spaces found in-between tag args.
raw docstring

tag-text-arg-textclj/s

Regular text found in text arguments to tag fns (enclosed in braces).

Regular text found in text arguments to tag fns (enclosed in braces).
raw docstring

verbatim-textclj/s

Text found in verbatim blocks.

Text found in verbatim blocks.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close