ont-app.vocabulary.format — ont-app/vocabulary 0.5.0

Logic to handle all the various escapes and en/decoding required for URIs and keywords.

cljs-kw-escapes clj/s

A map {kw-char escape-string, ...}, for keyword-invalid chars under cljs.

cljs-uri-escapes clj/s

A direct copy of (io/resource 'uri-escapes.edn'), for use in cljs.

decode-kw-name clj/s

(decode-kw-name kw-name)

Inverse of encode-kw-name. Returns original value of kw-name. Where kw-name is a string, typically the name string of a KWI.

decode-kw-ns clj/s

(decode-kw-ns kw-ns)

Returns kw-ns with any escapes translated.

decode-uri-string clj/s

(decode-uri-string s)

Inverts URI escapes in s. Inverse of encode-uri-string.

encode-kw-name clj/s

(encode-kw-name kw-name)

Returns kw-name, modified to bet reader-safe. Derived s.t. when used as the name component of some kw, kw will not choke the reader. Inverse of decode-kw-name Where

• `kw-name`` is a string
• kw is a keyword := :ns/s

encode-kw-ns clj/s

(encode-kw-ns kw-ns)

Returns kw-ns, modified to be reader-safe. Derived s.t. when used as the namespace component of some kw, kw will not choke the reader. Inverse of decode-kw-name. Where

• `kw-ns`` is a string
• kw is a keyword := :ns/s

encode-uri-string clj/s

(encode-uri-string s)

Renders s in a form that can be parsed as a URI.

escape-slash clj/s

(escape-slash s)

Replaces a slash in s with a backslash-escaped slash.

escape-utf-8 clj/s

(escape-utf-8 c)

Returns a string for c, escaped as its hex equivalent.

escapes-re clj/s

(escapes-re inverted-escapes-map)

Returns a regex to recognize escape patterns in an encoded string per inverted-escapes-map. Where

• inverted-escapes-map := {escape-pattern original, ...}

generate-kwi-escapes clj

(generate-kwi-escapes)

Side-effects: writes uri-escapes.edn and uri-escapes-inverted.edn. These are used to cache values used in clj/s to escape URIs Note: typically used once to populate the resources.

generate-uri-escapes clj

(generate-uri-escapes)

Side-effects: writes uri-escapes.edn and uri-escapes-inverted.edn. These are used to cache values used in clj/s to escape URIs Note: typically used once to populate the resources.

get-escapes clj

(get-escapes char-test escape-fn)

(get-escapes char-test escape-fn key-fn)

Returns {test-breaker escaped, ...} for char-test and escape-fn.

• Where
  • test-breaker is a char that breaks char-test
  • escaped is a string escaping c
  • char-test := fn [c] -> true if the char does not need escaping
  • escape-fn := fn [c] -> escaped
• NOTE: typically called once and stored as a static resource.

invert-escape-map clj/s

A fn [{escaped-char escape-str, ...}] -> {escape-str escaped-char-str, ...}.

kw-escapes clj/s

Escapes map for keywords.

kw-escapes-inverted clj/s

Maps escaped characters to the originals.

kw-escapes-re clj/s

A regex to recognize when a string contains escapes.

kw-terminal-escapes clj/s

Escapes for characters forbidden a the end of a keyword.

kw-test clj/s

(kw-test c)

True when c is problem-free in keywords. Typically used in creataing edn files to inform encoding/decoding keywords

unescaped-slash-re clj/s

Matches a string preceded by a backslash escape.

uri-escapes clj/s

A map {c escape-str, ...} for characters that break a URI string.

uri-escapes-inverted clj/s

A map {escape-str char-str, ...} to decode escaped URI strings.

uri-escapes-re clj/s

A regex to replace escape strings with the original escaped char.

uri-string? clj

(uri-string? s)

True iff s is a valid URI string.

uri-test clj/s

(uri-test c)

True when c is problem-free in java URIs. Typically used to create an edn file to inform encoding/decoding URI strings