Fix kicad_string.h / string.cpp mismatch.
They don't define a KiCad string class, so the header file name was somewhat misleading. But the fact that they didn't match definitely made coding more difficult.
This commit is contained in:
Jeff Young
@@ -0,0 +1,351 @@
|
||||
/*
|
||||
* This program source code file is part of KiCad, a free EDA CAD application.
|
||||
*
|
||||
* Copyright (C) 2004-2021 KiCad Developers, see change_log.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, you may find one here:
|
||||
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
||||
* or you may search the http://www.gnu.org website for the version 2 license,
|
||||
* or you may write to the Free Software Foundation, Inc.,
|
||||
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||
*/
|
||||
|
||||
#ifndef STRING_UTILS_H
|
||||
#define STRING_UTILS_H
|
||||
|
||||
#include "config.h"
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <wx/string.h>
|
||||
#include <wx/filename.h>
|
||||
|
||||
|
||||
/**
|
||||
* Convert the old `~...~` overbar notation to the new `~{...}` one.
|
||||
*/
|
||||
wxString ConvertToNewOverbarNotation( const wxString& aOldStr );
|
||||
|
||||
/**
|
||||
* Convert curly quotes and em/en dashes to straight quotes and dashes.
|
||||
*
|
||||
* @return true if any characters required conversion.
|
||||
*/
|
||||
bool ConvertSmartQuotesAndDashes( wxString* aString );
|
||||
|
||||
/**
|
||||
* Escape/Unescape routines to safely encode reserved-characters in various contexts.
|
||||
*/
|
||||
enum ESCAPE_CONTEXT
|
||||
{
|
||||
CTX_NETNAME,
|
||||
CTX_LIBID,
|
||||
CTX_QUOTED_STR,
|
||||
CTX_LINE,
|
||||
CTX_FILENAME
|
||||
};
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
wxString EscapeString( const wxString& aSource, ESCAPE_CONTEXT aContext );
|
||||
|
||||
wxString UnescapeString( const wxString& aSource );
|
||||
|
||||
/**
|
||||
* Remove markup (such as overbar or subscript) that we can't render to menu items.
|
||||
*/
|
||||
wxString PrettyPrintForMenu( const wxString& aString );
|
||||
|
||||
/**
|
||||
* Capitalize the first letter in each word.
|
||||
*/
|
||||
wxString TitleCaps( const wxString& aString );
|
||||
|
||||
/**
|
||||
* Copy bytes from @a aSource delimited string segment to @a aDest buffer.
|
||||
*
|
||||
* The extracted string will be null terminated even if truncation is necessary
|
||||
* because aDestSize was not large enough.
|
||||
*
|
||||
* @param aDest is the destination byte buffer.
|
||||
* @param aSource is the source bytes as a C string.
|
||||
* @param aDestSize is the size of the destination byte buffer.
|
||||
* @return 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.
|
||||
*/
|
||||
int ReadDelimitedText( char* aDest, const char* aSource, int aDestSize );
|
||||
|
||||
/**
|
||||
* Copy bytes from @a aSource delimited string segment to @a aDest wxString.
|
||||
*
|
||||
* @param aDest is the destination wxString.
|
||||
* @param aSource is the source C string holding utf8 encoded bytes.
|
||||
* @return 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.
|
||||
*/
|
||||
int ReadDelimitedText( wxString* aDest, const char* aSource );
|
||||
|
||||
/**
|
||||
* 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().
|
||||
*
|
||||
* @param aString is the input string to convert.
|
||||
* @return the escaped input text, without the wrapping double quotes.
|
||||
*/
|
||||
std::string EscapedUTF8( const wxString& aString );
|
||||
|
||||
/**
|
||||
* Return a new wxString escaped for embedding in HTML.
|
||||
*/
|
||||
wxString EscapeHTML( const wxString& aString );
|
||||
|
||||
/**
|
||||
* Read one line line from \a aFile.
|
||||
*
|
||||
* @return a pointer the first useful line read by eliminating blank lines and comments.
|
||||
*/
|
||||
char* GetLine( FILE* aFile, char* Line, int* LineNum = nullptr, int SizeLine = 255 );
|
||||
|
||||
/**
|
||||
* Return true if the string is empty or contains only whitespace.
|
||||
*/
|
||||
bool NoPrintableChars( const wxString& aString );
|
||||
|
||||
/**
|
||||
* Remove leading and training spaces, tabs and end of line chars in \a text
|
||||
*
|
||||
* @return a pointer on the first n char in text
|
||||
*/
|
||||
char* StrPurge( char* text );
|
||||
|
||||
/**
|
||||
* @return a string giving the current date and time.
|
||||
*/
|
||||
wxString DateAndTime();
|
||||
|
||||
/**
|
||||
* Compare two strings with alphanumerical content.
|
||||
*
|
||||
* This function is equivalent to strncmp() or strncasecmp() if \a 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.
|
||||
*
|
||||
* @param aString1 A wxString reference to the reference string.
|
||||
* @param aString2 A wxString reference to the comparison string.
|
||||
* @param aIgnoreCase Use true to make the comparison case insensitive.
|
||||
* @return An integer value of -1 if \a aString1 is less than \a aString2, 0 if
|
||||
* \a aString1 is equal to \a aString2, or 1 if \a aString1 is greater
|
||||
* than \a aString2.
|
||||
*/
|
||||
int StrNumCmp( const wxString& aString1, const wxString& aString2, bool aIgnoreCase = false );
|
||||
|
||||
/**
|
||||
* Compare a string against wild card (* and ?) pattern using the usual rules.
|
||||
*
|
||||
* @return true if pattern matched otherwise false.
|
||||
*/
|
||||
bool WildCompareString( const wxString& pattern,
|
||||
const wxString& string_to_tst,
|
||||
bool case_sensitive = true );
|
||||
|
||||
/**
|
||||
* Compare strings like the strcmp function but handle numbers and modifiers within the
|
||||
* string text correctly for sorting. eg. 1mF > 55uF
|
||||
*
|
||||
* @return -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.
|
||||
*/
|
||||
int ValueStringCompare( const wxString& strFWord, const wxString& strSWord );
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
int SplitString( const wxString& strToSplit,
|
||||
wxString* strBeginning,
|
||||
wxString* strDigits,
|
||||
wxString* strEnd );
|
||||
|
||||
/**
|
||||
* Gets the trailing int, if any, from a string.
|
||||
*
|
||||
* @param aStr the string to check.
|
||||
* @return the trailing int or 0 if none found.
|
||||
*/
|
||||
int GetTrailingInt( const wxString& aStr );
|
||||
|
||||
/**
|
||||
* @return a wxString object containing the illegal file name characters for all platforms.
|
||||
*/
|
||||
wxString GetIllegalFileNameWxChars();
|
||||
|
||||
/**
|
||||
* Checks \a 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
|
||||
*
|
||||
* @param aName is a point to a std::string object containing the footprint name to verify.
|
||||
* @param aReplaceChar (if not 0) is the replacement char.
|
||||
* @return true if any characters have been replaced in \a aName.
|
||||
*/
|
||||
bool ReplaceIllegalFileNameChars( std::string* aName, int aReplaceChar = 0 );
|
||||
bool ReplaceIllegalFileNameChars( wxString& aName, int aReplaceChar = 0 );
|
||||
|
||||
#ifndef HAVE_STRTOKR
|
||||
// common/strtok_r.c optionally:
|
||||
extern "C" char* strtok_r( char* str, const char* delim, char** nextp );
|
||||
#endif
|
||||
|
||||
|
||||
/**
|
||||
* A helper for sorting strings from the rear.
|
||||
*
|
||||
* Useful for things like 3D model names where they tend to be largely repetitious at the front.
|
||||
*/
|
||||
struct rsort_wxString
|
||||
{
|
||||
bool operator() ( const wxString& strA, const wxString& strB ) const
|
||||
{
|
||||
wxString::const_reverse_iterator sA = strA.rbegin();
|
||||
wxString::const_reverse_iterator eA = strA.rend();
|
||||
|
||||
wxString::const_reverse_iterator sB = strB.rbegin();
|
||||
wxString::const_reverse_iterator eB = strB.rend();
|
||||
|
||||
if( strA.empty() )
|
||||
{
|
||||
if( strB.empty() )
|
||||
return false;
|
||||
|
||||
// note: this rule implies that a null string is first in the sort order
|
||||
return true;
|
||||
}
|
||||
|
||||
if( strB.empty() )
|
||||
return false;
|
||||
|
||||
while( sA != eA && sB != eB )
|
||||
{
|
||||
if( ( *sA ) == ( *sB ) )
|
||||
{
|
||||
++sA;
|
||||
++sB;
|
||||
continue;
|
||||
}
|
||||
|
||||
if( ( *sA ) < ( *sB ) )
|
||||
return true;
|
||||
else
|
||||
return false;
|
||||
}
|
||||
|
||||
if( sB == eB )
|
||||
return false;
|
||||
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Split the input string into a vector of output strings
|
||||
*
|
||||
* @note Multiple delimiters are considered to be separate records with empty strings
|
||||
*
|
||||
* @param aStr Input string with 0 or more delimiters.
|
||||
* @param aDelim The string of delimiter. Multiple characters here denote alternate delimiters.
|
||||
* @return a vector of strings
|
||||
*/
|
||||
static inline std::vector<std::string> split( const std::string& aStr, const std::string& aDelim )
|
||||
{
|
||||
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;
|
||||
}
|
||||
|
||||
/// Utility to build comma separated lists in messages
|
||||
inline void AccumulateDescription( wxString& aDesc, const wxString& aItem )
|
||||
{
|
||||
if( !aDesc.IsEmpty() )
|
||||
aDesc << wxT( ", " );
|
||||
|
||||
aDesc << aItem;
|
||||
}
|
||||
|
||||
/**
|
||||
* Split \a aString to a string list separated at \a aSplitter.
|
||||
*
|
||||
* @param aText is the text to split.
|
||||
* @param aStrings will contain the split lines.
|
||||
* @param aSplitter is the 'split' character.
|
||||
*/
|
||||
void wxStringSplit( const wxString& aText, wxArrayString& aStrings, wxChar aSplitter );
|
||||
|
||||
/**
|
||||
* Remove trailing zeros from a string containing a converted float number.
|
||||
*
|
||||
* The trailing zeros are removed if the mantissa has more than \a aTrailingZeroAllowed
|
||||
* digits and some trailing zeros.
|
||||
*/
|
||||
void StripTrailingZeros( wxString& aStringValue, unsigned aTrailingZeroAllowed = 1 );
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
std::string Double2Str( double aValue );
|
||||
|
||||
/**
|
||||
* A helper to convert the \a double \a aAngle (in internal unit) to a string in degrees.
|
||||
*/
|
||||
wxString AngleToStringDegrees( double aAngle );
|
||||
|
||||
#endif // STRING_UTILS_H
|
||||
Reference in New Issue
Block a user