cljstyle.format.zloc — mvxcvi/cljstyle 0.15.0

Common utility functions for using rewrite-clj zippers and editing forms.

comment? clj

(comment? zloc)

True if the node at this location is a comment.

discard-macro? clj

(discard-macro? zloc)

True if the node at this location is a discard reader macro.

eat-whitespace clj

(eat-whitespace zloc)

Eat whitespace characters, leaving the zipper located at the next non-whitespace node.

edit-scan clj

(edit-scan zloc f)

Scan rightward from the given location, editing nodes by applying the given function. Returns the final zipper location.

edit-walk clj

(edit-walk zloc f)

Visit all nodes in zloc by applying the given function. Returns the final zipper location.

form-symbol clj

(form-symbol zloc)

Return a name-only symbol for the leftmost node from this location.

form-symbol-full clj

(form-symbol-full zloc)

Return the symbol in the leftmost node from this location.

ignored-form? clj

(ignored-form? zloc)

True if the node at this location is an ignored form.

keyword? clj

(keyword? zloc)

True if the node at this location is a keyword.

line-break clj

(line-break zloc)

Ensure the node at this location breaks onto a new line. Returns the zipper at the location following the whitespace, if there is one.

line-join clj

(line-join zloc)

Ensure the node at this location joins onto the same line. Returns the zipper at the location following the whitespace.

move-n clj

(move-n zloc move n)

Repeatedly move in a direction n times.

multiline? clj

(multiline? zloc)

True if the form at this location spans more than one line.

reader-conditional? clj

(reader-conditional? zloc)

True if the node at this location is a reader conditional form.

reader-macro? clj

(reader-macro? zloc)

True if the node at this location is a reader macro expression.

replace-with-blank-lines clj

(replace-with-blank-lines zloc n)

Replace all whitespace at the location with n blank lines.

root? clj

(root? zloc)

True if this location is the root node.

safe-edit clj

(safe-edit f zloc & args)

Wrap an editing function with error handling logic which will capture information about the surrounding form and the cause of the failure.

skip-next clj

(skip-next zloc)

Like z/next*, but skips the current location instead of visiting and descending into it.

skip-whitespace clj

(skip-whitespace zloc)

Skip to the location of the next non-whitespace node.

space? clj

(space? zloc)

True if the node at this location is whitespace and not a line break character.

string? clj

(string? zloc)

True if the node at this location is a string.

syntax-quoted? clj

(syntax-quoted? zloc)

True if the location is inside a macro syntax quote.

token-value clj

(token-value zloc)

Return the s-expression form of the token at this location.

token? clj

(token? zloc)

True if the node at this location is a token.

unwrap-meta clj

(unwrap-meta zloc)

If this location is a metadata node, recursively unwrap it and return the location of the nested value form. Otherwise returns the location unchanged.

whitespace-after? clj

(whitespace-after? match? zloc)

True if the location is a whitespace node preceding a location matching match?.

whitespace-before? clj

(whitespace-before? match? zloc)

True if the location is a whitespace node preceding a location matching match?.

whitespace-between? clj

(whitespace-between? pre? post? zloc)

True if the location is whitespace between locations matching pre? and post?, with nothing but whitespace between.

zprn clj

(zprn zloc tag)

Print a zipper location for debugging purposes. Returns the location unchanged.

zstr clj

(zstr zloc)

Return the string representation of the nodes at the given location.