KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ki_error.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#include <ki_error.h>
21#include <ki_exception.h>
22
23#include <fmt/format.h>
24#include <wx/tokenzr.h>
25
26
27wxString KI_ERROR::AsString() const
28{
29 wxString flat;
30
31 if( !m_title.empty() )
32 flat << m_title;
33
34 if( !m_description.empty() )
35 {
36 if( !flat.empty() )
37 flat << wxS( ": " );
38
39 flat << m_description;
40 }
41
42 if( !m_debugText.empty() )
43 {
44 if( !flat.empty() )
45 flat << wxS( "\n" );
46
47 flat << m_debugText;
48 }
49
50 return flat;
51}
52
53
54auto format_as( const KI_ERROR& aError )
55{
56 return aError.AsString().ToStdString( wxConvUTF8 );
57}
Holds a structured error message.
Definition ki_error.h:38
wxString m_description
Definition ki_error.h:90
wxString m_debugText
Definition ki_error.h:91
wxString AsString() const
Definition ki_error.cpp:27
wxString m_title
Definition ki_error.h:89
auto format_as(const KI_ERROR &aError)
Definition ki_error.cpp:54