string_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef STRING_UTILS_H
#define STRING_UTILS_H
 
#include <algorithm>
#include <string>
#include <vector>
 
#include <wx/string.h>
#include <wx/filename.h>
 
#include <kicommon.h>
 
class PROJECT;
 
void ConvertMarkdown2Html( const wxString& aMarkdownInput, wxString& aHtmlOutput );

KICOMMON_API wxString ConvertToNewOverbarNotation( const wxString& aOldStr );

KICOMMON_API bool ConvertSmartQuotesAndDashes( wxString* aString );

KICOMMON_API std::vector<wxString> SplitGraphemeClusters( const wxString& aText );

enum ESCAPE_CONTEXT
{
    CTX_NETNAME,
    CTX_LIBID,
    CTX_LEGACY_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
    CTX_REGEX
};

KICOMMON_API wxString EscapeString( const wxString& aSource, ESCAPE_CONTEXT aContext );
 
KICOMMON_API wxString UnescapeString( const wxString& aSource );

KICOMMON_API wxString PrettyPrintForMenu( const wxString& aString );

KICOMMON_API wxString TitleCaps( const wxString& aString );

KICOMMON_API wxString InitialCaps( const wxString& aString );

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

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

KICOMMON_API std::string EscapedUTF8( const wxString& aString );

KICOMMON_API wxString EscapeHTML( const wxString& aString );

KICOMMON_API wxString UnescapeHTML( const wxString& aString );

KICOMMON_API wxString RemoveHTMLTags( const wxString& aInput );

KICOMMON_API wxString LinkifyHTML( wxString aStr );

KICOMMON_API bool IsURL( wxString aStr );

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

KICOMMON_API bool NoPrintableChars( const wxString& aString );

KICOMMON_API int PrintableCharCount( const wxString& aString );

KICOMMON_API char* StrPurge( char* text );

KICOMMON_API wxString GetISO8601CurrentDateTime();

KICOMMON_API int StrNumCmp( const wxString& aString1, const wxString& aString2,
                            bool aIgnoreCase = false );
 
 
enum class CASE_SENSITIVITY
{
    SENSITIVE,
    INSENSITIVE
};
 

template <typename T>
inline void StrNumSort( T& aList, CASE_SENSITIVITY aCaseSensitivity )
{
    std::sort( aList.begin(), aList.end(),
               [aCaseSensitivity]( const wxString& lhs, const wxString& rhs )
               {
                   return StrNumCmp( lhs, rhs, aCaseSensitivity == CASE_SENSITIVITY::INSENSITIVE ) < 0;
               } );
}
 

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

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

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

KICOMMON_API int GetTrailingInt( const wxString& aStr );

KICOMMON_API wxString GetIllegalFileNameWxChars();

KICOMMON_API bool IsFullFileNameValid( const wxString& aFullFilename );

KICOMMON_API bool ReplaceIllegalFileNameChars( std::string& aName, int aReplaceChar = 0 );
KICOMMON_API bool  ReplaceIllegalFileNameChars( wxString& aName, int aReplaceChar = 0 );
 

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;
    }
};

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;
}

inline void AccumulateDescription( wxString& aDesc, const wxString& aItem )
{
    if( !aDesc.IsEmpty() )
        aDesc << wxT( ", " );
 
    aDesc << aItem;
}
 

template <typename T>
inline void AccumulateDescriptions( wxString& aDesc, const T& aItemCollection )
{
    for( const auto& item : aItemCollection )
        AccumulateDescription( aDesc, item );
}
 
 
template <typename T>
inline wxString AccumulateDescriptions( const T& aItemCollection )
{
    wxString desc;
    AccumulateDescriptions( desc, aItemCollection );
    return desc;
}

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

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

KICOMMON_API std::string UIDouble2Str( double aValue );

KICOMMON_API std::string FormatDouble2Str( double aValue );

KICOMMON_API wxString FormatTrimmedDecimal( double aValue, int aPrecision );

#define TO_UTF8( wxstring ) ( (const char*) ( wxstring ).utf8_str() )

KICOMMON_API wxString From_UTF8( const std::string& aString );
KICOMMON_API wxString  From_UTF8( const char* cstring );

KICOMMON_API wxString NormalizeFileUri( const wxString& aFileUri );

KICOMMON_API wxString ConvertPathToFileUri( const wxString& aPath, const PROJECT* aProject = nullptr );

KICOMMON_API std::vector<wxString> ExpandStackedPinNotation( const wxString& aPinName,
                                                            bool* aValid = nullptr );

KICOMMON_API wxString EscapeStackedPinItem( const wxString& aPinNumber );

KICOMMON_API std::vector<wxString> SplitStackedPinDisplayItems( const wxString& aInner );

KICOMMON_API int CountStackedPinNotation( const wxString& aPinName, bool* aValid = nullptr );
 

KICOMMON_API bool IsAutoGeneratedNetName( const wxString& aNetName );
 
 
KICOMMON_API wxString GetDefaultVariantName();
KICOMMON_API wxString GetVariantFileToken( const wxString& aVariantName );
KICOMMON_API wxString ExpandVariantOutputPath( const wxString& aPath, const wxString& aVariantName );
 
KICOMMON_API int SortVariantNames( const wxString& aLhs, const wxString& aRhs );
 
class IO_ERROR;

KICOMMON_API wxString ExtractLibraryLoadException( const IO_ERROR& aException );
 
#endif  // STRING_UTILS_H