plugin_common_layer_mapping.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Jan Mrázek <[email protected]>
 * Copyright (C) 2020 Roberto Fernandez Bautista <[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 PLUGIN_COMMON_LAYER_MAPPING_H
#define PLUGIN_COMMON_LAYER_MAPPING_H
 
#include <functional>
#include <map>
 
#include <pcb_io/pcb_io_mgr.h>
#include <layer_ids.h> // PCB_LAYER_ID
#include <lset.h>

struct INPUT_LAYER_DESC
{
    wxString     Name;             
    LSET         PermittedLayers;  
    PCB_LAYER_ID AutoMapLayer;     
    bool         Required;         
 
    INPUT_LAYER_DESC()
            : Name( wxEmptyString ),
              PermittedLayers(),
              AutoMapLayer( PCB_LAYER_ID::UNDEFINED_LAYER ),
              Required( true )
    {
    }
};

using LAYER_MAPPING_HANDLER = std::function<std::map<wxString, PCB_LAYER_ID>( const std::vector<INPUT_LAYER_DESC>& )>;
 

class LAYER_MAPPABLE_PLUGIN
{
public:
    virtual void RegisterCallback( LAYER_MAPPING_HANDLER aLayerMappingHandler )
    {
        m_layer_mapping_handler = aLayerMappingHandler;
    }
 
    virtual ~LAYER_MAPPABLE_PLUGIN() = default;
protected:
    LAYER_MAPPING_HANDLER m_layer_mapping_handler; 
};
 
#endif // PLUGIN_COMMON_LAYER_MAPPING_H