Variant of PARSE_ERROR indicating that a syntax or related error was likely caused by a file generated by a newer version of KiCad than this. More...

#include <ki_exception.h>

Inheritance diagram for FUTURE_FORMAT_ERROR:

Public Member Functions
	FUTURE_FORMAT_ERROR (const wxString &aRequiredVersion, const wxString &aRequiredGenerator=wxEmptyString)

	FUTURE_FORMAT_ERROR (const PARSE_ERROR &aParseError, const wxString &aRequiredVersion, const wxString &aRequiredGenerator=wxEmptyString)

	~FUTURE_FORMAT_ERROR () throw ()

void	init (const wxString &aRequiredVersion, const wxString &aRequiredGenerator=wxEmptyString)

void	init (const wxString &aProblem, const char aThrowersFile, const char aThrowersFunction, int aThrowersLineNumber, const wxString &aSource, const char *aInputLine, int aLineNumber, int aByteIndex)

void	init (const wxString &aProblem, const char aThrowersFile, const char aThrowersFunction, int aThrowersLineNumber)

const wxString	ParseProblem ()

virtual const wxString	Problem () const
	what was the problem?

virtual const wxString	Where () const
	where did the Problem() occur?

virtual const wxString	What () const
	A composite of Problem() and Where()

Public Attributes
wxString	requiredVersion
	Date of KiCad file format required to open file.

wxString	requiredGenerator
	Version of KiCad required to open file.

int	lineNumber
	at which line number, 1 based index.

int	byteIndex
	at which byte offset within the line, 1 based index

std::string	inputLine
	problem line of input [say, from a LINE_READER].

Protected Attributes
wxString	parseProblem

wxString	problem

wxString	where

Detailed Description

Variant of PARSE_ERROR indicating that a syntax or related error was likely caused by a file generated by a newer version of KiCad than this.

This can be used to generate more informative error messages.

Definition at line 175 of file ki_exception.h.

Constructor & Destructor Documentation

◆ FUTURE_FORMAT_ERROR() [1/2]

FUTURE_FORMAT_ERROR::FUTURE_FORMAT_ERROR	(	const wxString &	aRequiredVersion,
		const wxString &	aRequiredGenerator = `wxEmptyString`
	)

Definition at line 126 of file exceptions.cpp.

References PARSE_ERROR::byteIndex, init(), and PARSE_ERROR::lineNumber.

◆ FUTURE_FORMAT_ERROR() [2/2]

FUTURE_FORMAT_ERROR::FUTURE_FORMAT_ERROR	(	const PARSE_ERROR &	aParseError,
		const wxString &	aRequiredVersion,
		const wxString &	aRequiredGenerator = `wxEmptyString`
	)

Definition at line 137 of file exceptions.cpp.

References _, PARSE_ERROR::byteIndex, init(), PARSE_ERROR::inputLine, PARSE_ERROR::lineNumber, IO_ERROR::Problem(), IO_ERROR::problem, requiredGenerator, and requiredVersion.

◆ ~FUTURE_FORMAT_ERROR()

FUTURE_FORMAT_ERROR::~FUTURE_FORMAT_ERROR	(	)
throw	(
	)

inline

Definition at line 184 of file ki_exception.h.

Member Function Documentation

◆ init() [1/3]

void IO_ERROR::init	(	const wxString &	aProblem,
		const char *	aThrowersFile,
		const char *	aThrowersFunction,
		int	aThrowersLineNumber
	)

inherited

Definition at line 53 of file exceptions.cpp.

References IO_ERROR::problem, and IO_ERROR::where.

◆ init() [2/3]

void PARSE_ERROR::init	(	const wxString &	aProblem,
		const char *	aThrowersFile,
		const char *	aThrowersFunction,
		int	aThrowersLineNumber,
		const wxString &	aSource,
		const char *	aInputLine,
		int	aLineNumber,
		int	aByteIndex
	)

inherited

Definition at line 71 of file exceptions.cpp.

References _, PARSE_ERROR::byteIndex, PARSE_ERROR::inputLine, PARSE_ERROR::lineNumber, PARSE_ERROR::parseProblem, IO_ERROR::problem, and IO_ERROR::where.

◆ init() [3/3]

void FUTURE_FORMAT_ERROR::init	(	const wxString &	aRequiredVersion,
		const wxString &	aRequiredGenerator = `wxEmptyString`
	)

Definition at line 101 of file exceptions.cpp.

References _, IO_ERROR::problem, requiredGenerator, and requiredVersion.

Referenced by FUTURE_FORMAT_ERROR().

◆ ParseProblem()

const wxString PARSE_ERROR::ParseProblem ( )

inlineinherited

Definition at line 151 of file ki_exception.h.

Referenced by PANEL_SETUP_RULES::OnCompile().

◆ Problem()

const wxString IO_ERROR::Problem ( ) const

virtualinherited

what was the problem?

Definition at line 46 of file exceptions.cpp.

References IO_ERROR::problem.

Referenced by SIM_MODEL::Create(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), FUTURE_FORMAT_ERROR(), SYMBOL_LIBRARY_MANAGER::GetAliases(), PNS_LOG_FILE::Load(), PCB_TEST_FRAME_BASE::LoadAndDisplayBoard(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), and IO_ERROR::What().

◆ What()

const wxString IO_ERROR::What ( ) const

virtualinherited

A composite of Problem() and Where()

Definition at line 30 of file exceptions.cpp.

References IO_ERROR::Problem(), and IO_ERROR::Where().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), PCB_CONTROL::AppendBoard(), PL_EDIT_TOOL::Copy(), SIM_MODEL::Create(), SCH_EDIT_FRAME::CreateArchiveLibrary(), SCH_PLOTTER::createDXFFiles(), SCH_PLOTTER::createHPGLFiles(), SIM_LIB_MGR::CreateModel(), PCB_BASE_EDIT_FRAME::createNewLibrary(), SCH_PLOTTER::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_PLOTTER::createPSFiles(), SCH_PLOTTER::createSVGFiles(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), DS_DATA_MODEL_FILEIO::DS_DATA_MODEL_FILEIO(), DS_DATA_MODEL_STRINGIO::DS_DATA_MODEL_STRINGIO(), PCB_EDIT_FRAME::Export_IDF3(), FOOTPRINT_EDIT_FRAME::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), PCB_EDIT_FRAME::ExportSpecctraFile(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), PCB_EDIT_FRAME::FetchNetlistFromSchematic(), PCB_IO_EAGLE::FootprintEnumerate(), PCB_IO_GEDA::FootprintEnumerate(), PCB_IO_KICAD_LEGACY::FootprintEnumerate(), PCB_IO_KICAD_SEXPR::FootprintEnumerate(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), PCB_EDIT_FRAME::GenIPC2581File(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), PGM_BASE::HandleException(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), PCB_EDIT_FRAME::ImportSpecctraSession(), SYMBOL_EDIT_FRAME::ImportSymbol(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), GPCB_FPL_CACHE::Load(), FP_CACHE::Load(), PNS_LOG_FILE::Load(), LTSPICE_SCHEMATIC::Load(), SYMBOL_LIBS::LoadAllLibraries(), KI_TEST::LoadBoard(), DS_DATA_MODEL::LoadDrawingSheet(), SCH::IFACE::loadGlobalLibTable(), PCB::IFACE::loadGlobalLibTable(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), LoadVRML(), main(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), APP_TEST::OnInit(), CV::IFACE::OnKifaceStart(), APP_TEST::OnRun(), DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), DIALOG_SIM_MODEL< T >::onWaveformChoice(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SPICE_LIBRARY_PARSER::parseFile(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), PROJECT::PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), PANEL_REGULATOR::ReadDataFile(), SPICE_LIBRARY_PARSER::readFallbacks(), CVPCB_MAINFRAME::readNetListAndFpFiles(), PCB_EDIT_FRAME::ReadNetlistFromFile(), CVPCB_MAINFRAME::readSchematicNetlist(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB_EDIT_FRAME::RunEeschema(), LIB_BUFFER::SaveBuffer(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::saveSchematicFile(), SCH_BASE_FRAME::saveSymbolLibTables(), SchGetLibSymbol(), PROJECT_SCH::SchLibs(), PROJECT_SCH::SchSymbolLibTable(), PCB_BASE_FRAME::setFPWatcher(), SIM_LIB_MGR::SetLibrary(), DS_DATA_MODEL::SetPageLayout(), SCH_BASE_FRAME::setSymWatcher(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), KICAD_MANAGER_CONTROL::ShowPlayer(), SCH_EDITOR_CONTROL::SimProbe(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), SCH_SCREEN::UpdateSymbolLinks(), PANEL_SYM_LIB_TABLE::verifyTables(), SYMBOL_ASYNC_LOADER::worker(), WriteDRCReport(), NETLIST_EXPORTER_KICAD::WriteNetlist(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

◆ Where()

const wxString IO_ERROR::Where ( ) const

virtualinherited

where did the Problem() occur?

Definition at line 40 of file exceptions.cpp.

References IO_ERROR::where.

Referenced by PCB_EDIT_FRAME::FetchNetlistFromSchematic(), and IO_ERROR::What().

Member Data Documentation

◆ byteIndex

int PARSE_ERROR::byteIndex

inherited

at which byte offset within the line, 1 based index

Definition at line 122 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), PARSE_ERROR::init(), and PANEL_SETUP_RULES::OnCompile().

◆ inputLine

std::string PARSE_ERROR::inputLine

inherited

problem line of input [say, from a LINE_READER].

this is brought up in original byte format rather than wxString form, in case there was a problem with the encoding, in which case converting to wxString is not reliable in this context.

Definition at line 128 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), PARSE_ERROR::init(), and PROJECT_SCH::SchLibs().

◆ lineNumber

int PARSE_ERROR::lineNumber

inherited

at which line number, 1 based index.

Definition at line 121 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), PARSE_ERROR::init(), and PANEL_SETUP_RULES::OnCompile().

◆ parseProblem

wxString PARSE_ERROR::parseProblem

protectedinherited

Definition at line 161 of file ki_exception.h.

Referenced by PARSE_ERROR::init().

◆ problem

wxString IO_ERROR::problem

protectedinherited

Definition at line 107 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), IO_ERROR::init(), PARSE_ERROR::init(), init(), and IO_ERROR::Problem().

◆ requiredGenerator

wxString FUTURE_FORMAT_ERROR::requiredGenerator

Version of KiCad required to open file.

Definition at line 178 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), and init().

◆ requiredVersion

wxString FUTURE_FORMAT_ERROR::requiredVersion

Date of KiCad file format required to open file.

Definition at line 177 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR(), and init().

◆ where

wxString IO_ERROR::where

protectedinherited

Definition at line 108 of file ki_exception.h.

Referenced by IO_ERROR::init(), PARSE_ERROR::init(), and IO_ERROR::Where().

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

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FUTURE_FORMAT_ERROR() [1/2]

◆ FUTURE_FORMAT_ERROR() [2/2]

◆ ~FUTURE_FORMAT_ERROR()

Member Function Documentation

◆ init() [1/3]

◆ init() [2/3]

◆ init() [3/3]

◆ ParseProblem()

◆ Problem()

◆ What()

◆ Where()

Member Data Documentation

◆ byteIndex

◆ inputLine

◆ lineNumber

◆ parseProblem

◆ problem

◆ requiredGenerator

◆ requiredVersion

◆ where