array_axis.cpp

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/>.
 */
 
#include <array_axis.h>
 
#include <increment.h>
 

static bool schemeNonUnitColsStartAt0( ARRAY_AXIS::NUMBERING_TYPE type )
{
    return type == ARRAY_AXIS::NUMBERING_TYPE::NUMBERING_ALPHA_FULL
           || type == ARRAY_AXIS::NUMBERING_TYPE::NUMBERING_ALPHA_NO_IOSQXZ;
}
 
 
ARRAY_AXIS::ARRAY_AXIS() :
        m_type( NUMBERING_TYPE::NUMBERING_NUMERIC ),
        m_offset( 0 ),
        m_step( 1 ),
        m_useLowercase( false )
{
}
 
 
const wxString& ARRAY_AXIS::GetAlphabet() const
{
    static const wxString alphaNumeric = wxS( "0123456789" );
    static const wxString alphaHex = wxS( "0123456789ABCDEF" );
    static const wxString alphaFull = wxS( "ABCDEFGHIJKLMNOPQRSTUVWXYZ" );
    static const wxString alphaNoIOSQXZ = wxS( "ABCDEFGHJKLMNPRTUVWY" );
 
    switch( m_type )
    {
    default:
    case NUMBERING_NUMERIC:
        return alphaNumeric;
    case NUMBERING_HEX:
        return alphaHex;
    case NUMBERING_ALPHA_NO_IOSQXZ:
        return alphaNoIOSQXZ;
    case NUMBERING_ALPHA_FULL:
        return alphaFull;
    }
}
 
 
std::optional<int> ARRAY_AXIS::getNumberingOffset( const wxString& str ) const
{
    if( str.length() == 0 )
        return std::optional<int>{};
 
    const wxString& alphabet = GetAlphabet();
 
    int       offset = 0;
    const int radix = alphabet.length();
 
    for( unsigned i = 0; i < str.length(); i++ )
    {
        wxUniChar ch = str[i];
 
        // For alphabetic types, convert to uppercase for lookup since our alphabets
        // are defined with uppercase letters. This allows users to enter lowercase.
        if( !TypeIsNumeric( m_type ) && ch >= 'a' && ch <= 'z' )
            ch = ch - 'a' + 'A';
 
        int chIndex = alphabet.Find( ch, false );
 
        if( chIndex == wxNOT_FOUND )
            return std::optional<int>{};
 
        const bool start0 = schemeNonUnitColsStartAt0( m_type );
 
        // eg "AA" is actually index 27, not 26
        if( start0 && i < str.length() - 1 )
            chIndex++;
 
        offset *= radix;
        offset += chIndex;
    }
 
    return std::optional<int>{ offset };
}
 
 
void ARRAY_AXIS::SetAxisType( NUMBERING_TYPE aType )
{
    m_type = aType;
}
 
 
bool ARRAY_AXIS::SetOffset( const wxString& aOffsetName )
{
    std::optional<int> offset = getNumberingOffset( aOffsetName );
 
    // The string does not decode to a valid offset
    if( !offset )
        return false;
 
    // For alphabetic types, check if the user entered lowercase letters.
    // If so, we'll output lowercase letters as well.
    if( !TypeIsNumeric( m_type ) && !aOffsetName.IsEmpty() )
    {
        wxUniChar firstChar = aOffsetName[0];
        m_useLowercase = ( firstChar >= 'a' && firstChar <= 'z' );
    }
    else
    {
        m_useLowercase = false;
    }
 
    SetOffset( *offset );
    return true;
}
 
 
void ARRAY_AXIS::SetOffset( int aOffset )
{
    m_offset = aOffset;
}
 
 
int ARRAY_AXIS::GetOffset() const
{
    return m_offset;
}
 
 
void ARRAY_AXIS::SetStep( int aStep )
{
    m_step = aStep;
}
 
 
wxString ARRAY_AXIS::GetItemNumber( int n ) const
{
    const wxString& alphabet = GetAlphabet();
    const bool      nonUnitColsStartAt0 = schemeNonUnitColsStartAt0( m_type );
 
    n = m_offset + m_step * n;
 
    wxString result = AlphabeticFromIndex( n, alphabet, nonUnitColsStartAt0 );
 
    // If the user entered a lowercase starting value, output lowercase letters
    if( m_useLowercase )
        result = result.Lower();
 
    return result;
}