symbol_library_query.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 <vector>
 
#include <lib_id.h>
#include <wx/string.h>
 
 
class KIWAY;
 

struct FOOTPRINT_USERS_QUERY
{
    LIB_ID m_Footprint;

    bool m_MatchFilters = true;

    bool m_MatchFootprintField = true;

    bool m_MatchPinMaps = true;

    int m_MaxResults = 400;

    wxString ToJsonStr() const;

    static FOOTPRINT_USERS_QUERY FromJsonStr( const wxString& aJson );
};
 

struct FOOTPRINT_USER_MATCH
{
    LIB_ID m_Symbol;

    int m_PinCount = 0;

    bool m_IsDerived = false;

    wxString m_MatchedFilter;

    bool m_MatchesFootprintField = false;

    std::vector<wxString> m_MatchedPinMaps;
};
 

struct FOOTPRINT_USERS_RESULT
{
    bool m_Success = false;

    std::vector<FOOTPRINT_USER_MATCH> m_Matches;

    bool m_IsLimited = false;

    wxString ToJsonStr() const;

    static FOOTPRINT_USERS_RESULT FromJsonStr( const wxString& aJson );
};
 

FOOTPRINT_USERS_RESULT QueryFootprintUsers( KIWAY& aKiway, const FOOTPRINT_USERS_QUERY& aQuery );
 

bool StartSymbolLibrariesLoad( KIWAY& aKiway );
 

float GetSymbolLibrariesLoadProgress( KIWAY& aKiway );