KiCad PCB EDA Suite
richio.h File Reference
#include <vector>
#include <utf8.h>
#include <cstdio>
#include <wx/string.h>
#include <wx/stream.h>
#include <ki_exception.h>

Go to the source code of this file.

Classes

class  LINE_READER
 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...
 
class  FILE_LINE_READER
 A LINE_READER that reads from an open file. More...
 
class  STRING_LINE_READER
 Is a LINE_READER that reads from a multiline 8 bit wide std::string. More...
 
class  INPUTSTREAM_LINE_READER
 A LINE_READER that reads from a wxInputStream object. More...
 
class  OUTPUTFORMATTER
 An interface used to output 8 bit text in a convenient way. More...
 
class  STRING_FORMATTER
 Implement an OUTPUTFORMATTER to a memory buffer. More...
 
class  FILE_OUTPUTFORMATTER
 Used for text file output. More...
 
class  STREAM_OUTPUTFORMATTER
 Implement an OUTPUTFORMATTER to a wxWidgets wxOutputStream. More...
 

Macros

#define LINE_READER_LINE_DEFAULT_MAX   1000000
 
#define LINE_READER_LINE_INITIAL_SIZE   5000
 
#define OUTPUTFMTBUFZ   500
 default buffer size for any OUTPUT_FORMATTER More...
 
#define PRINTF_FUNC
 

Functions

int StrPrintf (std::string *aResult, const char *aFormat,...)
 This is like sprintf() but the output is appended to a std::string instead of to a character array. More...
 
std::string StrPrintf (const char *format,...)
 This is like sprintf() but the output is returned in a std::string instead of to a character array. More...
 

Macro Definition Documentation

◆ LINE_READER_LINE_DEFAULT_MAX

#define LINE_READER_LINE_DEFAULT_MAX   1000000

Definition at line 73 of file richio.h.

◆ LINE_READER_LINE_INITIAL_SIZE

#define LINE_READER_LINE_INITIAL_SIZE   5000

Definition at line 74 of file richio.h.

◆ OUTPUTFMTBUFZ

#define OUTPUTFMTBUFZ   500

default buffer size for any OUTPUT_FORMATTER

Definition at line 289 of file richio.h.

◆ PRINTF_FUNC

#define PRINTF_FUNC

Definition at line 347 of file richio.h.

Function Documentation

◆ StrPrintf() [1/2]

int StrPrintf ( std::string *  aResult,
const char *  aFormat,
  ... 
)

This is like sprintf() but the output is appended to a std::string instead of to a character array.

Parameters
aResultis the string to append to, previous text is not clear()ed.
aFormatis a printf() style format string.
Returns
the count of bytes appended to the result string, no terminating nul is included.

Definition at line 78 of file richio.cpp.

79 {
80  va_list args;
81 
82  va_start( args, format );
83  int ret = vprint( result, format, args );
84  va_end( args );
85 
86  return ret;
87 }
static int vprint(std::string *result, const char *format, va_list ap)
Definition: richio.cpp:42

References vprint().

Referenced by fmt_mask(), PCB_IO::format(), FormatProbeItem(), GenCADLayerName(), GenCADLayerNameFlipped(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), PCB_PARSER::init(), GENDRILL_WRITER_BASE::layerName(), PCB_EDIT_FRAME::OpenProjectFiles(), ReplaceIllegalFileNameChars(), SCH_EDIT_FRAME::SendCrossProbeNetName(), PCB_EDIT_FRAME::SendCrossProbeNetName(), CVPCB_MAINFRAME::SendMessageToEESCHEMA(), and SCH_EDIT_FRAME::SetCrossProbeConnection().

◆ StrPrintf() [2/2]

std::string StrPrintf ( const char *  format,
  ... 
)

This is like sprintf() but the output is returned in a std::string instead of to a character array.

Parameters
formatis a printf() style format string.
Returns
std::string - the result of the sprintf().

Definition at line 90 of file richio.cpp.

91 {
92  std::string ret;
93  va_list args;
94 
95  va_start( args, format );
96  int ignore = vprint( &ret, format, args );
97  (void) ignore;
98  va_end( args );
99 
100  return ret;
101 }
static int vprint(std::string *result, const char *format, va_list ap)
Definition: richio.cpp:42

References vprint().