symbol_async_loader.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Jon Evans <[email protected]>
 * Copyright (C) 2021-2022 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/>.
 */

#ifndef KICAD_SYMBOL_ASYNC_LOADER_H
#define KICAD_SYMBOL_ASYNC_LOADER_H

#include <atomic>
#include <future>
#include <mutex>
#include <unordered_map>
#include <vector>

#include <wx/string.h>

class LIB_SYMBOL;
class PROGRESS_REPORTER;
class SYMBOL_LIB_TABLE;


class SYMBOL_ASYNC_LOADER
{
public:
 SYMBOL_ASYNC_LOADER( const std::vector<wxString>& aNicknames,
 SYMBOL_LIB_TABLE* aTable, bool aOnlyPowerSymbols = false,
 std::unordered_map<wxString, std::vector<LIB_SYMBOL*>>* aOutput = nullptr,
 PROGRESS_REPORTER* aReporter = nullptr );

 ~SYMBOL_ASYNC_LOADER();

 void Start();

 bool Join();

 bool Done();

 const wxString& GetErrors() const { return m_errors; }

 typedef std::pair<wxString, std::vector<LIB_SYMBOL*>> LOADED_PAIR;

private:
 std::vector<LOADED_PAIR> worker();

 std::vector<wxString> m_nicknames;

 SYMBOL_LIB_TABLE* m_table;

 bool m_onlyPowerSymbols;

 std::unordered_map<wxString, std::vector<LIB_SYMBOL*>>* m_output;

 PROGRESS_REPORTER* m_reporter;

 size_t m_threadCount;
 std::atomic<size_t> m_nextLibrary;
 wxString m_errors;
 std::mutex m_errorMutex;

 std::vector<std::future<std::vector<LOADED_PAIR>>> m_returns;
};

#endif