File: http_lib_settings.h

package info (click to toggle)
kicad 9.0.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 788,516 kB
  • sloc: cpp: 976,024; ansic: 121,001; xml: 66,428; python: 18,419; sh: 1,010; awk: 301; asm: 292; makefile: 228; javascript: 167; perl: 10
file content (103 lines) | stat: -rw-r--r-- 2,590 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2023 Andre F. K. Iwers <iwers11@gmail.com>
 * 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 <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <settings/json_settings.h>
#include <ctime>


enum class HTTP_LIB_SOURCE_TYPE
{
    REST_API,
    INVALID
};


struct HTTP_LIB_SOURCE
{
    HTTP_LIB_SOURCE_TYPE type;
    std::string          root_url;
    std::string          api_version;
    std::string          token;
    int                  timeout_parts;
    int                  timeout_categories;
};


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;

    std::string              desc;
    std::string              keywords;
    std::vector<std::string> fp_filters;

    std::vector<std::pair<std::string, std::tuple<std::string, bool>>> fields;
};


struct HTTP_LIB_CATEGORY
{
    std::string id;          ///< id of category
    std::string name;        ///< name of category
    std::string description; ///< description of category

    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";
};