class RSTStateMachine(StateMachineWS):
reStructuredText's master StateMachine.
The entry point to reStructuredText parsing is the run()
method.
Method | run |
Parse input_lines and modify the document node in place. |
Instance Variable | document |
Undocumented |
Instance Variable | language |
Undocumented |
Instance Variable | match_titles |
Undocumented |
Instance Variable | memo |
Undocumented |
Instance Variable | node |
Undocumented |
Instance Variable | reporter |
Undocumented |
Inherited from StateMachineWS
:
Method | get_first_known_indented |
Return an indented block and info. |
Method | get_indented |
Return a block of indented lines of text, and info. |
Method | get_known_indented |
Return an indented block and info. |
Inherited from StateMachine
(via StateMachineWS
):
Method | __init__ |
Initialize a StateMachine object; add state objects. |
Method | abs_line_number |
Return line number of current line (counting from 1). |
Method | abs_line_offset |
Return line offset of current line, from beginning of file. |
Method | add_state |
Initialize & add a state_class (State subclass) object. |
Method | add_states |
Add state_classes (a list of State subclasses). |
Method | at_bof |
Return 1 if the input is at or before beginning-of-file. |
Method | at_eof |
Return 1 if the input is at or past end-of-file. |
Method | attach_observer |
The observer parameter is a function or bound method which takes two arguments, the source and offset of the current line. |
Method | check_line |
Examine one line of input for a transition match & execute its method. |
Method | detach_observer |
Undocumented |
Method | error |
Report error details. |
Method | get_source |
Return source of line at absolute line offset line_offset . |
Method | get_source_and_line |
Return (source, line) tuple for current or given line number. |
Method | get_state |
Return current state object; set it first if next_state given. |
Method | get_text_block |
Return a contiguous block of text. |
Method | goto_line |
Jump to absolute line offset line_offset , load and return it. |
Method | insert_input |
Undocumented |
Method | is_next_line_blank |
Return True if the next line is blank or non-existent. |
Method | next_line |
Load self.line with the n 'th next line and return it. |
Method | notify_observers |
Undocumented |
Method | previous_line |
Load self.line with the n 'th previous line and return it. |
Method | runtime_init |
Initialize self.states . |
Method | unlink |
Remove circular references to objects no longer required. |
Instance Variable | current_state |
The name of the current state (key to self.states ). |
Instance Variable | debug |
Debugging mode on/off. |
Instance Variable | initial_state |
The name of the initial state (key to self.states ). |
Instance Variable | input_lines |
StringList of input lines (without newlines). Filled by self.run() . |
Instance Variable | input_offset |
Offset of self.input_lines from the beginning of the file. |
Instance Variable | line |
Current input line. |
Instance Variable | line_offset |
Current input line offset from beginning of self.input_lines . |
Instance Variable | observers |
List of bound methods or functions to call whenever the current line changes. Observers are called with one argument, self. Cleared at the end of run() . |
Instance Variable | states |
Mapping of {state_name: State_object}. |
Instance Variable | _stderr |
Wrapper around sys.stderr catching en-/decoding errors |
docutils.statemachine.StateMachine.run
Parse input_lines
and modify the document
node in place.
Extend StateMachineWS.run()
: set up parse-global data and
run the StateMachine.