kicad_io_utils.h

Go to the documentation of this file.

/*
 * 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 <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <optional>
 
#include <wx/buffer.h>
#include <wx/stream.h>
#include <wx/string.h>
 
#include <kicommon.h>
 
class OUTPUTFORMATTER;
class EDA_ITEM;
class KIID;
 
class wxMemoryBuffer;
 
namespace KICAD_FORMAT {

KICOMMON_API void FormatBool( OUTPUTFORMATTER* aOut, const wxString& aKey, bool aValue );

KICOMMON_API void FormatOptBool( OUTPUTFORMATTER* aOut, const wxString& aKey,
                                 std::optional<bool> aValue );
 
KICOMMON_API void FormatUuid( OUTPUTFORMATTER* aOut, const KIID& aUuid );

KICOMMON_API void FormatCustomProperties( OUTPUTFORMATTER* aOut, const EDA_ITEM& aItem );

KICOMMON_API void FormatStreamData( OUTPUTFORMATTER& aOut, const wxStreamBuffer& aStream );

enum class KICOMMON_API FORMAT_MODE
{
    NORMAL,                     
    COMPACT_TEXT_PROPERTIES,    
    LIBRARY_TABLE               
};

KICOMMON_API void Prettify( std::string& aSource, FORMAT_MODE aMode = FORMAT_MODE::NORMAL );
 
} // namespace KICAD_FORMAT
 

KICOMMON_API bool LoadFileToMemory( const wxString& aFileName, wxMemoryBuffer& aBuffer );