docutils.utils.math.math2html.Position

class documentation

class Position(Globable): (source)

Known subclasses: docutils.utils.math.math2html.FilePosition, docutils.utils.math.math2html.TextPosition

View In Hierarchy

A position in a text to parse. Including those in Globable, functions to implement by subclasses are: skip(), identifier(), extract(), isout() and current().

Method __init__ Undocumented
Method __next__ Advance the position and return the next character.
Method checkfor Check for a string at the given position.
Method checkforlower Check for a string in lower case.
Method checkskip Check for a string at the given position; if there, skip it
Method error Show an error message and the position identifier.
Method extract Extract the next string of the given length, or None if not enough text,
Method identifier Return an identifier for the current position.
Method skip Skip a string
Method skipcurrent Return the current character and skip it.

Inherited from Globable:

Method checkbytemark Check for a Unicode byte mark and skip it.
Method current Return the current character.
Method finished Find out if the current text has finished.
Method glob Glob a bit of text that satisfies a check on the current char.
Method globalpha Glob a bit of alpha text
Method globexcluding Glob a bit of text up until (excluding) any excluded character.
Method globidentifier Glob alphanumeric and _ symbols.
Method globincluding Glob a bit of text up to (including) the magic char.
Method globnumber Glob a row of digits.
Method globvalue Glob a value: any symbols but brackets.
Method isidentifier Return if the current character is alphanumeric or _.
Method isout Find out if we are out of the position yet.
Method isvalue Return if the current character is a value character:
Method nextending Return the next ending in the queue.
Method popending Pop the ending found at the current position
Method pushending Push a new ending to the bottom
Method skipspace Skip all whitespace at current position.
Class Variable leavepending Undocumented
Instance Variable endinglist Undocumented
def __init__(self): (source)
overrides docutils.utils.math.math2html.Globable.__init__
overridden in docutils.utils.math.math2html.FilePosition, docutils.utils.math.math2html.TextPosition

Undocumented

def __next__(self): (source)

Advance the position and return the next character.

def checkfor(self, string): (source)
overrides docutils.utils.math.math2html.Globable.checkfor

Check for a string at the given position.

def checkforlower(self, string): (source)

Check for a string in lower case.

def checkskip(self, string): (source)

Check for a string at the given position; if there, skip it

def error(self, message): (source)

Show an error message and the position identifier.

def extract(self, length): (source)
overridden in docutils.utils.math.math2html.FilePosition, docutils.utils.math.math2html.TextPosition

Extract the next string of the given length, or None if not enough text,

def identifier(self): (source)
overridden in docutils.utils.math.math2html.FilePosition, docutils.utils.math.math2html.TextPosition

Return an identifier for the current position.

def skip(self, string): (source)
overridden in docutils.utils.math.math2html.FilePosition, docutils.utils.math.math2html.TextPosition

Skip a string

def skipcurrent(self): (source)
overrides docutils.utils.math.math2html.Globable.skipcurrent

Return the current character and skip it.