KiCad PCB EDA Suite
STRING_LINE_READER Class Reference

Class STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string. More...

#include <richio.h>

Inheritance diagram for STRING_LINE_READER:
LINE_READER

Public Member Functions

 STRING_LINE_READER (const std::string &aString, const wxString &aSource)
 Constructor STRING_LINE_READER( const std::string&, const wxString& ) More...
 
 STRING_LINE_READER (const STRING_LINE_READER &aStartingPoint)
 Constructor STRING_LINE_READER( const STRING_LINE_READER& ) allows for a continuation of the reading of a stream started by another STRING_LINE_READER. More...
 
char * ReadLine () override
 Function ReadLine reads a line of text into the buffer and increments the line number counter. More...
 
virtual const wxString & GetSource () const
 Function GetSource returns the name of the source of the lines in an abstract sense. More...
 
char * Line () const
 Function Line returns a pointer to the last line that was read in. More...
 
 operator char * () const
 Operator char* is a casting operator that returns a char* pointer to the start of the line buffer. More...
 
virtual unsigned LineNumber () const
 Function Line Number returns the line number of the last line read from this LINE_READER. More...
 
unsigned Length () const
 Function Length returns the number of bytes in the last line read from this LINE_READER. More...
 

Protected Member Functions

void expandCapacity (unsigned aNewsize)
 Function expandCapacity 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

std::string m_lines
 
size_t m_ndx
 
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

Class STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.

Definition at line 254 of file richio.h.

Constructor & Destructor Documentation

STRING_LINE_READER::STRING_LINE_READER ( const std::string &  aString,
const wxString &  aSource 
)

Constructor STRING_LINE_READER( const std::string&, const wxString& )

Parameters
aStringis a source string consisting of one or more lines of text, where multiple lines are separated with a '
' character. The last line does not necessarily need a trailing '
'.
aSourcedescribes the source of aString for error reporting purposes can be anything meaninful, such as wxT( "clipboard" ).

Definition at line 228 of file richio.cpp.

References LINE_READER::m_source.

228  :
230  m_lines( aString ), m_ndx( 0 )
231 {
232  // Clipboard text should be nice and _use multiple lines_ so that
233  // we can report _line number_ oriented error messages when parsing.
234  m_source = aSource;
235 }
#define LINE_READER_LINE_DEFAULT_MAX
Definition: richio.h:73
LINE_READER(unsigned aMaxLineLength=LINE_READER_LINE_DEFAULT_MAX)
Constructor LINE_READER builds a line reader and fixes the length of the maximum supported line lengt...
Definition: richio.cpp:102
wxString m_source
origin of text lines, e.g. filename or "clipboard"
Definition: richio.h:92
std::string m_lines
Definition: richio.h:257
STRING_LINE_READER::STRING_LINE_READER ( const STRING_LINE_READER aStartingPoint)

Constructor STRING_LINE_READER( const STRING_LINE_READER& ) allows for a continuation of the reading of a stream started by another STRING_LINE_READER.

Any stream offset and source name are used from aStartingPoint.

Definition at line 238 of file richio.cpp.

References LINE_READER::m_lineNum, and LINE_READER::m_source.

238  :
240  m_lines( aStartingPoint.m_lines ),
241  m_ndx( aStartingPoint.m_ndx )
242 {
243  // since we are keeping the same "source" name, for error reporting purposes
244  // we need to have the same notion of line number and offset.
245 
246  m_source = aStartingPoint.m_source;
247  m_lineNum = aStartingPoint.m_lineNum;
248 }
unsigned m_lineNum
Definition: richio.h:85
#define LINE_READER_LINE_DEFAULT_MAX
Definition: richio.h:73
LINE_READER(unsigned aMaxLineLength=LINE_READER_LINE_DEFAULT_MAX)
Constructor LINE_READER builds a line reader and fixes the length of the maximum supported line lengt...
Definition: richio.cpp:102
wxString m_source
origin of text lines, e.g. filename or "clipboard"
Definition: richio.h:92
std::string m_lines
Definition: richio.h:257

Member Function Documentation

void LINE_READER::expandCapacity ( unsigned  aNewsize)
protectedinherited

Function expandCapacity 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 131 of file richio.cpp.

References LINE_READER::m_capacity, LINE_READER::m_length, LINE_READER::m_line, and LINE_READER::m_maxLineLength.

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

132 {
133  // m_length can equal maxLineLength and nothing breaks, there's room for
134  // the terminating nul. cannot go over this.
135  if( aNewsize > m_maxLineLength+1 )
136  aNewsize = m_maxLineLength+1;
137 
138  if( aNewsize > m_capacity )
139  {
140  m_capacity = aNewsize;
141 
142  // resize the buffer, and copy the original data
143  // Be sure there is room for the null EOL char, so reserve capacity+1 bytes
144  // to ensure capacity line lenght. Use capacity+5 to cover and corner case
145  char* bigger = new char[m_capacity+5];
146 
147  wxASSERT( m_capacity >= m_length+1 );
148 
149  memcpy( bigger, m_line, m_length );
150  bigger[m_length] = 0;
151 
152  delete[] m_line;
153  m_line = bigger;
154  }
155 }
char * m_line
the read line of UTF8 text
Definition: richio.h:87
unsigned m_capacity
no. bytes allocated for line.
Definition: richio.h:88
unsigned m_length
no. bytes in line before trailing nul.
Definition: richio.h:84
unsigned m_maxLineLength
maximum allowed capacity using resizing.
Definition: richio.h:90
virtual const wxString& LINE_READER::GetSource ( ) const
inlinevirtualinherited

Function GetSource 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 WHITESPACE_FILTER_READER, and FILTER_READER.

Definition at line 130 of file richio.h.

References LINE_READER::m_source.

Referenced by LEGACY_PLUGIN::biuParse(), LEGACY_PLUGIN::checkVersion(), DSNLEXER::CurSource(), LEGACY_PLUGIN::degParse(), FILTER_READER::GetSource(), WHITESPACE_FILTER_READER::GetSource(), CMP_READER::Load(), LEGACY_NETLIST_READER::loadComponent(), LEGACY_NETLIST_READER::loadFootprintFilters(), LEGACY_NETLIST_READER::loadNet(), LEGACY_PLUGIN::loadSETUP(), GPCB_FPL_CACHE::parseMODULE(), and KICAD_NETLIST_PARSER::parseNet().

131  {
132  return m_source;
133  }
wxString m_source
origin of text lines, e.g. filename or "clipboard"
Definition: richio.h:92
unsigned LINE_READER::Length ( ) const
inlineinherited

Function Length returns the number of bytes in the last line read from this LINE_READER.

Definition at line 168 of file richio.h.

References LINE_READER::m_length.

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

169  {
170  return m_length;
171  }
unsigned m_length
no. bytes in line before trailing nul.
Definition: richio.h:84
char* LINE_READER::Line ( ) const
inlineinherited

Function Line returns a pointer to the last line that was read in.

Definition at line 139 of file richio.h.

References LINE_READER::m_line.

Referenced by LEGACY_PLUGIN::biuParse(), LEGACY_PLUGIN::checkVersion(), LEGACY_PLUGIN::degParse(), NETLIST_READER::GuessNetlistFileType(), CMP_READER::Load(), LIB_PIN::Load(), LIB_PART::Load(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), SCH_LEGACY_PLUGIN::loadBitmap(), SCH_LEGACY_PLUGIN::loadBusEntry(), SCH_LEGACY_PLUGIN_CACHE::loadCircle(), SCH_LEGACY_PLUGIN::loadComponent(), BITMAP_BASE::LoadData(), SCH_LEGACY_PLUGIN_CACHE::loadDrawEntries(), SCH_LEGACY_PLUGIN_CACHE::loadField(), EXCELLON_IMAGE::LoadFile(), SCH_LEGACY_PLUGIN::loadFile(), SCH_LEGACY_PLUGIN_CACHE::loadFootprintFilters(), SCH_LEGACY_PLUGIN::loadHeader(), SCH_LEGACY_PLUGIN_CACHE::loadHeader(), SCH_LEGACY_PLUGIN::loadJunction(), LEGACY_PLUGIN::loadMODULE_EDGE(), 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::loadRectangle(), SCH_LEGACY_PLUGIN::loadText(), SCH_LEGACY_PLUGIN_CACHE::loadText(), LEGACY_PLUGIN::loadTrackList(), SCH_LEGACY_PLUGIN::loadWire(), LINE_READER::operator char *(), KICAD_NETLIST_PARSER::parseNet(), GPCB_FPL_CACHE::parseParameters(), DSNLEXER::PopReader(), SCH_EDIT_FRAME::ProcessCmpToFootprintLinkFile(), MWAVE_POLYGONAL_SHAPE_DLG::ReadDataShapeDescr(), FILTER_READER::ReadLine(), DSNLEXER::readLine(), and LP_CACHE::SkipIndex().

140  {
141  return m_line;
142  }
char * m_line
the read line of UTF8 text
Definition: richio.h:87
LINE_READER::operator char * ( ) const
inlineinherited

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

Definition at line 149 of file richio.h.

References LINE_READER::Line().

150  {
151  return Line();
152  }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
char * STRING_LINE_READER::ReadLine ( )
overridevirtual

Function ReadLine reads a line of text into the buffer and increments the line number counter.

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

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

Implements LINE_READER.

Definition at line 251 of file richio.cpp.

References LINE_READER::expandCapacity(), LINE_READER::m_capacity, LINE_READER::m_length, LINE_READER::m_line, LINE_READER::m_lineNum, m_lines, LINE_READER::m_maxLineLength, m_ndx, and THROW_IO_ERROR.

252 {
253  size_t nlOffset = m_lines.find( '\n', m_ndx );
254 
255  if( nlOffset == std::string::npos )
256  m_length = m_lines.length() - m_ndx;
257  else
258  m_length = nlOffset - m_ndx + 1; // include the newline, so +1
259 
260  if( m_length )
261  {
262  if( m_length >= m_maxLineLength )
263  THROW_IO_ERROR( _("Line length exceeded") );
264 
265  if( m_length+1 > m_capacity ) // +1 for terminating nul
267 
268  wxASSERT( m_ndx + m_length <= m_lines.length() );
269 
270  memcpy( m_line, &m_lines[m_ndx], m_length );
271  m_ndx += m_length;
272  }
273 
274  ++m_lineNum; // this gets incremented even if no bytes were read
275  m_line[m_length] = 0;
276 
277  return m_length ? m_line : NULL;
278 }
char * m_line
the read line of UTF8 text
Definition: richio.h:87
unsigned m_lineNum
Definition: richio.h:85
unsigned m_capacity
no. bytes allocated for line.
Definition: richio.h:88
void expandCapacity(unsigned aNewsize)
Function expandCapacity will expand the capacity of line up to maxLineLength but not greater...
Definition: richio.cpp:131
unsigned m_length
no. bytes in line before trailing nul.
Definition: richio.h:84
std::string m_lines
Definition: richio.h:257
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
unsigned m_maxLineLength
maximum allowed capacity using resizing.
Definition: richio.h:90

Member Data Documentation

unsigned LINE_READER::m_capacity
protectedinherited
unsigned LINE_READER::m_length
protectedinherited
std::string STRING_LINE_READER::m_lines
protected

Definition at line 257 of file richio.h.

Referenced by ReadLine().

unsigned LINE_READER::m_maxLineLength
protectedinherited

maximum allowed capacity using resizing.

Definition at line 90 of file richio.h.

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

size_t STRING_LINE_READER::m_ndx
protected

Definition at line 258 of file richio.h.

Referenced by ReadLine().

wxString LINE_READER::m_source
protectedinherited

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

Definition at line 92 of file richio.h.

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


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