scout.core — scout 0.1.1

beginning-of-line? clj

(beginning-of-line? scanner)

Return true if the current position is the beginning of a line.

check clj

(check s pattern)

Returns what scan would return as its result.

check-until clj

(check-until s pattern)

Returns what scan-until would return as its match.

check-until-inclusive clj

(check-until-inclusive s pattern)

Returns the string between the scanner's starting position and the end of what scan-until would match.

end? clj

(end? scanner)

Return true if the current position is the end of the input string.

groups clj

(groups scanner)

Return the groups from the last match. Remember that the first group will be the complete match.

match-info clj

(match-info matcher)

(match-info start end)

(match-info start end groups)

matched clj

(matched scanner)

Return the last matched string.

peek clj

(peek s n)

Returns the string containing the next n characters after current location.

position clj

(position scanner)

Returns the current position in the string (an integer index).

post-match clj

(post-match scanner)

Return the 'post-match' of the last scan. This is the part of the input after the end of the last match.

pre-match clj

(pre-match scanner)

Return the 'pre-match' of the last scan. This is the part of the input before the beginning of the match.

remainder clj

(remainder scanner)

Return what remains of the string after the scan pointer.

scan clj

(scan s pattern)

Match pattern starting at current location. On match, advances the current location and puts the matched string in result. Otherwise, just returns the same scanner, minus any previous match data.

scan-until clj

(scan-until s pattern)

Match pattern at any point after the current location. On match, advances the current location to the end of the match, and puts just the matching part in the match info. Otherwise, just returns the same scanner, minus any previous match data.

scanner clj

(scanner source-string)

(scanner source-string pos)

(scanner source-string pos match)

Create a Scanner from a string. If the optional integer second argument is provided, it sets the scanner's current position to that index. If the optional third argument is provided, it must be a MatchInfo data structure which will be used as the scanner's latest match info.

skip-to-match-start clj

(skip-to-match-start s pattern)

Match pattern at any point after the current location. On match, advances the current location to the beginning of the match, so that a subsequent scan with the same pattern will succeed. Matched pattern is stored in the result. Otherwise, just returns the same scanner, minus any previous match data.