#include <cstdint>
#include <vector>
#include <lset.h>
#include <wx/string.h>

Classes
struct	GENERATED_TABLE_COLUMN
	A column as a generated table actually carries it: what a row's cell in that column holds and how it is presented. More...

struct	GENERATED_TABLE_COLUMN_DEF
	The column a schema knows how to build, independent of whether any particular table shows it. More...

class	GENERATED_TABLE_SCHEMA
	The columns one generator (the drill chart, a stackup table, ...) can produce, and the units and precision it starts from. More...

Enumerations
enum class	GENERATED_TABLE_ALIGN { LEFT , CENTER , RIGHT }

enum class	GENERATED_TABLE_UNITS { MM , INCH , MILS }

Functions
wxString	FormatGeneratedTableLength (int aValue, GENERATED_TABLE_UNITS aUnits, int aPrecision)
	Render a length the way a generated table's cell shows it.

const char *	GeneratedTableUnitsToken (GENERATED_TABLE_UNITS aUnits)
	Stable file tokens, independent of enum ordering so inserting a value later cannot change what an existing board file means.

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 ()
	Layers a drill chart or drill map may live on.

Variables
constexpr int	GENERATED_TABLE_MAX_COLUMN_WIDTH = 1000 * 1000000
	A column can be no wider than this.

constexpr int64_t	GENERATED_TABLE_MAX_TOTAL_WIDTH = 10LL * 1000 * 1000000
	A column set can be no wider than this in total, summed after each column is clamped to GENERATED_TABLE_MAX_COLUMN_WIDTH.

Enumeration Type Documentation

◆ GENERATED_TABLE_ALIGN

enum class GENERATED_TABLE_ALIGN

strong

Enumerator
LEFT
CENTER
RIGHT

Definition at line 30 of file generated_table_schema.h.

◆ GENERATED_TABLE_UNITS

enum class GENERATED_TABLE_UNITS

strong

Enumerator
MM
INCH
MILS

Definition at line 38 of file generated_table_schema.h.

Function Documentation

◆ DocumentationLayers()

LSET DocumentationLayers ( )

Layers a drill chart or drill map may live on.

Manufacturing layers would be corrupted.

Excludes copper, silkscreen, mask, paste, adhesive, Edge.Cuts, Margin, courtyard and rescue layers. Chart artwork and hole symbols must not alter fabrication outputs or DRC constraints.

Definition at line 126 of file generated_table_schema.cpp.

References LSET::AllNonCuMask(), B_CrtYd, Edge_Cuts, F_CrtYd, Margin, Rescue, and BASE_SET::reset().

Referenced by PCB_DRILL_MAP::Deserialize(), DIALOG_GENERATED_TABLE_PROPERTIES::DIALOG_GENERATED_TABLE_PROPERTIES(), PCB_IO_KICAD_SEXPR_PARSER::parseGeneratedTable(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_DRILL_MAP(), PCB_CONTROL::pickDocumentationLayer(), PCB_CONTROL::PlaceDrillMap(), PCB_CONTROL::placeGeneratedTable(), and UnpackGeneratedTable().

◆ FormatGeneratedTableLength()

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

Render a length the way a generated table's cell shows it.

INCH and MILS both derive their decimal count from aPrecision, so a table can switch units without needing a second precision setting.

Definition at line 142 of file generated_table_schema.cpp.

References INCH, MILS, MM, and pcbIUScale.

Referenced by PCB_DRILL_CHART::generate().

◆ GeneratedTableAlignFromToken()

bool GeneratedTableAlignFromToken	(	const wxString &	aToken,
		GENERATED_TABLE_ALIGN &	aAlign )

Definition at line 238 of file generated_table_schema.cpp.

Referenced by DRILL_CHART_TEMPLATE::LoadFromFile(), and PCB_IO_KICAD_SEXPR_PARSER::parseGeneratedTable().

◆ GeneratedTableAlignToken()

const char * GeneratedTableAlignToken ( GENERATED_TABLE_ALIGN aAlign )

Definition at line 232 of file generated_table_schema.cpp.

Referenced by PCB_IO_KICAD_SEXPR::format(), and DRILL_CHART_TEMPLATE::SaveToFile().

◆ GeneratedTableUnitsFromToken()

bool GeneratedTableUnitsFromToken	(	const wxString &	aToken,
		GENERATED_TABLE_UNITS &	aUnits )

Definition at line 220 of file generated_table_schema.cpp.

Referenced by DRILL_CHART_TEMPLATE::LoadFromFile(), and PCB_IO_KICAD_SEXPR_PARSER::parseGeneratedTable().

◆ GeneratedTableUnitsToken()

const char * GeneratedTableUnitsToken ( GENERATED_TABLE_UNITS aUnits )

Stable file tokens, independent of enum ordering so inserting a value later cannot change what an existing board file means.

Definition at line 214 of file generated_table_schema.cpp.

Referenced by PCB_IO_KICAD_SEXPR::format(), and DRILL_CHART_TEMPLATE::SaveToFile().

Variable Documentation

◆ GENERATED_TABLE_MAX_COLUMN_WIDTH

int GENERATED_TABLE_MAX_COLUMN_WIDTH = 1000 * 1000000

constexpr

A column can be no wider than this.

Bounds hostile input from any decoder. No real table column is a metre across.

Definition at line 50 of file generated_table_schema.h.

Referenced by BOOST_FIXTURE_TEST_CASE(), DIALOG_GENERATED_TABLE_PROPERTIES::harvestColumnGrid(), UnpackGeneratedTable(), and GENERATED_TABLE_SCHEMA::Validate().

◆ GENERATED_TABLE_MAX_TOTAL_WIDTH

int64_t GENERATED_TABLE_MAX_TOTAL_WIDTH = 10LL * 1000 * 1000000

constexpr

A column set can be no wider than this in total, summed after each column is clamped to GENERATED_TABLE_MAX_COLUMN_WIDTH.

Every column can pass the per-column bound on its own and still push table geometry past int range once enough of them are laid out side by side, so the total is checked separately, in int64 so the check itself cannot overflow.

Definition at line 59 of file generated_table_schema.h.

Referenced by GENERATED_TABLE_SCHEMA::Validate().

Classes

Enumerations

Functions

Variables