KICAD_FORMAT Namespace Reference

Functions
void	FormatBool (OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
	Writes a boolean to the formatter, in the style (aKey [yes|no])
void	FormatUuid (OUTPUTFORMATTER *aOut, const KIID &aUuid)
void	FormatStreamData (OUTPUTFORMATTER &aOut, const wxStreamBuffer &aStream)
	Write binary data to the formatter as base 64 encoded string.
void	Prettify (std::string &aSource, bool aCompactSave)

Function Documentation

FormatBool()

KICOMMON_API void KICAD_FORMAT::FormatBool	(	OUTPUTFORMATTER *	aOut,
		const wxString &	aKey,
		bool	aValue
	)

Writes a boolean to the formatter, in the style (aKey [yes|no])

Parameters

aOut	is the output formatter to write to
aKey	is the name of the boolean flag
aValue	is the value to write

Definition at line 35 of file kicad_io_utils.cpp.

References OUTPUTFORMATTER::Print().

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_PLOT_PARAMS::Format(), EDA_TEXT::Format(), SCH_IO_KICAD_SEXPR::Format(), BOARD_STACKUP::FormatBoardStackup(), PCB_IO_KICAD_SEXPR::formatGeneral(), PCB_IO_KICAD_SEXPR::formatSetup(), PCB_IO_KICAD_SEXPR::formatTeardropParameters(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveTable(), SCH_IO_KICAD_SEXPR::saveText(), and SCH_IO_KICAD_SEXPR::saveTextBox().

FormatStreamData()

KICOMMON_API void KICAD_FORMAT::FormatStreamData	(	OUTPUTFORMATTER &	aOut,
		const wxStreamBuffer &	aStream
	)

Write binary data to the formatter as base 64 encoded string.

Definition at line 47 of file kicad_io_utils.cpp.

References MIME_BASE64_LENGTH, OUTPUTFORMATTER::Print(), and TO_UTF8.

Referenced by PCB_IO_KICAD_SEXPR::format(), DS_DATA_MODEL_IO::format(), and SCH_IO_KICAD_SEXPR::saveBitmap().

FormatUuid()

KICOMMON_API void KICAD_FORMAT::FormatUuid	(	OUTPUTFORMATTER *	aOut,
		const KIID &	aUuid
	)

Definition at line 41 of file kicad_io_utils.cpp.

References KIID::AsString(), OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_SEXPR::saveBitmap(), SCH_IO_KICAD_SEXPR::saveBusEntry(), SCH_IO_KICAD_SEXPR::saveJunction(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_SEXPR::saveNoConnect(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveText(), and SCH_IO_KICAD_SEXPR::saveTextBox().

Prettify()

KICOMMON_API void KICAD_FORMAT::Prettify	(	std::string &	aSource,
		bool	aCompactSave
	)

Definition at line 89 of file kicad_io_utils.cpp.

References cursor, and next().

Referenced by BOOST_FIXTURE_TEST_CASE(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SCH_EDITOR_CONTROL::doCopy(), PRETTIFIED_FILE_OUTPUTFORMATTER::Finish(), CLIPBOARD_IO::SaveBoard(), and CLIPBOARD_IO::SaveSelection().