KiCad PCB EDA Suite
FUTURE_FORMAT_ERROR Struct Reference

Struct FUTURE_FORMAT_ERROR 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:
PARSE_ERROR IO_ERROR

Public Member Functions

 FUTURE_FORMAT_ERROR (const PARSE_ERROR &aParseError, const wxString &aRequiredVersion)
 
 ~FUTURE_FORMAT_ERROR () throw ()
 
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)
 
virtual const wxString Problem () const
 what was the problem? More...
 
virtual const wxString Where () const
 where did the Problem() occur? More...
 
virtual const wxString What () const
 A composite of Problem() and Where() More...
 

Public Attributes

wxString requiredVersion
 version or date of KiCad required to open file More...
 
int lineNumber
 at which line number, 1 based index. More...
 
int byteIndex
 at which byte offset within the line, 1 based index More...
 
std::string inputLine
 problem line of input [say, from a LINE_READER]. More...
 

Protected Attributes

wxString problem
 
wxString where
 

Detailed Description

Struct FUTURE_FORMAT_ERROR 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.

Can be used to generate more informative error messages.

Definition at line 172 of file ki_exception.h.

Constructor & Destructor Documentation

◆ FUTURE_FORMAT_ERROR()

FUTURE_FORMAT_ERROR::FUTURE_FORMAT_ERROR ( const PARSE_ERROR aParseError,
const wxString &  aRequiredVersion 
)

Definition at line 90 of file exceptions.cpp.

91  :
92  PARSE_ERROR(), requiredVersion( aRequiredVersion )
93 {
94  // Avoid double-printing the error message
95  bool wrapped_same_type = !!( dynamic_cast<const FUTURE_FORMAT_ERROR *>( &aParseError ) );
96 
97  if( wrapped_same_type )
98  {
99  problem = aParseError.Problem();
100  }
101  else
102  {
103  problem.Printf( _(
104  "KiCad was unable to open this file, as it was created with\n"
105  "a more recent version than the one you are running.\n"
106  "To open it, you'll need to upgrade KiCad to a more recent version.\n\n"
107  "Date of KiCad version required (or newer): %s\n\n"
108  "Full error text:\n%s" ),
109  requiredVersion, aParseError.Problem() );
110  }
111 
112  lineNumber = aParseError.lineNumber;
113  byteIndex = aParseError.byteIndex;
114  inputLine = aParseError.inputLine;
115 }
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:49
int lineNumber
at which line number, 1 based index.
Definition: ki_exception.h:125
wxString requiredVersion
version or date of KiCad required to open file
Definition: ki_exception.h:174
#define _(s)
Definition: 3d_actions.cpp:31
int byteIndex
at which byte offset within the line, 1 based index
Definition: ki_exception.h:126
std::string inputLine
problem line of input [say, from a LINE_READER].
Definition: ki_exception.h:132
wxString problem
Definition: ki_exception.h:111

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

◆ ~FUTURE_FORMAT_ERROR()

FUTURE_FORMAT_ERROR::~FUTURE_FORMAT_ERROR ( )
throw (
)
inline

Definition at line 177 of file ki_exception.h.

177 {}

Member Function Documentation

◆ init() [1/2]

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

Definition at line 56 of file exceptions.cpp.

57 {
58  problem = aProblem;
59 
60  // The throwers filename is a full filename, depending on Kicad source location.
61  // a short filename will be printed (it is better for user, the full filename has no meaning).
62  wxString srcname = aThrowersFile;
63 
64  where.Printf( THROWERS_WHERE, srcname.AfterLast( '/' ).GetData(),
65  wxString( aThrowersFunction ).GetData(), aThrowersLineNumber );
66 }
#define THROWERS_WHERE
Definition: exceptions.cpp:29
wxString where
Definition: ki_exception.h:112
wxString problem
Definition: ki_exception.h:111

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

Referenced by IO_ERROR::IO_ERROR().

◆ init() [2/2]

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 69 of file exceptions.cpp.

74 {
75  problem.Printf( PARSE_PROBLEM, aProblem.GetData(), aSource.GetData(), aLineNumber, aByteIndex );
76 
77  inputLine = aInputLine;
78  lineNumber = aLineNumber;
79  byteIndex = aByteIndex;
80 
81  // The throwers filename is a full filename, depending on Kicad source location.
82  // a short filename will be printed (it is better for user, the full filename has no meaning).
83  wxString srcname = aThrowersFile;
84 
85  where.Printf( THROWERS_WHERE, srcname.AfterLast( '/' ).GetData(),
86  wxString( aThrowersFunction ).GetData(), aThrowersLineNumber );
87 }
int lineNumber
at which line number, 1 based index.
Definition: ki_exception.h:125
#define THROWERS_WHERE
Definition: exceptions.cpp:29
int byteIndex
at which byte offset within the line, 1 based index
Definition: ki_exception.h:126
wxString where
Definition: ki_exception.h:112
std::string inputLine
problem line of input [say, from a LINE_READER].
Definition: ki_exception.h:132
wxString problem
Definition: ki_exception.h:111
#define PARSE_PROBLEM
Definition: exceptions.cpp:30

References PARSE_ERROR::byteIndex, PARSE_ERROR::inputLine, PARSE_ERROR::lineNumber, PARSE_PROBLEM, IO_ERROR::problem, THROWERS_WHERE, and IO_ERROR::where.

Referenced by PARSE_ERROR::PARSE_ERROR().

◆ Problem()

◆ What()

const wxString IO_ERROR::What ( ) const
virtualinherited

A composite of Problem() and Where()

Definition at line 33 of file exceptions.cpp.

34 {
35 #ifdef DEBUG
36  return wxString( "IO_ERROR: " ) + Problem() + "\n\n" + Where();
37 #else
38  return Problem();
39 #endif
40 }
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:49
virtual const wxString Where() const
where did the Problem() occur?
Definition: exceptions.cpp:43

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::ArchiveModulesOnBoard(), SCH_EDIT_FRAME::CreateArchiveLibrary(), DIALOG_PLOT_SCHEMATIC::CreateDXFFile(), DIALOG_PLOT_SCHEMATIC::createHPGLFile(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DIALOG_PLOT_SCHEMATIC::createPDFFile(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DIALOG_PLOT_SCHEMATIC::createPSFile(), DIALOG_PLOT_SCHEMATIC::createSVGFile(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), SCH_EDIT_FRAME::EditSheet(), PCB_EDIT_FRAME::Export_IDF3(), FOOTPRINT_EDIT_FRAME::Export_Module(), LIB_EDIT_FRAME::ExportPart(), PCB_EDIT_FRAME::ExportSpecctraFile(), GPCB_PLUGIN::FootprintEnumerate(), LEGACY_PLUGIN::FootprintEnumerate(), PCB_IO::FootprintEnumerate(), EAGLE_PLUGIN::FootprintEnumerate(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), LIB_MANAGER::GetAlias(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::GetLibrary(), LIB_MANAGER::getOriginalParts(), FOOTPRINT_EDIT_FRAME::Import_Module(), PCB_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::importFile(), LIB_EDIT_FRAME::ImportPart(), PCB_EDIT_FRAME::ImportSpecctraSession(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), FP_CACHE::Load(), GPCB_FPL_CACHE::Load(), PART_LIBS::LoadAllLibraries(), LIB_EDIT_FRAME::LoadComponentFromCurrentLib(), PCB_BASE_FRAME::loadFootprint(), PCB_BASE_FRAME::LoadFootprint(), SCH_LEGACY_PLUGIN::loadHierarchy(), LIB_EDIT_FRAME::LoadOneSymbol(), SCH_EDIT_FRAME::LoadSheetFromFile(), main(), KICAD_MANAGER_FRAME::OnImportEagleFiles(), APP_SINGLE_TOP::OnInit(), CV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), APP_SINGLE_TOP::OnRun(), APP_KICAD::OnRun(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), PROJECT::PcbFootprintLibs(), DIALOG_CHOOSE_COMPONENT::PopulateFootprintSelector(), PCB_CALCULATOR_FRAME::ReadDataFile(), CVPCB_MAINFRAME::ReadNetListAndFpFiles(), PCB_EDIT_FRAME::ReadNetlistFromFile(), CVPCB_MAINFRAME::ReadSchematicNetlist(), GITHUB_GETLIBLIST::remoteGetJSON(), GITHUB_PLUGIN::remoteGetZip(), SCH_COMPONENT::Resolve(), PCB_EDIT_FRAME::RunEeschema(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), SCH_EDIT_FRAME::SaveEEFile(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), LIB_EDIT_FRAME::SaveOneSymbol(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_BASE_FRAME::saveSymbolLibTables(), SchGetLibPart(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), WS_DATA_MODEL::SetPageLayout(), DIALOG_CHOOSE_COMPONENT::ShowFootprintFor(), KICAD_MANAGER_CONTROL::ShowPlayer(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), NETLIST_EXPORTER_KICAD::WriteNetlist(), SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary(), WS_DATA_MODEL_FILEIO::WS_DATA_MODEL_FILEIO(), and WS_DATA_MODEL_STRINGIO::WS_DATA_MODEL_STRINGIO().

◆ Where()

const wxString IO_ERROR::Where ( ) const
virtualinherited

where did the Problem() occur?

Definition at line 43 of file exceptions.cpp.

44 {
45  return where;
46 }
wxString where
Definition: ki_exception.h:112

References IO_ERROR::where.

Referenced by parse(), KI_TEST::ReadBoardItemFromStream(), 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 126 of file ki_exception.h.

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

◆ 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, incase there was a problem with the encoding, in which case converting to wxString is not reliable in this context.

Definition at line 132 of file ki_exception.h.

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

◆ lineNumber

int PARSE_ERROR::lineNumber
inherited

at which line number, 1 based index.

Definition at line 125 of file ki_exception.h.

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

◆ problem

wxString IO_ERROR::problem
protectedinherited

◆ requiredVersion

wxString FUTURE_FORMAT_ERROR::requiredVersion

version or date of KiCad required to open file

Definition at line 174 of file ki_exception.h.

Referenced by FUTURE_FORMAT_ERROR().

◆ where

wxString IO_ERROR::where
protectedinherited

Definition at line 112 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: