File: increment.cpp

package info (click to toggle)
kicad 9.0.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 770,320 kB
  • sloc: cpp: 961,692; ansic: 121,001; xml: 66,428; python: 18,387; sh: 1,010; awk: 301; asm: 292; makefile: 227; javascript: 167; perl: 10
file content (288 lines) | stat: -rw-r--r-- 7,909 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
/*
 * 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, 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
 */

#include "increment.h"

#include <wx/wxcrt.h>

#include <cmath>
#include <iostream>
#include <regex>


KICOMMON_API bool IncrementString( wxString& name, int aIncrement )
{
    if( name.IsEmpty() )
        return true;

    wxString suffix;
    wxString digits;
    wxString outputFormat;
    wxString outputNumber;
    int      ii     = name.Len() - 1;
    int      dCount = 0;

    while( ii >= 0 && !wxIsdigit( name.GetChar( ii ) ) )
    {
        suffix = name.GetChar( ii ) + suffix;
        ii--;
    }

    while( ii >= 0 && wxIsdigit( name.GetChar( ii ) ) )
    {
        digits = name.GetChar( ii ) + digits;
        ii--;
        dCount++;
    }

    if( digits.IsEmpty() )
        return true;

    long number = 0;

    if( digits.ToLong( &number ) )
    {
        number += aIncrement;

        // Don't let result go below zero
        if( number > -1 )
        {
            name.Remove( ii + 1 );

            //write out a format string with correct number of leading zeroes
            outputFormat.Printf( wxS( "%%0%dld" ), dCount );

            //write out the number using the format string
            outputNumber.Printf( outputFormat, number );
            name << outputNumber << suffix;
            return true;
        }
    }

    return false;
}


std::optional<wxString> STRING_INCREMENTER::Increment( const wxString& aStr, int aDelta,
                                                       size_t aRightIndex ) const
{
    if( aStr.IsEmpty() )
        return std::nullopt;

    wxString                                           remaining = aStr;
    std::vector<std::pair<wxString, STRING_PART_TYPE>> parts;
    size_t                                             goodParts = 0;

    // Keep popping chunks off the string until we have what we need
    while( goodParts < ( aRightIndex + 1 ) && !remaining.IsEmpty() )
    {
        static const std::regex integerRegex( R"(\d+$)" );

        // ABC or abc but not Abc
        static const std::regex sameCaseAlphabetRegex( R"(([a-z]+|[A-Z]+)$)" );

        // Skippables - for now anything that isn't a letter or number
        static const std::regex skipRegex( R"([^a-zA-Z0-9]+$)" );

        std::string remainingStr = remaining.ToStdString();
        std::smatch match;

        if( std::regex_search( remainingStr, match, integerRegex ) )
        {
            parts.push_back( { match.str(), STRING_PART_TYPE::INTEGER } );
            remaining = remaining.Left( remaining.Len() - match.str().size() );
            goodParts++;
        }
        else if( std::regex_search( remainingStr, match, sameCaseAlphabetRegex ) )
        {
            parts.push_back( { match.str(), STRING_PART_TYPE::ALPHABETIC } );
            remaining = remaining.Left( remaining.Len() - match.str().size() );
            goodParts++;
        }
        else if( std::regex_search( remainingStr, match, skipRegex ) )
        {
            parts.push_back( { match.str(), STRING_PART_TYPE::SKIP } );
            remaining = remaining.Left( remaining.Len() - match.str().size() );
        }
        else
        {
            // Out of ideas
            break;
        }
    }

    // Couldn't find the part we wanted
    if( goodParts < aRightIndex + 1 )
        return std::nullopt;

    // Increment the part we wanted
    bool didIncrement = incrementPart( parts.back().first, parts.back().second, aDelta );

    if( !didIncrement )
        return std::nullopt;

    // Reassemble the string - the left-over part, then parts in reverse
    wxString result = remaining;

    for( auto it = parts.rbegin(); it != parts.rend(); ++it )
    {
        result << it->first;
    }

    return result;
}


static bool containsIOSQXZ( const wxString& aStr )
{
    static const wxString iosqxz = "IOSQXZ";

    for( const wxUniChar& c : aStr )
    {
        if( iosqxz.Contains( c ) )
            return true;
    }

    return false;
}


bool STRING_INCREMENTER::incrementPart( wxString& aPart, STRING_PART_TYPE aType, int aDelta ) const
{
    switch( aType )
    {
    case STRING_PART_TYPE::INTEGER:
    {
        long   number = 0;
        bool   zeroPadded = aPart.StartsWith( '0' );
        size_t oldLen = aPart.Len();

        if( aPart.ToLong( &number ) )
        {
            number += aDelta;

            // Going below zero makes things awkward
            // and is not usually that useful.
            if( number < 0 )
                return false;

            aPart.Printf( "%ld", number );

            // If the number was zero-padded, we need to re-pad it
            if( zeroPadded )
            {
                aPart = wxString( "0", oldLen - aPart.Len() ) + aPart;
            }

            return true;
        }

        break;
    }
    case STRING_PART_TYPE::ALPHABETIC:
    {
        // Covert to uppercase
        wxString upper = aPart.Upper();
        bool     wasUpper = aPart == upper;

        static const wxString alphabetFull = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
        static const wxString alphaNoIOSQXZ = "ABCDEFGHJKLMNPRTUVWY";

        const wxString& alpha =
                ( m_SkipIOSQXZ & !containsIOSQXZ( aPart ) ) ? alphaNoIOSQXZ : alphabetFull;

        int index = IndexFromAlphabetic( upper, alpha );

        // Something was not in the alphabet
        if( index == -1 )
            return false;

        // It's such a big number that we don't want to increment it
        if( index > m_AlphabeticMaxIndex && m_AlphabeticMaxIndex >= 0 )
            return false;

        index += aDelta;

        if( index < 0 )
            return false;

        wxString newStr = AlphabeticFromIndex( index, alpha, true );

        if( !wasUpper )
            newStr = newStr.Lower();

        aPart = newStr;

        return true;
    }
    case STRING_PART_TYPE::SKIP: break;
    }

    return false;
}


KICOMMON_API int IndexFromAlphabetic( const wxString& aStr, const wxString& aAlphabet )
{
    int       index = 0;
    const int radix = aAlphabet.Length();

    for( size_t i = 0; i < aStr.Len(); i++ )
    {
        int alphaIndex = aAlphabet.Find( aStr[i] );

        if( alphaIndex == wxNOT_FOUND )
            return -1;

        if( i != aStr.Len() - 1 )
            alphaIndex++;

        index += alphaIndex * pow( radix, aStr.Len() - 1 - i );
    }

    return index;
}


wxString KICOMMON_API AlphabeticFromIndex( size_t aN, const wxString& aAlphabet,
                                           bool aZeroBasedNonUnitCols )
{
    wxString  itemNum;
    bool      firstRound = true;
    const int radix = aAlphabet.Length();

    do
    {
        int modN = aN % radix;

        if( aZeroBasedNonUnitCols && !firstRound )
            modN--; // Start the "tens/hundreds/etc column" at "Ax", not "Bx"

        itemNum.insert( 0, 1, aAlphabet[modN] );

        aN /= radix;
        firstRound = false;
    } while( aN );

    return itemNum;
}