string_utils.h File Reference

#include "config.h"
#include <string>
#include <vector>
#include <wx/string.h>
#include <wx/filename.h>

Go to the source code of this file.

Classes
struct	rsort_wxString
	A helper for sorting strings from the rear. More...

Enumerations
enum	ESCAPE_CONTEXT {   CTX_NETNAME , CTX_LIBID , CTX_IPC , CTX_QUOTED_STR ,   CTX_JS_STR , CTX_LINE , CTX_CSV , CTX_FILENAME ,   CTX_NO_SPACE }
	Escape/Unescape routines to safely encode reserved-characters in various contexts. More...

Functions
void	ConvertMarkdown2Html (const wxString &aMarkdownInput, wxString &aHtmlOutput)
wxString	ConvertToNewOverbarNotation (const wxString &aOldStr)
	Convert the old ~...~ overbar notation to the new ~{...} one. More...
bool	ConvertSmartQuotesAndDashes (wxString *aString)
	Convert curly quotes and em/en dashes to straight quotes and dashes. More...
wxString	EscapeString (const wxString &aSource, ESCAPE_CONTEXT aContext)
	The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are: (a) not legal in filenames (b) used as control characters in LIB_IDs (c) used to delineate hierarchical paths. More...
wxString	UnescapeString (const wxString &aSource)
wxString	PrettyPrintForMenu (const wxString &aString)
	Remove markup (such as overbar or subscript) that we can't render to menu items. More...
wxString	TitleCaps (const wxString &aString)
	Capitalize the first letter in each word. More...
int	ReadDelimitedText (char *aDest, const char *aSource, int aDestSize)
	Copy bytes from aSource delimited string segment to aDest buffer. More...
int	ReadDelimitedText (wxString *aDest, const char *aSource)
	Copy bytes from aSource delimited string segment to aDest wxString. More...
std::string	EscapedUTF8 (const wxString &aString)
	Return an 8 bit UTF8 string given aString in Unicode form. More...
wxString	EscapeHTML (const wxString &aString)
	Return a new wxString escaped for embedding in HTML. More...
char *	GetLine (FILE *aFile, char *Line, int *LineNum=nullptr, int SizeLine=255)
	Read one line line from aFile. More...
bool	NoPrintableChars (const wxString &aString)
	Return true if the string is empty or contains only whitespace. More...
int	PrintableCharCount (const wxString &aString)
	Return the number of printable (ie: non-formatting) chars. More...
char *	StrPurge (char *text)
	Remove leading and training spaces, tabs and end of line chars in text. More...
wxString	DateAndTime ()
int	StrNumCmp (const wxString &aString1, const wxString &aString2, bool aIgnoreCase=false)
	Compare two strings with alphanumerical content. More...
bool	WildCompareString (const wxString &pattern, const wxString &string_to_tst, bool case_sensitive=true)
	Compare a string against wild card (* and ?) pattern using the usual rules. More...
int	ValueStringCompare (const wxString &strFWord, const wxString &strSWord)
	Compare strings like the strcmp function but handle numbers and modifiers within the string text correctly for sorting. More...
int	SplitString (const wxString &strToSplit, wxString *strBeginning, wxString *strDigits, wxString *strEnd)
	Break a string into three parts: he alphabetic preamble, the numeric part, and any alphabetic ending. More...
int	GetTrailingInt (const wxString &aStr)
	Gets the trailing int, if any, from a string. More...
wxString	GetIllegalFileNameWxChars ()
bool	ReplaceIllegalFileNameChars (std::string *aName, int aReplaceChar=0)
	Checks aName for illegal file name characters. More...
bool	ReplaceIllegalFileNameChars (wxString &aName, int aReplaceChar=0)
char *	strtok_r (char *str, const char *delim, char **nextp)
static std::vector< std::string >	split (const std::string &aStr, const std::string &aDelim)
	Split the input string into a vector of output strings. More...
void	AccumulateDescription (wxString &aDesc, const wxString &aItem)
	Utility to build comma separated lists in messages. More...
void	wxStringSplit (const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
	Split aString to a string list separated at aSplitter. More...
void	StripTrailingZeros (wxString &aStringValue, unsigned aTrailingZeroAllowed=1)
	Remove trailing zeros from a string containing a converted float number. More...
std::string	UIDouble2Str (double aValue)
	Print a float number without using scientific notation and no trailing 0 We want to avoid scientific notation in S-expr files (not easy to read) for floating numbers. More...
std::string	FormatDouble2Str (double aValue)
	Print a float number without using scientific notation and no trailing 0 This function is intended in uses to write to file, it ignores locale. More...

Enumeration Type Documentation

ESCAPE_CONTEXT

enum ESCAPE_CONTEXT

Escape/Unescape routines to safely encode reserved-characters in various contexts.

Enumerator
CTX_NETNAME
CTX_LIBID
CTX_IPC
CTX_QUOTED_STR
CTX_JS_STR
CTX_LINE
CTX_CSV
CTX_FILENAME
CTX_NO_SPACE

Definition at line 52 of file string_utils.h.

{
 CTX_NETNAME,
 CTX_LIBID,
 CTX_IPC,
 CTX_QUOTED_STR,
 CTX_JS_STR,
 CTX_LINE,
 CTX_CSV,
 CTX_FILENAME,
 CTX_NO_SPACE // to replace spaces in names that do not accept spaces
};

Function Documentation

AccumulateDescription()

void AccumulateDescription ( wxString &  aDesc, const wxString &  aItem  )

inline

Utility to build comma separated lists in messages.

Definition at line 322 of file string_utils.h.

{
 if( !aDesc.IsEmpty() )
 aDesc << wxT( ", " );
 
 aDesc << aItem;
}

Referenced by ZONE::GetMsgPanelInfo().

ConvertMarkdown2Html()

void ConvertMarkdown2Html	(	const wxString &	aMarkdownInput,
		wxString &	aHtmlOutput
	)

Referenced by PANEL_TRACK_WIDTH::LoadSettings(), DIALOG_BOM::OnHelp(), PANEL_SETUP_RULES::OnSyntaxHelp(), SCH_TEXT::ShowSyntaxHelp(), and PANEL_ATTENUATORS::TransfAttenuatorDataToPanel().

ConvertSmartQuotesAndDashes()

bool ConvertSmartQuotesAndDashes

(

wxString *

aString

)

Convert curly quotes and em/en dashes to straight quotes and dashes.

Returns

true if any characters required conversion.

Definition at line 117 of file string_utils.cpp.

{
 bool retVal = false;
 
 for( wxString::iterator ii = aString->begin(); ii != aString->end(); ++ii )
 {
 if( *ii == L'\u00B4' || *ii == L'\u2018' || *ii == L'\u2019' )
 {
 *ii = '\'';
 retVal = true;
 }
 if( *ii == L'\u201C' || *ii == L'\u201D' )
 {
 *ii = '"';
 retVal = true;
 }
 if( *ii == L'\u2013' || *ii == L'\u2014' )
 {
 *ii = '-';
 retVal = true;
 }
 }
 
 return retVal;
}

Referenced by WX_HTML_REPORT_PANEL::onBtnSaveToFile(), SCINTILLA_TRICKS::onCharHook(), and PANEL_SETUP_RULES::TransferDataToWindow().

ConvertToNewOverbarNotation()

wxString ConvertToNewOverbarNotation

(

const wxString &

aOldStr

)

Convert the old ~...~ overbar notation to the new ~{...} one.

Definition at line 45 of file string_utils.cpp.

{
 wxString newStr;
 bool inOverbar = false;
 
 // Don't get tripped up by the legacy empty-string token.
 if( aOldStr == wxT( "~" ) )
 return aOldStr;
 
 newStr.reserve( aOldStr.length() );
 
 for( wxString::const_iterator chIt = aOldStr.begin(); chIt != aOldStr.end(); ++chIt )
 {
 if( *chIt == '~' )
 {
 wxString::const_iterator lookahead = chIt + 1;
 
 if( lookahead != aOldStr.end() && *lookahead == '~' )
 {
 if( ++lookahead != aOldStr.end() && *lookahead == '{' )
 {
 // This way the subsequent opening curly brace will not start an
 // overbar.
 newStr << wxT( "~~{}" );
 continue;
 }
 
 // Two subsequent tildes mean a tilde.
 newStr << wxT( "~" );
 ++chIt;
 continue;
 }
 else if( lookahead != aOldStr.end() && *lookahead == '{' )
 {
 // Could mean the user wants "{" with an overbar, but more likely this
 // is a case of double notation conversion. Bail out.
 return aOldStr;
 }
 else
 {
 if( inOverbar )
 {
 newStr << wxT( "}" );
 inOverbar = false;
 }
 else
 {
 newStr << wxT( "~{" );
 inOverbar = true;
 }
 
 continue;
 }
 }
 else if( ( *chIt == ' ' || *chIt == '}' || *chIt == ')' ) && inOverbar )
 {
 // Spaces were used to terminate overbar as well
 newStr << wxT( "}" );
 inOverbar = false;
 }
 
 newStr << *chIt;
 }
 
 // Explicitly end the overbar even if there was no terminating '~' in the aOldStr.
 if( inOverbar )
 newStr << wxT( "}" );
 
 return newStr;
}

Referenced by escapeName(), CADSTAR_ARCHIVE_PARSER::HandleTextOverbar(), SCH_LEGACY_PLUGIN_CACHE::loadField(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadNETCLASS(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPAD(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN_CACHE::loadPin(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadText(), SCH_LEGACY_PLUGIN_CACHE::loadText(), NET_SETTINGS::migrateSchema0to1(), SCH_SEXPR_PARSER::parseBusAlias(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_PARSER::parseNETCLASS(), PCB_PARSER::parseNETINFO_ITEM(), PCB_PARSER::parsePAD(), SCH_SEXPR_PARSER::parsePin(), and DRAWING_SHEET_PARSER::parseText().

DateAndTime()

wxString DateAndTime

(

)

Returns

a string giving the current date and time.

Definition at line 647 of file string_utils.cpp.

{
 wxDateTime datetime = wxDateTime::Now();
 
 datetime.SetCountry( wxDateTime::Country_Default );
 return datetime.Format( wxDefaultDateTimeFormat, wxDateTime::Local );
}

Referenced by GENDRILL_WRITER_BASE::GenDrillReportFile(), PLACE_FILE_EXPORTER::GenPositionData(), PLACE_FILE_EXPORTER::GenReportData(), NETLIST_EXPORTER_XML::makeDesignHeader(), RecreateCmpFile(), EXCELLON_WRITER::writeEXCELLONHeader(), PCB_CALCULATOR_DATAFILE::WriteHeader(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), NETLIST_EXPORTER_ORCADPCB2::WriteNetlist(), and DIALOG_ERC::writeReport().

EscapedUTF8()

std::string EscapedUTF8

(

const wxString &

aString

)

Return an 8 bit UTF8 string given aString in Unicode form.

Any double quoted or back slashes are prefixed with a '\' byte and the form of this UTF8 byte string is compatible with function ReadDelimitedText().

Parameters

aString

is the input string to convert.

Returns

the escaped input text, without the wrapping double quotes.

Definition at line 453 of file string_utils.cpp.

{
 wxString str = aString;
 
 // No new-lines allowed in quoted strings
 str.Replace( wxT( "\r\n" ), wxT( "\r" ) );
 str.Replace( wxT( "\n" ), wxT( "\r" ) );
 
 std::string utf8 = TO_UTF8( aString );
 
 std::string ret;
 
 ret.reserve( utf8.length() + 2 );
 
 ret += '"';
 
 for( std::string::const_iterator it = utf8.begin(); it!=utf8.end(); ++it )
 {
 // this escaping strategy is designed to be compatible with ReadDelimitedText():
 if( *it == '"' )
 {
 ret += '\\';
 ret += '"';
 }
 else if( *it == '\\' )
 {
 ret += '\\'; // double it up
 ret += '\\';
 }
 else
 {
 ret += *it;
 }
 }
 
 ret += '"';
 
 return ret;
}

References TO_UTF8.

Referenced by SCH_LEGACY_PLUGIN::Format(), PLACE_FILE_EXPORTER::GenReportData(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN::saveSheet(), and SCH_SEXPR_PLUGIN::saveSheet().

EscapeHTML()

wxString EscapeHTML

(

const wxString &

aString

)

Return a new wxString escaped for embedding in HTML.

Definition at line 494 of file string_utils.cpp.

{
 wxString converted;
 
 converted.reserve( aString.length() );
 
 for( wxUniChar c : aString )
 {
 if( c == '\"' )
 converted += wxT( """ );
 else if( c == '\'' )
 converted += wxT( "'" );
 else if( c == '&' )
 converted += wxT( "&" );
 else if( c == '<' )
 converted += wxT( "&lt;" );
 else if( c == '>' )
 converted += wxT( "&gt;" );
 else
 converted += c;
 }
 
 return converted;
}

Referenced by DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_ENGINE::ProcessAssertions(), BOARD_INSPECTION_TOOL::reportHeader(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), FOOTPRINT_INFO_GENERATOR::SetHtmlDesc(), FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords(), FOOTPRINT_INFO_GENERATOR::SetHtmlName(), and PANEL_PACKAGES_VIEW::setPackageDetails().

EscapeString()

wxString EscapeString	(	const wxString &	aSource,
		ESCAPE_CONTEXT	aContext
	)

The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are: (a) not legal in filenames (b) used as control characters in LIB_IDs (c) used to delineate hierarchical paths.

Definition at line 144 of file string_utils.cpp.

{
 wxString converted;
 std::vector<bool> braceStack; // true == formatting construct
 
 converted.reserve( aSource.length() );
 
 for( wxUniChar c: aSource )
 {
 if( aContext == CTX_NETNAME )
 {
 if( c == '/' )
 converted += wxT( "{slash}" );
 else if( c == '\n' || c == '\r' )
 converted += wxEmptyString; // drop
 else
 converted += c;
 }
 else if( aContext == CTX_LIBID )
 {
 if( c == '\\' )
 converted += wxT( "{backslash}" );
 else if( c == '<' )
 converted += wxT( "{lt}" );
 else if( c == '>' )
 converted += wxT( "{gt}" );
 else if( c == ':' )
 converted += wxT( "{colon}" );
 else if( c == '\"' )
 converted += wxT( "{dblquote}" );
 else if( c == '\n' || c == '\r' )
 converted += wxEmptyString; // drop
 else
 converted += c;
 }
 else if( aContext == CTX_IPC )
 {
 if( c == '/' )
 converted += wxT( "{slash}" );
 else if( c == ',' )
 converted += wxT( "{comma}" );
 else if( c == '\"' )
 converted += wxT( "{dblquote}" );
 else
 converted += c;
 }
 else if( aContext == CTX_QUOTED_STR )
 {
 if( c == '\"' )
 converted += wxT( "{dblquote}" );
 else
 converted += c;
 }
 else if( aContext == CTX_JS_STR )
 {
 if( c == '\'' )
 converted += wxT( "{quote}" );
 else
 converted += c;
 }
 else if( aContext == CTX_LINE )
 {
 if( c == '\n' || c == '\r' )
 converted += wxT( "{return}" );
 else
 converted += c;
 }
 else if( aContext == CTX_FILENAME )
 {
 if( c == '/' )
 converted += wxT( "{slash}" );
 else if( c == '\\' )
 converted += wxT( "{backslash}" );
 else if( c == '\"' )
 converted += wxT( "{dblquote}" );
 else if( c == '<' )
 converted += wxT( "{lt}" );
 else if( c == '>' )
 converted += wxT( "{gt}" );
 else if( c == '|' )
 converted += wxT( "{bar}" );
 else if( c == ':' )
 converted += wxT( "{colon}" );
 else if( c == '\t' )
 converted += wxT( "{tab}" );
 else if( c == '\n' || c == '\r' )
 converted += wxT( "{return}" );
 else
 converted += c;
 }
 else if( aContext == CTX_NO_SPACE )
 {
 if( c == ' ' )
 converted += wxT( "{space}" );
 else
 converted += c;
 }
 else if( aContext == CTX_CSV )
 {
 if( c == ',' )
 converted += wxT( "{comma}" );
 else if( c == '\n' || c == '\r' )
 converted += wxT( "{return}" );
 else
 converted += c;
 }
 else
 {
 converted += c;
 }
 }
 
 return converted;
}

References CTX_CSV, CTX_FILENAME, CTX_IPC, CTX_JS_STR, CTX_LIBID, CTX_LINE, CTX_NETNAME, CTX_NO_SPACE, and CTX_QUOTED_STR.

Referenced by AltiumToKiCadLibID(), SCH_EDIT_TOOL::ChangeTextType(), SYMBOL_VIEWER_FRAME::ClickOnLibList(), SYMBOL_VIEWER_FRAME::ClickOnSymbolList(), collectItemsForSyncParts(), PANEL_SYM_LIB_TABLE::convertLibrary(), CONNECTION_SUBGRAPH::driverName(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), PDF_PLOTTER::EndPlot(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), TEXT_BUTTON_SYMBOL_CHOOSER::escapeLibId(), PCB_EDIT_FRAME::FindItemsFromSyncSelection(), RESCUE_CASE_CANDIDATE::FindRescues(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SYMBOL_VIEWER_FRAME::FinishModal(), PCB_PLUGIN::format(), SCH_PIN::GetDefaultNetName(), getLibIdValue(), DIALOG_LIB_NEW_SYMBOL::GetName(), DIALOG_LIB_NEW_SYMBOL::GetParentSymbolName(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_EAGLE_PLUGIN::loadLibrary(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), netList(), DIALOG_NET_INSPECTOR::onRenameNet(), NET_SETTINGS::ParseBusGroup(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveDcmInfoAsFields(), SIM_PLOT_FRAME::saveWorkbook(), CVPCB_MAINFRAME::SendComponentSelectionToSch(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), FIELDS_GRID_TABLE< T >::SetValue(), LIB_TABLE_GRID::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and FOOTPRINT_LIST_IMPL::WriteCacheToFile().

FormatDouble2Str()

std::string FormatDouble2Str

(

double

aValue

)

Print a float number without using scientific notation and no trailing 0 This function is intended in uses to write to file, it ignores locale.

We cannot always just use the g or the f format to print a fp number this helper function uses the f format when needed, or g when f is not well working and then removes trailing 0

Definition at line 1092 of file string_utils.cpp.

{
 std::string buf;
 
 if( aValue != 0.0 && std::fabs( aValue ) <= 0.0001 )
 {
 buf = fmt::format( "{:.16f}", aValue );
 
 // remove trailing zeros
 while( !buf.empty() && buf[buf.size() - 1] == '0' )
 {
 buf.pop_back();
 }
 }
 else
 {
 buf = fmt::format( "{:.10g}", aValue );
 }
 
 return buf;
}

Referenced by GBR_TO_PCB_EXPORTER::export_non_copper_item(), GBR_TO_PCB_EXPORTER::export_via(), PCB_PLUGIN::format(), DS_DATA_MODEL_IO::format(), DS_DATA_MODEL_IO::Format(), EDA_TEXT::Format(), STROKE_PARAMS::Format(), BOARD_STACKUP::FormatBoardStackup(), DS_DATA_MODEL_IO::formatCoordinate(), formatFill(), DS_DATA_MODEL_IO::formatRepeatParameters(), PCB_PLUGIN::formatSetup(), SCH_SEXPR_PLUGIN::saveJunction(), GBR_TO_PCB_EXPORTER::writeCopperLineItem(), GBR_TO_PCB_EXPORTER::writePcbFilledCircle(), GBR_TO_PCB_EXPORTER::writePcbPolygon(), and GBR_TO_PCB_EXPORTER::writePcbZoneItem().

GetIllegalFileNameWxChars()

wxString GetIllegalFileNameWxChars

(

)

Returns

a wxString object containing the illegal file name characters for all platforms.

Definition at line 981 of file string_utils.cpp.

{
 return FROM_UTF8( illegalFileNameChars );
}

References FROM_UTF8(), and illegalFileNameChars.

Referenced by ReplaceIllegalFileNameChars().

GetLine()

char * GetLine	(	FILE *	aFile,
		char *	Line,
		int *	LineNum = nullptr,
		int	SizeLine = 255
	)

Read one line line from aFile.

Returns

a pointer the first useful line read by eliminating blank lines and comments.

Definition at line 631 of file string_utils.cpp.

{
 do {
 if( fgets( Line, SizeLine, File ) == nullptr )
 return nullptr;
 
 if( LineNum )
 *LineNum += 1;
 
 } while( Line[0] == '#' || Line[0] == '\n' || Line[0] == '\r' || Line[0] == 0 );
 
 strtok( Line, "\n\r" );
 return Line;
}

Referenced by CVPCB_MAINFRAME::buildEquivalenceList().

GetTrailingInt()

int GetTrailingInt

(

const wxString &

aStr

)

Gets the trailing int, if any, from a string.

Parameters

aStr	the string to check.

Returns

the trailing int or 0 if none found.

Definition at line 957 of file string_utils.cpp.

{
 int number = 0;
 int base = 1;
 
 // Trim and extract the trailing numeric part
 int index = aStr.Len() - 1;
 
 while( index >= 0 )
 {
 const char chr = aStr.GetChar( index );
 
 if( chr < '0' || chr > '9' )
 break;
 
 number += ( chr - '0' ) * base;
 base *= 10;
 index--;
 }
 
 return number;
}

Referenced by BOOST_AUTO_TEST_CASE(), compareFootprintsbyRef(), FOOTPRINT::GetNextPadNumber(), and FOOTPRINT::IncrementReference().

NoPrintableChars()

bool NoPrintableChars

(

const wxString &

aString

)

Return true if the string is empty or contains only whitespace.

Definition at line 520 of file string_utils.cpp.

{
 wxString tmp = aString;
 
 return tmp.Trim( true ).Trim( false ).IsEmpty();
}

Referenced by SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DRAWING_TOOL::PlaceText(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

PrettyPrintForMenu()

wxString PrettyPrintForMenu

(

const wxString &

aString

)

Remove markup (such as overbar or subscript) that we can't render to menu items.

PrintableCharCount()

int PrintableCharCount

(

const wxString &

aString

)

Return the number of printable (ie: non-formatting) chars.

Used to approximate rendered text size when speed is more important than accuracy.

Definition at line 532 of file string_utils.cpp.

{
 int char_count = 0;
 int overbarDepth = -1;
 int superSubDepth = -1;
 int braceNesting = 0;
 
 for( auto chIt = aString.begin(), end = aString.end(); chIt < end; ++chIt )
 {
 if( *chIt == '\t' )
 {
 // We don't format tabs in bitmap text (where this is currently used), so just
 // drop them from the count.
 continue;
 }
 else if( *chIt == '^' && superSubDepth == -1 )
 {
 auto lookahead = chIt;
 
 if( ++lookahead != end && *lookahead == '{' )
 {
 chIt = lookahead;
 superSubDepth = braceNesting;
 braceNesting++;
 continue;
 }
 }
 else if( *chIt == '_' && superSubDepth == -1 )
 {
 auto lookahead = chIt;
 
 if( ++lookahead != end && *lookahead == '{' )
 {
 chIt = lookahead;
 superSubDepth = braceNesting;
 braceNesting++;
 continue;
 }
 }
 else if( *chIt == '~' && overbarDepth == -1 )
 {
 auto lookahead = chIt;
 
 if( ++lookahead != end && *lookahead == '{' )
 {
 chIt = lookahead;
 overbarDepth = braceNesting;
 braceNesting++;
 continue;
 }
 }
 else if( *chIt == '{' )
 {
 braceNesting++;
 }
 else if( *chIt == '}' )
 {
 if( braceNesting > 0 )
 braceNesting--;
 
 if( braceNesting == superSubDepth )
 {
 superSubDepth = -1;
 continue;
 }
 
 if( braceNesting == overbarDepth )
 {
 overbarDepth = -1;
 continue;
 }
 }
 
 char_count++;
 }
 
 return char_count;
}

Referenced by KIGFX::PCB_PAINTER::draw().

ReadDelimitedText() [1/2]

int ReadDelimitedText	(	char *	aDest,
		const char *	aSource,
		int	aDestSize
	)

Copy bytes from aSource delimited string segment to aDest buffer.

The extracted string will be null terminated even if truncation is necessary because aDestSize was not large enough.

Parameters

aDest	is the destination byte buffer.
aSource	is the source bytes as a C string.
aDestSize	is the size of the destination byte buffer.

Returns

the number of bytes read from source, which may be more than the number copied, due to escaping of double quotes and the escape byte itself.

Deprecated:

should use the one which fetches a wxString, below.

Definition at line 404 of file string_utils.cpp.

{
 if( aDestSize <= 0 )
 return 0;
 
 bool inside = false;
 const char* start = aSource;
 char* limit = aDest + aDestSize - 1;
 char cc;
 
 while( (cc = *aSource++) != 0 && aDest < limit )
 {
 if( cc == '"' )
 {
 if( inside )
 break; // 2nd double quote is end of delimited text
 
 inside = true; // first delimiter found, make note, do not copy
 }
 
 else if( inside )
 {
 if( cc == '\\' )
 {
 cc = *aSource++;
 
 if( !cc )
 break;
 
 // do no copy the escape byte if it is followed by \ or "
 if( cc != '"' && cc != '\\' )
 *aDest++ = '\\';
 
 if( aDest < limit )
 *aDest++ = cc;
 }
 else
 {
 *aDest++ = cc;
 }
 }
 }
 
 *aDest = 0;
 
 return aSource - start;
}

ReadDelimitedText() [2/2]

int ReadDelimitedText	(	wxString *	aDest,
		const char *	aSource
	)

Copy bytes from aSource delimited string segment to aDest wxString.

Parameters

aDest	is the destination wxString.
aSource	is the source C string holding utf8 encoded bytes.

Returns

the number of bytes read from source, which may be more than the number copied, due to escaping of double quotes and the escape byte itself.

Definition at line 359 of file string_utils.cpp.

{
 std::string utf8; // utf8 but without escapes and quotes.
 bool inside = false;
 const char* start = aSource;
 char cc;
 
 while( (cc = *aSource++) != 0 )
 {
 if( cc == '"' )
 {
 if( inside )
 break; // 2nd double quote is end of delimited text
 
 inside = true; // first delimiter found, make note, do not copy
 }
 
 else if( inside )
 {
 if( cc == '\\' )
 {
 cc = *aSource++;
 
 if( !cc )
 break;
 
 // do no copy the escape byte if it is followed by \ or "
 if( cc != '"' && cc != '\\' )
 utf8 += '\\';
 
 utf8 += cc;
 }
 else
 {
 utf8 += cc;
 }
 }
 }
 
 *aDest = FROM_UTF8( utf8.c_str() );
 
 return aSource - start;
}

References FROM_UTF8().

Referenced by LEGACY_PLUGIN::load3D(), LEGACY_PLUGIN::loadDIMENSION(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadNETCLASS(), LEGACY_PLUGIN::loadNETINFO_ITEM(), LEGACY_PLUGIN::loadPAD(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadSHEET(), and LEGACY_PLUGIN::loadZONE_CONTAINER().

ReplaceIllegalFileNameChars() [1/2]

bool ReplaceIllegalFileNameChars	(	std::string *	aName,
		int	aReplaceChar = 0
	)

Checks aName for illegal file name characters.

The Windows (DOS) file system forbidden characters already include the forbidden file name characters for both Posix and OSX systems. The characters \/?*|"<> are illegal and are replaced with xx where xx the hexadecimal equivalent of the replaced character. This replacement may not be as elegant as using an underscore ('_') or hyphen ('-') but it guarantees that there will be no naming conflicts when fixing footprint library names. however, if aReplaceChar is given, it will replace the illegal chars

Parameters

aName	is a point to a std::string object containing the footprint name to verify.
aReplaceChar	(if not 0) is the replacement char.

Returns

true if any characters have been replaced in aName.

Definition at line 987 of file string_utils.cpp.

{
 bool changed = false;
 std::string result;
 result.reserve( aName->length() );
 
 for( std::string::iterator it = aName->begin(); it != aName->end(); ++it )
 {
 if( strchr( illegalFileNameChars, *it ) )
 {
 if( aReplaceChar )
 StrPrintf( &result, "%c", aReplaceChar );
 else
 StrPrintf( &result, "%%%02x", *it );
 
 changed = true;
 }
 else
 {
 result += *it;
 }
 }
 
 if( changed )
 *aName = result;
 
 return changed;
}

References illegalFileNameChars, and StrPrintf().

Referenced by EDEVICE::EDEVICE(), EELEMENT::EELEMENT(), LEGACY_PLUGIN::loadAllSections(), FABMASTER::loadFootprints(), EAGLE_PLUGIN::loadLibrary(), LP_CACHE::LoadModules(), SCH_EAGLE_PLUGIN::loadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSheets().

ReplaceIllegalFileNameChars() [2/2]

bool ReplaceIllegalFileNameChars	(	wxString &	aName,
		int	aReplaceChar = 0
	)

Definition at line 1017 of file string_utils.cpp.

{
 bool changed = false;
 wxString result;
 result.reserve( aName.Length() );
 wxString illWChars = GetIllegalFileNameWxChars();
 
 for( wxString::iterator it = aName.begin(); it != aName.end(); ++it )
 {
 if( illWChars.Find( *it ) != wxNOT_FOUND )
 {
 if( aReplaceChar )
 result += aReplaceChar;
 else
 result += wxString::Format( "%%%02x", *it );
 
 changed = true;
 }
 else
 {
 result += *it;
 }
 }
 
 if( changed )
 aName = result;
 
 return changed;
}

References Format(), and GetIllegalFileNameWxChars().

split()

static std::vector< std::string > split ( const std::string &  aStr, const std::string &  aDelim  )

inlinestatic

Split the input string into a vector of output strings.

Note

Multiple delimiters are considered to be separate records with empty strings

Parameters

aStr	Input string with 0 or more delimiters.
aDelim	The string of delimiter. Multiple characters here denote alternate delimiters.

Returns

a vector of strings

Definition at line 296 of file string_utils.h.

{
 size_t pos = 0;
 size_t last_pos = 0;
 size_t len;
 
 std::vector<std::string> tokens;
 
 while( pos < aStr.size() )
 {
 pos = aStr.find_first_of( aDelim, last_pos );
 
 if( pos == std::string::npos )
 pos = aStr.size();
 
 len = pos - last_pos;
 
 tokens.push_back( aStr.substr( last_pos, len ) );
 
 last_pos = pos + 1;
 }
 
 return tokens;
}

Referenced by CompareToBucket::CompareToBucket(), HLBVH_SAH_Evaluator::HLBVH_SAH_Evaluator(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_VIEWER_FRAME::KiwayMailIn(), FABMASTER::processText(), and PNS::NODE::rebuildJoint().

SplitString()

int SplitString	(	const wxString &	strToSplit,
		wxString *	strBeginning,
		wxString *	strDigits,
		wxString *	strEnd
	)

Break a string into three parts: he alphabetic preamble, the numeric part, and any alphabetic ending.

For example C10A is split to C 10 A

Definition at line 896 of file string_utils.cpp.

{
 static const wxString separators( wxT( ".," ) );
 
 // Clear all the return strings
 strBeginning->Empty();
 strDigits->Empty();
 strEnd->Empty();
 
 // There no need to do anything if the string is empty
 if( strToSplit.length() == 0 )
 return 0;
 
 // Starting at the end of the string look for the first digit
 int ii;
 
 for( ii = (strToSplit.length() - 1); ii >= 0; ii-- )
 {
 if( wxIsdigit( strToSplit[ii] ) )
 break;
 }
 
 // If there were no digits then just set the single string
 if( ii < 0 )
 {
 *strBeginning = strToSplit;
 }
 else
 {
 // Since there is at least one digit this is the trailing string
 *strEnd = strToSplit.substr( ii + 1 );
 
 // Go to the end of the digits
 int position = ii + 1;
 
 for( ; ii >= 0; ii-- )
 {
 if( !wxIsdigit( strToSplit[ii] ) && separators.Find( strToSplit[ii] ) < 0 )
 break;
 }
 
 // If all that was left was digits, then just set the digits string
 if( ii < 0 )
 *strDigits = strToSplit.substr( 0, position );
 
 /* We were only looking for the last set of digits everything else is
 * part of the preamble */
 else
 {
 *strDigits = strToSplit.substr( ii + 1, position - ii - 1 );
 *strBeginning = strToSplit.substr( 0, ii + 1 );
 }
 }
 
 return 0;
}

Referenced by ValueStringCompare().

StripTrailingZeros()

void StripTrailingZeros	(	wxString &	aStringValue,
		unsigned	aTrailingZeroAllowed = 1
	)

Remove trailing zeros from a string containing a converted float number.

The trailing zeros are removed if the mantissa has more than aTrailingZeroAllowed digits and some trailing zeros.

Definition at line 1070 of file string_utils.cpp.

{
 struct lconv* lc = localeconv();
 char sep = lc->decimal_point[0];
 unsigned sep_pos = aStringValue.Find( sep );
 
 if( sep_pos > 0 )
 {
 // We want to keep at least aTrailingZeroAllowed digits after the separator
 unsigned min_len = sep_pos + aTrailingZeroAllowed + 1;
 
 while( aStringValue.Len() > min_len )
 {
 if( aStringValue.Last() == '0' )
 aStringValue.RemoveLast();
 else
 break;
 }
 }
}

StrNumCmp()

int StrNumCmp	(	const wxString &	aString1,
		const wxString &	aString2,
		bool	aIgnoreCase = false
	)

Compare two strings with alphanumerical content.

This function is equivalent to strncmp() or strncasecmp() if aIgnoreCase is true except that strings containing numbers are compared by their integer value not by their ASCII code. In other words U10 would be greater than U2.

Parameters

aString1	A wxString reference to the reference string.
aString2	A wxString reference to the comparison string.
aIgnoreCase	Use true to make the comparison case insensitive.

Returns

An integer value of -1 if aString1 is less than aString2, 0 if aString1 is equal to aString2, or 1 if aString1 is greater than aString2.

Definition at line 656 of file string_utils.cpp.

{
 int nb1 = 0, nb2 = 0;
 
 auto str1 = aString1.begin();
 auto str2 = aString2.begin();
 
 while( str1 != aString1.end() && str2 != aString2.end() )
 {
 wxUniChar c1 = *str1;
 wxUniChar c2 = *str2;
 
 if( wxIsdigit( c1 ) && wxIsdigit( c2 ) ) // Both characters are digits, do numeric compare.
 {
 nb1 = 0;
 nb2 = 0;
 
 do
 {
 c1 = *str1;
 nb1 = nb1 * 10 + (int) c1 - '0';
 ++str1;
 } while( str1 != aString1.end() && wxIsdigit( *str1 ) );
 
 do
 {
 c2 = *str2;
 nb2 = nb2 * 10 + (int) c2 - '0';
 ++str2;
 } while( str2 != aString2.end() && wxIsdigit( *str2 ) );
 
 if( nb1 < nb2 )
 return -1;
 
 if( nb1 > nb2 )
 return 1;
 
 c1 = ( str1 != aString1.end() ) ? *str1 : wxUniChar( 0 );
 c2 = ( str2 != aString2.end() ) ? *str2 : wxUniChar( 0 );
 }
 
  // Any numerical comparisons to here are identical.
 if( aIgnoreCase )
 {
 if( wxToupper( c1 ) < wxToupper( c2 ) )
 return -1;
 
 if( wxToupper( c1 ) > wxToupper( c2 ) )
 return 1;
 }
 else
 {
 if( c1 < c2 )
 return -1;
 
 if( c1 > c2 )
 return 1;
 }
 
 if( str1 != aString1.end() )
 ++str1;
 
 if( str2 != aString2.end() )
 ++str2;
 }
 
 if( str1 == aString1.end() && str2 != aString2.end() )
 {
 return -1; // Identical to here but aString1 is longer.
 }
 else if( str1 != aString1.end() && str2 == aString2.end() )
 {
 return 1; // Identical to here but aString2 is longer.
 }
 
 return 0;
}

Referenced by REGULATOR_LIST::Add(), BOOST_AUTO_TEST_CASE(), ChangeArrayCompare(), FIELDS_EDITOR_GRID_DATA_MODEL::cmp(), PIN_TABLE_DATA_MODEL::compare(), SCH_PIN_TABLE_DATA_MODEL::compare(), SCH_SHEET::ComparePageNum(), FP_TREE_MODEL_ADAPTER::getFootprints(), NETLIST_EXPORTER_XML::makeSymbols(), myCompareFunction(), FOOTPRINT::cmp_pads::operator()(), operator<(), SCH_REFERENCE_LIST::sortByReferenceOnly(), sortFPlist(), and sortPinsByNumber().

StrPurge()

char * StrPurge

(

char *

text

)

Remove leading and training spaces, tabs and end of line chars in text.

Returns

a pointer on the first n char in text

Definition at line 612 of file string_utils.cpp.

{
 static const char whitespace[] = " \t\n\r\f\v";
 
 if( text )
 {
 while( *text && strchr( whitespace, *text ) )
 ++text;
 
 char* cp = text + strlen( text ) - 1;
 
 while( cp >= text && strchr( whitespace, *cp ) )
 *cp-- = '\0';
 }
 
 return text;
}

References text.

Referenced by detect_file_type(), LEGACY_PLUGIN::loadAllSections(), EXCELLON_IMAGE::LoadFile(), LEGACY_PLUGIN::loadFOOTPRINT(), GERBER_FILE_IMAGE::LoadGerberFile(), LP_CACHE::LoadModules(), LEGACY_NETLIST_READER::LoadNetlist(), LEGACY_PLUGIN::loadPAD(), EXCELLON_IMAGE::TestFileIsExcellon(), and GERBER_FILE_IMAGE::TestFileIsRS274().

strtok_r()

char * strtok_r	(	char *	str,
		const char *	delim,
		char **	nextp
	)

Referenced by LEGACY_PLUGIN::loadDIMENSION(), LEGACY_PLUGIN::loadFOOTPRINT(), LEGACY_PLUGIN::loadGENERAL(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPAD(), LEGACY_PLUGIN::loadPCB_LINE(), LEGACY_PLUGIN::loadPCB_TARGET(), LEGACY_PLUGIN::loadPCB_TEXT(), LEGACY_PLUGIN::loadSETUP(), LEGACY_PLUGIN::loadSHEET(), LEGACY_PLUGIN::loadTrackList(), LEGACY_PLUGIN::loadZONE_CONTAINER(), and LP_CACHE::ReadAndVerifyHeader().

TitleCaps()

wxString TitleCaps

(

const wxString &

aString

)

Capitalize the first letter in each word.

Definition at line 338 of file string_utils.cpp.

{
 wxArrayString words;
 wxString result;
 
 wxStringSplit( aString, words, ' ' );
 
 result.reserve( aString.length() );
 
 for( const wxString& word : words )
 {
 if( !result.IsEmpty() )
 result += wxT( " " );
 
 result += word.Capitalize();
 }
 
 return result;
}

References wxStringSplit().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), and SCH_EDIT_TOOL::editFieldText().

UIDouble2Str()

std::string UIDouble2Str

(

double

aValue

)

Print a float number without using scientific notation and no trailing 0 We want to avoid scientific notation in S-expr files (not easy to read) for floating numbers.

We cannot always just use the g or the f format to print a fp number this helper function uses the f format when needed, or g when f is not well working and then removes trailing 0

Definition at line 1115 of file string_utils.cpp.

{
 char buf[50];
 int len;
 
 if( aValue != 0.0 && std::fabs( aValue ) <= 0.0001 )
 {
 // For these small values, %f works fine,
 // and %g gives an exponent
 len = sprintf( buf, "%.16f", aValue );
 
 while( --len > 0 && buf[len] == '0' )
 buf[len] = '\0';
 
 if( buf[len] == '.' )
 buf[len] = '\0';
 else
 ++len;
 }
 else
 {
 // For these values, %g works fine, and sometimes %f
 // gives a bad value (try aValue = 1.222222222222, with %.16f format!)
 len = sprintf( buf, "%.10g", aValue );
 }
 
 return std::string( buf, len );
}

Referenced by PANEL_SETUP_BOARD_STACKUP::createRowData(), DIELECTRIC_SUBSTRATE::FormatEpsilonR(), BOARD_STACKUP_ITEM::FormatEpsilonR(), DIELECTRIC_SUBSTRATE::FormatLossTangent(), BOARD_STACKUP_ITEM::FormatLossTangent(), NUMERIC_EVALUATOR::parseSetResult(), and PANEL_SETUP_BOARD_STACKUP::synchronizeWithBoard().

UnescapeString()

wxString UnescapeString

(

const wxString &

aSource

)

Definition at line 260 of file string_utils.cpp.

{
 size_t sourceLen = aSource.length();
 
 // smallest escape string is three characters, shortcut everything else
 if( sourceLen <= 2 )
 {
 return aSource;
 }
 
 wxString newbuf;
 newbuf.reserve( sourceLen );
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 wxUniChar ch = aSource[i];
 
 if( ( ch == '$' || ch == '~' || ch == '^' || ch == '_' )
 && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 for( ; i < sourceLen; ++i )
 {
 ch = aSource[i];
 newbuf += ch;
 
 if( ch == '}' )
 break;
 }
 }
 else if( ch == '{' )
 {
 wxString token;
 int depth = 1;
 
 for( i = i + 1; i < sourceLen; ++i )
 {
 ch = aSource[i];
 if( ch == '{' )
 depth++;
 else if( ch == '}' )
 depth--;
 
 if( depth <= 0 )
 break;
 else
 token.append( ch );
 }
 
 if( token == wxT( "dblquote" ) ) newbuf.append( wxT( "\"" ) );
 else if( token == wxT( "quote" ) ) newbuf.append( wxT( "'" ) );
 else if( token == wxT( "lt" ) ) newbuf.append( wxT( "<" ) );
 else if( token == wxT( "gt" ) ) newbuf.append( wxT( ">" ) );
 else if( token == wxT( "backslash" ) ) newbuf.append( wxT( "\\" ) );
 else if( token == wxT( "slash" ) ) newbuf.append( wxT( "/" ) );
 else if( token == wxT( "bar" ) ) newbuf.append( wxT( "|" ) );
 else if( token == wxT( "comma" ) ) newbuf.append( wxT( "," ) );
 else if( token == wxT( "colon" ) ) newbuf.append( wxT( ":" ) );
 else if( token == wxT( "space" ) ) newbuf.append( wxT( " " ) );
 else if( token == wxT( "dollar" ) ) newbuf.append( wxT( "$" ) );
 else if( token == wxT( "tab" ) ) newbuf.append( wxT( "\t" ) );
 else if( token == wxT( "return" ) ) newbuf.append( wxT( "\n" ) );
 else if( token == wxT( "brace" ) ) newbuf.append( wxT( "{" ) );
 else if( token.IsEmpty() ) newbuf.append( wxT( "{" ) );
 else
 {
 newbuf.append( wxT( "{" ) + UnescapeString( token ) + wxT( "}" ) );
 }
 }
 else
 {
 newbuf.append( ch );
 }
 }
 
 return newbuf;
}

References UnescapeString().

Referenced by NET_SELECTOR_COMBOPOPUP::Accept(), DIALOG_EDIT_SYMBOLS_LIBID::AddRowToGrid(), NETLIST_EXPORTER_XML::addSymbolFields(), SCH_CONNECTION::AppendInfoToMsgPanel(), EDA_TEXT::cacheShownText(), SCH_EDIT_TOOL::ChangeTextType(), SCH_CONNECTION::ConfigureFromLabel(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), DIALOG_LIB_NEW_SYMBOL::DIALOG_LIB_NEW_SYMBOL(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GRID_CELL_ESCAPED_TEXT_RENDERER::Draw(), KIUI::EllipsizeMenuText(), KIUI::EllipsizeStatusText(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckHierSheets(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), SYMBOL_EDIT_FRAME::ExportSymbol(), findItemsFromSyncSelection(), PCB_EDIT_FRAME::FindItemsFromSyncSelection(), DIALOG_NET_INSPECTOR::formatNetName(), NETLIST_EXPORTER_SPICE::GenerateItemPinNetName(), GRID_CELL_ESCAPED_TEXT_RENDERER::GetBestSize(), LIB_FIELD::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_SYMBOL::GetMsgPanelInfo(), GERBER_DRAW_ITEM::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::GetRootSymbolNames(), LIB_PIN::GetSelectMenuText(), SCH_SYMBOL::GetSelectMenuText(), DIALOG_COPPER_ZONE::getUnescapedNetName(), FIELDS_GRID_TABLE< T >::GetValue(), LIB_TABLE_GRID::GetValue(), LIB_TREE_MODEL_ADAPTER::GetValue(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GERBVIEW_CONTROL::HighlightControl(), SCH_CONNECTION::IsBusLabel(), SYMBOL_EDIT_FRAME::KiwayMailIn(), DIALOG_CHANGE_SYMBOLS::launchMatchIdSymbolBrowser(), DIALOG_CHANGE_SYMBOLS::launchNewIdSymbolBrowser(), DIALOG_NET_INSPECTOR::LIST_ITEM::LIST_ITEM(), SCH_EAGLE_PLUGIN::loadInstance(), SCH_LEGACY_PLUGIN_CACHE::LoadPart(), SIM_PLOT_FRAME::loadWorkbook(), SCH_CONNECTION::MightBeBusLabel(), DIALOG_NET_INSPECTOR::netFilterMatches(), TEXT_BUTTON_SYMBOL_CHOOSER::OnButtonClick(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), APPEARANCE_CONTROLS::OnNetGridRightClick(), DIALOG_NET_INSPECTOR::onRenameNet(), SCH_SEXPR_PARSER::parseProperty(), DIALOG_CHANGE_SYMBOLS::processSymbol(), FOOTPRINT_LIST_IMPL::ReadCacheFromFile(), NET_SELECTOR_COMBOPOPUP::rebuildList(), APPEARANCE_CONTROLS::rebuildNets(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SYMBOL_EDIT_FRAME::SetCurSymbol(), FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf(), FOOTPRINT_INFO_GENERATOR::SetHtmlName(), DIALOG_EDIT_SYMBOLS_LIBID::setLibIdByBrowser(), DIALOG_LIB_NEW_SYMBOL::SetName(), SYMBOL_VIEWER_FRAME::SetSelectedLibrary(), NET_SELECTOR::SetSelectedNet(), NET_SELECTOR::SetSelectedNetcode(), SYMBOL_VIEWER_FRAME::SetSelectedSymbol(), SYMBOL_VIEWER_FRAME::ShowModal(), ERC_TESTER::TestLibSymbolIssues(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SIGNAL_LIST::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), UnescapeString(), HIGHLIGHT_MENU::update(), SYMBOL_EDIT_FRAME::UpdateAfterSymbolProperties(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), SCH_SYMBOL::UpdateFields(), ROUTER_TOOL::UpdateMessagePanel(), SCH_EDIT_FRAME::UpdateNetHighlightStatus(), GERBVIEW_FRAME::updateNetnameListSelectBox(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), LIB_TREE_NODE_LIB_ID::UpdateScore(), SCH_SCREEN::UpdateSymbolLinks(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), SYMBOL_EDIT_FRAME::updateTitle(), ValueStringCompare(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

ValueStringCompare()

int ValueStringCompare	(	const wxString &	strFWord,
		const wxString &	strSWord
	)

Compare strings like the strcmp function but handle numbers and modifiers within the string text correctly for sorting.

eg. 1mF > 55uF

Returns

-1 if first string is less than the second, 0 if the strings are equal, or 1 if the first string is greater than the second.

Definition at line 844 of file string_utils.cpp.

{
 // Compare unescaped text
 wxString fWord = UnescapeString( strFWord );
 wxString sWord = UnescapeString( strSWord );
 
 // The different sections of the two strings
 wxString strFWordBeg, strFWordMid, strFWordEnd;
 wxString strSWordBeg, strSWordMid, strSWordEnd;
 
 // Split the two strings into separate parts
 SplitString( fWord, &strFWordBeg, &strFWordMid, &strFWordEnd );
 SplitString( sWord, &strSWordBeg, &strSWordMid, &strSWordEnd );
 
 // Compare the Beginning section of the strings
 int isEqual = strFWordBeg.CmpNoCase( strSWordBeg );
 
 if( isEqual > 0 )
 {
 return 1;
 }
 else if( isEqual < 0 )
 {
 return -1;
 }
 else
 {
 // If the first sections are equal compare their digits
 double lFirstNumber = 0;
 double lSecondNumber = 0;
 bool endingIsModifier = false;
 
 strFWordMid.ToDouble( &lFirstNumber );
 strSWordMid.ToDouble( &lSecondNumber );
 
 endingIsModifier |= ApplyModifier( lFirstNumber, strFWordEnd );
 endingIsModifier |= ApplyModifier( lSecondNumber, strSWordEnd );
 
 if( lFirstNumber > lSecondNumber )
 return 1;
 else if( lFirstNumber < lSecondNumber )
 return -1;
 // If the first two sections are equal and the endings are modifiers then compare them
 else if( !endingIsModifier )
 return strFWordEnd.CmpNoCase( strSWordEnd );
 // Ran out of things to compare; they must match
 else
 return 0;
 }
}

References ApplyModifier(), SplitString(), and UnescapeString().

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::cmp().

WildCompareString()

bool WildCompareString	(	const wxString &	pattern,
		const wxString &	string_to_tst,
		bool	case_sensitive = true
	)

Compare a string against wild card (* and ?) pattern using the usual rules.

Returns

true if pattern matched otherwise false.

Definition at line 735 of file string_utils.cpp.

{
 const wxChar* cp = nullptr, * mp = nullptr;
 const wxChar* wild, * str;
 wxString _pattern, _string_to_tst;
 
 if( case_sensitive )
 {
 wild = pattern.GetData();
 str = string_to_tst.GetData();
 }
 else
 {
 _pattern = pattern;
 _pattern.MakeUpper();
 _string_to_tst = string_to_tst;
 _string_to_tst.MakeUpper();
 wild = _pattern.GetData();
 str = _string_to_tst.GetData();
 }
 
 while( ( *str ) && ( *wild != '*' ) )
 {
 if( ( *wild != *str ) && ( *wild != '?' ) )
 return false;
 
 wild++;
 str++;
 }
 
 while( *str )
 {
 if( *wild == '*' )
 {
 if( !*++wild )
 return 1;
 mp = wild;
 cp = str + 1;
 }
 else if( ( *wild == *str ) || ( *wild == '?' ) )
 {
 wild++;
 str++;
 }
 else
 {
 wild = mp;
 str = cp++;
 }
 }
 
 while( *wild == '*' )
 {
 wild++;
 }
 
 return !*wild;
}

Referenced by FROM_TO_CACHE::cacheFromToPaths(), LIBEVAL::VALUE::EqualTo(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

wxStringSplit()

void wxStringSplit	(	const wxString &	aText,
		wxArrayString &	aStrings,
		wxChar	aSplitter
	)

Split aString to a string list separated at aSplitter.

Parameters

aText	is the text to split.
aStrings	will contain the split lines.
aSplitter	is the 'split' character.

Definition at line 1048 of file string_utils.cpp.

{
 wxString tmp;
 
 for( unsigned ii = 0; ii < aText.Length(); ii++ )
 {
 if( aText[ii] == aSplitter )
 {
 aStrings.Add( tmp );
 tmp.Clear();
 }
 else
 {
 tmp << aText[ii];
 }
 }
 
 if( !tmp.IsEmpty() )
 aStrings.Add( tmp );
}

Referenced by KIFONT::FONT::getLinePositions(), EDA_TEXT::GetTextBox(), KIFONT::FONT::LinebreakText(), HTML_MESSAGE_BOX::ListSet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PANEL_SETUP_RULES::OnErrorLinkClicked(), pcbnewGetWizardsBackTrace(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), TitleCaps(), and wordbreakMarkup().