kicad_io_utils.cpp File Reference

#include "io/kicad/kicad_io_utils.h"
#include <wx/buffer.h>
#include <wx/ffile.h>
#include <wx/base64.h>
#include <fmt/format.h>
#include <eda_item.h>
#include <kiid.h>
#include <richio.h>
#include <string_utils.h>

Go to the source code of this file.

Namespaces
namespace	KICAD_FORMAT

Macros
#define	wxUSE_BASE64   1

Functions
void	KICAD_FORMAT::FormatBool (OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
	Writes a boolean to the formatter, in the style (aKey [yes|no])
void	KICAD_FORMAT::FormatOptBool (OUTPUTFORMATTER *aOut, const wxString &aKey, std::optional< bool > aValue)
	Writes an optional boolean to the formatter.
void	KICAD_FORMAT::FormatUuid (OUTPUTFORMATTER *aOut, const KIID &aUuid)
void	KICAD_FORMAT::FormatCustomProperties (OUTPUTFORMATTER *aOut, const EDA_ITEM &aItem)
	Writes the item's custom properties as a series of (custom_property "key" "value")
void	KICAD_FORMAT::FormatStreamData (OUTPUTFORMATTER &aOut, const wxStreamBuffer &aStream)
	Write binary data to the formatter as base 64 encoded string.
void	KICAD_FORMAT::Prettify (std::string &aSource, FORMAT_MODE aMode=FORMAT_MODE::NORMAL)
	Pretty-prints s-expression text according to KiCad format rules.
bool	LoadFileToMemory (const wxString &aFileName, wxMemoryBuffer &aBuffer)
	Load the contents of a file into a memory buffer.

Macro Definition Documentation

wxUSE_BASE64

#define wxUSE_BASE64   1

Definition at line 27 of file kicad_io_utils.cpp.

Function Documentation

LoadFileToMemory()

bool LoadFileToMemory	(	const wxString &	aFileName,
		wxMemoryBuffer &	aBuffer )

Load the contents of a file into a memory buffer.

Parameters

aFileName	is the file to read.
aBuffer	receives the file contents.

Returns

true when the file was read, false when the file cannot be read or is empty.

Definition at line 358 of file kicad_io_utils.cpp.