generated_table_schema.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 GENERATED_TABLE_SCHEMA_H
#define GENERATED_TABLE_SCHEMA_H
 
#include <cstdint>
#include <vector>
 
#include <lset.h>
#include <wx/string.h>
 
 
enum class GENERATED_TABLE_ALIGN
{
    LEFT,
    CENTER,
    RIGHT
};
 
 
enum class GENERATED_TABLE_UNITS
{
    MM,
    INCH,
    MILS
};
 

constexpr int GENERATED_TABLE_MAX_COLUMN_WIDTH = 1000 * 1000000;
 

constexpr int64_t GENERATED_TABLE_MAX_TOTAL_WIDTH = 10LL * 1000 * 1000000;
 

struct GENERATED_TABLE_COLUMN
{
    int                   m_Id = 0;
    wxString              m_Heading;
    GENERATED_TABLE_ALIGN m_Align = GENERATED_TABLE_ALIGN::LEFT;
    int                   m_Width = 0;    // minimum width, 0 = autosize
 
    bool operator==( const GENERATED_TABLE_COLUMN& aOther ) const = default;
};
 

struct GENERATED_TABLE_COLUMN_DEF
{
    int                   m_Id;
    const char*           m_Token;           // file and JSON token, never translated
    const wxChar*         m_Heading;         // _HKI() string, translated when used
    GENERATED_TABLE_ALIGN m_Align;
    bool                  m_DefaultShown;    // part of Defaults()
    const wxChar*         m_Label = nullptr; // _HKI() UI name, the heading when null
};
 

class GENERATED_TABLE_SCHEMA
{
public:
    GENERATED_TABLE_SCHEMA( std::vector<GENERATED_TABLE_COLUMN_DEF> aDefs, GENERATED_TABLE_UNITS aDefaultUnits,
                            int aDefaultPrecision );
 
    const std::vector<GENERATED_TABLE_COLUMN_DEF>& Defs() const { return m_defs; }
 
    const GENERATED_TABLE_COLUMN_DEF* Find( int aId ) const;
    const GENERATED_TABLE_COLUMN_DEF* FindToken( const wxString& aToken ) const;

    const char* Token( int aId ) const;
 
    GENERATED_TABLE_COLUMN              DefaultColumn( int aId ) const;
    std::vector<GENERATED_TABLE_COLUMN> Defaults() const;

    bool Validate( std::vector<GENERATED_TABLE_COLUMN>& aColumns ) const;
 
    GENERATED_TABLE_UNITS DefaultUnits() const { return m_defaultUnits; }
    int                   DefaultPrecision() const { return m_defaultPrecision; }
 
private:
    std::vector<GENERATED_TABLE_COLUMN_DEF> m_defs;
    GENERATED_TABLE_UNITS                   m_defaultUnits;
    int                                      m_defaultPrecision;
};
 

wxString FormatGeneratedTableLength( int aValue, GENERATED_TABLE_UNITS aUnits, int aPrecision );
 

const char* GeneratedTableUnitsToken( GENERATED_TABLE_UNITS aUnits );
bool        GeneratedTableUnitsFromToken( const wxString& aToken, GENERATED_TABLE_UNITS& aUnits );
const char* GeneratedTableAlignToken( GENERATED_TABLE_ALIGN aAlign );
bool        GeneratedTableAlignFromToken( const wxString& aToken, GENERATED_TABLE_ALIGN& aAlign );
 

LSET DocumentationLayers();
 
#endif // GENERATED_TABLE_SCHEMA_H