docutils.utils.math.math2html.Globable

class documentation

class Globable(object): (source)

Known subclasses: docutils.utils.math.math2html.Position

View In Hierarchy

A bit of text which can be globbed (lumped together in bits). Methods current(), skipcurrent(), checkfor() and isout() have to be implemented by subclasses.

Method __init__ Undocumented
Method checkbytemark Check for a Unicode byte mark and skip it.
Method checkfor Check for the given string in the current position.
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 skipcurrent Return the current character and skip it.
Method skipspace Skip all whitespace at current position.
Class Variable leavepending Undocumented
Instance Variable endinglist Undocumented
def __init__(self): (source)
overridden in docutils.utils.math.math2html.Position

Undocumented

def checkbytemark(self): (source)

Check for a Unicode byte mark and skip it.

def checkfor(self, string): (source)
overridden in docutils.utils.math.math2html.Position

Check for the given string in the current position.

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

Return the current character.

def finished(self): (source)

Find out if the current text has finished.

def glob(self, currentcheck): (source)

Glob a bit of text that satisfies a check on the current char.

def globalpha(self): (source)

Glob a bit of alpha text

def globexcluding(self, excluded): (source)

Glob a bit of text up until (excluding) any excluded character.

def globidentifier(self): (source)

Glob alphanumeric and _ symbols.

def globincluding(self, magicchar): (source)

Glob a bit of text up to (including) the magic char.

def globnumber(self): (source)

Glob a row of digits.

def globvalue(self): (source)

Glob a value: any symbols but brackets.

def isidentifier(self): (source)

Return if the current character is alphanumeric or _.

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

Find out if we are out of the position yet.

def isvalue(self): (source)

Return if the current character is a value character:

def nextending(self): (source)

Return the next ending in the queue.

def popending(self, expected=None): (source)

Pop the ending found at the current position

def pushending(self, ending, optional=False): (source)

Push a new ending to the bottom

def skipcurrent(self): (source)
overridden in docutils.utils.math.math2html.Position

Return the current character and skip it.

def skipspace(self): (source)

Skip all whitespace at current position.

leavepending: bool = (source)

Undocumented

endinglist = (source)

Undocumented