sch_sexpr_plugin_common.cpp File Reference

#include <advanced_config.h>
#include <base_units.h>
#include <macros.h>
#include <schematic_lexer.h>
#include "sch_sexpr_plugin_common.h"
#include <string_utils.h>

Go to the source code of this file.

Functions
void	formatFill (OUTPUTFORMATTER *aFormatter, int aNestLevel, FILL_T aFillMode, const COLOR4D &aFillColor)
	Fill token formatting helper. More...
const char *	getPinElectricalTypeToken (ELECTRICAL_PINTYPE aType)
const char *	getPinShapeToken (GRAPHIC_PINSHAPE aShape)
EDA_ANGLE	getPinAngle (int aOrientation)
const char *	getSheetPinShapeToken (LABEL_FLAG_SHAPE aShape)
EDA_ANGLE	getSheetPinAngle (SHEET_SIDE aSide)
const char *	getTextTypeToken (KICAD_T aType)
void	formatArc (OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aArc, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void	formatCircle (OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aCircle, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void	formatRect (OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aRect, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void	formatBezier (OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aBezier, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void	formatPoly (OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aPolyLine, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)

Variables
static const char *	emptyString = ""

Function Documentation

formatArc()

void formatArc	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		EDA_SHAPE *	aArc,
		bool	aIsPrivate,
		const STROKE_PARAMS &	aStroke,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor,
		const KIID &	aUuid
	)

Definition at line 211 of file sch_sexpr_plugin_common.cpp.

{
 aFormatter->Print( aNestLevel, "(arc%s (start %s) (mid %s) (end %s)\n",
 aIsPrivate ? " private" : "",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aArc->GetStart() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aArc->GetArcMid() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aArc->GetEnd() ).c_str() );
 
 aStroke.Format( aFormatter, schIUScale, aNestLevel + 1 );
 aFormatter->Print( 0, "\n" );
 formatFill( aFormatter, aNestLevel + 1, aFillMode, aFillColor );
 aFormatter->Print( 0, "\n" );
 
 if( aUuid != niluuid )
 aFormatter->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aUuid.AsString() ) );
 
 aFormatter->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), niluuid, OUTPUTFORMATTER::Print(), schIUScale, and TO_UTF8.

Referenced by SCH_SEXPR_PLUGIN::saveShape(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

formatBezier()

void formatBezier	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		EDA_SHAPE *	aBezier,
		bool	aIsPrivate,
		const STROKE_PARAMS &	aStroke,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor,
		const KIID &	aUuid
	)

Definition at line 277 of file sch_sexpr_plugin_common.cpp.

{
 aFormatter->Print( aNestLevel, "(bezier%s (pts ",
 aIsPrivate ? " private" : "" );
 
 for( const VECTOR2I& pt : { aBezier->GetStart(), aBezier->GetBezierC1(),
 aBezier->GetBezierC2(), aBezier->GetEnd() } )
 {
 aFormatter->Print( 0, " (xy %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.y ).c_str() );
 }
 
 aFormatter->Print( 0, ")\n" ); // Closes pts token on same line.
 
 aStroke.Format( aFormatter, schIUScale, aNestLevel + 1 );
 aFormatter->Print( 0, "\n" );
 formatFill( aFormatter, aNestLevel + 1, aFillMode, aFillColor );
 aFormatter->Print( 0, "\n" );
 
 if( aUuid != niluuid )
 aFormatter->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aUuid.AsString() ) );
 
 aFormatter->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), niluuid, OUTPUTFORMATTER::Print(), schIUScale, and TO_UTF8.

Referenced by SCH_SEXPR_PLUGIN::saveShape(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

formatCircle()

void formatCircle	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		EDA_SHAPE *	aCircle,
		bool	aIsPrivate,
		const STROKE_PARAMS &	aStroke,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor,
		const KIID &	aUuid
	)

Definition at line 233 of file sch_sexpr_plugin_common.cpp.

{
 aFormatter->Print( aNestLevel, "(circle%s (center %s %s) (radius %s)\n",
 aIsPrivate ? " private" : "",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aCircle->GetStart().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aCircle->GetStart().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aCircle->GetRadius() ).c_str() );
 
 aStroke.Format( aFormatter, schIUScale, aNestLevel + 1 );
 aFormatter->Print( 0, "\n" );
 formatFill( aFormatter, aNestLevel + 1, aFillMode, aFillColor );
 aFormatter->Print( 0, "\n" );
 
 if( aUuid != niluuid )
 aFormatter->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aUuid.AsString() ) );
 
 aFormatter->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), niluuid, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_SEXPR_PLUGIN::saveShape(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

formatFill()

void formatFill	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor
	)

Fill token formatting helper.

Definition at line 34 of file sch_sexpr_plugin_common.cpp.

{
 const char* fillType;
 
 switch( aFillMode )
 {
 default:
 case FILL_T::NO_FILL: fillType = "none"; break;
 case FILL_T::FILLED_SHAPE: fillType = "outline"; break;
 case FILL_T::FILLED_WITH_BG_BODYCOLOR: fillType = "background"; break;
 case FILL_T::FILLED_WITH_COLOR: fillType = "color"; break;
 }
 
 if( aFillMode == FILL_T::FILLED_WITH_COLOR )
 {
 aFormatter->Print( aNestLevel, "(fill (type %s) (color %d %d %d %s))",
 fillType,
 KiROUND( aFillColor.r * 255.0 ),
 KiROUND( aFillColor.g * 255.0 ),
 KiROUND( aFillColor.b * 255.0 ),
 FormatDouble2Str( aFillColor.a ).c_str() );
 }
 else
 {
 aFormatter->Print( aNestLevel, "(fill (type %s))",
 fillType );
 }
}

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, FILLED_WITH_COLOR, FormatDouble2Str(), KIGFX::COLOR4D::g, KiROUND(), NO_FILL, OUTPUTFORMATTER::Print(), and KIGFX::COLOR4D::r.

Referenced by formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), and SCH_SEXPR_PLUGIN::saveTextBox().

formatPoly()

void formatPoly	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		EDA_SHAPE *	aPolyLine,
		bool	aIsPrivate,
		const STROKE_PARAMS &	aStroke,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor,
		const KIID &	aUuid
	)

Definition at line 306 of file sch_sexpr_plugin_common.cpp.

{
 int newLine = 0;
 int lineCount = 1;
 aFormatter->Print( aNestLevel, "(polyline%s\n",
 aIsPrivate ? " private" : "" );
 aFormatter->Print( aNestLevel + 1, "(pts" );
 
 for( const VECTOR2I& pt : aPolyLine->GetPolyShape().Outline( 0 ).CPoints() )
 {
 if( newLine == 4 || !ADVANCED_CFG::GetCfg().m_CompactSave )
 {
 aFormatter->Print( 0, "\n" );
 aFormatter->Print( aNestLevel + 2, "(xy %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.y ).c_str() );
 newLine = 0;
 lineCount += 1;
 }
 else
 {
 aFormatter->Print( 0, " (xy %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, pt.y ).c_str() );
 }
 
 newLine += 1;
 }
 
 if( lineCount == 1 )
 {
 aFormatter->Print( 0, ")\n" ); // Closes pts token on same line.
 }
 else
 {
 aFormatter->Print( 0, "\n" );
 aFormatter->Print( aNestLevel + 1, ")\n" ); // Closes pts token with multiple lines.
 }
 
 aStroke.Format( aFormatter, schIUScale, aNestLevel + 1 );
 aFormatter->Print( 0, "\n" );
 formatFill( aFormatter, aNestLevel + 1, aFillMode, aFillColor );
 aFormatter->Print( 0, "\n" );
 
 if( aUuid != niluuid )
 aFormatter->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aUuid.AsString() ) );
 
 aFormatter->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), SHAPE_LINE_CHAIN::CPoints(), STROKE_PARAMS::Format(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), ADVANCED_CFG::GetCfg(), EDA_SHAPE::GetPolyShape(), niluuid, SHAPE_POLY_SET::Outline(), OUTPUTFORMATTER::Print(), schIUScale, and TO_UTF8.

Referenced by SCH_SEXPR_PLUGIN::saveShape(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

formatRect()

void formatRect	(	OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		EDA_SHAPE *	aRect,
		bool	aIsPrivate,
		const STROKE_PARAMS &	aStroke,
		FILL_T	aFillMode,
		const COLOR4D &	aFillColor,
		const KIID &	aUuid
	)

Definition at line 255 of file sch_sexpr_plugin_common.cpp.

{
 aFormatter->Print( aNestLevel, "(rectangle%s (start %s %s) (end %s %s)\n",
 aIsPrivate ? " private" : "",
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aRect->GetStart().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aRect->GetStart().y ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aRect->GetEnd().x ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( schIUScale, aRect->GetEnd().y ).c_str() );
 aStroke.Format( aFormatter, schIUScale, aNestLevel + 1 );
 aFormatter->Print( 0, "\n" );
 formatFill( aFormatter, aNestLevel + 1, aFillMode, aFillColor );
 aFormatter->Print( 0, "\n" );
 
 if( aUuid != niluuid )
 aFormatter->Print( aNestLevel + 1, "(uuid %s)\n", TO_UTF8( aUuid.AsString() ) );
 
 aFormatter->Print( aNestLevel, ")\n" );
}

References KIID::AsString(), STROKE_PARAMS::Format(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), niluuid, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_SEXPR_PLUGIN::saveShape(), and SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem().

getPinAngle()

EDA_ANGLE getPinAngle

(

int

aOrientation

)

Definition at line 152 of file sch_sexpr_plugin_common.cpp.

{
 switch( aOrientation )
 {
 case PIN_RIGHT: return ANGLE_0;
 case PIN_LEFT: return ANGLE_180;
 case PIN_UP: return ANGLE_90;
 case PIN_DOWN: return ANGLE_270;
 default: wxFAIL_MSG( "Missing symbol library pin orientation type" ); return ANGLE_0;
 }
}

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, PIN_DOWN, PIN_LEFT, PIN_RIGHT, and PIN_UP.

Referenced by SCH_SEXPR_PLUGIN_CACHE::savePin().

getPinElectricalTypeToken()

const char * getPinElectricalTypeToken

(

ELECTRICAL_PINTYPE

aType

)

Definition at line 65 of file sch_sexpr_plugin_common.cpp.

{
 switch( aType )
 {
 case ELECTRICAL_PINTYPE::PT_INPUT:
 return SCHEMATIC_LEXER::TokenName( T_input );
 
 case ELECTRICAL_PINTYPE::PT_OUTPUT:
 return SCHEMATIC_LEXER::TokenName( T_output );
 
 case ELECTRICAL_PINTYPE::PT_BIDI:
 return SCHEMATIC_LEXER::TokenName( T_bidirectional );
 
 case ELECTRICAL_PINTYPE::PT_TRISTATE:
 return SCHEMATIC_LEXER::TokenName( T_tri_state );
 
 case ELECTRICAL_PINTYPE::PT_PASSIVE:
 return SCHEMATIC_LEXER::TokenName( T_passive );
 
 case ELECTRICAL_PINTYPE::PT_NIC:
 return SCHEMATIC_LEXER::TokenName( T_free );
 
 case ELECTRICAL_PINTYPE::PT_UNSPECIFIED:
 return SCHEMATIC_LEXER::TokenName( T_unspecified );
 
 case ELECTRICAL_PINTYPE::PT_POWER_IN:
 return SCHEMATIC_LEXER::TokenName( T_power_in );
 
 case ELECTRICAL_PINTYPE::PT_POWER_OUT:
 return SCHEMATIC_LEXER::TokenName( T_power_out );
 
 case ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR:
 return SCHEMATIC_LEXER::TokenName( T_open_collector );
 
 case ELECTRICAL_PINTYPE::PT_OPENEMITTER:
 return SCHEMATIC_LEXER::TokenName( T_open_emitter );
 
 case ELECTRICAL_PINTYPE::PT_NC:
 return SCHEMATIC_LEXER::TokenName( T_no_connect );
 
 default:
 wxFAIL_MSG( "Missing symbol library pin connection type" );
 }
 
 return emptyString;
}

References emptyString, PT_BIDI, PT_INPUT, PT_NC, PT_NIC, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_POWER_OUT, PT_TRISTATE, and PT_UNSPECIFIED.

Referenced by SCH_SEXPR_PLUGIN_CACHE::savePin().

getPinShapeToken()

const char * getPinShapeToken

(

GRAPHIC_PINSHAPE

aShape

)

Definition at line 113 of file sch_sexpr_plugin_common.cpp.

{
 switch( aShape )
 {
 case GRAPHIC_PINSHAPE::LINE:
 return SCHEMATIC_LEXER::TokenName( T_line );
 
 case GRAPHIC_PINSHAPE::INVERTED:
 return SCHEMATIC_LEXER::TokenName( T_inverted );
 
 case GRAPHIC_PINSHAPE::CLOCK:
 return SCHEMATIC_LEXER::TokenName( T_clock );
 
 case GRAPHIC_PINSHAPE::INVERTED_CLOCK:
 return SCHEMATIC_LEXER::TokenName( T_inverted_clock );
 
 case GRAPHIC_PINSHAPE::INPUT_LOW:
 return SCHEMATIC_LEXER::TokenName( T_input_low );
 
 case GRAPHIC_PINSHAPE::CLOCK_LOW:
 return SCHEMATIC_LEXER::TokenName( T_clock_low );
 
 case GRAPHIC_PINSHAPE::OUTPUT_LOW:
 return SCHEMATIC_LEXER::TokenName( T_output_low );
 
 case GRAPHIC_PINSHAPE::FALLING_EDGE_CLOCK:
 return SCHEMATIC_LEXER::TokenName( T_edge_clock_high );
 
 case GRAPHIC_PINSHAPE::NONLOGIC:
 return SCHEMATIC_LEXER::TokenName( T_non_logic );
 
 default:
 wxFAIL_MSG( "Missing symbol library pin shape type" );
 }
 
 return emptyString;
}

References CLOCK, CLOCK_LOW, emptyString, FALLING_EDGE_CLOCK, INPUT_LOW, INVERTED, INVERTED_CLOCK, LINE, NONLOGIC, and OUTPUT_LOW.

Referenced by SCH_SEXPR_PLUGIN_CACHE::savePin().

getSheetPinAngle()

EDA_ANGLE getSheetPinAngle

(

SHEET_SIDE

aSide

)

Definition at line 183 of file sch_sexpr_plugin_common.cpp.

{
 switch( aSide )
 {
 case SHEET_SIDE::UNDEFINED:
 case SHEET_SIDE::LEFT: return ANGLE_180;
 case SHEET_SIDE::RIGHT: return ANGLE_0;
 case SHEET_SIDE::TOP: return ANGLE_90;
 case SHEET_SIDE::BOTTOM: return ANGLE_270;
 default: wxFAIL; return ANGLE_0;
 }
}

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, BOTTOM, LEFT, RIGHT, TOP, and UNDEFINED.

Referenced by SCH_SEXPR_PLUGIN::saveSheet().

getSheetPinShapeToken()

const char * getSheetPinShapeToken

(

LABEL_FLAG_SHAPE

aShape

)

Definition at line 165 of file sch_sexpr_plugin_common.cpp.

{
 switch( aShape )
 {
 case LABEL_FLAG_SHAPE::L_INPUT: return SCHEMATIC_LEXER::TokenName( T_input );
 case LABEL_FLAG_SHAPE::L_OUTPUT: return SCHEMATIC_LEXER::TokenName( T_output );
 case LABEL_FLAG_SHAPE::L_BIDI: return SCHEMATIC_LEXER::TokenName( T_bidirectional );
 case LABEL_FLAG_SHAPE::L_TRISTATE: return SCHEMATIC_LEXER::TokenName( T_tri_state );
 case LABEL_FLAG_SHAPE::L_UNSPECIFIED: return SCHEMATIC_LEXER::TokenName( T_passive );
 case LABEL_FLAG_SHAPE::F_DOT: return SCHEMATIC_LEXER::TokenName( T_dot );
 case LABEL_FLAG_SHAPE::F_ROUND: return SCHEMATIC_LEXER::TokenName( T_round );
 case LABEL_FLAG_SHAPE::F_DIAMOND: return SCHEMATIC_LEXER::TokenName( T_diamond );
 case LABEL_FLAG_SHAPE::F_RECTANGLE: return SCHEMATIC_LEXER::TokenName( T_rectangle );
 default: wxFAIL; return SCHEMATIC_LEXER::TokenName( T_passive );
 }
}

References F_DIAMOND, F_DOT, F_RECTANGLE, F_ROUND, L_BIDI, L_INPUT, L_OUTPUT, L_TRISTATE, and L_UNSPECIFIED.

Referenced by SCH_SEXPR_PLUGIN::saveSheet(), and SCH_SEXPR_PLUGIN::saveText().

getTextTypeToken()

const char * getTextTypeToken

(

KICAD_T

aType

)

Definition at line 197 of file sch_sexpr_plugin_common.cpp.

{
 switch( aType )
 {
 case SCH_TEXT_T: return SCHEMATIC_LEXER::TokenName( T_text );
 case SCH_LABEL_T: return SCHEMATIC_LEXER::TokenName( T_label );
 case SCH_GLOBAL_LABEL_T: return SCHEMATIC_LEXER::TokenName( T_global_label );
 case SCH_HIER_LABEL_T: return SCHEMATIC_LEXER::TokenName( T_hierarchical_label );
 case SCH_DIRECTIVE_LABEL_T: return SCHEMATIC_LEXER::TokenName( T_netclass_flag );
 default: wxFAIL; return SCHEMATIC_LEXER::TokenName( T_text );
 }
}

References SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, and SCH_TEXT_T.

Referenced by SCH_SEXPR_PLUGIN::saveText().

Variable Documentation

emptyString

const char* emptyString = ""

static

Definition at line 31 of file sch_sexpr_plugin_common.cpp.

Referenced by getPinElectricalTypeToken(), getPinShapeToken(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().