KiCad PCB EDA Suite
Loading...
Searching...
No Matches
richio.h File Reference
#include <vector>
#include <core/utf8.h>
#include <cstdio>
#include <wx/string.h>
#include <wx/stream.h>
#include <ki_exception.h>
#include <kicommon.h>
#include <io/kicad/kicad_io_utils.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  PRETTIFIED_FILE_OUTPUTFORMATTER
 

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
 
#define PRINTF_FUNC_N
 
#define PRINTF_FUNC
 

Functions

KICOMMON_API wxString SafeReadFile (const wxString &aFilePath, const wxString &aReadType)
 Nominally opens a file and reads it into a string.
 

Macro Definition Documentation

◆ LINE_READER_LINE_DEFAULT_MAX

#define LINE_READER_LINE_DEFAULT_MAX   1000000

◆ LINE_READER_LINE_INITIAL_SIZE

#define LINE_READER_LINE_INITIAL_SIZE   5000

Definition at line 59 of file richio.h.

Referenced by LINE_READER::LINE_READER().

◆ OUTPUTFMTBUFZ

#define OUTPUTFMTBUFZ   500

◆ PRINTF_FUNC

#define PRINTF_FUNC

Definition at line 335 of file richio.h.

◆ PRINTF_FUNC_N

#define PRINTF_FUNC_N

Definition at line 334 of file richio.h.

Function Documentation

◆ SafeReadFile()

KICOMMON_API wxString SafeReadFile ( const wxString & aFilePath,
const wxString & aReadType )

Nominally opens a file and reads it into a string.

But unlike other facilities, this handles mis-encoded Wine-written files on macOS.

Parameters
aFilePath
aReadType
Exceptions
IO_ERRORif the file can't be opened
Returns
the file contents

Definition at line 53 of file richio.cpp.

References _, and THROW_IO_ERROR.

Referenced by PIN_TABLE_IMPORT::ImportData(), LTSPICE_SCHEMATIC::Load(), SPICE_LIBRARY_PARSER::parseFile(), LTSPICE_SCHEMATIC::ReadAsyFile(), and LTSPICE_SCHEMATIC::ReadAsyFiles().