sources.SourceBlock Class Reference

SOURCE BLOCK CLASS. More...

Public Member Functions
def	__init__
def	dump
def	location

Public Attributes
	content
	filename
	format
	lineno
	lines
	processor

Detailed Description

SOURCE BLOCK CLASS.

A SourceProcessor is in charge of reading a C source file and decomposing it into a series of different "SourceBlocks". each one of these blocks can be made of the following data:

• A documentation comment block that starts with "/**" and whose exact format will be discussed later
• normal sources lines, including comments

the important fields in a text block are the following ones:

self.lines : a list of text lines for the corresponding block

self.content : for documentation comment blocks only, this is the block content that has been "unboxed" from its decoration. This is None for all other blocks (i.e. sources or ordinary comments with no starting markup tag)

Definition at line 201 of file sources.py.

Constructor & Destructor Documentation

def sources.SourceBlock.__init__	(		self,
			processor,
			filename,
			lineno,
			lines
	)

Definition at line 203 of file sources.py.

Member Function Documentation

def sources.SourceBlock.dump

(

self

)

Definition at line 237 of file sources.py.

References sources.SourceBlock.content, PCF_TableRec_.format, GXV_lcar_DataRec_.format, GXV_opbd_DataRec_.format, TT_CMap_ClassRec_.format, TT_CMapInfo_.format, CFF_EncodingRec_.format, CFF_CharsetRec_.format, FT_GlyphRec_.format, bdf_property_t_.format, CFF_FDSelectRec_.format, sources.SourceBlock.format, TT_NameTableRec_.format, PFR_GlyphRec_.format, FTC_SBitRec_.format, FT_GlyphSlotRec_.format, content.DocCode.lines, content.DocPara.lines, and sources.SourceBlock.lines.

def sources.SourceBlock.location

(

self

)

Definition at line 233 of file sources.py.

References sources.SourceBlock.filename, and sources.SourceBlock.lineno.

Member Data Documentation

sources.SourceBlock.content

Definition at line 209 of file sources.py.

Referenced by sources.SourceBlock.dump().

sources.SourceBlock.filename

Definition at line 205 of file sources.py.

Referenced by sources.SourceProcessor.add_block_lines(), sources.SourceBlock.location(), and sources.SourceProcessor.parse_file().

sources.SourceBlock.format

Definition at line 208 of file sources.py.

Referenced by sources.SourceProcessor.add_block_lines(), sources.SourceBlock.dump(), sources.SourceProcessor.parse_file(), sources.SourceProcessor.process_normal_line(), and sources.SourceProcessor.reset().

sources.SourceBlock.lineno

Definition at line 206 of file sources.py.

Referenced by sources.SourceProcessor.add_block_lines(), sources.SourceBlock.location(), and sources.SourceProcessor.process_normal_line().

sources.SourceBlock.lines

Definition at line 207 of file sources.py.

Referenced by sources.SourceProcessor.add_block_lines(), and sources.SourceBlock.dump().

sources.SourceBlock.processor

Definition at line 204 of file sources.py.

---

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

• zenilib/jni/external/freetype2/src/tools/docmaker/sources.py