KiCad PCB EDA Suite
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
LINE_READER Class Referenceabstract

An abstract class from which implementation specific LINE_READERs may be derived to read single lines of text and manage a line number counter. More...

#include <richio.h>

Inheritance diagram for LINE_READER:
FILE_LINE_READER FILTER_READER INPUTSTREAM_LINE_READER STDISTREAM_LINE_READER STRING_LINE_READER WHITESPACE_FILTER_READER IFSTREAM_LINE_READER

Public Member Functions

 LINE_READER (unsigned aMaxLineLength=LINE_READER_LINE_DEFAULT_MAX)
 Build a line reader and fixes the length of the maximum supported line length to aMaxLineLength. More...
 
virtual ~LINE_READER ()
 
virtual char * ReadLine ()=0
 Read a line of text into the buffer and increments the line number counter. More...
 
virtual const wxString & GetSource () const
 Returns the name of the source of the lines in an abstract sense. More...
 
char * Line () const
 Return a pointer to the last line that was read in. More...
 
 operator char * () const
 A casting operator that returns a char* pointer to the start of the line buffer. More...
 
virtual unsigned LineNumber () const
 Return the line number of the last line read from this LINE_READER. More...
 
unsigned Length () const
 Return the number of bytes in the last line read from this LINE_READER. More...
 

Protected Member Functions

void expandCapacity (unsigned aNewsize)
 Will expand the capacity of line up to maxLineLength but not greater, so be careful about making assumptions of capacity after calling this. More...
 

Protected Attributes

unsigned m_length
 no. bytes in line before trailing nul. More...
 
unsigned m_lineNum
 
char * m_line
 the read line of UTF8 text More...
 
unsigned m_capacity
 no. bytes allocated for line. More...
 
unsigned m_maxLineLength
 maximum allowed capacity using resizing. More...
 
wxString m_source
 origin of text lines, e.g. filename or "clipboard" More...
 

Detailed Description

An abstract class from which implementation specific LINE_READERs may be derived to read single lines of text and manage a line number counter.

Definition at line 80 of file richio.h.

Constructor & Destructor Documentation

◆ LINE_READER()

LINE_READER::LINE_READER ( unsigned  aMaxLineLength = LINE_READER_LINE_DEFAULT_MAX)

Build a line reader and fixes the length of the maximum supported line length to aMaxLineLength.

Definition at line 111 of file richio.cpp.

111 :
112 m_length( 0 ), m_lineNum( 0 ), m_line( nullptr ),
113 m_capacity( 0 ), m_maxLineLength( aMaxLineLength )
114{
115 if( aMaxLineLength != 0 )
116 {
117 // start at the INITIAL size, expand as needed up to the MAX size in maxLineLength
118 m_capacity = LINE_READER_LINE_INITIAL_SIZE;
119
120 // but never go above user's aMaxLineLength, and leave space for trailing nul
121 if( m_capacity > aMaxLineLength+1 )
122 m_capacity = aMaxLineLength+1;
123
124 // Be sure there is room for a null EOL char, so reserve at least capacity+1 bytes
125 // to ensure capacity line length and avoid corner cases
126 // Use capacity+5 to cover and corner case
127 m_line = new char[m_capacity+5];
128
129 m_line[0] = '\0';
130 }
131}
LINE_READER::m_maxLineLength
unsigned m_maxLineLength
maximum allowed capacity using resizing.
Definition: richio.h:161
LINE_READER::m_length
unsigned m_length
no. bytes in line before trailing nul.
Definition: richio.h:155
LINE_READER::m_capacity
unsigned m_capacity
no. bytes allocated for line.
Definition: richio.h:159
LINE_READER::m_line
char * m_line
the read line of UTF8 text
Definition: richio.h:158
LINE_READER::m_lineNum
unsigned m_lineNum
Definition: richio.h:156
LINE_READER_LINE_INITIAL_SIZE
#define LINE_READER_LINE_INITIAL_SIZE
Definition: richio.h:74

References LINE_READER_LINE_INITIAL_SIZE, m_capacity, and m_line.

◆ ~LINE_READER()

LINE_READER::~LINE_READER ( )
virtual

Definition at line 134 of file richio.cpp.

135{
136 delete[] m_line;
137}

References m_line.

Member Function Documentation

◆ expandCapacity()

void LINE_READER::expandCapacity ( unsigned  aNewsize)
protected

Will expand the capacity of line up to maxLineLength but not greater, so be careful about making assumptions of capacity after calling this.

Definition at line 140 of file richio.cpp.

141{
142 // m_length can equal maxLineLength and nothing breaks, there's room for
143 // the terminating nul. cannot go over this.
144 if( aNewsize > m_maxLineLength+1 )
145 aNewsize = m_maxLineLength+1;
146
147 if( aNewsize > m_capacity )
148 {
149 m_capacity = aNewsize;
150
151 // resize the buffer, and copy the original data
152 // Be sure there is room for the null EOL char, so reserve capacity+1 bytes
153 // to ensure capacity line length. Use capacity+5 to cover and corner case
154 char* bigger = new char[m_capacity+5];
155
156 wxASSERT( m_capacity >= m_length+1 );
157
158 memcpy( bigger, m_line, m_length );
159 bigger[m_length] = 0;
160
161 delete[] m_line;
162 m_line = bigger;
163 }
164}

References m_capacity, m_length, m_line, and m_maxLineLength.

Referenced by FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), and INPUTSTREAM_LINE_READER::ReadLine().

◆ GetSource()

virtual const wxString & LINE_READER::GetSource ( ) const
inlinevirtual

Returns the name of the source of the lines in an abstract sense.

This may be a file or it may be the clipboard or any other source of lines of text. The returned string is useful for reporting error messages.

Reimplemented in FILTER_READER, and WHITESPACE_FILTER_READER.

Definition at line 109 of file richio.h.

110 {
111 return m_source;
112 }
LINE_READER::m_source
wxString m_source
origin of text lines, e.g. filename or "clipboard"
Definition: richio.h:163

References m_source.

Referenced by LEGACY_PLUGIN::biuParse(), LEGACY_PLUGIN::checkVersion(), DSNLEXER::CurSource(), LEGACY_PLUGIN::degParse(), WRLPROC::GetFileName(), FILTER_READER::GetSource(), WHITESPACE_FILTER_READER::GetSource(), CMP_READER::Load(), LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::loadNet(), LEGACY_PLUGIN::loadPAD(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LEGACY_PLUGIN::loadSETUP(), SCH_LEGACY_PLUGIN::loadSymbol(), GPCB_FPL_CACHE::parseFOOTPRINT(), KICAD_NETLIST_PARSER::parseNet(), and WRLPROC::WRLPROC().

◆ Length()

unsigned LINE_READER::Length ( ) const
inline

Return the number of bytes in the last line read from this LINE_READER.

Definition at line 143 of file richio.h.

144 {
145 return m_length;
146 }

References m_length.

Referenced by LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::loadNet(), KICAD_NETLIST_PARSER::parseNet(), DSNLEXER::readLine(), FILTER_READER::ReadLine(), and WHITESPACE_FILTER_READER::ReadLine().

◆ Line()

char * LINE_READER::Line ( ) const
inline

Return a pointer to the last line that was read in.

Definition at line 117 of file richio.h.

118 {
119 return m_line;
120 }

References m_line.

Referenced by bench_string_lr(), bench_string_lr_reuse(), bench_wxbis(), bench_wxbis_reuse(), bench_wxis(), bench_wxis_reuse(), LEGACY_PLUGIN::biuParse(), LEGACY_PLUGIN::checkVersion(), LEGACY_PLUGIN::degParse(), detect_file_type(), NETLIST_READER::GuessNetlistFileType(), SCH_LEGACY_PLUGIN_CACHE::Load(), CMP_READER::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN::loadBitmap(), SCH_LEGACY_PLUGIN::loadBusAlias(), SCH_LEGACY_PLUGIN::loadBusEntry(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN::LoadContent(), BITMAP_BASE::LoadData(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_LEGACY_PLUGIN_CACHE::loadDrawEntries(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_LEGACY_PLUGIN::loadFile(), EXCELLON_IMAGE::LoadFile(), SCH_LEGACY_PLUGIN_CACHE::loadFootprintFilters(), LEGACY_PLUGIN::loadFP_SHAPE(), SCH_LEGACY_PLUGIN_CACHE::loadHeader(), SCH_LEGACY_PLUGIN::loadHeader(), SCH_LEGACY_PLUGIN::loadJunction(), LEGACY_PLUGIN::loadMODULE_TEXT(), LP_CACHE::LoadModules(), LEGACY_NETLIST_READER::LoadNetlist(), SCH_LEGACY_PLUGIN::loadNoConnect(), SCH_LEGACY_PLUGIN::loadPageSettings(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_LEGACY_PLUGIN_CACHE::loadRect(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_LEGACY_PLUGIN::loadText(), SCH_LEGACY_PLUGIN_CACHE::loadText(), LEGACY_PLUGIN::loadTrackList(), SCH_LEGACY_PLUGIN::loadWire(), operator char *(), KICAD_NETLIST_PARSER::parseNet(), GPCB_FPL_CACHE::parseParameters(), DSNLEXER::PopReader(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), MWAVE_POLYGONAL_SHAPE_DLG::ReadDataShapeDescr(), DSNLEXER::readLine(), FILTER_READER::ReadLine(), LP_CACHE::SkipIndex(), EXCELLON_IMAGE::TestFileIsExcellon(), and GERBER_FILE_IMAGE::TestFileIsRS274().

◆ LineNumber()

virtual unsigned LINE_READER::LineNumber ( ) const
inlinevirtual

Return the line number of the last line read from this LINE_READER.

Lines start from 1.

Reimplemented in FILTER_READER, and WHITESPACE_FILTER_READER.

Definition at line 135 of file richio.h.

136 {
137 return m_lineNum;
138 }

References m_lineNum.

Referenced by LEGACY_PLUGIN::biuParse(), SCH_SEXPR_PARSER::checkpoint(), SCH_LEGACY_PLUGIN::checkpoint(), LEGACY_PLUGIN::checkpoint(), DSNLEXER::CurLineNumber(), LEGACY_PLUGIN::degParse(), FILTER_READER::LineNumber(), WHITESPACE_FILTER_READER::LineNumber(), CMP_READER::Load(), LEGACY_NETLIST_READER::loadComponent(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_PLUGIN::loadFP_SHAPE(), LEGACY_NETLIST_READER::loadNet(), LEGACY_PLUGIN::loadPAD(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), LEGACY_PLUGIN::loadSHEET(), SCH_LEGACY_PLUGIN::loadSymbol(), GPCB_FPL_CACHE::parseFOOTPRINT(), and KICAD_NETLIST_PARSER::parseNet().

◆ operator char *()

LINE_READER::operator char * ( ) const
inline

A casting operator that returns a char* pointer to the start of the line buffer.

Definition at line 125 of file richio.h.

126 {
127 return Line();
128 }
LINE_READER::Line
char * Line() const
Return a pointer to the last line that was read in.
Definition: richio.h:117

References Line().

◆ ReadLine()

virtual char * LINE_READER::ReadLine ( )
pure virtual

Read a line of text into the buffer and increments the line number counter.

If the line is larger than the maximum length passed to the constructor, then an exception is thrown. The line is nul terminated.

Returns
The beginning of the read line, or NULL if EOF.
Exceptions
IO_ERRORwhen a line is too long.

Implemented in FILTER_READER, WHITESPACE_FILTER_READER, FILE_LINE_READER, STRING_LINE_READER, INPUTSTREAM_LINE_READER, and STDISTREAM_LINE_READER.

Referenced by LEGACY_PLUGIN::checkVersion(), NETLIST_READER::GuessNetlistFileType(), CMP_READER::Load(), SCH_LEGACY_PLUGIN::loadBitmap(), SCH_LEGACY_PLUGIN::loadBusEntry(), SCH_LEGACY_PLUGIN::LoadContent(), BITMAP_BASE::LoadData(), SCH_LEGACY_PLUGIN_CACHE::loadDrawEntries(), LEGACY_NETLIST_READER::loadFootprintFilters(), SCH_LEGACY_PLUGIN_CACHE::loadFootprintFilters(), SCH_LEGACY_PLUGIN::loadHeader(), LP_CACHE::LoadModules(), LEGACY_NETLIST_READER::LoadNetlist(), SCH_LEGACY_PLUGIN::loadPageSettings(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_LEGACY_PLUGIN::loadText(), SCH_LEGACY_PLUGIN::loadWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), GPCB_FPL_CACHE::parseParameters(), LP_CACHE::ReadAndVerifyHeader(), DSNLEXER::readLine(), FILTER_READER::ReadLine(), WHITESPACE_FILTER_READER::ReadLine(), and LP_CACHE::SkipIndex().

Member Data Documentation

◆ m_capacity

unsigned LINE_READER::m_capacity
protected

no. bytes allocated for line.

Definition at line 159 of file richio.h.

Referenced by expandCapacity(), LINE_READER(), FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), and INPUTSTREAM_LINE_READER::ReadLine().

◆ m_length

unsigned LINE_READER::m_length
protected

no. bytes in line before trailing nul.

Definition at line 155 of file richio.h.

Referenced by expandCapacity(), Length(), FILTER_READER::ReadLine(), WHITESPACE_FILTER_READER::ReadLine(), FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), INPUTSTREAM_LINE_READER::ReadLine(), and STDISTREAM_LINE_READER::ReadLine().

◆ m_line

char* LINE_READER::m_line
protected

the read line of UTF8 text

Definition at line 158 of file richio.h.

Referenced by expandCapacity(), FILTER_READER::FILTER_READER(), Line(), LINE_READER(), FILTER_READER::ReadLine(), WHITESPACE_FILTER_READER::ReadLine(), FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), INPUTSTREAM_LINE_READER::ReadLine(), STDISTREAM_LINE_READER::ReadLine(), STDISTREAM_LINE_READER::STDISTREAM_LINE_READER(), WHITESPACE_FILTER_READER::WHITESPACE_FILTER_READER(), FILTER_READER::~FILTER_READER(), ~LINE_READER(), STDISTREAM_LINE_READER::~STDISTREAM_LINE_READER(), and WHITESPACE_FILTER_READER::~WHITESPACE_FILTER_READER().

◆ m_lineNum

unsigned LINE_READER::m_lineNum
protected

Definition at line 156 of file richio.h.

Referenced by FILE_LINE_READER::FILE_LINE_READER(), LineNumber(), FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), INPUTSTREAM_LINE_READER::ReadLine(), STDISTREAM_LINE_READER::ReadLine(), FILE_LINE_READER::Rewind(), STDISTREAM_LINE_READER::STDISTREAM_LINE_READER(), and STRING_LINE_READER::STRING_LINE_READER().

◆ m_maxLineLength

unsigned LINE_READER::m_maxLineLength
protected

maximum allowed capacity using resizing.

Definition at line 161 of file richio.h.

Referenced by expandCapacity(), FILE_LINE_READER::ReadLine(), STRING_LINE_READER::ReadLine(), and INPUTSTREAM_LINE_READER::ReadLine().

◆ m_source

wxString LINE_READER::m_source
protected

origin of text lines, e.g. filename or "clipboard"

Definition at line 163 of file richio.h.

Referenced by FILE_LINE_READER::FILE_LINE_READER(), GetSource(), IFSTREAM_LINE_READER::IFSTREAM_LINE_READER(), INPUTSTREAM_LINE_READER::INPUTSTREAM_LINE_READER(), and STRING_LINE_READER::STRING_LINE_READER().

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