a

OԼaT��@s�
dZd
dl
mZ
dZd
dlZd
dlZd
dlmZ
d
dlm	Z	
d
dl
mZ
ejdkrVe
ZGd	d
�d
e�ZGdd�de�ZGd
d�de�ZGdd�de�ZGdd�de�ZGdd�dee�ZGdd�dee�ZGdd�de�ZGdd�de�ZGdd�de�ZGdd�de�ZGdd �d e�ZGd!d"�d"e�ZGd#d$�d$e�ZGd%d&�d&e�ZGd'd(�d(e�Z Gd)d*�d*e�Z!Gd+d,�d,e�Z"Gd-d.�d.e�Z#d/d0e�$d1�
fd2d3�
Z%d4d5�Z&dS)6a

A finite state machine specialized for regular-expression-based text filters,
this module defines the following classes:

- `StateMachine`, a state machine
- `State`, a state superclass
- `StateMachineWS`, a whitespace-sensitive version of `StateMachine`
- `StateWS`, a state superclass for use with `StateMachineWS`
- `SearchStateMachine`, uses `re.search()` instead of `re.match()`
- `SearchStateMachineWS`, uses `re.search()` instead of `re.match()`
- `ViewList`, extends standard Python lists.
- `StringList`, string-specific ViewList.

Exception classes:

- `StateMachineError`
- `UnknownStateError`
- `DuplicateStateError`
- `UnknownTransitionError`
- `DuplicateTransitionError`
- `TransitionPatternNotFound`
- `TransitionMethodNotFound`
- `UnexpectedIndentationError`
- `TransitionCorrection`: Raised to switch to another transition.
- `StateCorrection`: Raised to switch to another state & transition.

Functions:

- `string2lines()`: split a multi-line string into a list of one-line strings


How To Use This Module
======================
(See the individual classes, methods, and attributes for details.)

1. Import it: ``import statemachine`` or ``from statemachine import ...``.
   You will also need to ``import re``.

2. Derive a subclass of `State` (or `StateWS`) for each state in your state
   machine::

       class MyState(statemachine.State):

   Within the state's class definition:

   a) Include a pattern for each transition, in `State.patterns`::

          patterns = {'atransition': r'pattern', ...}

   b) Include a list of initial transitions to be set up automatically, in
      `State.initial_transitions`::

          initial_transitions = ['atransition', ...]

   c) Define a method for each transition, with the same name as the
      transition pattern::

          def atransition(self, match, context, next_state):
              # do something
              result = [...]  # a list
              return context, next_state, result
              # context, next_state may be altered

      Transition methods may raise an `EOFError` to cut processing short.

   d) You may wish to override the `State.bof()` and/or `State.eof()` implicit
      transition methods, which handle the beginning- and end-of-file.

   e) In order to handle nested processing, you may wish to override the
      attributes `State.nested_sm` and/or `State.nested_sm_kwargs`.

      If you are using `StateWS` as a base class, in order to handle nested
      indented blocks, you may wish to:

      - override the attributes `StateWS.indent_sm`,
        `StateWS.indent_sm_kwargs`, `StateWS.known_indent_sm`, and/or
        `StateWS.known_indent_sm_kwargs`;
      - override the `StateWS.blank()` method; and/or
      - override or extend the `StateWS.indent()`, `StateWS.known_indent()`,
        and/or `StateWS.firstknown_indent()` methods.

3. Create a state machine object::

       sm = StateMachine(state_classes=[MyState, ...],
                         initial_state='MyState')

4. Obtain the input text, which needs to be converted into a tab-free list of
   one-line strings. For example, to read text from a file called
   'inputfile'::

       input_string = open('inputfile').read()
       input_lines = statemachine.string2lines(input_string)

5. Run the state machine on the input text and collect the results, a list::

       results = sm.run(input_lines)

6. Remove any lingering circular references::

       sm.unlink()
�)
�print_functionZrestructuredtextN)
�east_asian_width)
�utils)
�ErrorOutput)�r
c@s�eZ
dZd
Zd6dd�
Zdd�Zd7d	d
�
Zd8dd�
Zd9dd�
Zdd�Z	dd�Z
dd�Zd:dd�
Zdd�Z
dd�Zdd�Zdd�Zd;d d!�
Zd"d#�Zd<d$d%�
Zd=d&d'�
Zd(d)�Zd*d+�Zd,d-�Zd.d/�Zd0d1�Zd2d3�Zd4d5�ZdS)>�StateMachinea�

    A finite state machine for text filters using regular expressions.

    The input is provided in the form of a list of one-line strings (no
    newlines). States are subclasses of the `State` class. Transitions consist
    of regular expression patterns and transition methods, and are defined in
    each state.

    The state machine is started with the `run()` method, which returns the
    results of processing in a list.
    FcCsLd
|_d|_
d
|_d|_||_||_||_i|_|�|
�

g|_	t
�|_d
S)a+

        Initialize a `StateMachine` object; add state objects.

        Parameters:

        - `state_classes`: a list of `State` (sub)classes.
        - `initial_state`: a string, the class name of the initial state.
        - `debug`: a boolean; produce verbose output if true (nonzero).
        Nr
���)�input_lines�input_offset�line�line_offset�debug�
initial_state�
current_state�states�
add_states�	observersr�_stderr)�self�
state_classesrr
�r�9/usr/lib/python3.9/site-packages/docutils/statemachine.py�__init__�s

zStateMachine.__init__c
Cs"|j�
�D]}
|
��
q
d
|_d
S�z9Remove circular references to objects no longer required.N)r�values�unlink�r�staterrrr�s


zStateMachine.unlinkr
Nc
Csz|��
t
|
t�r|
|_nt|
|d
�|_||_d|_|p<|j|_|jrft	d|jd�
|j�
f|jd�
d}g}|��}�
z�|jr�t	d|jd�
|�
|�
\}}	|�|	�

z�zR|��
|jr�|j�|j�
\}
}t	d|
||jf|jd�
|�|||�\}}}	WnNt�
yH


|j�
r(t	d	|jj|jd�
|�|�
}	|�|	�

YW�qNYn0|�|	�

Wn�t�
y�
}

zR|��
|
jd
f
}|j�
r�t	d|jj|d
f|jd�
WYd}
~
q�WYd}
~
n�d}
~
0t�y<
}

zb|��
|
jd
}t|
j�
dk�
r�d}n|
jdf
}|j�r(t	d
||d
f|jd�
WYd}
~
nd}
~
00d}|�|�
}q�Wn


|j�rh|��
�Yn0g|_|S)a�
        Run the state machine on `input_lines`. Return results (a list).

        Reset `self.line_offset` and `self.current_state`. Run the
        beginning-of-file transition. Input one line at a time and check for a
        matching transition. If a match is found, call the transition method
        and possibly change the state. Store the context returned by the
        transition method to be passed on to the next transition matched.
        Accumulate the results returned by the transition methods in a list.
        Run the end-of-file transition. Finally, return the accumulated
        results.

        Parameters:

        - `input_lines`: a list of strings without newlines, or `StringList`.
        - `input_offset`: the line offset of `input_lines` from the beginning
          of the file.
        - `context`: application-specific storage.
        - `input_source`: name or path of source of `input_lines`.
        - `initial_state`: name of initial state.
        �
�sourcerz5
StateMachine.run: input_lines (line_offset=%s):
| %sz
| �
�fileNz!
StateMachine.run: bof transitionz4
StateMachine.run: line (source=%r, offset=%r):
| %sz$
StateMachine.run: %s.eof transitionr
zE
StateMachine.run: TransitionCorrection to state "%s", transition %s.�
z@
StateMachine.run: StateCorrection to state "%s", transition %s.)�runtime_init�
isinstance�
StringListr	r
rrrr
�print�joinr�	get_state�bof�extend�	next_line�infor�
check_line�EOFError�	__class__�__name__�eof�TransitionCorrection�
previous_line�args�StateCorrection�len�errorr)rr	r
�contextZinput_sourcer�transitions�resultsr�resultr�offset�
next_state�	exceptionrrr�run�s�








�
�












�
��
�


�
�








�� 








��






zStateMachine.runcCsh|
r8|jr2|
|j
kr2td
|j
|
|��f|jd�
|
|_
z|j|j
WStyb


t|j
�
�
Yn0dS)z�
        Return current state object; set it first if `next_state` given.

        Parameter `next_state`: a string, the name of the next state.

        Exception: `UnknownStateError` raised if `next_state` unknown.
        zJ
StateMachine.get_state: Changing state from "%s" to "%s" (input line %s).r N)r
rr&�abs_line_numberrr�KeyError�UnknownStateError)rr=rrrr(
s


���



zStateMachine.get_stater"cCs^zNz |j|
7_|j
|j|_Wnty>


d
|_t�
Yn0|jW|��
S|��
0d
S)z9Load `self.line` with the `n`'th next line and return it.N)rr	r�
IndexErrorr.�notify_observers�r�
nrrrr+,
s







�zStateMachine.next_linec

Cs2z|j|j
d
��WSty,


Yd
S0dS)z6Return True if the next line is blank or non-existent.r"N)r	r�striprC�
rrrr�is_next_line_blank9
s


zStateMachine.is_next_line_blankc

Cs|jt
|j�
d
kS)z0Return 1 if the input is at or past end-of-file.r")rr6r	rHrrr�at_eof@
szStateMachine.at_eofc

Cs
|jd
k
S)z8Return 1 if the input is at or before beginning-of-file.r
)
rrHrrr�at_bofD
szStateMachine.at_bofcCs<|j|
8_|jd
kr d|_
n|j|j|_
|��
|j
S)z=Load `self.line` with the `n`'th previous line and return it.r
N)rrr	rDrErrrr3H
s




zStateMachine.previous_linecCs\zLz|
|j|_
|j|j
|_Wnty<


d
|_t�
Yn0|jW|��
S|��
0d
S)z?Jump to absolute line offset `line_offset`, load and return it.N)r
rr	rrCr.rD�rrrrr�	goto_lineR
s







�zStateMachine.goto_linecCs|j�
|
|j�
S)
z<Return source of line at absolute line offset `line_offset`.)r	rr
rLrrr�
get_source_
szStateMachine.get_sourcec

Cs|j|j
S)
z;Return line offset of current line, from beginning of file.�rr
rHrrr�abs_line_offsetc
szStateMachine.abs_line_offsetc

Cs|j|j
d
S)z5Return line number of current line (counting from 1).r"rOrHrrrr@g
szStateMachine.abs_line_numbercCs�|
d
ur|j}n|
|j
d}z|j�|�
\}}|d}WnJtyl


|�||j
�
\}}||dfYSty�


d\}}Yn0||fS)a\
Return (source, line) tuple for current or given line number.

        Looks up the source and line number in the `self.input_lines`
        StringList instance to count for included source files.

        If the optional argument `lineno` is given, convert it from an
        absolute line number to the corresponding (source, line) pair.
        Nr"�NN)rr
r	r,�	TypeError�get_source_and_linerC)r�linenor<�srcZ	srcoffsetZsrclinerrrrSk
s	







z StateMachine.get_source_and_linecCs^|jj
|jd
dd|t|
�
d�
|jj
|jd
dd|dd�
|j�
|jdt|
|��
dS)Nr"�zinternal padding after )rr<zinternal padding before r�)r	�insertrr6r%)rr	rrrr�insert_input�
s


�

�
�zStateMachine.insert_inputc
Cspz(|j�
|j|
�}|�t|�
d
�

|WStyj
}
z*|jd}|�t|�
d
�

�WYd}~n
d}~00dS)��
        Return a contiguous block of text.

        If `flush_left` is true, raise `UnexpectedIndentationError` if an
        indented line is encountered before the text block ends (with a blank
        line).
        r"r
N)r	�get_text_blockrr+r6�UnexpectedIndentationErrorr4)r�
flush_left�block�errrrrr[�
s


�





zStateMachine.get_text_blockc
Cs�|d
ur|j}d
}|j
r2td|jj|f|jd�
|D]T}|j|\}}}|�|j�
}	|	r6|j
rztd||jjf|jd�
||	|
|�
Sq6|j
r�td|jj|jd�
|�	|
|�S)a�
        Examine one line of input for a transition match & execute its method.

        Parameters:

        - `context`: application-dependent storage.
        - `state`: a `State` object, the current state.
        - `transitions`: an optional ordered list of transition names to try,
          instead of ``state.transition_order``.

        Return the values returned by the transition method:

        - context: possibly modified from the parameter `context`;
        - next state name (`State` subclass name);
        - the result output of the transition, a list.

        When there is no match, ``state.no_match()`` is called and its return
        value is returned.
        Nz5
StateMachine.check_line: state="%s", transitions=%r.r z@
StateMachine.check_line: Matched transition "%s" in state "%s".z1
StateMachine.check_line: No match in state "%s".)
�transition_orderr
r&r/r0rr9�matchr�no_match)
rr8rr9Zstate_correction�name�pattern�methodr=rarrrr-�
s6





�
�





��

�
�zStateMachine.check_linecCs.|
j}||j
vrt|�
�
|
||j�|j
|<d
S)z�
        Initialize & add a `state_class` (`State` subclass) object.

        Exception: `DuplicateStateError` raised if `state_class` was already
        added.
        N)r0r�DuplicateStateErrorr
)r�state_classZ	statenamerrr�	add_state�
s



zStateMachine.add_statecCs|
D]}|�|�

qd
S)zE
        Add `state_classes` (a list of `State` subclasses).
        N)
rh)rrrgrrrr�
s
zStateMachine.add_statesc
Cs|j�
�D]}
|
��
q
d
S)z+
        Initialize `self.states`.
        N)rrr#rrrrr#�
s
zStateMachine.runtime_initc
CsXt�\}
}}}}t
d
|
|f|jd�
t
d|��|jd�
t
d|||f|jd�
dS)zReport error details.z%s: %sr z
input line %szmodule %s, line %s, function %sN)�_exception_datar&rr@)r�type�value�moduler�functionrrrr7�
s



�
�zStateMachine.errorcCs|j�
|
�

d
S)z�
        The `observer` parameter is a function or bound method which takes two
        arguments, the source and offset of the current line.
        N)r�append�r�observerrrr�attach_observer�
szStateMachine.attach_observercCs|j�
|
�

dS�
N)r�removerorrr�detach_observer�
s
zStateMachine.detach_observerc
	CsB|jD]6}
z|j
�|j�
}Wnty2


d
}Yn0|
|�
qdS)NrQ)rr	r,rrC)rrpr,rrrrD�
s







zStateMachine.notify_observers)
F)r
NNN)
N)
r")
r")
N)
F)
N)r0�
__module__�__qualname__�__doc__rrr?r(r+rIrJrKr3rMrNrPr@rSrYr[r-rhrr#r7rqrtrDrrrrrys6
/
�
\









)rc@s�eZ
dZd
ZdZdZdZdZddd�
Zdd�Z	dd	�Z
d
d�Zdd
�Zdd�Z
dd�Zddd�
Zdd�Zdd�Zdd�Zdd�Zdd�ZdS) �Stateaw
    State superclass. Contains a list of transitions, and transition methods.

    Transition methods all have the same signature. They take 3 parameters:

    - An `re` match object. ``match.string`` contains the matched input line,
      ``match.start()`` gives the start index of the match, and
      ``match.end()`` gives the end index.
    - A context object, whose meaning is application-defined (initial value
      ``None``). It can be used to store any information required by the state
      machine, and the returned context is passed on to the next transition
      method unchanged.
    - The name of the next state, a string, taken from the transitions list;
      normally it is returned unchanged, but it may be altered by the
      transition method if necessary.

    Transition methods all return a 3-tuple:

    - A context object, as (potentially) modified by the transition method.
    - The next state name (a return value of ``None`` means no state change).
    - The processing result, a list, which is accumulated by the state
      machine.

    Transition methods may raise an `EOFError` to cut processing short.

    There are two implicit transitions, and corresponding transition methods
    are defined: `bof()` handles the beginning-of-file, and `eof()` handles
    the end-of-file. These methods have non-standard signatures and return
    values. `bof()` returns the initial context and results, and may be used
    to return a header string, or do any other processing needed. `eof()`
    should handle any remaining context and wrap things up; it returns the
    final processing result.

    Typical applications need only subclass `State` (or a subclass), set the
    `patterns` and `initial_transitions` class attributes, and provide
    corresponding transition methods. The default object initialization will
    take care of constructing the list of transitions.
    NFcCsVg|_i|_
|��
|
|_||_|jd
ur4|jj|_|jd
urR|jg
|jjd�|_d
S)z�
        Initialize a `State` object; make & add initial transitions.

        Parameters:

        - `statemachine`: the controlling `StateMachine` object.
        - `debug`: a boolean; produce verbose output if true.
        N)rr)	r`r9�add_initial_transitions�
state_machiner
�	nested_smr/�nested_sm_kwargsr0�rrzr
rrrrMs
	






�zState.__init__c


Csd
S)z{
        Initialize this `State` before running the state machine; called from
        `self.state_machine.run()`.
        NrrHrrrr#qszState.runtime_initc

Cs
d
|_d
Sr)
rzrHrrrrxszState.unlinkc
Cs&|jr"|�
|j�
\}
}|�|
|�
d
S)z>Make and add transitions listed in `self.initial_transitions`.N)�initial_transitions�make_transitions�add_transitions�r�namesr9rrrry|s


�zState.add_initial_transitionscCsJ|
D]&}||jvrt
|�
�
||v
rt|�
�
q|
|jd
d�<|j�|�

d
S)a"

        Add a list of transitions to the start of the transition list.

        Parameters:

        - `names`: a list of transition names.
        - `transitions`: a mapping of names to transition tuples.

        Exceptions: `DuplicateTransitionError`, `UnknownTransitionError`.
        Nr
)r9�DuplicateTransitionError�UnknownTransitionErrorr`�update)rr�r9rcrrrr��s







zState.add_transitionscCs0|
|jvrt
|
�
�
|
g
|jd
d�<||j|
<d
S)z�
        Add a transition to the start of the transition list.

        Parameter `transition`: a ready-made transition 3-tuple.

        Exception: `DuplicateTransitionError`.
        Nr
)r9r�r`)rrcZ
transitionrrr�add_transition�s



zState.add_transitioncCs2z|j|
=|j
�|
�

Wn


t|
�
�
Yn0d
S)z^
        Remove a transition by `name`.

        Exception: `UnknownTransitionError`.
        N)r9r`rsr�)rrcrrr�remove_transition�s




zState.remove_transitioncCs�|d
ur|jj
}z,|j|
}t|d�s:t�|�
}|j|
<Wn&tyb


td|jj
|
f�
�
Yn0zt||
�}Wn&t	y�


t
d|jj
|
f�
�
Yn0|||fS)a�
        Make & return a transition tuple based on `name`.

        This is a convenience function to simplify transition creation.

        Parameters:

        - `name`: a string, the name of the transition pattern & method. This
          `State` object must have a method called '`name`', and a dictionary
          `self.patterns` containing a key '`name`'.
        - `next_state`: a string, the name of the next `State` object for this
          transition. A value of ``None`` (or absent) implies no state change
          (i.e., continue with the same state).

        Exceptions: `TransitionPatternNotFound`, `TransitionMethodNotFound`.
        Nraz%s.patterns[%r]z%s.%s)r/r0�patterns�hasattr�re�compilerA�TransitionPatternNotFound�getattr�AttributeError�TransitionMethodNotFound)rrcr=rdrerrr�make_transition�s"









�




�
zState.make_transitioncCsftd
�
}g}i}|
D]H}t
||�r<|�|�
||<|�|�

q|j|�||d<|�|d�

q||fS)z�
        Return a list of transition names and a transition mapping.

        Parameter `name_list`: a list, where each entry is either a transition
        name string, or a 1- or 2-tuple (transition name, optional next state
        name).
        rVr
)rjr$r�rn)rZ	name_listZ
stringtyper�r9Z	namestaterrrr�s








zState.make_transitionscCs
|
d
gfS)a'

        Called when there is no match from `StateMachine.check_line()`.

        Return the same values returned by transition methods:

        - context: unchanged;
        - next state name: ``None``;
        - empty result list.

        Override in subclasses to catch this event.
        Nr)rr8r9rrrrb�szState.no_matchcCs|
gfS)
z�
        Handle beginning-of-file. Return unchanged `context`, empty result.

        Override in subclasses.

        Parameter `context`: application-defined storage.
        r�rr8rrrr)�sz	State.bofc
CsgS)
z�
        Handle end-of-file. Return empty result.

        Override in subclasses.

        Parameter `context`: application-defined storage.
        rr�rrrr1�sz	State.eofcCs
||gfS)
z�
        A "do nothing" transition method.

        Return unchanged `context` & `next_state`, empty result. Useful for
        simple state changes (actionless transitions).
        r�rrar8r=rrr�nopsz	State.nop)
F)
N)r0rurvrwr�r~r{r|rr#rryr�r�r�r�rrbr)r1r�rrrrrxs$'
$

!

rxc@s.eZ
dZd
Zddd�
Zddd�
Zd
dd	�
Zd
S)�StateMachineWSaq

    `StateMachine` subclass specialized for whitespace recognition.

    There are three methods provided for extracting indented text blocks:

    - `get_indented()`: use when the indent is unknown.
    - `get_known_indented()`: use when the indent is known for all lines.
    - `get_first_known_indented()`: use when only the first line's indent is
      known.
    FTcCsd|��}|j
�|j|
|�\}}}|r6|�t|�
d
�

|rX|d��sX|��
|d
7}q6||||fS)a
        Return a block of indented lines of text, and info.

        Extract an indented block where the indent is unknown for all lines.

        :Parameters:
            - `until_blank`: Stop collecting at the first blank line if true.
            - `strip_indent`: Strip common leading indent if true (default).

        :Return:
            - the indented block (a list of lines of text),
            - its indent,
            - its first line offset from BOF, and
            - whether or not it finished with a blank line.
        r"r
�rPr	�get_indentedrr+r6rG�
trim_start)r�until_blank�strip_indentr<�indented�indent�blank_finishrrrr�s

�






zStateMachineWS.get_indentedcCsb|��}|j
j|j|||
d
�\}}
}|�t|�
d�

|rX|d��sX|��
|d7}q6|||fS)a�
        Return an indented block and info.

        Extract an indented block where the indent is known for all lines.
        Starting with the current line, extract the entire text block with at
        least `indent` indentation (which must be whitespace, except for the
        first line).

        :Parameters:
            - `indent`: The number of indent columns/characters.
            - `until_blank`: Stop collecting at the first blank line if true.
            - `strip_indent`: Strip `indent` characters of indentation if true
              (default).

        :Return:
            - the indented block,
            - its first line offset from BOF, and
            - whether or not it finished with a blank line.
        )
�block_indentr"r
r�)rr�r�r�r<r�r�rrr�get_known_indented7s


�




z!StateMachineWS.get_known_indentedcCsh|��}|j
j|j|||
d
�\}}
}|�t|�
d�

|r\|r\|d��s\|��
|d7}q:||
||fS)a�
        Return an indented block and info.

        Extract an indented block where the indent is known for the first line
        and unknown for all other lines.

        :Parameters:
            - `indent`: The first line's indent (# of columns/characters).
            - `until_blank`: Stop collecting at the first blank line if true
              (1).
            - `strip_indent`: Strip `indent` characters of indentation if true
              (1, default).
            - `strip_top`: Strip blank lines from the beginning of the block.

        :Return:
            - the indented block,
            - its indent,
            - its first line offset from BOF, and
            - whether or not it finished with a blank line.
        )
�first_indentr"r
r�)rr�r�r�Z	strip_topr<r�r�rrr�get_first_known_indentedUs


�





z'StateMachineWS.get_first_known_indentedN)FT)FT)FTT)r0rurvrwr�r�r�rrrrr�s


�r�c@sleZ
dZd
ZdZdZdZdZe�	d�
e�	d�
d�Z
dZddd�
Zd	d
�Z
dd�Zd
d�Zdd�Zdd�ZdS)�StateWSa�
    State superclass specialized for whitespace (blank lines & indents).

    Use this class with `StateMachineWS`.  The transitions 'blank' (for blank
    lines) and 'indent' (for indented text blocks) are added automatically,
    before any other transitions.  The transition method `blank()` handles
    blank lines and `indent()` handles nested indented blocks.  Indented
    blocks trigger a new state machine to be created by `indent()` and run.
    The class of the state machine to be created is in `indent_sm`, and the
    constructor keyword arguments are in the dictionary `indent_sm_kwargs`.

    The methods `known_indent()` and `firstknown_indent()` are provided for
    indented blocks where the indent (all lines' and first line's only,
    respectively) is known to the transition method, along with the attributes
    `known_indent_sm` and `known_indent_sm_kwargs`.  Neither transition method
    is triggered automatically.
    Nz *$z +)�blankr�FcCsZt�
||
|�
|jd
ur |j|_|jd
ur2|j|_|jd
urD|j|_|jd
urV|j|_d
S)z�
        Initialize a `StateSM` object; extends `State.__init__()`.

        Check for indent state machine attributes, set defaults if not set.
        N)rxr�	indent_smr{�indent_sm_kwargsr|�known_indent_sm�known_indent_sm_kwargsr}rrrr�s











zStateWS.__init__c
CsHt�
|�

|jd
uri|_|j�|j�

|�|j�
\}
}|�|
|�
d
S)z�
        Add whitespace-specific transitions before those defined in subclass.

        Extends `State.add_initial_transitions()`.
        N)rxryr�r��ws_patternsr�ws_initial_transitionsr�r�rrrry�s






�zStateWS.add_initial_transitionscCs|�|
||�S)
z9Handle blank lines. Does nothing. Override in subclasses.)
r�r�rrrr��sz
StateWS.blankc
CsB|j�
�\}}}}|jfd
|ji
|j�
�
}|j||d�}	|||	fS)z�
        Handle an indented text block. Extend or override in subclasses.

        Recursively run the registered state machine for indented blocks
        (`self.indent_sm`).
        r
�
r
)rzr�r�r
r�r?)
rrar8r=r�r�rr��smr:rrrr��s
�


zStateWS.indentc	CsF|j�
|
���
\}}}|jfd
|ji
|j�
�
}|j||d�}|||fS)a

        Handle a known-indent text block. Extend or override in subclasses.

        Recursively run the registered state machine for known-indent indented
        blocks (`self.known_indent_sm`). The indent is the length of the
        match, ``match.end()``.
        r
r�)rzr��endr�r
r�r?�	rrar8r=r�rr�r�r:rrr�known_indent�s	�
�
zStateWS.known_indentc	CsF|j�
|
���
\}}}|jfd
|ji
|j�
�
}|j||d�}|||fS)a0

        Handle an indented text block (first line's indent known).

        Extend or override in subclasses.

        Recursively run the registered state machine for known-indent indented
        blocks (`self.known_indent_sm`). The indent is the length of the
        match, ``match.end()``.
        r
r�)rzr�r�r�r
r�r?r�rrr�first_known_indent�s�
�
zStateWS.first_known_indent)
F)r0rurvrwr�r�r�r�r�r�r�r�rryr�r�r�r�rrrrr�ws
�

r�c@seZ
dZd
Zdd�ZdS)�_SearchOverridea�

    Mix-in class to override `StateMachine` regular expression behavior.

    Changes regular expression matching, from the default `re.match()`
    (succeeds only if the pattern matches at the start of `self.line`) to
    `re.search()` (succeeds if the pattern matches anywhere in `self.line`).
    When subclassing a `StateMachine`, list this class **first** in the
    inheritance list of the class definition.
    cCs|
�|j
�
S)
z�
        Return the result of a regular expression search.

        Overrides `StateMachine.match()`.

        Parameter `pattern`: `re` compiled regular expression.
        )�searchr)rrdrrrrasz_SearchOverride.matchN)r0rurvrwrarrrrr�s
r�c
@seZ
dZd
ZdS)�SearchStateMachinez@`StateMachine` which uses `re.search()` instead of `re.match()`.N�r0rurvrwrrrrr�s

r�c
@seZ
dZd
ZdS)�SearchStateMachineWSzB`StateMachineWS` which uses `re.search()` instead of `re.match()`.Nr�rrrrr� s

r�c@sP
eZ
dZd
ZdRdd�
Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dd�Z
dd�Zdd�Zdd�Z
dd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd#d$�Zd%d&�Zd'd(�Zd)d*�ZeZd+d,�Zd-d.�ZdSd0d1�
ZdTd2d3�
ZdUd5d6�
ZdVd8d9�
ZdWd:d;�
Zd<d=�Z d>d?�Z!d@dA�Z"dBdC�Z#dDdE�Z$dFdG�Z%dHdI�Z&dJdK�Z'dLdM�Z(dNdO�Z)dPdQ�Z*dS)X�ViewLista>
    List with extended functionality: slices of ViewList objects are child
    lists, linked to their parents. Changes made to a child list also affect
    the parent list.  A child list is effectively a "view" (in the SQL sense)
    of the parent list.  Changes to parent lists, however, do *not* affect
    active child lists.  If a parent list is changed, any active child lists
    should be recreated.

    The start and end of the slice can be trimmed using the `trim_start()` and
    `trim_end()` methods, without affecting the parent list.  The link between
    child and parent lists can be broken by calling `disconnect()` on the
    child list.

    Also, ViewList objects keep track of the source & offset of each item.
    This information is accessible via the `source()`, `offset()`, and
    `info()` methods.
    Ncs�g|_g|_
||_||_t|
t�rD|
jdd�|_|
j
dd�|_
n:|
du
r~t|
�
|_|rb||_
n�f
d
d�tt|
�
�
D�
|_
dS)Nc
sg|]}
�|
f�qSrr)�.0�
irrr�
<listcomp>Q�z%ViewList.__init__.<locals>.<listcomp>)	�data�items�parent�
parent_offsetr$r��list�ranger6)r�initlistrr�r�r�rrrr9s








zViewList.__init__c

Cs
t|j
�
Srr)�strr�rHrrr�__str__Ts
zViewList.__str__c

Csd
|jj
|j|jfS)Nz%s(%s, items=%s))r/r0r�r�rHrrr�__repr__Ws

�zViewList.__repr__cCs|j|�
|
�
kSrr�r��_ViewList__cast�r�otherrrr�__lt__[r�zViewList.__lt__cCs|j|�
|
�
k
Srrr�r�rrr�__le__\r�zViewList.__le__cCs|j|�
|
�
kSrrr�r�rrr�__eq__]r�zViewList.__eq__cCs|j|�
|
�
kSrrr�r�rrr�__ne__^r�zViewList.__ne__cCs|j|�
|
�
kSrrr�r�rrr�__gt___r�zViewList.__gt__cCs|j|�
|
�
kSrrr�r�rrr�__ge__`r�zViewList.__ge__cCs |j}|�
|
�
}||k||kSrrr�)rr�ZmineZyoursrrr�__cmp__bs


zViewList.__cmp__cCst|
t
�r|
jS|
SdSrr)r$r�r�r�rrr�__casths


zViewList.__castcCs
|
|jvSrr�
r��r�itemrrr�__contains__nr�zViewList.__contains__c

Cs
t|j
�
Srr)r6r�rHrrr�__len__or�zViewList.__len__cCsLt|
t
�r>|j|j|
j|
j�|j|
j|
j�||
jp8d
d�S|j|
SdS)Nr
)r�r�r�)r$�slicer/r��start�stopr��rr�rrr�__getitem__us




�zViewList.__getitem__cCs�t|
t
�rvt|t�std
�
�
|j|j|
j|
j�<|j|j|
j|
j�<|jr�||j|
jpXd|j	|
jpjt
|�
|j	�<n ||j|
<|jr�||j|
|j	<dS)Nz(assigning non-ViewList to ViewList slicer
)r$r�r�rRr�r�r�r�r�r�r6)rr�r�rrr�__setitem__~s





�
�


zViewList.__setitem__cCs�z(|j|
=|j
|
=|jr&|j|
|j=Wn`ty�


|j|
j|
j�=|j
|
j|
j�=|jr�|j|
jphd
|j|
jpzt|�
|j�=Yn0dS)Nr
)r�r�r�r�rRr�r�r6r�rrr�__delitem__�s









�zViewList.__delitem__cCs4t|
t
�r(|j|j|
j|j|
jd
�Std�
�
dS)N�
r�z!adding non-ViewList to a ViewList�r$r�r/r�r�rRr�rrr�__add__�s





�zViewList.__add__cCs4t|
t
�r(|j|
j|j|
j|jd
�Std�
�
dS)Nr�z!adding ViewList to a non-ViewListr�r�rrr�__radd__�s





�zViewList.__radd__cCs(t|
t
�r|j|
j7_ntd
�
�
|S)Nz!argument to += must be a ViewList)r$r�r�rRr�rrr�__iadd__�s



zViewList.__iadd__cCs|j|j
|
|j|
d
�S)Nr�)r/r�r�rErrr�__mul__�s
zViewList.__mul__cCs |j|
9_|j
|
9_
|Srr)r�r�rErrr�__imul__�s


zViewList.__imul__cCsRt|
t
�std
�
�
|jr2|j�t|j�
|j|
�
|j�|
j�

|j	�|
j	�

dS)Nz(extending a ViewList with a non-ViewList)
r$r�rRr�rXr6r�r�r*r�r�rrrr*�s






zViewList.extendr
cCsX|dur|�|
�

n@|j
r8|j
�t|j�
|j|
||�
|j�|
�

|j�||f�

dSrr)r*r�rXr6r�r�rnr�)rr�rr<rrrrn�s



�
zViewList.appendcCs�|durnt|t
�std
�
�
|j|j|
|
�<|j|j|
|
�<|jr�t|j�
|
t|j�
}|j�||j|�
nV|j�|
|�
|j�|
||f�
|jr�t|j�
|
t|j�
}|j�||j|||�
dS)Nz+inserting non-ViewList with no source given)	r$r�rRr�r�r�r6rXr�)rr�r�rr<�indexrrrrX�s













�zViewList.insertrcCsH|jr0t
|j�
|
t
|j�
}|j�||j�

|j�|
�

|j�|
�
Srr)r�r6r��popr�r�)rr�r�rrrr��s





zViewList.popr"cCsf|
t|j
�
kr&td
|
t|j
�
f�
�
n|
dkr6td�
�
|j
d|
�=|jd|
�=|jrb|j|
7_dS)zW
        Remove items from the start of the list, without touching the parent.
        �CSize of trim too large; can't trim %s items from a list of size %s.r
�Trim size must be >= 0.N)r6r�rCr�r�r�rErrrr��s

�




zViewList.trim_startcCsV|
t|j
�
kr&td
|
t|j
�
f�
�
n|
dkr6td�
�
|j
|
d�=|j|
d�=dS)zU
        Remove items from the end of the list, without touching the parent.
        r�r
r�N)r6r�rCr�rErrr�trim_end�s

�


zViewList.trim_endcCs|�|
�
}||=dSrr)
r�)rr�r�rrrrs�s


zViewList.removecCs|j�
|
�
Srr)r��countr�rrrr�r�zViewList.countcCs|j�
|
�
Srr)r�r�r�rrrr�r�zViewList.indexc

Cs|j�
�
|j�
�
d|_dSrr)r��reverser�r�rHrrrr�s




zViewList.reversec
GsDtt
|j|j�g
|
�
R�}d
d�|D�
|_dd�|D�
|_d|_dS)Nc
Ssg|]}
|
d�qS)
r
r�r��entryrrrr�
r�z!ViewList.sort.<locals>.<listcomp>c
Ssg|]}
|
d�qS)
r"rr�rrrr�r�)�sorted�zipr�r�r�)rr4�tmprrr�sorts



z
ViewList.sortcCsNz|j|
WSt
yH


|
t|j�
krB|j|
d
ddfYS�Yn0dS)z%Return source & offset for index `i`.r"r
N)r�rCr6r�r�rrrr,s



z
ViewList.infocCs|�|
�
d
S)zReturn source for index `i`.r
�
r,r�rrrrszViewList.sourcecCs|�|
�
d
S)zReturn offset for index `i`.r"r�r�rrrr<szViewList.offsetc

Cs
d
|_d
S)z-Break link between this list and parent list.N)
r�rHrrr�
disconnect#szViewList.disconnectc
cs,t|j
|j�D]\}
\}}|||
fV
qd
S)z8Return iterator yielding (source, offset, value) tuples.N)r�r�r�)rrkrr<rrr�xitems's
zViewList.xitemsc
Cs|��D]}
t
d
|
�

qdS)z=Print the list in `grep` format (`source:offset:value` lines)z%s:%d:%sN)r�r&)rrrrr�pprint,s
zViewList.pprint)NNNNN)Nr
)Nr
)
r)
r")
r")+r0rurvrwrr�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r�r��__rmul__r�r*rnrXr�r�r�rsr�r�r�r�r,rr<r�r�r�rrrrr�%sT
�






	







r�c@sNeZ
dZd
Zdejfdd�
Zddd�
Zdd
d�
Zddd
�
Z	dd�Z
dd�Zd	S)r%z*A `ViewList` with string-specific methods.r
cs*�f
d
d�|j||�D�
|j||�<dS)z�
        Trim `length` characters off the beginning of each item, in-place,
        from index `start` to `end`.  No whitespace-checking is done on the
        trimmed text.  Does not affect slice parent.
        c
sg|]}
|
�d��qSrrr�r�r�
�lengthrrr�<s
�z(StringList.trim_left.<locals>.<listcomp>Nr�)rr�r�r�rr�r�	trim_left6s

�zStringList.trim_leftFcCsv|
}t|j
�
}||krj|j
|}|��s*qj|r`|d
dkr`|�|�
\}}t||
|�||d��
|d7}q||
|�S)rZr
�
 r")r6r�rGr,r\)rr�r]r��lastrrr<rrrr[?s










�

zStringList.get_text_blockTNcCsF
|}|
}|d
u
r|d
ur|}|d
u
r,|d7}t|j
�
}||kr�|j
|}	|	r�|	ddksp|d
u
r�|	d
|���r�||
ko�|j
|d��}
q�|	��}|s�|r�d}
q�n0|d
ur�t|	�
t|�
}|d
ur�|}n
t||�}|d7}q6d}
||
|�}
|d
u
�
r|
�
r|
j
d|d
�|
j
d<|�
r6|�
r6|
j||d
u
d�
|
|�
p@d|
fS)a�
        Extract and return a StringList of indented lines of text.

        Collect all lines with indentation, determine the minimum indentation,
        remove the minimum indentation from all indented lines (unless
        `strip_indent` is false), and return them. All lines up to but not
        including the first unindented line will be returned.

        :Parameters:
          - `start`: The index of the first line to examine.
          - `until_blank`: Stop collecting at the first blank line if true.
          - `strip_indent`: Strip common leading indent if true (default).
          - `block_indent`: The indent of the entire block, if known.
          - `first_indent`: The indent of the first line, if known.

        :Return:
          - a StringList of indented lines with minimum indent removed;
          - the amount of the indent;
          - a boolean: did the indented block finish with a blank line or EOF?
        Nr"r
r�)
r�)r6r�rG�lstrip�minr�)rr�r�r�r�r�r�r�r�rr��strippedZline_indentr^rrrr�TsH











��
�

















zStringList.get_indentedc
	s"
||
|�}|�tt
|j�
�
D]�}t�|j|�
}z||}Wn,tyj


|t
|j|�
t
|�
7}Yn0z||}Wn,ty�


|t
|j|�
t
|�
7}Yn0|j|||���|j|<}	|	rt�t
|	�
t
|	���
��q|�
rd
�k�
r|k�
rn
n�f
dd�|jD�
|_|S)Nr
c
sg|]}
|
�d��qSrrrr��
r�rrr��r�z+StringList.get_2D_block.<locals>.<listcomp>)	r�r6r�rZcolumn_indicesrC�rstripr�r�)
r�top�leftZbottom�rightr�r^r�Zcirrr�r�get_2D_block�s$






 



 
 


"

zStringList.get_2D_blockcCsjtt
|j�
�
D]V}|j|}t|t�rg}|D]$}|�|�

t|�
d
vr.|�|
�

q.d�|�
|j|<qdS)z�
        Pad all double-width characters in self by appending `pad_char` to each.
        For East Asian language support.
        ZWFrVN)r�r6r�r$�unicodernrr')rZpad_charr�r�new�charrrr�pad_double_width�s










zStringList.pad_double_widthcCs0tt
|j�
�
D]}|j|�|
|�|j|<qd
S)z6Replace all occurrences of substring `old` with `new`.N)r�r6r��replace)r�oldr
r�rrrr
�s
zStringList.replace)
F)r
FTNN)
T)r0rurvrw�sys�maxsizer�r[r�r
r
r
rrrrr%2s	

�
<
r%c
@seZ
dZd
S)�StateMachineErrorN�r0rurvrrrrr
�r�r
c
@seZ
dZd
S)rBNr
rrrrrB�r�rBc
@seZ
dZd
S)rfNr
rrrrrf�r�rfc
@seZ
dZd
S)r�Nr
rrrrr��r�r�c
@seZ
dZd
S)r�Nr
rrrrr��r�r�c
@seZ
dZd
S)r�Nr
rrrrr��r�r�c
@seZ
dZd
S)r�Nr
rrrrr��r�r�c
@seZ
dZd
S)r\Nr
rrrrr\�r�r\c
@seZ
dZd
ZdS)r2z�
    Raise from within a transition method to switch to another transition.

    Raise with one argument, the new transition name.
    Nr�rrrrr2�sr2c
@seZ
dZd
ZdS)r5z�
    Raise from within a transition method to switch to another state.

    Raise with one or two arguments: new state name, and an optional new
    transition name.
    Nr�rrrrr5�sr5�Fz[]cs*|r|�d
|�}�f
dd�|�
�D�
}|S)a6
    Return a list of one-line strings with tabs expanded, no newlines, and
    trailing whitespace stripped.

    Each tab is expanded with between 1 and `tab_width` spaces, so that the
    next character's index becomes a multiple of `tab_width` (8 by default).

    Parameters:

    - `astring`: a multi-line string.
    - `tab_width`: the number of columns between tab stops.
    - `convert_whitespace`: convert form feeds and vertical tabs to spaces?
    - `whitespace`: pattern object with the to-be-converted
      whitespace characters (default [\v\f]).
    r�c
sg|]}
|
���
�
��qSr)�
expandtabsr�)r��
s�
�	tab_widthrrr��r�z string2lines.<locals>.<listcomp>)�sub�
splitlines)Zastringr
Zconvert_whitespaceZ
whitespace�linesrr
r�string2lines�s


r
cCs:t�
�\}}
}|jr|j}q|jj}|j|
|j|j|jfS)
z�
    Return exception information:

    - the exception's class name;
    - the exception object;
    - the name of the file containing the offending code;
    - the line number of the offending code;
    - the function name of the offending code.
    )	r	
�exc_info�tb_next�tb_frame�f_coder0�co_filename�	tb_lineno�co_name)rjrk�	traceback�coderrrri�s





�ri)'rwZ
__future__rZ
__docformat__r	
r��unicodedatarZdocutilsrZdocutils.utils.error_reportingr�version_infor�r
�objectrrxr�r�r�r�r�r�r%�	Exceptionr
rBrfr�r�r�r�r\r2r5r�r
rirrrr�<module>sRe





g	






		
�