sch_io_kicad_sexpr_lib_cache.cpp

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.
 *
 * @author Wayne Stambaugh <[email protected]>
 *
 * 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 2
 * 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/>.
 */
 
#include <fmt/format.h>
#include <set>
 
#include <wx/log.h>
#include <wx/dir.h>
 
#include <base_units.h>
#include <build_version.h>
#include <common.h>
#include <sch_shape.h>
#include <lib_symbol.h>
#include <sch_textbox.h>
#include <macros.h>
#include <richio.h>
#include "sch_io_kicad_sexpr_lib_cache.h"
#include "sch_io_kicad_sexpr_common.h"
#include "sch_io_kicad_sexpr_parser.h"
#include <string_utils.h>
#include <trace_helpers.h>
#include <io/kicad/kicad_io_utils.h>
 
 
SCH_IO_KICAD_SEXPR_LIB_CACHE::SCH_IO_KICAD_SEXPR_LIB_CACHE( const wxString& aFullPathAndFileName ) :
    SCH_IO_LIB_CACHE( aFullPathAndFileName )
{
    m_fileFormatVersionAtLoad = 0;
}
 
 
SCH_IO_KICAD_SEXPR_LIB_CACHE::~SCH_IO_KICAD_SEXPR_LIB_CACHE()
{
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::Load()
{
    // Normalize the path: if it's a directory on the filesystem, ensure m_libFileName
    // is marked as a directory so that IsDir() checks work correctly throughout the code.
    // wxFileName::IsDir() only checks if the path string ends with a separator, not if
    // the path is actually a directory on the filesystem.
    if( !m_libFileName.IsDir() && wxFileName::DirExists( m_libFileName.GetFullPath() ) )
        m_libFileName.AssignDir( m_libFileName.GetFullPath() );
 
    if( !isLibraryPathValid() )
    {
        THROW_IO_ERROR( wxString::Format( _( "Library '%s' not found." ), m_libFileName.GetFullPath() ) );
    }
 
    wxCHECK_RET( m_libFileName.IsAbsolute(),
                 wxString::Format( "Cannot use relative file paths in sexpr plugin to "
                                   "open library '%s'.", m_libFileName.GetFullPath() ) );
 
    if( !m_libFileName.IsDir() )
    {
        wxLogTrace( traceSchLegacyPlugin, "Loading sexpr symbol library file '%s'",
                    m_libFileName.GetFullPath() );
 
        FILE_LINE_READER reader( m_libFileName.GetFullPath() );
 
        SCH_IO_KICAD_SEXPR_PARSER parser( &reader );
 
        parser.ParseLib( m_symbols );
 
        SetFileFormatVersionAtLoad( parser.GetParsedRequiredVersion() );
        updateParentSymbolLinks();
        IncrementModifyHash();
 
        // Check if there were any parse warnings (symbols that failed to parse).
        // If so, mark the library as having parse errors and throw to notify the user.
        // The library has loaded all valid symbols, but saving would lose the bad ones.
        const std::vector<wxString>& warnings = parser.GetParseWarnings();
 
        if( !warnings.empty() )
        {
            SetParseError( true );
 
            wxString errorMsg = wxString::Format(
                    _( "Library '%s' loaded with errors:\n\n" ), m_libFileName.GetFullPath() );
 
            for( const wxString& warning : warnings )
                errorMsg += warning + wxT( "\n\n" );
 
            errorMsg += _( "The library cannot be saved until these errors are fixed manually." );
 
            THROW_IO_ERROR( errorMsg );
        }
    }
    else
    {
        wxString libFileName;
 
        wxLogTrace( traceSchLegacyPlugin, "Loading sexpr symbol library folder '%s'", m_libFileName.GetPath() );
 
        // Clear source file tracking for fresh load
        m_symbolSourceFiles.clear();
 
        wxFileName tmp( m_libFileName.GetPath(), wxS( "dummy" ), wxString( FILEEXT::KiCadSymbolLibFileExtension ) );
        wxDir dir( m_libFileName.GetPath() );
        wxString fileSpec = wxS( "*." ) + wxString( FILEEXT::KiCadSymbolLibFileExtension );
 
        if( dir.GetFirst( &libFileName, fileSpec ) )
        {
            wxString errorCache;
 
            do
            {
                tmp.SetFullName( libFileName );
                wxString sourceFilePath = tmp.GetFullPath();
 
                // Track symbol pointers before parsing so we can detect which were replaced.
                // When the parser encounters a duplicate name, it overwrites the existing
                // symbol, so we need to update source tracking for those symbols too.
                std::map<wxString, LIB_SYMBOL*> existingPtrs;
 
                for( const auto& [ name, symbol ] : m_symbols )
                    existingPtrs[ name ] = symbol;
 
                try
                {
                    FILE_LINE_READER reader( sourceFilePath );
                    SCH_IO_KICAD_SEXPR_PARSER parser( &reader );
 
                    parser.ParseLib( m_symbols );
                    SetFileFormatVersionAtLoad( parser.GetParsedRequiredVersion() );
 
                    // Update source tracking for all symbols that came from this file.
                    // This includes both new symbols and symbols that were overwritten
                    // (when a duplicate name existed in a previously loaded file).
                    for( const auto& [ name, symbol ] : m_symbols )
                    {
                        auto it = existingPtrs.find( name );
 
                        if( it == existingPtrs.end() )
                        {
                            // New symbol from this file
                            m_symbolSourceFiles[ name ] = sourceFilePath;
                        }
                        else if( it->second != symbol )
                        {
                            // Symbol pointer changed - this file overwrote the previous version.
                            // Update tracking so we save to this file (the one whose version
                            // is actually in memory).
                            m_symbolSourceFiles[ name ] = sourceFilePath;
                        }
                    }
 
                    // Collect any parse warnings from this file
                    for( const wxString& warning : parser.GetParseWarnings() )
                    {
                        SetParseError( true );
 
                        if( !errorCache.IsEmpty() )
                            errorCache += wxT( "\n\n" );
 
                        errorCache += warning;
                    }
                }
                catch( const IO_ERROR& ioe )
                {
                    // Mark that we had a parse error - saving would lose symbols
                    SetParseError( true );
 
                    if( !errorCache.IsEmpty() )
                        errorCache += wxT( "\n\n" );
 
                    errorCache += wxString::Format( _( "Unable to read file '%s'" ) + '\n', sourceFilePath );
                    errorCache += ioe.What();
                }
            } while( dir.GetNext( &libFileName ) );
 
            if( !errorCache.IsEmpty() )
            {
                errorCache += _( "\n\nThe library cannot be saved until these errors are fixed manually." );
                THROW_IO_ERROR( errorCache );
            }
        }
 
        updateParentSymbolLinks();
        IncrementModifyHash();
    }
 
    // Remember the file modification time of library file when the cache snapshot was made,
    // so that in a networked environment we will reload the cache as needed.
    m_fileModTime = GetLibModificationTime();
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::Save( const std::optional<bool>& aOpt )
{
    if( !m_isModified )
        return;
 
    // If the library had a parse error during loading, we cannot safely save it.
    // Only symbols before the parse error were loaded, so saving would permanently
    // lose all symbols after the error point. See issue #22241.
    if( HasParseError() )
    {
        THROW_IO_ERROR( wxString::Format(
                _( "Cannot save library '%s' because it had a parse error during loading.\n\n"
                   "Saving would permanently lose symbols that could not be loaded.\n"
                   "Please fix the library file manually before saving." ),
                m_libFileName.GetFullPath() ) );
    }
 
    // Write through symlinks, don't replace them.
    wxFileName fn = GetRealFile();
 
    // Normalize the path: if it's a directory on the filesystem, ensure fn is marked as a
    // directory so that IsDir() checks work correctly.
    if( !fn.IsDir() && wxFileName::DirExists( fn.GetFullPath() ) )
        fn.AssignDir( fn.GetFullPath() );
 
    if( !fn.IsDir() )
    {
        auto formatter = std::make_unique<PRETTIFIED_FILE_OUTPUTFORMATTER>( fn.GetFullPath() );
 
        formatLibraryHeader( *formatter.get() );
 
        std::vector<LIB_SYMBOL*> orderedSymbols;
 
        for( const auto& [ name, symbol ] : m_symbols )
        {
            if( symbol )
                orderedSymbols.push_back( symbol );
        }
 
        // Library must be ordered by inheritance depth.
        std::sort( orderedSymbols.begin(), orderedSymbols.end(),
                   []( const LIB_SYMBOL* aLhs, const LIB_SYMBOL* aRhs )
                   {
                       unsigned int lhDepth = aLhs->GetInheritanceDepth();
                       unsigned int rhDepth = aRhs->GetInheritanceDepth();
 
                       if( lhDepth == rhDepth )
                           return aLhs->GetName() < aRhs->GetName();
 
                       return lhDepth < rhDepth;
                   } );
 
        for( LIB_SYMBOL* symbol : orderedSymbols )
            SaveSymbol( symbol, *formatter.get() );
 
        formatter->Print( ")" );
        formatter->Finish();
        formatter.reset();
    }
    else
    {
        if( !fn.DirExists() )
        {
            if( !fn.Mkdir( wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
                THROW_IO_ERROR( wxString::Format( _( "Cannot create symbol library path '%s'." ), fn.GetPath() ) );
        }
 
        // Detect renamed symbols whose old source file entries are now orphaned.
        // Schedule the old files for deletion so they don't linger on disk.
        for( auto it = m_symbolSourceFiles.begin(); it != m_symbolSourceFiles.end(); )
        {
            if( m_symbols.find( it->first ) == m_symbols.end() )
            {
                m_pendingFileDeletes.insert( it->second );
                it = m_symbolSourceFiles.erase( it );
            }
            else
            {
                ++it;
            }
        }
 
        // Group symbols by their source file to preserve multi-symbol files
        std::map<wxString, std::vector<LIB_SYMBOL*>> symbolsByFile;
 
        for( const auto& [ name, symbol ] : m_symbols )
        {
            auto it = m_symbolSourceFiles.find( name );
 
            if( it != m_symbolSourceFiles.end() )
            {
                // Symbol has a known source file - group it with others from that file
                symbolsByFile[ it->second ].push_back( symbol );
            }
            else
            {
                // New symbol without source file - create individual file
                wxFileName saveFn( fn );
                saveFn.SetName( EscapeString( name, CTX_FILENAME ) );
                saveFn.SetExt( FILEEXT::KiCadSymbolLibFileExtension );
 
                symbolsByFile[ saveFn.GetFullPath() ].push_back( symbol );
            }
        }
 
        // Sort each file's symbols by inheritance depth
        auto sortByInheritance = []( LIB_SYMBOL* aLhs, LIB_SYMBOL* aRhs )
        {
            unsigned int lhDepth = aLhs->GetInheritanceDepth();
            unsigned int rhDepth = aRhs->GetInheritanceDepth();
 
            if( lhDepth == rhDepth )
                return aLhs->GetName() < aRhs->GetName();
 
            return lhDepth < rhDepth;
        };
 
        // Write each file
        for( auto& [ filePath, symbols ] : symbolsByFile )
        {
            wxFileName oldFn = filePath;
 
            if( oldFn.GetPath() != m_libFileName.GetPath() )
                oldFn.SetPath( m_libFileName.GetPath() );
 
            std::sort( symbols.begin(), symbols.end(), sortByInheritance );
 
            auto formatter = std::make_unique<PRETTIFIED_FILE_OUTPUTFORMATTER>( oldFn.GetFullPath() );
 
            formatLibraryHeader( *formatter.get() );
 
            for( LIB_SYMBOL* symbol : symbols )
                SaveSymbol( symbol, *formatter.get() );
 
            formatter->Print( ")" );
            formatter->Finish();
            formatter.reset();
 
            // Update source file tracking for new symbols
            for( LIB_SYMBOL* symbol : symbols )
                m_symbolSourceFiles[ symbol->GetName() ] = filePath;
        }
 
        // Remove files for deleted symbols that are no longer needed
        for( const wxString& deadFile : m_pendingFileDeletes )
        {
            if( symbolsByFile.find( deadFile ) == symbolsByFile.end() && wxFileExists( deadFile ) )
            {
                wxRemoveFile( deadFile );
            }
        }
 
        m_pendingFileDeletes.clear();
    }
 
    m_fileModTime = GetLibModificationTime();
    m_isModified = false;
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter,
                                               const wxString& aLibName, bool aIncludeData )
{
    wxCHECK_RET( aSymbol, "Invalid LIB_SYMBOL pointer." );
 
    // If we've requested to embed the fonts in the symbol, do so.
    // Otherwise, clear the embedded fonts from the symbol.  Embedded
    // fonts will be used if available
    if( aSymbol->GetAreFontsEmbedded() )
        aSymbol->EmbedFonts();
    else
        aSymbol->GetEmbeddedFiles()->ClearEmbeddedFonts();
 
    std::vector<SCH_FIELD*> orderedFields;
    std::string name = aFormatter.Quotew( aSymbol->GetLibId().GetLibItemName().wx_str() );
    std::string unitName = aSymbol->GetLibId().GetLibItemName();
 
    if( !aLibName.IsEmpty() )
    {
        name = aFormatter.Quotew( aLibName );
 
        LIB_ID unitId;
 
        wxCHECK2( unitId.Parse( aLibName ) < 0, /* do nothing */ );
 
        unitName = unitId.GetLibItemName();
    }
 
    if( aSymbol->IsRoot() )
    {
        aFormatter.Print( "(symbol %s", name.c_str() );
 
        if( aSymbol->IsGlobalPower() )
            aFormatter.Print( "(power global)" );
        else if( aSymbol->IsLocalPower() )
            aFormatter.Print( "(power local)" );
 
        // TODO: add uuid token here.
 
        // TODO: add anchor position token here.
 
        if( aSymbol->IsMultiBodyStyle() )
        {
            aFormatter.Print( "(body_styles " );
 
            if( aSymbol->HasDeMorganBodyStyles() )
            {
                aFormatter.Print( "demorgan" );
            }
            else
            {
                for( const wxString& bodyStyle : aSymbol->GetBodyStyleNames() )
                    aFormatter.Print( "%s ", aFormatter.Quotew( bodyStyle ).c_str() );
            }
 
            aFormatter.Print( ")" );
        }
 
        if( !aSymbol->GetShowPinNumbers() )
            aFormatter.Print( "(pin_numbers (hide yes))" );
 
        if( aSymbol->GetPinNameOffset() != schIUScale.MilsToIU( DEFAULT_PIN_NAME_OFFSET )
          || !aSymbol->GetShowPinNames() )
        {
            aFormatter.Print( "(pin_names" );
 
            if( aSymbol->GetPinNameOffset() != schIUScale.MilsToIU( DEFAULT_PIN_NAME_OFFSET ) )
            {
                aFormatter.Print( "(offset %s)",
                                  EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                                       aSymbol->GetPinNameOffset() ).c_str() );
            }
 
            if( !aSymbol->GetShowPinNames() )
                KICAD_FORMAT::FormatBool( &aFormatter, "hide", true );
 
            aFormatter.Print( ")" );
        }
 
        KICAD_FORMAT::FormatBool( &aFormatter, "exclude_from_sim",  aSymbol->GetExcludedFromSim() );
        KICAD_FORMAT::FormatBool( &aFormatter, "in_bom", !aSymbol->GetExcludedFromBOM() );
        KICAD_FORMAT::FormatBool( &aFormatter, "on_board", !aSymbol->GetExcludedFromBoard() );
        KICAD_FORMAT::FormatBool( &aFormatter, "in_pos_files", !aSymbol->GetExcludedFromPosFiles() );
 
        KICAD_FORMAT::FormatBool( &aFormatter, "duplicate_pin_numbers_are_jumpers",
                                  aSymbol->GetDuplicatePinNumbersAreJumpers() );
 
        const std::vector<std::set<wxString>>& jumperGroups = aSymbol->JumperPinGroups();
 
        if( !jumperGroups.empty() )
        {
            aFormatter.Print( "(jumper_pin_groups" );
 
            for( const std::set<wxString>& group : jumperGroups )
            {
                aFormatter.Print( "(" );
 
                for( const wxString& padName : group )
                    aFormatter.Print( "%s ", aFormatter.Quotew( padName ).c_str() );
 
                aFormatter.Print( ")" );
            }
 
            aFormatter.Print( ")" );
        }
 
        // TODO: add atomic token here.
 
        // TODO: add required token here."
 
        aSymbol->GetFields( orderedFields );
 
        for( SCH_FIELD* field : orderedFields )
            saveField( field, aFormatter );
 
        // @todo At some point in the future the lock status (all units interchangeable) should
        // be set deterministically.  For now a custom lock property is used to preserve the
        // locked flag state.
        if( aSymbol->UnitsLocked() )
        {
            SCH_FIELD locked( nullptr, FIELD_T::USER, "ki_locked" );
            saveField( &locked, aFormatter );
        }
 
        saveDcmInfoAsFields( aSymbol, aFormatter );
 
        savePinMapData( aSymbol, aFormatter );
 
        // Save the draw items grouped by units.
        std::vector<LIB_SYMBOL_UNIT> units = aSymbol->GetUnitDrawItems();
        std::sort( units.begin(), units.end(),
                   []( const LIB_SYMBOL_UNIT& a, const LIB_SYMBOL_UNIT& b )
                   {
                        if( a.m_unit == b.m_unit )
                            return a.m_bodyStyle < b.m_bodyStyle;
 
                        return a.m_unit < b.m_unit;
                   } );
 
        for( const LIB_SYMBOL_UNIT& unit : units )
        {
            // Add quotes and escape chars like ") to the UTF8 unitName string
            name = aFormatter.Quotes( unitName );
            name.pop_back();    // Remove last char: the quote ending the string.
 
            aFormatter.Print( "(symbol %s_%d_%d\"",
                              name.c_str(),
                              unit.m_unit,
                              unit.m_bodyStyle );
 
            // if the unit has a display name, write that
            if( aSymbol->GetUnitDisplayNames().contains( unit.m_unit ) )
            {
                name = aSymbol->GetUnitDisplayNames().at( unit.m_unit );
                aFormatter.Print( "(unit_name %s)", aFormatter.Quotes( name ).c_str() );
            }
 
            // Enforce item ordering
            auto cmp =
                    []( const SCH_ITEM* a, const SCH_ITEM* b )
                    {
                        return *a < *b;
                    };
 
            std::multiset<SCH_ITEM*, decltype( cmp )> save_map( cmp );
 
            for( SCH_ITEM* item : unit.m_items )
                save_map.insert( item );
 
            for( SCH_ITEM* item : save_map )
                saveSymbolDrawItem( item, aFormatter );
 
            aFormatter.Print( ")" );
        }
 
        KICAD_FORMAT::FormatBool( &aFormatter, "embedded_fonts", aSymbol->GetAreFontsEmbedded() );
 
        if( !aSymbol->EmbeddedFileMap().empty() )
            aSymbol->WriteEmbeddedFiles( aFormatter, aIncludeData );
    }
    else
    {
        std::shared_ptr<LIB_SYMBOL> parent = aSymbol->GetParent().lock();
 
        wxASSERT( parent );
 
        // Prefer the recorded parent name over dereferencing the live parent pointer. The parent
        // LIB_SYMBOL uses a null_deleter shared_ptr, so the weak_ptr's control block can outlive the
        // parent object (for example when a derived symbol is copied to another library and the
        // buffered parent is freed before this symbol is serialized). In that state GetParent().lock()
        // can return a non-null but dangling pointer, and reading parent->GetName() is a use-after-
        // free that crashes release builds while only tripping the assertion above in debug builds.
        // The recorded parent name is a value member and is always safe to read.
        wxString parentName = aSymbol->GetParentName();
 
        if( parentName.IsEmpty() && parent )
            parentName = parent->GetName();
 
        aFormatter.Print( "(symbol %s (extends %s)",
                          name.c_str(),
                          aFormatter.Quotew( parentName ).c_str() );
 
        aSymbol->GetFields( orderedFields );
 
        for( SCH_FIELD* field : orderedFields )
            saveField( field, aFormatter );
 
        saveDcmInfoAsFields( aSymbol, aFormatter );
 
        savePinMapData( aSymbol, aFormatter );
 
        KICAD_FORMAT::FormatBool( &aFormatter, "embedded_fonts", aSymbol->GetAreFontsEmbedded() );
 
        if( !aSymbol->EmbeddedFileMap().empty() )
            aSymbol->WriteEmbeddedFiles( aFormatter, aIncludeData );
    }
 
    aFormatter.Print( ")" );
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields( LIB_SYMBOL* aSymbol,
                                                        OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aSymbol, "Invalid LIB_SYMBOL pointer." );
 
    if( !aSymbol->GetKeyWords().IsEmpty() )
    {
        SCH_FIELD keywords( nullptr, FIELD_T::USER, wxString( "ki_keywords" ) );
        keywords.SetVisible( false );
        keywords.SetText( aSymbol->GetKeyWords() );
        saveField( &keywords, aFormatter );
    }
 
    wxArrayString fpFilters = aSymbol->GetFPFilters();
 
    if( !fpFilters.IsEmpty() )
    {
        wxString tmp;
 
        for( const wxString& filter : fpFilters )
        {
            // Spaces are not handled in fp filter names so escape spaces if any
            wxString curr_filter = EscapeString( filter, ESCAPE_CONTEXT::CTX_NO_SPACE );
 
            if( tmp.IsEmpty() )
                tmp = curr_filter;
            else
                tmp += " " + curr_filter;
        }
 
        SCH_FIELD description( nullptr, FIELD_T::USER, wxString( "ki_fp_filters" ) );
        description.SetVisible( false );
        description.SetText( tmp );
        saveField( &description, aFormatter );
    }
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::savePinMapData( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aSymbol, "Invalid LIB_SYMBOL pointer." );
 
    // Emit only the symbol's own bundle; derived symbols inheriting the parent's maps write
    // nothing here so the inheritance is preserved on round-trip.
    const std::vector<ASSOCIATED_FOOTPRINT>& associations = aSymbol->GetAssociatedFootprints();
 
    if( !associations.empty() )
    {
        aFormatter.Print( "(associated_footprints" );
 
        for( const ASSOCIATED_FOOTPRINT& assoc : associations )
        {
            aFormatter.Print( "(footprint %s",
                              aFormatter.Quotew( assoc.m_FootprintLibId.GetUniStringLibId() ).c_str() );
 
            if( !assoc.m_MapName.IsEmpty() )
                aFormatter.Print( "(map %s)", aFormatter.Quotew( assoc.m_MapName ).c_str() );
 
            aFormatter.Print( ")" );
        }
 
        aFormatter.Print( ")" );
    }
 
    const std::vector<PIN_MAP>& maps = aSymbol->GetPinMaps().GetAll();
 
    if( !maps.empty() )
    {
        aFormatter.Print( "(pin_maps" );
 
        for( const PIN_MAP& map : maps )
        {
            aFormatter.Print( "(pin_map %s", aFormatter.Quotew( map.GetName() ).c_str() );
 
            for( const PIN_MAP_ENTRY& entry : map.GetEntries() )
            {
                aFormatter.Print( "(entry %s %s)", aFormatter.Quotew( entry.m_PinNumber ).c_str(),
                                  aFormatter.Quotew( entry.m_PadNumber ).c_str() );
            }
 
            aFormatter.Print( ")" );
        }
 
        aFormatter.Print( ")" );
    }
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem( SCH_ITEM* aItem, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aItem, "Invalid SCH_ITEM pointer." );
 
    switch( aItem->Type() )
    {
    case SCH_SHAPE_T:
    {
        SCH_SHAPE*    shape = static_cast<SCH_SHAPE*>( aItem );
        STROKE_PARAMS stroke = shape->GetStroke();
        FILL_T        fillMode = shape->GetFillMode();
        COLOR4D       fillColor = shape->GetFillColor();
        bool          isPrivate = shape->IsPrivate();
 
        switch( shape->GetShape() )
        {
        case SHAPE_T::ARC:
            formatArc( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        case SHAPE_T::CIRCLE:
            formatCircle( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        case SHAPE_T::RECTANGLE:
            formatRect( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        case SHAPE_T::BEZIER:
            formatBezier(&aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        case SHAPE_T::POLY:
            formatPoly( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        case SHAPE_T::ELLIPSE: formatEllipse( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true ); break;
 
        case SHAPE_T::ELLIPSE_ARC:
            formatEllipseArc( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor, true );
            break;
 
        default:
            UNIMPLEMENTED_FOR( shape->SHAPE_T_asString() );
        }
 
        break;
    }
 
    case SCH_PIN_T:
        savePin( static_cast<SCH_PIN*>( aItem ), aFormatter );
        break;
 
    case SCH_TEXT_T:
        saveText( static_cast<SCH_TEXT*>( aItem ), aFormatter );
        break;
 
    case SCH_TEXTBOX_T:
        saveTextBox( static_cast<SCH_TEXTBOX*>( aItem ), aFormatter );
        break;
 
    default:
        UNIMPLEMENTED_FOR( aItem->GetClass() );
    }
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField( SCH_FIELD* aField, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aField && aField->Type() == SCH_FIELD_T, "Invalid SCH_FIELD object." );
 
    wxString fieldName = aField->GetName();
 
    if( aField->IsMandatory() )
        fieldName = GetCanonicalFieldName( aField->GetId() );
 
    aFormatter.Print( "(property %s %s %s (at %s %s %s)",
                      aField->IsPrivate() ? "private" : "",
                      aFormatter.Quotew( fieldName ).c_str(),
                      aFormatter.Quotew( aField->GetText() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aField->GetPosition().x ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           -aField->GetPosition().y ).c_str(),
                      fmt::format( "{:g}", aField->GetTextAngle().AsDegrees() ).c_str() );
 
    KICAD_FORMAT::FormatBool( &aFormatter, "show_name", aField->IsNameShown() );
 
    KICAD_FORMAT::FormatBool( &aFormatter, "do_not_autoplace", !aField->CanAutoplace() );
 
    if( !aField->IsVisible() )
        KICAD_FORMAT::FormatBool( &aFormatter, "hide", true );
 
    aField->Format( &aFormatter, 0 );
    aFormatter.Print( ")" );
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin( SCH_PIN* aPin, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aPin && aPin->Type() == SCH_PIN_T, "Invalid SCH_PIN object." );
 
    aPin->ClearFlags( IS_CHANGED );
 
    aFormatter.Print( "(pin %s %s (at %s %s %s) (length %s)",
                      getPinElectricalTypeToken( aPin->GetType() ),
                      getPinShapeToken( aPin->GetShape() ),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetPosition().x ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           -aPin->GetPosition().y ).c_str(),
                      EDA_UNIT_UTILS::FormatAngle( getPinAngle( aPin->GetOrientation() ) ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetLength() ).c_str() );
 
    if( !aPin->IsVisible() )
        KICAD_FORMAT::FormatBool( &aFormatter, "hide", true );
 
    // This follows the EDA_TEXT effects formatting for future expansion.
    aFormatter.Print( "(name %s (effects (font (size %s %s))))",
                      aFormatter.Quotew( aPin->GetName() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetNameTextSize() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetNameTextSize() ).c_str() );
 
    aFormatter.Print( "(number %s (effects (font (size %s %s))))",
                      aFormatter.Quotew( aPin->GetNumber() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetNumberTextSize() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aPin->GetNumberTextSize() ).c_str() );
 
 
    for( const std::pair<const wxString, SCH_PIN::ALT>& alt : aPin->GetAlternates() )
    {
        // There was a bug somewhere in the alternate pin code that allowed pin alternates with no
        // name to be saved in library symbols.  This strips any invalid alternates just in case
        // that code resurfaces.
        if( alt.second.m_Name.IsEmpty() )
            continue;
 
        aFormatter.Print( "(alternate %s %s %s)",
                          aFormatter.Quotew( alt.second.m_Name ).c_str(),
                          getPinElectricalTypeToken( alt.second.m_Type ),
                          getPinShapeToken( alt.second.m_Shape ) );
    }
 
    aFormatter.Print( ")" );
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText( SCH_TEXT* aText, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aText && aText->Type() == SCH_TEXT_T, "Invalid SCH_TEXT object." );
 
    aFormatter.Print( "(text %s %s (at %s %s %d)",
                      aText->IsPrivate() ? "private" : "",
                      aFormatter.Quotew( aText->GetText() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           aText->GetPosition().x ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale,
                                                           -aText->GetPosition().y ).c_str(),
                      aText->GetTextAngle().AsTenthsOfADegree() );
 
    aText->EDA_TEXT::Format( &aFormatter, 0 );
    aFormatter.Print( ")" );
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox( SCH_TEXTBOX* aTextBox, OUTPUTFORMATTER& aFormatter )
{
    wxCHECK_RET( aTextBox && aTextBox->Type() == SCH_TEXTBOX_T, "Invalid SCH_TEXTBOX object." );
 
    aFormatter.Print( "(text_box %s %s",
                      aTextBox->IsPrivate() ? "private" : "",
                      aFormatter.Quotew( aTextBox->GetText() ).c_str() );
 
    VECTOR2I pos = aTextBox->GetStart();
    VECTOR2I size = aTextBox->GetEnd() - pos;
 
    aFormatter.Print( "(at %s %s %s) (size %s %s) (margins %s %s %s %s)",
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pos.x ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, -pos.y ).c_str(),
                      EDA_UNIT_UTILS::FormatAngle( aTextBox->GetTextAngle() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, size.x ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, -size.y ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aTextBox->GetMarginLeft() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aTextBox->GetMarginTop() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aTextBox->GetMarginRight() ).c_str(),
                      EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aTextBox->GetMarginBottom() ).c_str() );
 
    aTextBox->GetStroke().Format( &aFormatter, schIUScale );
    formatFill( &aFormatter, aTextBox->GetFillMode(), aTextBox->GetFillColor() );
    aTextBox->EDA_TEXT::Format( &aFormatter, 0 );
    aFormatter.Print( ")" );
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol( const wxString& aSymbolName )
{
    LIB_SYMBOL_MAP::iterator it = m_symbols.find( aSymbolName );
 
    if( it == m_symbols.end() )
        THROW_IO_ERROR( wxString::Format( _( "library %s does not contain a symbol named %s" ),
                                          m_libFileName.GetFullName(), aSymbolName ) );
 
    LIB_SYMBOL* symbol = it->second;
 
    auto recordSourceFileForDeletion = [this]( const wxString& aName )
    {
        auto srcIt = m_symbolSourceFiles.find( aName );
 
        if( srcIt != m_symbolSourceFiles.end() )
        {
            m_pendingFileDeletes.insert( srcIt->second );
            m_symbolSourceFiles.erase( srcIt );
        }
    };
 
    if( symbol->IsRoot() )
    {
        LIB_SYMBOL* rootSymbol = symbol;
 
        recordSourceFileForDeletion( aSymbolName );
 
        // Remove the root symbol and all its children.
        m_symbols.erase( it );
 
        LIB_SYMBOL_MAP::iterator it1 = m_symbols.begin();
 
        while( it1 != m_symbols.end() )
        {
            if( it1->second->IsDerived()
              && it1->second->GetParent().lock() == rootSymbol->SharedPtr() )
            {
                recordSourceFileForDeletion( it1->first );
                delete it1->second;
                it1 = m_symbols.erase( it1 );
            }
            else
            {
                it1++;
            }
        }
 
        delete rootSymbol;
    }
    else
    {
        recordSourceFileForDeletion( aSymbolName );
        // Just remove the alias.
        m_symbols.erase( it );
        delete symbol;
    }
 
    IncrementModifyHash();
    m_isModified = true;
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::updateParentSymbolLinks()
{
    for( auto& [name, symbol] : m_symbols )
    {
        if( symbol->GetParentName().IsEmpty() )
            continue;
 
        auto it = m_symbols.find( symbol->GetParentName() );
 
        if( it == m_symbols.end() )
        {
            wxString error;
 
            error.Printf( _( "No parent for extended symbol %s found in library '%s'" ),
                          name.c_str(), m_libFileName.GetFullPath() );
            THROW_IO_ERROR( error );
        }
 
        symbol->SetParent( it->second );
    }
}
 
 
void SCH_IO_KICAD_SEXPR_LIB_CACHE::formatLibraryHeader( OUTPUTFORMATTER& aFormatter )
{
    aFormatter.Print( "(kicad_symbol_lib (version %d) (generator \"kicad_symbol_editor\") "
                      "(generator_version \"%s\")",
                      SEXPR_SYMBOL_LIB_FILE_VERSION,
                      GetMajorMinorVersion().c_str().AsChar() );
}
 
 
bool SCH_IO_KICAD_SEXPR_LIB_CACHE::isLibraryPathValid() const
{
    if( !m_libFileName.IsDir() )
        return m_libFileName.FileExists();
    else
        return m_libFileName.DirExists();
}