mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 02:03:12 +02:00
65 lines
2.0 KiB
C++
65 lines
2.0 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License as published by the
|
|
* Free Software Foundation, either version 3 of the License, or (at your
|
|
* option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <optional>
|
|
|
|
#include <wx/stream.h>
|
|
#include <wx/string.h>
|
|
|
|
#include <kicommon.h>
|
|
|
|
class OUTPUTFORMATTER;
|
|
class KIID;
|
|
|
|
namespace KICAD_FORMAT {
|
|
|
|
/**
|
|
* Writes a boolean to the formatter, in the style (aKey [yes|no])
|
|
*
|
|
* @param aOut is the output formatter to write to
|
|
* @param aKey is the name of the boolean flag
|
|
* @param aValue is the value to write
|
|
*/
|
|
KICOMMON_API void FormatBool( OUTPUTFORMATTER* aOut, const wxString& aKey, bool aValue );
|
|
|
|
/**
|
|
* Writes an optional boolean to the formatter.
|
|
* If a value is present, calls FormatBool.
|
|
* If no value is present, Writes (aKey none).
|
|
*
|
|
* @param aOut is the output formatter to write to
|
|
* @param aKey is the name of the boolean flag
|
|
* @param aValue is the value to write
|
|
*/
|
|
KICOMMON_API void FormatOptBool( OUTPUTFORMATTER* aOut, const wxString& aKey,
|
|
std::optional<bool> aValue );
|
|
|
|
KICOMMON_API void FormatUuid( OUTPUTFORMATTER* aOut, const KIID& aUuid );
|
|
|
|
/**
|
|
* Write binary data to the formatter as base 64 encoded string.
|
|
*/
|
|
KICOMMON_API void FormatStreamData( OUTPUTFORMATTER& aOut, const wxStreamBuffer& aStream );
|
|
|
|
KICOMMON_API void Prettify( std::string& aSource, bool aCompactSave );
|
|
|
|
} // namespace KICAD_FORMAT
|