import_proj_properties.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 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/>.
 */
 
#ifndef IMPORT_PROJ_PROPERTIES_H
#define IMPORT_PROJ_PROPERTIES_H
 
#include <map>
#include <optional>
#include <string>
#include <vector>
 
#include <core/utf8.h>
#include <lib_id.h>
#include <wx/arrstr.h>
#include <wx/string.h>

namespace IMPORT_PROJ_PROPS
{
inline constexpr char FP_CACHE_NICKNAME[]  = "import_fp_cache_nickname";
inline constexpr char SOURCE_FP_LIBS[]     = "import_source_fp_libs";
inline constexpr char SYM_CACHE_NICKNAME[] = "import_sym_cache_nickname";
inline constexpr char SOURCE_SYM_LIBS[]    = "import_source_sym_libs";
inline constexpr char NET_NAME_MAP[]       = "import_net_name_map";

inline constexpr char PROJECT_FILE[]       = "project_file";

inline constexpr char LIST_SEPARATOR = '\x1f';

inline constexpr char MANAGED_CACHE_KEY[] = "kicad_import_cache";

inline wxString ManagedCacheOption()
{
    return wxString( MANAGED_CACHE_KEY ) + wxS( "=1" );
}

inline wxString JoinList( const wxArrayString& aItems )
{
    return wxJoin( aItems, LIST_SEPARATOR, '\0' );
}

inline std::vector<wxString> SplitList( const wxString& aValue )
{
    std::vector<wxString> out;
 
    for( const wxString& item : wxSplit( aValue, LIST_SEPARATOR, '\0' ) )
    {
        if( !item.IsEmpty() )
            out.push_back( item );
    }
 
    return out;
}

inline constexpr char NET_NAME_MAP_TAG[] = "netmap";

inline constexpr char FOOTPRINT_ID_MAP_TAG[] = "fpids";

inline wxString JoinTaggedMap( const char* aTag, const std::map<wxString, wxString>& aPairs )
{
    wxArrayString fields;
    fields.Add( aTag );
 
    for( const auto& [key, value] : aPairs )
    {
        fields.Add( key );
        fields.Add( value );
    }
 
    return JoinList( fields );
}

inline std::optional<std::map<wxString, wxString>> SplitTaggedMap( const char* aTag, const wxString& aValue )
{
    wxArrayString fields = wxSplit( aValue, LIST_SEPARATOR, '\0' );
 
    if( fields.IsEmpty() || fields[0] != aTag || fields.GetCount() % 2 == 0 )
        return std::nullopt;
 
    std::map<wxString, wxString> pairs;
 
    for( size_t i = 1; i < fields.GetCount(); i += 2 )
        pairs.emplace( fields[i], fields[i + 1] );
 
    return pairs;
}

inline wxString JoinNetNameMap( const std::map<wxString, wxString>& aNames )
{
    return JoinTaggedMap( NET_NAME_MAP_TAG, aNames );
}

inline std::optional<std::map<wxString, wxString>> SplitNetNameMap( const wxString& aValue )
{
    return SplitTaggedMap( NET_NAME_MAP_TAG, aValue );
}

inline void ReadFootprintProps( const std::map<std::string, UTF8>* aProps, wxString& aCacheNickname,
                                std::vector<wxString>& aSourceFpLibs )
{
    if( !aProps )
        return;
 
    if( auto it = aProps->find( FP_CACHE_NICKNAME ); it != aProps->end() )
        aCacheNickname = it->second.wx_str();
 
    if( auto it = aProps->find( SOURCE_FP_LIBS ); it != aProps->end() )
        aSourceFpLibs = SplitList( it->second.wx_str() );
}

inline void ReadSymbolProps( const std::map<std::string, UTF8>* aProps, wxString& aCacheNickname,
                             std::vector<wxString>& aSourceSymLibs )
{
    if( !aProps )
        return;
 
    if( auto it = aProps->find( SYM_CACHE_NICKNAME ); it != aProps->end() )
        aCacheNickname = it->second.wx_str();
 
    if( auto it = aProps->find( SOURCE_SYM_LIBS ); it != aProps->end() )
        aSourceSymLibs = SplitList( it->second.wx_str() );
}

inline wxString MakeCacheNickname( const wxString& aStem )
{
    return LIB_ID::FixIllegalChars( aStem + wxS( "-import-fps" ), true ).wx_str();
}

inline wxString MakeSymbolCacheNickname( const wxString& aStem )
{
    return LIB_ID::FixIllegalChars( aStem + wxS( "-import-syms" ), true ).wx_str();
}
}
 
#endif // IMPORT_PROJ_PROPERTIES_H