KiCad PCB EDA Suite
Toggle main menu visibility
Main Page
Related Pages
Modules
Namespaces
Namespace List
Namespace Members
All
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
Functions
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
r
s
t
u
v
w
Variables
a
c
d
e
f
g
h
i
k
l
m
o
p
r
s
t
u
v
Typedefs
a
c
e
f
i
k
l
m
n
o
p
s
v
w
Enumerations
c
d
f
g
l
m
n
o
p
q
r
s
t
v
Enumerator
a
b
c
d
e
g
h
i
l
m
n
o
p
r
s
t
u
v
Classes
Class List
Class Index
Class Hierarchy
Class Members
All
$
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Functions
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
~
Variables
$
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Typedefs
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
Enumerations
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Related Functions
a
b
c
d
e
f
g
h
i
j
l
m
n
o
p
r
s
t
u
v
z
Files
File List
File Members
All
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
Functions
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
z
Variables
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
z
Typedefs
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Enumerations
_
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
z
Enumerator
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
r
s
t
u
v
w
x
y
z
Macros
_
a
b
c
d
e
f
g
h
i
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
KiCad Dev Docs
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Modules
Pages
Concepts
Loading...
Searching...
No Matches
kicad_io_utils.h
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 modify it
7
* under the terms of the GNU General Public License as published by the
8
* Free Software Foundation, either version 3 of the License, or (at your
9
* option) any later version.
10
*
11
* This program is distributed in the hope that it will be useful, but
12
* WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
* General Public License for more details.
15
*
16
* You should have received a copy of the GNU General Public License along
17
* with this program. If not, see <http://www.gnu.org/licenses/>.
18
*/
19
20
#pragma once
21
22
#include <optional>
23
24
#include <wx/stream.h>
25
#include <wx/string.h>
26
27
#include <
kicommon.h
>
28
29
class
OUTPUTFORMATTER
;
30
class
KIID
;
31
32
namespace
KICAD_FORMAT
{
33
41
KICOMMON_API
void
FormatBool
(
OUTPUTFORMATTER
* aOut,
const
wxString& aKey,
bool
aValue );
42
52
KICOMMON_API
void
FormatOptBool
(
OUTPUTFORMATTER
* aOut,
const
wxString& aKey,
53
std::optional<bool> aValue );
54
55
KICOMMON_API
void
FormatUuid
(
OUTPUTFORMATTER
* aOut,
const
KIID
& aUuid );
56
60
KICOMMON_API
void
FormatStreamData
(
OUTPUTFORMATTER
& aOut,
const
wxStreamBuffer& aStream );
61
62
KICOMMON_API
void
Prettify
( std::string& aSource,
bool
aCompactSave );
63
64
}
// namespace KICAD_FORMAT
KIID
Definition:
kiid.h:49
OUTPUTFORMATTER
An interface used to output 8 bit text in a convenient way.
Definition:
richio.h:322
kicommon.h
KICOMMON_API
#define KICOMMON_API
Definition:
kicommon.h:28
KICAD_FORMAT
Definition:
kicad_io_utils.cpp:33
KICAD_FORMAT::FormatOptBool
void FormatOptBool(OUTPUTFORMATTER *aOut, const wxString &aKey, std::optional< bool > aValue)
Writes an optional boolean to the formatter.
Definition:
kicad_io_utils.cpp:40
KICAD_FORMAT::Prettify
void Prettify(std::string &aSource, bool aCompactSave)
Definition:
kicad_io_utils.cpp:97
KICAD_FORMAT::FormatUuid
void FormatUuid(OUTPUTFORMATTER *aOut, const KIID &aUuid)
Definition:
kicad_io_utils.cpp:49
KICAD_FORMAT::FormatStreamData
void FormatStreamData(OUTPUTFORMATTER &aOut, const wxStreamBuffer &aStream)
Write binary data to the formatter as base 64 encoded string.
Definition:
kicad_io_utils.cpp:55
KICAD_FORMAT::FormatBool
void FormatBool(OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
Writes a boolean to the formatter, in the style (aKey [yes|no])
Definition:
kicad_io_utils.cpp:35
src
include
io
kicad
kicad_io_utils.h
Generated on Tue Apr 1 2025 00:05:32 for KiCad PCB EDA Suite by
1.9.6