markdown_it.rules_block.state_block.StateBlock Class Reference

Inheritance diagram for markdown_it.rules_block.state_block.StateBlock:

Collaboration diagram for markdown_it.rules_block.state_block.StateBlock:

Public Member Functions
None	__init__ (self, str src, MarkdownIt md, EnvType env, list[Token] tokens)
str	__repr__ (self)
Token	push (self, str ttype, str tag, Literal[-1, 0, 1] nesting)
bool	isEmpty (self, int line)
int	skipEmptyLines (self, int from_pos)
int	skipSpaces (self, int pos)
int	skipSpacesBack (self, int pos, int minimum)
int	skipChars (self, int pos, int code)
int	skipCharsStr (self, int pos, str ch)
int	skipCharsBack (self, int pos, int code, int minimum)
int	skipCharsStrBack (self, int pos, str ch, int minimum)
str	getLines (self, int begin, int end, int indent, bool keepLastLF)
bool	is_code_block (self, int line)
Public Member Functions inherited from markdown_it.ruler.StateBase
str	src (self)
None	src (self, str value)
tuple[int,...]	srcCharCode (self)

Public Attributes
	src
	md
	env
	tokens
	blkIndent
	line
	lineMax
	tight
	ddIndent
	listIndent
	parentType
	level
	result
Public Attributes inherited from markdown_it.ruler.StateBase
	src
	env
	md

Protected Attributes
	_code_enabled
Protected Attributes inherited from markdown_it.ruler.StateBase
	_src
	_srcCharCode

Constructor & Destructor Documentation

__init__()

None markdown_it.rules_block.state_block.StateBlock.__init__	(		self,
		str	src,
		MarkdownIt	md,
		EnvType	env,
		list[Token]	tokens
	)

Reimplemented from markdown_it.ruler.StateBase.

Member Function Documentation

getLines()

str markdown_it.rules_block.state_block.StateBlock.getLines	(		self,
		int	begin,
		int	end,
		int	indent,
		bool	keepLastLF
	)

Cut lines range from source.

is_code_block()

bool markdown_it.rules_block.state_block.StateBlock.is_code_block	(		self,
		int	line
	)

Check if line is a code block,
i.e. the code block rule is enabled and text is indented by more than 3 spaces.

isEmpty()

bool markdown_it.rules_block.state_block.StateBlock.isEmpty	(		self,
		int	line
	)

.

push()

Token markdown_it.rules_block.state_block.StateBlock.push	(		self,
		str	ttype,
		str	tag,
		Literal[-1, 0, 1]	nesting
	)

Push new token to "stream".

skipChars()

int markdown_it.rules_block.state_block.StateBlock.skipChars	(		self,
		int	pos,
		int	code
	)

Skip character code from given position.

skipCharsBack()

int markdown_it.rules_block.state_block.StateBlock.skipCharsBack	(		self,
		int	pos,
		int	code,
		int	minimum
	)

Skip character code reverse from given position - 1.

skipCharsStr()

int markdown_it.rules_block.state_block.StateBlock.skipCharsStr	(		self,
		int	pos,
		str	ch
	)

Skip character string from given position.

skipCharsStrBack()

int markdown_it.rules_block.state_block.StateBlock.skipCharsStrBack	(		self,
		int	pos,
		str	ch,
		int	minimum
	)

Skip character string reverse from given position - 1.

skipEmptyLines()

int markdown_it.rules_block.state_block.StateBlock.skipEmptyLines	(		self,
		int	from_pos
	)

.

skipSpaces()

int markdown_it.rules_block.state_block.StateBlock.skipSpaces	(		self,
		int	pos
	)

Skip spaces from given position.

skipSpacesBack()

int markdown_it.rules_block.state_block.StateBlock.skipSpacesBack	(		self,
		int	pos,
		int	minimum
	)

Skip spaces from given position in reverse.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/markdown_it/rules_block/state_block.py