Class | Asciidoctor::Reader |
In: |
lib/asciidoctor/reader.rb
|
Parent: | Object |
Public: Advance to the next line by discarding the line at the front of the stack
direct - A Boolean flag to bypasses the check for more lines and immediately
returns the first element of the internal @lines Array. (default: true)
Returns a Boolean indicating whether there was a line to discard.
Public: Check whether there are any lines left to read.
If a previous call to this method resulted in a value of false, immediately returned the cached value. Otherwise, delegate to peek_line to determine if there is a next line available.
Returns True if there are more lines, False if there are not.
Public: Peek at the next line and check if it‘s empty (i.e., whitespace only)
This method Does not consume the line from the stack.
Returns True if the there are no more lines or if the next line is empty
Public: Peek at the next line of source data. Processes the line, if not already marked as processed, but does not consume it.
This method will probe the reader for more lines. If there is a next line that has not previously been visited, the line is passed to the Reader#process_line method to be initialized. This call gives sub-classess the opportunity to do preprocessing. If the return value of the Reader#process_line is nil, the data is assumed to be changed and Reader#peek_line is invoked again to perform further processing.
direct - A Boolean flag to bypasses the check for more lines and immediately
returns the first element of the internal @lines Array. (default: false)
Returns the next line of the source data as a String if there are lines remaining. Returns nothing if there is no more data.
Public: Peek at the next multiple lines of source data. Processes the lines, if not already marked as processed, but does not consume them.
This method delegates to Reader#read_line to process and collect the line, then restores the lines to the stack before returning them. This allows the lines to be processed and marked as such so that subsequent reads will not need to process the lines again.
num - The Integer number of lines to peek. direct - A Boolean indicating whether processing should be disabled when reading lines
Returns A String Array of the next multiple lines of source data, or an empty Array if there are no more lines in this Reader.
Internal: Prepare the lines from the provided data
This method strips whitespace from the end of every line of the source data and appends a LF (i.e., Unix endline). This whitespace substitution is very important to how Asciidoctor works.
Any leading or trailing blank lines are also removed.
data - A String Array of input data to be normalized opts - A Hash of options to control what cleansing is done
Internal: Processes a previously unvisited line
By default, this method marks the line as processed by incrementing the look_ahead counter and returns the line unmodified.
Returns The String line the Reader should make available to the next invocation of Reader#read_line or nil if the Reader should drop the line, advance to the next line and process it.
Public: Get the next line of source data. Consumes the line returned.
direct - A Boolean flag to bypasses the check for more lines and immediately
returns the first element of the internal @lines Array. (default: false)
Returns the String of the next line of the source data if data is present. Returns nothing if there is no more data.
Public: Get the remaining lines of source data.
This method calls Reader#read_line repeatedly until all lines are consumed and returns the lines as a String Array. This method differs from Reader#lines in that it processes each line in turn, hence triggering any preprocessors implemented in sub-classes.
Public: Return all the lines from `@lines` until we (1) run out them,
(2) find a blank line with :break_on_blank_lines => true, or (3) find a line for which the given block evals to true.
options - an optional Hash of processing options:
* :break_on_blank_lines may be used to specify to break on blank lines * :skip_first_line may be used to tell the reader to advance beyond the first line before beginning the scan * :preserve_last_line may be used to specify that the String causing the method to stop processing lines should be pushed back onto the `lines` Array. * :read_last_line may be used to specify that the String causing the method to stop processing lines should be included in the lines being returned
Returns the Array of lines forming the next segment.
Examples
data = [ "First line\n", "Second line\n", "\n", "Third line\n", ] reader = Reader.new data, nil, :normalize => true reader.read_lines_until => ["First line", "Second line"]
Public: Replace the next line with the specified line.
Calls Reader#advance to consume the current line, then calls Reader#unshift to push the replacement onto the top of the line stack.
replacement - The String line to put in place of the next line (i.e., the line at the cursor).
Returns nothing.
Public: Advance to the end of the reader, consuming all remaining lines
Returns nothing.