summaryrefslogtreecommitdiff
path: root/common/string.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'common/string.cpp')
-rw-r--r--common/string.cpp485
1 files changed, 485 insertions, 0 deletions
diff --git a/common/string.cpp b/common/string.cpp
new file mode 100644
index 0000000..d0bfe33
--- /dev/null
+++ b/common/string.cpp
@@ -0,0 +1,485 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2004 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
+ */
+
+/**
+ * @file string.cpp
+ * @brief Some useful functions to handle strings.
+ */
+
+#include <fctsys.h>
+#include <macros.h>
+#include <richio.h> // StrPrintf
+#include <kicad_string.h>
+
+
+/**
+ * Illegal file name characters used to insure file names will be valid on all supported
+ * platforms. This is the list of illegal file name characters for Windows which includes
+ * the illegal file name characters for Linux and OSX.
+ */
+static const char illegalFileNameChars[] = "\\/:\"<>|";
+
+
+int ReadDelimitedText( wxString* aDest, const char* aSource )
+{
+ 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;
+}
+
+
+int ReadDelimitedText( char* aDest, const char* aSource, int aDestSize )
+{
+ 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;
+}
+
+
+std::string EscapedUTF8( const wxString& aString )
+{
+ std::string utf8 = TO_UTF8( aString );
+
+ std::string ret;
+
+ 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;
+}
+
+
+char* StrPurge( char* text )
+{
+ 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;
+}
+
+
+char* GetLine( FILE* File, char* Line, int* LineNum, int SizeLine )
+{
+ do {
+ if( fgets( Line, SizeLine, File ) == NULL )
+ return NULL;
+
+ if( LineNum )
+ *LineNum += 1;
+
+ } while( Line[0] == '#' || Line[0] == '\n' || Line[0] == '\r' || Line[0] == 0 );
+
+ strtok( Line, "\n\r" );
+ return Line;
+}
+
+
+wxString DateAndTime()
+{
+ wxDateTime datetime = wxDateTime::Now();
+
+ datetime.SetCountry( wxDateTime::Country_Default );
+ return datetime.Format( wxDefaultDateTimeFormat, wxDateTime::Local );
+}
+
+
+int StrNumCmp( const wxString& aString1, const wxString& aString2, int aLength, bool aIgnoreCase )
+{
+ int i;
+ int nb1 = 0, nb2 = 0;
+
+ wxString::const_iterator str1 = aString1.begin(), str2 = aString2.begin();
+
+ if( ( str1 == aString1.end() ) || ( str2 == aString2.end() ) )
+ return 0;
+
+ for( i = 0; i < aLength; i++ )
+ {
+ if( isdigit( *str1 ) && isdigit( *str2 ) ) /* digit found */
+ {
+ nb1 = 0;
+ nb2 = 0;
+
+ while( isdigit( *str1 ) )
+ {
+ nb1 = nb1 * 10 + (int) *str1 - '0';
+ ++str1;
+ }
+
+ while( isdigit( *str2 ) )
+ {
+ nb2 = nb2 * 10 + (int) *str2 - '0';
+ ++str2;
+ }
+
+ if( nb1 < nb2 )
+ return -1;
+
+ if( nb1 > nb2 )
+ return 1;
+ }
+
+ if( aIgnoreCase )
+ {
+ if( toupper( *str1 ) < toupper( *str2 ) )
+ return -1;
+
+ if( toupper( *str1 ) > toupper( *str2 ) )
+ return 1;
+
+ if( ( *str1 == 0 ) && ( *str2 == 0 ) )
+ return 0;
+ }
+ else
+ {
+ if( *str1 < *str2 )
+ return -1;
+
+ if( *str1 > *str2 )
+ return 1;
+
+ if( ( str1 == aString1.end() ) && ( str2 == aString2.end() ) )
+ return 0;
+ }
+
+ ++str1;
+ ++str2;
+ }
+
+ return 0;
+}
+
+
+bool WildCompareString( const wxString& pattern, const wxString& string_to_tst,
+ bool case_sensitive )
+{
+ const wxChar* cp = NULL, * mp = NULL;
+ const wxChar* wild, * string;
+ wxString _pattern, _string_to_tst;
+
+ if( case_sensitive )
+ {
+ wild = pattern.GetData();
+ string = string_to_tst.GetData();
+ }
+ else
+ {
+ _pattern = pattern;
+ _pattern.MakeUpper();
+ _string_to_tst = string_to_tst;
+ _string_to_tst.MakeUpper();
+ wild = _pattern.GetData();
+ string = _string_to_tst.GetData();
+ }
+
+ while( ( *string ) && ( *wild != '*' ) )
+ {
+ if( ( *wild != *string ) && ( *wild != '?' ) )
+ return false;
+
+ wild++; string++;
+ }
+
+ while( *string )
+ {
+ if( *wild == '*' )
+ {
+ if( !*++wild )
+ return 1;
+ mp = wild;
+ cp = string + 1;
+ }
+ else if( ( *wild == *string ) || ( *wild == '?' ) )
+ {
+ wild++;
+ string++;
+ }
+ else
+ {
+ wild = mp;
+ string = cp++;
+ }
+ }
+
+ while( *wild == '*' )
+ {
+ wild++;
+ }
+
+ return !*wild;
+}
+
+
+int RefDesStringCompare( const wxString& strFWord, const wxString& strSWord )
+{
+ // The different sections of the first string
+ wxString strFWordBeg, strFWordMid, strFWordEnd;
+
+ // The different sections of the second string
+ wxString strSWordBeg, strSWordMid, strSWordEnd;
+
+ int isEqual = 0; // The numerical results of a string compare
+ int iReturn = 0; // The variable that is being returned
+
+ long lFirstDigit = 0; // The converted middle section of the first string
+ long lSecondDigit = 0; // The converted middle section of the second string
+
+ // Split the two strings into separate parts
+ SplitString( strFWord, &strFWordBeg, &strFWordMid, &strFWordEnd );
+ SplitString( strSWord, &strSWordBeg, &strSWordMid, &strSWordEnd );
+
+ // Compare the Beginning section of the strings
+ isEqual = strFWordBeg.CmpNoCase( strSWordBeg );
+
+ if( isEqual > 0 )
+ iReturn = 1;
+ else if( isEqual < 0 )
+ iReturn = -1;
+ else
+ {
+ // If the first sections are equal compare their digits
+ strFWordMid.ToLong( &lFirstDigit );
+ strSWordMid.ToLong( &lSecondDigit );
+
+ if( lFirstDigit > lSecondDigit )
+ iReturn = 1;
+ else if( lFirstDigit < lSecondDigit )
+ iReturn = -1;
+ else
+ {
+ // If the first two sections are equal compare the endings
+ isEqual = strFWordEnd.CmpNoCase( strSWordEnd );
+
+ if( isEqual > 0 )
+ iReturn = 1;
+ else if( isEqual < 0 )
+ iReturn = -1;
+ else
+ iReturn = 0;
+ }
+ }
+
+ return iReturn;
+}
+
+
+int SplitString( wxString strToSplit,
+ wxString* strBeginning,
+ wxString* strDigits,
+ wxString* strEnd )
+{
+ // 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( isdigit( 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( !isdigit( strToSplit[ii] ) )
+ 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;
+}
+
+
+wxString GetIllegalFileNameWxChars()
+{
+ return FROM_UTF8( illegalFileNameChars );
+}
+
+
+bool ReplaceIllegalFileNameChars( std::string* aName, int aReplaceChar )
+{
+ bool changed = false;
+ std::string result;
+
+ 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;
+}
generated by cgit (git 2.34.1) at 2024-12-19 09:48:47 +0000