gerber_file_image_list.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010-2016 Jean-Pierre Charras  jp.charras at wanadoo.fr
 * Copyright (C) 1992-2021 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 2
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#ifndef GERBER_FILE_IMAGE_LIST_H
#define GERBER_FILE_IMAGE_LIST_H
 
#include <vector>
#include <set>
#include <unordered_map>
 
#include <gerber_draw_item.h>
#include <am_primitive.h>
 
 
enum class GERBER_ORDER_ENUM : int
{
    GERBER_DRILL = 0,
    GERBER_BOARD_OUTLINE,
    GERBER_KEEP_OUT,
    GERBER_MECHANICAL,
    GERBER_TOP_PASTE,
    GERBER_TOP_SILK_SCREEN,
    GERBER_TOP_SOLDER_MASK,
    GERBER_TOP_COPPER,
    GERBER_INNER,
    GERBER_BOTTOM_COPPER,
    GERBER_BOTTOM_SOLDER_MASK,
    GERBER_BOTTOM_SILK_SCREEN,
    GERBER_BOTTOM_PASTE,
    GERBER_LAYER_UNKNOWN,
};
 
 
/* gerber files have different parameters to define units and how items must be plotted.
 *  some are for the entire file, and other can change along a file.
 *  In Gerber world:
 *  an image is the entire gerber file and its "global" parameters
 *  a layer (that is very different from a board layer) is just a sub set of a file that
 *  have specific parameters
 *  if a Image parameter is set more than once, only the last value is used
 *  Some parameters can change along a file and are not layer specific: they are stored
 *  in GERBER_ITEM items, when instanced.
 *
 *  In GerbView, to handle these parameters, there are 2 classes:
 *  GERBER_FILE_IMAGE : the main class containing most of parameters and data to plot a graphic layer
 *  Some of them can change along the file
 *  There is one GERBER_FILE_IMAGE per file and one graphic layer per file or GERBER_FILE_IMAGE
 *  GerbView does not read and merge 2 gerber file in one graphic layer:
 *  I believe this is not possible due to the constraints in Image parameters.
 *  GERBER_LAYER : containing the subset of parameters that is layer specific
 *  A GERBER_FILE_IMAGE must include one GERBER_LAYER to define all parameters to plot a file.
 *  But a GERBER_FILE_IMAGE can use more than one GERBER_LAYER.
 */
 
typedef bool( LayerSortFunction )( const GERBER_FILE_IMAGE* const& ref,
                                   const GERBER_FILE_IMAGE* const& test );
 
class GERBER_FILE_IMAGE;
 
class GERBER_FILE_IMAGE_LIST
{
public:
    GERBER_FILE_IMAGE_LIST();
    ~GERBER_FILE_IMAGE_LIST();
 
    static void GetGerberLayerFromFilename( const wxString& filename, enum GERBER_ORDER_ENUM& order,
                                            wxString& matchedExtension );
 
    static GERBER_FILE_IMAGE_LIST& GetImagesList();
    GERBER_FILE_IMAGE* GetGbrImage( int aIdx );
 
    unsigned ImagesMaxCount() { return m_GERBER_List.size(); }
 
    int AddGbrImage( GERBER_FILE_IMAGE* aGbrImage, int aIdx );
 
 
    void DeleteAllImages();
 
    void DeleteImage( unsigned int aIdx );
 
    const wxString GetDisplayName( int aIdx, bool aNameOnly = false, bool aFullName = false );
 
    std::unordered_map<int, int> SortImagesByFunction( LayerSortFunction sortFunction );
 
    std::unordered_map<int, int> SortImagesByFileExtension();
 
    std::unordered_map<int, int> SortImagesByZOrder();
 
    std::unordered_map<int, int> SwapImages( unsigned int layer1, unsigned int layer2 );
 
    std::unordered_map<int, int> RemoveImage( unsigned int layer );
 
    unsigned GetLoadedImageCount();
 
private:
    std::unordered_map<int, int> GetLayerRemap();
 
    // the list of loaded images (1 image = 1 gerber file)
    std::vector<GERBER_FILE_IMAGE*> m_GERBER_List;
};
 
#endif  // ifndef GERBER_FILE_IMAGE_LIST_H