Package peppy :: Module fundamental :: Class ReindentBase

Class ReindentBase

object --+
         |
        ReindentBase

Known Subclasses:

Base class for reindenting code.

This class provides a base class for major modes that want to implement their own reindention code. The reindentLine method should use information about the major mode to indent the line to its correct column. For instance, the PythonMode uses the IDLEReindentMixin to calculate the correct indent column of the python source code line.

This operation is typically bound to the tab key, but regardless to the actual keypress to which it is bound is *only* called in response to a user keypress.

Instance Methods

getReindentColumn(self, linenum, linestart, pos, indpos, col, indcol)
User hook to return the new indentation position.

reindentLine(self, linenum=None, dedent_only=False)
Reindent the specified line to the correct level.

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties
Inherited from `object`: `__class__`

Method Details

getReindentColumn(self, linenum, linestart, pos, indpos, col, indcol)

User hook to return the new indentation position.

This routine should be overridden in subclasses to provide the correct indentation of the first not-blank character of the line.

linenum: current line number linestart: position of character at column zero of line pos: position of cursor indpos: position of first non-blank character in line col: column number of cursor indcol: column number of first non-blank character

return: the number of columns to indent, or None to leave as-is

reindentLine(self, linenum=None, dedent_only=False)

Reindent the specified line to the correct level.

This method should be overridden in subclasses to provide the proper indention based on the type of text file. The default implementation provided here will indent to the previous line.

Return the new cursor position, in case the cursor has moved as a result of the indention.