Public Member Functions | Private Attributes | List of all members
pddm.SourceFile.SectionBase Class Reference
Inheritance diagram for pddm.SourceFile.SectionBase:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, first_line_num)
 
def Append (self, line)
 
def BindMacroCollection (self, macro_collection)
 
def first_line (self)
 
def first_line_num (self)
 
def HitEOF (self)
 
def lines (self)
 
def num_lines_captured (self)
 
def text (self)
 
def TryAppend (self, line, line_num)
 

Private Attributes

 _first_line_num
 
 _lines
 

Detailed Description

Definition at line 380 of file pddm.py.

Constructor & Destructor Documentation

◆ __init__()

def pddm.SourceFile.SectionBase.__init__ (   self,
  first_line_num 
)

Reimplemented in pddm.SourceFile.ExpansionSection.

Definition at line 382 of file pddm.py.

Member Function Documentation

◆ Append()

def pddm.SourceFile.SectionBase.Append (   self,
  line 
)

Definition at line 413 of file pddm.py.

◆ BindMacroCollection()

def pddm.SourceFile.SectionBase.BindMacroCollection (   self,
  macro_collection 
)
Binds the chunk to a macro collection.

Args:
  macro_collection: The collection to bind too.

Reimplemented in pddm.SourceFile.ImportDefinesSection, pddm.SourceFile.DefinitionSection, and pddm.SourceFile.ExpansionSection.

Definition at line 405 of file pddm.py.

◆ first_line()

def pddm.SourceFile.SectionBase.first_line (   self)

Definition at line 429 of file pddm.py.

◆ first_line_num()

def pddm.SourceFile.SectionBase.first_line_num (   self)

Definition at line 425 of file pddm.py.

◆ HitEOF()

def pddm.SourceFile.SectionBase.HitEOF (   self)
Called when the EOF was reached for for a given section.

Reimplemented in pddm.SourceFile.ExpansionSection.

Definition at line 401 of file pddm.py.

◆ lines()

def pddm.SourceFile.SectionBase.lines (   self)

Reimplemented in pddm.SourceFile.ExpansionSection.

Definition at line 417 of file pddm.py.

◆ num_lines_captured()

def pddm.SourceFile.SectionBase.num_lines_captured (   self)

Definition at line 421 of file pddm.py.

◆ text()

def pddm.SourceFile.SectionBase.text (   self)

Definition at line 435 of file pddm.py.

◆ TryAppend()

def pddm.SourceFile.SectionBase.TryAppend (   self,
  line,
  line_num 
)
Try appending a line.

Args:
  line: The line to append.
  line_num: The number of the line.

Returns:
  A tuple of (SUCCESS, CAN_ADD_MORE).  If SUCCESS if False, the line
  wasn't append.  If SUCCESS is True, then CAN_ADD_MORE is True/False to
  indicate if more lines can be added after this one.

Reimplemented in pddm.SourceFile.ImportDefinesSection, pddm.SourceFile.DefinitionSection, pddm.SourceFile.ExpansionSection, and pddm.SourceFile.TextSection.

Definition at line 386 of file pddm.py.

Member Data Documentation

◆ _first_line_num

pddm.SourceFile.SectionBase._first_line_num
private

Definition at line 384 of file pddm.py.

◆ _lines

pddm.SourceFile.SectionBase._lines
private

Definition at line 383 of file pddm.py.


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


libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:11