pcb_generated_table.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCB_GENERATED_TABLE_H
#define PCB_GENERATED_TABLE_H
 
#include <algorithm>
#include <map>
#include <memory>
#include <string>
#include <vector>
 
#include <board_tables/generated_table_schema.h>
#include <pcb_table.h>
 
class GENERATED_TABLE_REFRESH;
 

struct GENERATED_TABLE_ROW
{
    std::string           m_Key;
    std::vector<wxString> m_Cells;
};
 

struct GENERATED_TABLE_CONTENT
{
    virtual ~GENERATED_TABLE_CONTENT() = default;
 
    std::vector<GENERATED_TABLE_ROW>   m_Rows;    
    std::vector<std::vector<wxString>> m_Trailer; 
};
 

class PCB_GENERATED_TABLE : public PCB_TABLE
{
public:
    virtual const GENERATED_TABLE_SCHEMA& Schema() const = 0;
 
    std::vector<GENERATED_TABLE_COLUMN>&       Columns() { return m_columns; }
    const std::vector<GENERATED_TABLE_COLUMN>& Columns() const { return m_columns; }
 
    GENERATED_TABLE_UNITS GetUnits() const { return m_units; }
    void                  SetUnits( GENERATED_TABLE_UNITS aUnits ) { m_units = aUnits; }
 
    int GetPrecision() const { return m_precision; }

    void SetPrecision( int aPrecision ) { m_precision = std::clamp( aPrecision, 0, 6 ); }

    const std::map<int, std::string>& RowKeys() const { return m_rowKeys; }
    std::map<int, std::string>&       RowKeys() { return m_rowKeys; }

    virtual bool IsStale( const BOARD& aBoard ) const;

    void RebuildCells( const BOARD& aBoard, GENERATED_TABLE_REFRESH* aRefresh = nullptr );

    virtual bool IsDataRow( int aRow ) const { return m_rowKeys.count( aRow ) > 0; }
 
    INSPECT_RESULT Visit( INSPECTOR aInspector, void* aTestData, const std::vector<KICAD_T>& aScanTypes ) override;
 
protected:
    PCB_GENERATED_TABLE( BOARD_ITEM* aParent, KICAD_T aType, int aLineWidth );
 
    PCB_GENERATED_TABLE( const PCB_GENERATED_TABLE& aOther ) = default;

    virtual std::unique_ptr<GENERATED_TABLE_CONTENT> generate( const BOARD&             aBoard,
                                                               GENERATED_TABLE_REFRESH* aRefresh ) const = 0;

    virtual void onRebuilt( const BOARD& aBoard, const GENERATED_TABLE_CONTENT& aContent ) {}

    virtual void styleNewCell( PCB_TABLECELL* aCell, bool aIsHeading ) {}
 
    void swapData( BOARD_ITEM* aImage ) override;

    bool generatedEquals( const PCB_GENERATED_TABLE& aOther ) const;
 
    std::vector<GENERATED_TABLE_COLUMN> m_columns;
    GENERATED_TABLE_UNITS               m_units;
    int                                 m_precision;
    std::map<int, std::string>          m_rowKeys;
 
private:
    void migrateRows( int aRows, int aCols, const std::vector<std::string>& aNewRowKeys );
};
 
#endif // PCB_GENERATED_TABLE_H