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 (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>


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

wxString ConvertToNewOverbarNotation( const wxString& aOldStr );

bool ConvertSmartQuotesAndDashes( wxString* aString );

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

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

wxString UnescapeString( const wxString& aSource );

wxString PrettyPrintForMenu( const wxString& aString );

wxString TitleCaps( const wxString& aString );

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

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

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

wxString EscapeHTML( const wxString& aString );

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

bool NoPrintableChars( const wxString& aString );

int PrintableCharCount( const wxString& aString );

char* StrPurge( char* text );

wxString DateAndTime();

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

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

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

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

int GetTrailingInt( const wxString& aStr );

wxString GetIllegalFileNameWxChars();

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


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

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

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

std::string Double2Str( double aValue );

wxString AngleToStringDegrees( double aAngle );

#endif  // STRING_UTILS_H