http_lib_settings.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Andre F. K. Iwers <[email protected]>
 * 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 <settings/json_settings.h>
#include <pin_map.h>
#include <unordered_map>
#include <vector>
#include <wx/string.h>
#include <ctime>
 
 
enum class HTTP_LIB_SOURCE_TYPE
{
    REST_API,
    INVALID
};
 

struct HTTP_LIB_SOURCE
{
    HTTP_LIB_SOURCE_TYPE type = HTTP_LIB_SOURCE_TYPE::INVALID;
    std::string          root_url;
    std::string          api_version;
    std::string          token;
    int                  timeout_parts = 30;
    int                  timeout_categories = 600;
};
 
 
struct HTTP_LIB_PART
{
    std::string id;
    std::string name;
    std::string symbolIdStr;
 
    bool        exclude_from_bom = false;
    bool        exclude_from_board = false;
    bool        exclude_from_sim = false;
 
    std::time_t lastCached = 0;
 
    bool        detailsLoaded = false;
 
    std::string              desc;
    std::string              keywords;
    std::vector<std::string> fp_filters;

    using field_type = std::tuple<std::string, bool>;
 
    std::vector<std::pair<std::string, field_type>> fields;

    std::unordered_map<wxString, std::vector<wxString>> pin_map;

    PIN_MAP_SET                       named_pin_maps;
    std::vector<ASSOCIATED_FOOTPRINT> associated_footprints;
};
 
 
struct HTTP_LIB_CATEGORY
{
    std::string id;          
    std::string name;        
    std::string description; 
 
    std::time_t lastCached = 0;
 
    std::vector<HTTP_LIB_PART> cachedParts;
};
 
 
class HTTP_LIB_SETTINGS : public JSON_SETTINGS
{
public:
    HTTP_LIB_SETTINGS( const std::string& aFilename );
    ~HTTP_LIB_SETTINGS() override = default;
 
    HTTP_LIB_SOURCE_TYPE get_HTTP_LIB_SOURCE_TYPE()
    {
        if( m_sourceType == "REST_API" )
            return HTTP_LIB_SOURCE_TYPE::REST_API;
 
        return HTTP_LIB_SOURCE_TYPE::INVALID;
    }
 
    std::string getSupportedAPIVersion() { return m_api_version; }
 
protected:
    wxString getFileExt() const override;
 
public:
    HTTP_LIB_SOURCE m_Source;
 
private:
    std::string     m_sourceType;
    std::string     m_api_version = "v1";
};