increment.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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, 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
 */
 
#pragma once
 
#include <optional>
 
#include <wx/string.h>
 
#include <kicommon.h>
 
KICOMMON_API bool IncrementString( wxString& aStr, int aDelta );
 
 
class KICOMMON_API STRING_INCREMENTER
{
public:
    void SetSkipIOSQXZ( bool aSkip ) { m_SkipIOSQXZ = aSkip; }
 
    void SetAlphabeticMaxIndex( int aMaxIndex ) { m_AlphabeticMaxIndex = aMaxIndex; }
 
    std::optional<wxString> Increment( const wxString& aStr, int aDelta, size_t aRightIndex ) const;
 
private:
    enum class STRING_PART_TYPE
    {
        ALPHABETIC,
        INTEGER,
        SKIP,
    };
 
    bool incrementPart( wxString& aPart, STRING_PART_TYPE aType, int aDelta ) const;
 
    bool m_SkipIOSQXZ = true;
    int  m_AlphabeticMaxIndex = 50;
};
 
KICOMMON_API int IndexFromAlphabetic( const wxString& aStr, const wxString& aAlphabet );
 
KICOMMON_API wxString AlphabeticFromIndex( size_t aN, const wxString& aAlphabet,
                                           bool aZeroBasedNonUnitCols );