database_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) 2022 Jon Evans <[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 <http://www.gnu.org/licenses/>.
 */
 
#ifndef KICAD_DATABASE_LIB_SETTINGS_H
#define KICAD_DATABASE_LIB_SETTINGS_H
 
#include <settings/json_settings.h>
#include <wx/string.h>
 
 
enum class DATABASE_SOURCE_TYPE
{
    ODBC,
    INVALID
};
 
 
struct KICOMMON_API DATABASE_SOURCE
{
    DATABASE_SOURCE_TYPE type;
    std::string          dsn;
    std::string          username;
    std::string          password;
    int                  timeout;
    std::string          connection_string;
};
 
 
struct KICOMMON_API DATABASE_FIELD_MAPPING
{
    std::string column;             
    std::string name;               
    wxString    name_wx;            
    bool        visible_on_add;     
    bool        visible_in_chooser; 
    bool        show_name;   
    bool        inherit_properties; 
 
    explicit DATABASE_FIELD_MAPPING( const std::string& aColumn, const std::string& aName,
                                     bool aVisibleOnAdd, bool aVisibleInChooser, bool aShowName,
                                     bool aInheritProperties );
};
 
 
struct KICOMMON_API MAPPABLE_SYMBOL_PROPERTIES
{
    std::string description;
    std::string footprint_filters;
    std::string keywords;
    std::string exclude_from_sim;
    std::string exclude_from_bom;
    std::string exclude_from_board;
};
 

struct KICOMMON_API DATABASE_LIB_TABLE
{
    std::string name;              
    std::string table;             
    std::string key_col;           
    std::string symbols_col;       
    std::string footprints_col;    
 
    MAPPABLE_SYMBOL_PROPERTIES properties;
    std::vector<DATABASE_FIELD_MAPPING> fields;
};
 
 
struct KICOMMON_API DATABASE_CACHE_SETTINGS
{
    int max_size;    
    int max_age;     
};
 
 
class KICOMMON_API DATABASE_LIB_SETTINGS : public JSON_SETTINGS
{
public:
    DATABASE_LIB_SETTINGS( const std::string& aFilename );
 
    virtual ~DATABASE_LIB_SETTINGS() {}
 
    DATABASE_SOURCE m_Source;
 
    std::vector<DATABASE_LIB_TABLE> m_Tables;
 
    DATABASE_CACHE_SETTINGS m_Cache;
 
protected:
    wxString getFileExt() const override;
};
 
#endif //KICAD_DATABASE_LIB_SETTINGS_H