sch_text.cpp File Reference

Code for handling schematic texts (texts, labels, hlabels and global labels). More...

#include <sch_symbol.h>
#include <sch_edit_frame.h>
#include <plotters/plotter.h>
#include <widgets/msgpanel.h>
#include <gal/stroke_font.h>
#include <bitmaps.h>
#include <string_utils.h>
#include <sch_text.h>
#include <schematic.h>
#include <settings/color_settings.h>
#include <sch_painter.h>
#include <default_values.h>
#include <wx/debug.h>
#include <wx/log.h>
#include <dialogs/html_message_box.h>
#include <project/project_file.h>
#include <project/net_settings.h>
#include <core/mirror.h>
#include <core/kicad_algo.h>
#include <trigo.h>
#include "sch_text_help_md.h"

Go to the source code of this file.

Functions
bool	IncrementLabelMember (wxString &name, int aIncrement)
wxString	getElectricalTypeLabel (PINSHEETLABEL_SHAPE aType)

Variables
static int	TemplateIN_HN [] = { 6, 0, 0, -1, -1, -2, -1, -2, 1, -1, 1, 0, 0 }
static int	TemplateIN_HI [] = { 6, 0, 0, 1, 1, 2, 1, 2, -1, 1, -1, 0, 0 }
static int	TemplateIN_UP [] = { 6, 0, 0, 1, -1, 1, -2, -1, -2, -1, -1, 0, 0 }
static int	TemplateIN_BOTTOM [] = { 6, 0, 0, 1, 1, 1, 2, -1, 2, -1, 1, 0, 0 }
static int	TemplateOUT_HN [] = { 6, -2, 0, -1, 1, 0, 1, 0, -1, -1, -1, -2, 0 }
static int	TemplateOUT_HI [] = { 6, 2, 0, 1, -1, 0, -1, 0, 1, 1, 1, 2, 0 }
static int	TemplateOUT_UP [] = { 6, 0, -2, 1, -1, 1, 0, -1, 0, -1, -1, 0, -2 }
static int	TemplateOUT_BOTTOM [] = { 6, 0, 2, 1, 1, 1, 0, -1, 0, -1, 1, 0, 2 }
static int	TemplateUNSPC_HN [] = { 5, 0, -1, -2, -1, -2, 1, 0, 1, 0, -1 }
static int	TemplateUNSPC_HI [] = { 5, 0, -1, 2, -1, 2, 1, 0, 1, 0, -1 }
static int	TemplateUNSPC_UP [] = { 5, 1, 0, 1, -2, -1, -2, -1, 0, 1, 0 }
static int	TemplateUNSPC_BOTTOM [] = { 5, 1, 0, 1, 2, -1, 2, -1, 0, 1, 0 }
static int	TemplateBIDI_HN [] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }
static int	TemplateBIDI_HI [] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }
static int	TemplateBIDI_UP [] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }
static int	TemplateBIDI_BOTTOM [] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }
static int	Template3STATE_HN [] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }
static int	Template3STATE_HI [] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }
static int	Template3STATE_UP [] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }
static int	Template3STATE_BOTTOM [] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }
static int *	TemplateShape [5][4]

Detailed Description

Code for handling schematic texts (texts, labels, hlabels and global labels).

Definition in file sch_text.cpp.

Function Documentation

getElectricalTypeLabel()

wxString getElectricalTypeLabel

(

PINSHEETLABEL_SHAPE

aType

)

Definition at line 576 of file sch_text.cpp.

{
 switch( aType )
 {
 case PINSHEETLABEL_SHAPE::PS_INPUT: return _( "Input" );
 case PINSHEETLABEL_SHAPE::PS_OUTPUT: return _( "Output" );
 case PINSHEETLABEL_SHAPE::PS_BIDI: return _( "Bidirectional" );
 case PINSHEETLABEL_SHAPE::PS_TRISTATE: return _( "Tri-State" );
 case PINSHEETLABEL_SHAPE::PS_UNSPECIFIED: return _( "Passive" );
 default: return wxT( "???" );
 }
}

References _, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_TRISTATE, and PS_UNSPECIFIED.

Referenced by SCH_TEXT::GetMsgPanelInfo(), and SCH_TEXT::GetShownText().

IncrementLabelMember()

bool IncrementLabelMember	(	wxString &	name,
		int	aIncrement
	)

Definition at line 55 of file sch_text.cpp.

{
 if( name.IsEmpty() )
 return true;

 wxString suffix;
 wxString digits;
 wxString outputFormat;
 wxString outputNumber;
 int ii = name.Len() - 1;
 int dCount = 0;

 while( ii >= 0 && !wxIsdigit( name.GetChar( ii ) ) )
 {
 suffix = name.GetChar( ii ) + suffix;
 ii--;
 }

 while( ii >= 0 && wxIsdigit( name.GetChar( ii ) ) )
 {
 digits = name.GetChar( ii ) + digits;
 ii--;
 dCount++;
 }

 if( digits.IsEmpty() )
 return true;

 long number = 0;

 if( digits.ToLong( &number ) )
 {
 number += aIncrement;

 // Don't let result go below zero

 if( number > -1 )
 {
 name.Remove( ii + 1 );
 //write out a format string with correct number of leading zeroes
 outputFormat.Printf( wxT( "%%0%dd" ), dCount );
 //write out the number using the format string
 outputNumber.Printf( outputFormat, number );
 name << outputNumber << suffix;
 return true;
 }
 }

 return false;
}

References name.

Referenced by SCH_TEXT::IncrementLabel(), and SYMBOL_EDITOR_PIN_TOOL::RepeatPin().

Variable Documentation

Template3STATE_BOTTOM

int Template3STATE_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }

static

Definition at line 135 of file sch_text.cpp.

Template3STATE_HI

int Template3STATE_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }

static

Definition at line 133 of file sch_text.cpp.

Template3STATE_HN

int Template3STATE_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }

static

Definition at line 132 of file sch_text.cpp.

Template3STATE_UP

int Template3STATE_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }

static

Definition at line 134 of file sch_text.cpp.

TemplateBIDI_BOTTOM

int TemplateBIDI_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }

static

Definition at line 130 of file sch_text.cpp.

TemplateBIDI_HI

int TemplateBIDI_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }

static

Definition at line 128 of file sch_text.cpp.

TemplateBIDI_HN

int TemplateBIDI_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }

static

Definition at line 127 of file sch_text.cpp.

TemplateBIDI_UP

int TemplateBIDI_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }

static

Definition at line 129 of file sch_text.cpp.

TemplateIN_BOTTOM

int TemplateIN_BOTTOM[] = { 6, 0, 0, 1, 1, 1, 2, -1, 2, -1, 1, 0, 0 }

static

Definition at line 115 of file sch_text.cpp.

TemplateIN_HI

int TemplateIN_HI[] = { 6, 0, 0, 1, 1, 2, 1, 2, -1, 1, -1, 0, 0 }

static

Definition at line 113 of file sch_text.cpp.

TemplateIN_HN

int TemplateIN_HN[] = { 6, 0, 0, -1, -1, -2, -1, -2, 1, -1, 1, 0, 0 }

static

Definition at line 112 of file sch_text.cpp.

TemplateIN_UP

int TemplateIN_UP[] = { 6, 0, 0, 1, -1, 1, -2, -1, -2, -1, -1, 0, 0 }

static

Definition at line 114 of file sch_text.cpp.

TemplateOUT_BOTTOM

int TemplateOUT_BOTTOM[] = { 6, 0, 2, 1, 1, 1, 0, -1, 0, -1, 1, 0, 2 }

static

Definition at line 120 of file sch_text.cpp.

TemplateOUT_HI

int TemplateOUT_HI[] = { 6, 2, 0, 1, -1, 0, -1, 0, 1, 1, 1, 2, 0 }

static

Definition at line 118 of file sch_text.cpp.

TemplateOUT_HN

int TemplateOUT_HN[] = { 6, -2, 0, -1, 1, 0, 1, 0, -1, -1, -1, -2, 0 }

static

Definition at line 117 of file sch_text.cpp.

TemplateOUT_UP

int TemplateOUT_UP[] = { 6, 0, -2, 1, -1, 1, 0, -1, 0, -1, -1, 0, -2 }

static

Definition at line 119 of file sch_text.cpp.

TemplateShape

int* TemplateShape[5][4]

static

Initial value:

=
{
 { TemplateIN_HN, TemplateIN_UP, TemplateIN_HI, TemplateIN_BOTTOM },
 { TemplateOUT_HN, TemplateOUT_UP, TemplateOUT_HI, TemplateOUT_BOTTOM },
 { TemplateBIDI_HN, TemplateBIDI_UP, TemplateBIDI_HI, TemplateBIDI_BOTTOM },
 { Template3STATE_HN, Template3STATE_UP, Template3STATE_HI, Template3STATE_BOTTOM },
 { TemplateUNSPC_HN, TemplateUNSPC_UP, TemplateUNSPC_HI, TemplateUNSPC_BOTTOM }
}

Definition at line 137 of file sch_text.cpp.

Referenced by SCH_HIERLABEL::CreateGraphicShape().

TemplateUNSPC_BOTTOM

int TemplateUNSPC_BOTTOM[] = { 5, 1, 0, 1, 2, -1, 2, -1, 0, 1, 0 }

static

Definition at line 125 of file sch_text.cpp.

TemplateUNSPC_HI

int TemplateUNSPC_HI[] = { 5, 0, -1, 2, -1, 2, 1, 0, 1, 0, -1 }

static

Definition at line 123 of file sch_text.cpp.

TemplateUNSPC_HN

int TemplateUNSPC_HN[] = { 5, 0, -1, -2, -1, -2, 1, 0, 1, 0, -1 }

static

Definition at line 122 of file sch_text.cpp.

TemplateUNSPC_UP

int TemplateUNSPC_UP[] = { 5, 1, 0, 1, -2, -1, -2, -1, 0, 1, 0 }

static

Definition at line 124 of file sch_text.cpp.