legacy_plugin.cpp 150 KB
Newer Older
1 2 3 4

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
5
 * Copyright (C) 2007-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6 7
 * Copyright (C) 2004 Jean-Pierre Charras, jp.charras@wanadoo.fr
 * Copyright (C) 1992-2012 KiCad Developers, see change_log.txt for contributors.
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
 *
 * 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
 */

/*
    This implements loading and saving a BOARD, behind the PLUGIN interface.

    The definitions:

    *) a Board Internal Unit (BIU) is a unit of length that is used only internally
       to PCBNEW, and is nanometers when this work is done, but deci-mils until done.

    The philosophies:

    *) BIUs should be typed as such to distinguish them from ints.  This is mostly
       for human readability, and having the type nearby in the source supports this readability.
    *) Do not assume that BIUs will always be int, doing a sscanf() into a BIU
       does not make sense in case the size of the BIU changes.
    *) variables are put onto the stack in an automatic, even when it might look
       more efficient to do otherwise.  This is so we can seem them with a debugger.
    *) Global variables should not be touched from within a PLUGIN, since it will eventually
       be in a DLL/DSO.  This includes window information too.  The PLUGIN API knows
       nothing of wxFrame or globals and all error reporting must be done by throwing
       an exception.
    *) No wxWindowing calls are made in here, since the UI resides higher up than in here,
       and is going to process a bucket of detailed information thrown from down here
       in the form of an exception if an error happens.
    *) Much of what we do in this source file is for human readability, not performance.
       Simply avoiding strtok() more often than the old code washes out performance losses.
       Remember strncmp() will bail as soon as a mismatch happens, not going all the way
       to end of string unless a full match.
    *) angles are in the process of migrating to doubles, and 'int' if used, is
       only shortterm, and along with this a change, and transition from from
       "tenths of degrees" to simply "degrees" in the double (which has no problem
       representing any portion of a degree).
*/


61
#include <cmath>
62 63 64
#include <stdio.h>
#include <string.h>
#include <errno.h>
65
#include <wx/ffile.h>
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84

#include <legacy_plugin.h>   // implement this here

#include <kicad_string.h>
#include <macros.h>
#include <zones.h>

#include <class_board.h>
#include <class_module.h>
#include <class_track.h>
#include <class_pcb_text.h>
#include <class_zone.h>
#include <class_dimension.h>
#include <class_drawsegment.h>
#include <class_mire.h>
#include <class_edge_mod.h>
#include <3d_struct.h>
#include <pcb_plot_params.h>
#include <drawtxt.h>
85
#include <convert_to_biu.h>
86
#include <trigo.h>
87
#include <build_version.h>
88

89 90
#include <boost/make_shared.hpp>

91

92 93 94
typedef LEGACY_PLUGIN::BIU      BIU;


95
#define VERSION_ERROR_FORMAT    _( "File '%s' is format version: %d.\nI only support format version <= %d.\nPlease upgrade Pcbnew to load this file." )
96 97 98 99
#define UNKNOWN_GRAPHIC_FORMAT  _( "unknown graphic type: %d")
#define UNKNOWN_PAD_FORMAT      _( "unknown pad type: %d")
#define UNKNOWN_PAD_ATTRIBUTE   _( "unknown pad attribute: %d" )

100

101
typedef unsigned                LEG_MASK;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
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

#define FIRST_LAYER             0
#define FIRST_COPPER_LAYER      0
#define LAYER_N_BACK            0
#define LAYER_N_2               1
#define LAYER_N_3               2
#define LAYER_N_4               3
#define LAYER_N_5               4
#define LAYER_N_6               5
#define LAYER_N_7               6
#define LAYER_N_8               7
#define LAYER_N_9               8
#define LAYER_N_10              9
#define LAYER_N_11              10
#define LAYER_N_12              11
#define LAYER_N_13              12
#define LAYER_N_14              13
#define LAYER_N_15              14
#define LAYER_N_FRONT           15
#define LAST_COPPER_LAYER       LAYER_N_FRONT
#define NB_COPPER_LAYERS        (LAST_COPPER_LAYER - FIRST_COPPER_LAYER + 1)

#define FIRST_NON_COPPER_LAYER  16
#define FIRST_TECHNICAL_LAYER   16
#define FIRST_USER_LAYER        24
#define ADHESIVE_N_BACK         16
#define ADHESIVE_N_FRONT        17
#define SOLDERPASTE_N_BACK      18
#define SOLDERPASTE_N_FRONT     19
#define SILKSCREEN_N_BACK       20
#define SILKSCREEN_N_FRONT      21
#define SOLDERMASK_N_BACK       22
#define SOLDERMASK_N_FRONT      23
#define DRAW_N                  24
#define COMMENT_N               25
#define ECO1_N                  26
#define ECO2_N                  27
#define EDGE_N                  28
#define LAST_NON_COPPER_LAYER   28
#define LAST_TECHNICAL_LAYER    23
#define LAST_USER_LAYER         27
#define NB_PCB_LAYERS           (LAST_NON_COPPER_LAYER + 1)
#define UNUSED_LAYER_29         29
#define UNUSED_LAYER_30         30
#define UNUSED_LAYER_31         31
#define NB_GERBER_LAYERS        32
#define NB_LAYERS               32

// Masks to identify a layer by a bit map
typedef unsigned LAYER_MSK;
#define LAYER_BACK              (1 << LAYER_N_BACK)     ///< bit mask for copper layer
#define LAYER_2                 (1 << LAYER_N_2)        ///< bit mask for layer 2
#define LAYER_3                 (1 << LAYER_N_3)        ///< bit mask for layer 3
#define LAYER_4                 (1 << LAYER_N_4)        ///< bit mask for layer 4
#define LAYER_5                 (1 << LAYER_N_5)        ///< bit mask for layer 5
#define LAYER_6                 (1 << LAYER_N_6)        ///< bit mask for layer 6
#define LAYER_7                 (1 << LAYER_N_7)        ///< bit mask for layer 7
#define LAYER_8                 (1 << LAYER_N_8)        ///< bit mask for layer 8
#define LAYER_9                 (1 << LAYER_N_9)        ///< bit mask for layer 9
#define LAYER_10                (1 << LAYER_N_10)       ///< bit mask for layer 10
#define LAYER_11                (1 << LAYER_N_11)       ///< bit mask for layer 11
#define LAYER_12                (1 << LAYER_N_12)       ///< bit mask for layer 12
#define LAYER_13                (1 << LAYER_N_13)       ///< bit mask for layer 13
#define LAYER_14                (1 << LAYER_N_14)       ///< bit mask for layer 14
#define LAYER_15                (1 << LAYER_N_15)       ///< bit mask for layer 15
#define LAYER_FRONT             (1 << LAYER_N_FRONT)    ///< bit mask for component layer
#define ADHESIVE_LAYER_BACK     (1 << ADHESIVE_N_BACK)
#define ADHESIVE_LAYER_FRONT    (1 << ADHESIVE_N_FRONT)
#define SOLDERPASTE_LAYER_BACK  (1 << SOLDERPASTE_N_BACK)
#define SOLDERPASTE_LAYER_FRONT (1 << SOLDERPASTE_N_FRONT)
#define SILKSCREEN_LAYER_BACK   (1 << SILKSCREEN_N_BACK)
#define SILKSCREEN_LAYER_FRONT  (1 << SILKSCREEN_N_FRONT)
#define SOLDERMASK_LAYER_BACK   (1 << SOLDERMASK_N_BACK)
#define SOLDERMASK_LAYER_FRONT  (1 << SOLDERMASK_N_FRONT)
#define DRAW_LAYER              (1 << DRAW_N)
#define COMMENT_LAYER           (1 << COMMENT_N)
#define ECO1_LAYER              (1 << ECO1_N)
#define ECO2_LAYER              (1 << ECO2_N)
#define EDGE_LAYER              (1 << EDGE_N)

//      extra bits              0xE0000000

// Helpful global layer masks:
// ALL_AUX_LAYERS layers are technical layers, ALL_NO_CU_LAYERS has user
// and edge layers too!
#define ALL_LAYERS              0x1FFFFFFF              // Pcbnew used 29 layers
#define FULL_LAYERS             0xFFFFFFFF              // Gerbview used 32 layers
#define ALL_NO_CU_LAYERS        0x1FFF0000
#define ALL_CU_LAYERS           0x0000FFFF
#define INTERNAL_CU_LAYERS      0x00007FFE
#define EXTERNAL_CU_LAYERS      0x00008001
#define FRONT_TECH_LAYERS       (SILKSCREEN_LAYER_FRONT | SOLDERMASK_LAYER_FRONT \
                                    | ADHESIVE_LAYER_FRONT | SOLDERPASTE_LAYER_FRONT)
#define BACK_TECH_LAYERS        (SILKSCREEN_LAYER_BACK | SOLDERMASK_LAYER_BACK \
                                    | ADHESIVE_LAYER_BACK | SOLDERPASTE_LAYER_BACK)
#define ALL_TECH_LAYERS         (FRONT_TECH_LAYERS | BACK_TECH_LAYERS)
#define BACK_LAYERS             (LAYER_BACK | BACK_TECH_LAYERS)
#define FRONT_LAYERS            (LAYER_FRONT | FRONT_TECH_LAYERS)

#define ALL_USER_LAYERS         (DRAW_LAYER | COMMENT_LAYER | ECO1_LAYER | ECO2_LAYER )

#define NO_LAYERS               0x00000000
204 205


206 207
// Old internal units definition (UI = decimil)
#define PCB_LEGACY_INTERNAL_UNIT 10000
208 209 210 211 212

/// Get the length of a string constant, at compile time
#define SZ( x )         (sizeof(x)-1)


Dick Hollenbeck's avatar
Dick Hollenbeck committed
213 214 215 216 217
static const char delims[] = " \t\r\n";


static bool inline isSpace( int c ) { return strchr( delims, c ) != 0; }

Dick Hollenbeck's avatar
Dick Hollenbeck committed
218
#define MASK(x)             (1<<(x))
Dick Hollenbeck's avatar
Dick Hollenbeck committed
219

220 221
//-----<BOARD Load Functions>---------------------------------------------------

222
/// C string compare test for a specific length of characters.
Dick Hollenbeck's avatar
Dick Hollenbeck committed
223
#define TESTLINE( x )   ( !strnicmp( line, x, SZ( x ) ) && isSpace( line[SZ( x )] ) )
224 225 226 227 228 229

/// C sub-string compare test for a specific length of characters.
#define TESTSUBSTR( x ) ( !strnicmp( line, x, SZ( x ) ) )


#if 1
230
#define READLINE( rdr )     rdr->ReadLine()
231 232 233 234 235

#else
/// The function and macro which follow comprise a shim which can be a
/// monitor on lines of text read in from the input file.
/// And it can be used as a trap.
236
static inline char* ReadLine( LINE_READER* rdr, const char* caller )
237
{
238
    char* ret = rdr->ReadLine();
239 240 241 242 243 244 245 246 247 248 249 250 251

    const char* line = rdr->Line();
    printf( "%-6u %s: %s", rdr->LineNumber(), caller, line );

#if 0   // trap
    if( !strcmp( "loadSETUP", caller ) && !strcmp( "$EndSETUP\n", line ) )
    {
        int breakhere = 1;
    }
#endif

    return ret;
}
252
#define READLINE( rdr )     ReadLine( rdr, __FUNCTION__ )
253 254 255
#endif


Dick Hollenbeck's avatar
Dick Hollenbeck committed
256 257
/* corrected old junk, element 14 was wrong.  can delete.
// Look up Table for conversion copper layer count -> general copper layer mask:
258
static const LEG_MASK all_cu_mask[] = {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
259 260 261 262 263 264 265 266
    0x0001, 0x8001, 0x8003, 0x8007,
    0x800F, 0x801F, 0x803F, 0x807F,
    0x80FF, 0x81FF, 0x83FF, 0x87FF,
    0x8FFF, 0x9FFF, 0xBFFF, 0xFFFF
};
*/


267
using namespace std;    // auto_ptr
268

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

static inline const char* ShowVertJustify( EDA_TEXT_VJUSTIFY_T vertical )
{
    const char* rs;
    switch( vertical )
    {
    case GR_TEXT_VJUSTIFY_TOP:      rs = "T";   break;
    case GR_TEXT_VJUSTIFY_CENTER:   rs = "C";   break;
    case GR_TEXT_VJUSTIFY_BOTTOM:   rs = "B";   break;
    default:                        rs = "?";   break;
    }
    return rs;
}

static inline const char* ShowHorizJustify( EDA_TEXT_HJUSTIFY_T horizontal )
{
    const char* rs;
    switch( horizontal )
    {
    case GR_TEXT_HJUSTIFY_LEFT:     rs = "L";   break;
    case GR_TEXT_HJUSTIFY_CENTER:   rs = "C";   break;
    case GR_TEXT_HJUSTIFY_RIGHT:    rs = "R";   break;
    default:                        rs = "?";   break;
    }
    return rs;
}

296
static EDA_TEXT_HJUSTIFY_T horizJustify( const char* horizontal )
297 298 299 300 301 302 303 304
{
    if( !strcmp( "L", horizontal ) )
        return GR_TEXT_HJUSTIFY_LEFT;
    if( !strcmp( "R", horizontal ) )
        return GR_TEXT_HJUSTIFY_RIGHT;
    return GR_TEXT_HJUSTIFY_CENTER;
}

305
static EDA_TEXT_VJUSTIFY_T vertJustify( const char* vertical )
306 307 308 309 310 311 312 313 314
{
    if( !strcmp( "T", vertical ) )
        return GR_TEXT_VJUSTIFY_TOP;
    if( !strcmp( "B", vertical ) )
        return GR_TEXT_VJUSTIFY_BOTTOM;
    return GR_TEXT_VJUSTIFY_CENTER;
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
315
/// Count the number of set layers in the mask
316
inline int layerMaskCountSet( LEG_MASK aMask )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
317 318 319
{
    int count = 0;

Dick Hollenbeck's avatar
Dick Hollenbeck committed
320
    for( int i = 0;  aMask;  ++i, aMask >>= 1 )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    {
        if( aMask & 1 )
            ++count;
    }

    return count;
}


LAYER_ID LEGACY_PLUGIN::leg_layer2new( int cu_count, LAYER_NUM aLayerNum )
{
    int         newid;
    unsigned    old = aLayerNum;

    // this is a speed critical function, be careful.

Dick Hollenbeck's avatar
Dick Hollenbeck committed
337
    if( unsigned( old ) <= unsigned( LAYER_N_FRONT ) )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
338 339 340
    {
        if( old == LAYER_N_FRONT )
            newid = F_Cu;
341 342
        else if( old == LAYER_N_BACK )
            newid = B_Cu;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
        else
        {
            newid = cu_count - 1 - old;

            wxASSERT( newid >= 0 );
        }
    }
    else
    {
        switch( old )
        {
        case ADHESIVE_N_BACK:       newid = B_Adhes;    break;
        case ADHESIVE_N_FRONT:      newid = F_Adhes;    break;
        case SOLDERPASTE_N_BACK:    newid = B_Paste;    break;
        case SOLDERPASTE_N_FRONT:   newid = F_Paste;    break;
        case SILKSCREEN_N_BACK:     newid = B_SilkS;    break;
        case SILKSCREEN_N_FRONT:    newid = F_SilkS;    break;
        case SOLDERMASK_N_BACK:     newid = B_Mask;     break;
        case SOLDERMASK_N_FRONT:    newid = F_Mask;     break;
        case DRAW_N:                newid = Dwgs_User;  break;
        case COMMENT_N:             newid = Cmts_User;  break;
        case ECO1_N:                newid = Eco1_User;  break;
        case ECO2_N:                newid = Eco2_User;  break;
        case EDGE_N:                newid = Edge_Cuts;  break;
        default:
            wxASSERT( 0 );
            newid = 0;
        }
    }

    return LAYER_ID( newid );
}


LSET LEGACY_PLUGIN::leg_mask2new( int cu_count, unsigned aMask )
{
    LSET    ret;

381 382 383 384 385 386 387
    if( ( aMask & ALL_CU_LAYERS ) == ALL_CU_LAYERS )
    {
        ret = LSET::AllCuMask();

        aMask &= ~ALL_CU_LAYERS;
    }

Dick Hollenbeck's avatar
Dick Hollenbeck committed
388
    for( int i=0;  aMask;  ++i, aMask >>= 1 )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
389 390 391 392 393 394 395 396 397
    {
        if( aMask & 1 )
            ret.set( leg_layer2new( cu_count, i ) );
    }

    return ret;
}


398 399 400 401 402 403 404 405 406 407 408 409 410
/**
 * Function intParse
 * parses an ASCII integer string with possible leading whitespace into
 * an integer and updates the pointer at \a out if it is not NULL, just
 * like "man strtol()".  I can use this without casting, and its name says
 * what I am doing.
 */
static inline int intParse( const char* next, const char** out = NULL )
{
    // please just compile this and be quiet, hide casting ugliness:
    return (int) strtol( next, (char**) out, 10 );
}

411 412 413 414 415 416 417 418
/**
 * Function layerParse
 * Like intParse but returns a LAYER_NUM
 */
static inline LAYER_NUM layerParse( const char* next, const char** out = NULL )
{
    return intParse( next, out );
}
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

/**
 * Function hexParse
 * parses an ASCII hex integer string with possible leading whitespace into
 * a long integer and updates the pointer at \a out if it is not NULL, just
 * like "man strtol".  I can use this without casting, and its name says
 * what I am doing.
 */
static inline long hexParse( const char* next, const char** out = NULL )
{
    // please just compile this and be quiet, hide casting ugliness:
    return strtol( next, (char**) out, 16 );
}


434
BOARD* LEGACY_PLUGIN::Load( const wxString& aFileName, BOARD* aAppendToMe, const PROPERTIES* aProperties )
435 436 437
{
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.

438 439
    init( aProperties );

440 441
    m_board = aAppendToMe ? aAppendToMe : new BOARD();

442 443 444 445
    // Give the filename to the board if it's new
    if( !aAppendToMe )
        m_board->SetFileName( aFileName );

446
    // delete on exception, iff I own m_board, according to aAppendToMe
447
    auto_ptr<BOARD> deleter( aAppendToMe ? NULL : m_board );
448

449
    FILE_LINE_READER    reader( aFileName );
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

    m_reader = &reader;          // member function accessibility

    checkVersion();

    loadAllSections( bool( aAppendToMe ) );

    deleter.release();
    return m_board;
}


void LEGACY_PLUGIN::loadAllSections( bool doAppend )
{
    // $GENERAL section is first

    // $SHEETDESCR section is next

    // $SETUP section is next

    // Then follows $EQUIPOT and all the rest
471
    char* line;
472

473
    while( ( line = READLINE( m_reader ) ) != NULL )
474 475 476 477 478
    {
        // put the more frequent ones at the top, but realize TRACKs are loaded as a group

        if( TESTLINE( "$MODULE" ) )
        {
479
            auto_ptr<MODULE>    module( new MODULE( m_board ) );
480

481
            FPID        fpid;
482
            std::string fpName = StrPurge( line + SZ( "$MODULE" ) );
483

484 485 486 487
            // The footprint names in legacy libraries can contain the '/' and ':'
            // characters which will cause the FPID parser to choke.
            ReplaceIllegalFileNameChars( &fpName );

488 489 490 491
            if( !fpName.empty() )
                fpid = FPID( fpName );

            module->SetFPID( fpid );
492

Dick Hollenbeck's avatar
Dick Hollenbeck committed
493
            loadMODULE( module.get() );
494
            m_board->Add( module.release(), ADD_APPEND );
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
        }

        else if( TESTLINE( "$DRAWSEGMENT" ) )
        {
            loadPCB_LINE();
        }

        else if( TESTLINE( "$EQUIPOT" ) )
        {
            loadNETINFO_ITEM();
        }

        else if( TESTLINE( "$TEXTPCB" ) )
        {
            loadPCB_TEXT();
        }

        else if( TESTLINE( "$TRACK" ) )
        {
514
            loadTrackList( PCB_TRACE_T );
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
        }

        else if( TESTLINE( "$NCLASS" ) )
        {
            loadNETCLASS();
        }

        else if( TESTLINE( "$CZONE_OUTLINE" ) )
        {
            loadZONE_CONTAINER();
        }

        else if( TESTLINE( "$COTATION" ) )
        {
            loadDIMENSION();
        }

        else if( TESTLINE( "$PCB_TARGET" ) || TESTLINE( "$MIREPCB" ) )
        {
            loadPCB_TARGET();
        }

        else if( TESTLINE( "$ZONE" ) )
        {
539
            loadTrackList( PCB_ZONE_T );
540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
        }

        else if( TESTLINE( "$GENERAL" ) )
        {
            loadGENERAL();
        }

        else if( TESTLINE( "$SHEETDESCR" ) )
        {
            loadSHEET();
        }

        else if( TESTLINE( "$SETUP" ) )
        {
            if( !doAppend )
            {
                loadSETUP();
            }
            else
            {
560
                while( ( line = READLINE( m_reader ) ) != NULL )
561
                {
562
                    // gobble until $EndSetup
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
                    if( TESTLINE( "$EndSETUP" ) )
                        break;
                }
            }
        }

        else if( TESTLINE( "$EndBOARD" ) )
            return;     // preferred exit
    }

    THROW_IO_ERROR( "Missing '$EndBOARD'" );
}


void LEGACY_PLUGIN::checkVersion()
{
    // Read first line and TEST if it is a PCB file format header like this:
    // "PCBNEW-BOARD Version 1 ...."

    m_reader->ReadLine();

    char* line = m_reader->Line();

    if( !TESTLINE( "PCBNEW-BOARD" ) )
    {
        THROW_IO_ERROR( "Unknown file type" );
    }

    int ver = 1;    // if sccanf fails
    sscanf( line, "PCBNEW-BOARD Version %d", &ver );

594
#if !defined(DEBUG)
595 596
    if( ver > LEGACY_BOARD_FILE_VERSION )
    {
597
        // "File '%s' is format version: %d.\nI only support format version <= %d.\nPlease upgrade Pcbnew to load this file."
598 599
        m_error.Printf( VERSION_ERROR_FORMAT,
            m_reader->GetSource().GetData(), ver, LEGACY_BOARD_FILE_VERSION );
600 601
        THROW_IO_ERROR( m_error );
    }
602
#endif
603 604

    m_loading_format_version = ver;
605
    m_board->SetFileFormatVersionAtLoad( m_loading_format_version );
606 607 608 609 610
}


void LEGACY_PLUGIN::loadGENERAL()
{
611
    char*   line;
612
    char*   saveptr;
613
    bool    saw_LayerCount = false;
614 615

    while( ( line = READLINE( m_reader ) ) != NULL )
616 617 618 619 620 621
    {
        const char* data;

        if( TESTLINE( "Units" ) )
        {
            // what are the engineering units of the lengths in the BOARD?
622
            data = strtok_r( line + SZ("Units"), delims, &saveptr );
623 624 625

            if( !strcmp( data, "mm" ) )
            {
626
                diskToBiu = IU_PER_MM;
627 628 629
            }
        }

630 631 632 633 634 635 636 637 638 639 640 641
        else if( TESTLINE( "LayerCount" ) )
        {
            int tmp = intParse( line + SZ( "LayerCount" ) );
            m_board->SetCopperLayerCount( tmp );

            // This has to be set early so that leg_layer2new() works OK, and
            // that means before parsing "EnabledLayers" and "VisibleLayers".
            m_cu_count = tmp;

            saw_LayerCount = true;
        }

642 643
        else if( TESTLINE( "EnabledLayers" ) )
        {
644 645 646 647
            if( !saw_LayerCount )
                THROW_IO_ERROR( "Missing '$GENERAL's LayerCount" );

            LEG_MASK enabledLayers = hexParse( line + SZ( "EnabledLayers" ) );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
648 649

            LSET new_mask = leg_mask2new( m_cu_count, enabledLayers );
650

651 652
            //DBG( printf( "EnabledLayers: %s\n", new_mask.FmtHex().c_str() );)

Dick Hollenbeck's avatar
Dick Hollenbeck committed
653
            m_board->SetEnabledLayers( new_mask );
654 655

            // layer visibility equals layer usage, unless overridden later via "VisibleLayers"
656
            // Must call SetEnabledLayers() before calling SetVisibleLayers().
Dick Hollenbeck's avatar
Dick Hollenbeck committed
657
            m_board->SetVisibleLayers( new_mask );
658 659 660 661
        }

        else if( TESTLINE( "VisibleLayers" ) )
        {
662 663 664 665
            if( !saw_LayerCount )
                THROW_IO_ERROR( "Missing '$GENERAL's LayerCount" );

            LEG_MASK visibleLayers = hexParse( line + SZ( "VisibleLayers" ) );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
666 667 668 669

            LSET new_mask = leg_mask2new( m_cu_count, visibleLayers );

            m_board->SetVisibleLayers( new_mask );
670 671 672 673
        }

        else if( TESTLINE( "Ly" ) )    // Old format for Layer count
        {
674 675 676 677 678
            if( !saw_LayerCount )
            {
                LEG_MASK layer_mask  = hexParse( line + SZ( "Ly" ) );

                m_cu_count = layerMaskCountSet( layer_mask & ALL_CU_LAYERS );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
679

680
                m_board->SetCopperLayerCount( m_cu_count );
681

682 683
                saw_LayerCount = true;
            }
684 685 686 687 688
        }

        else if( TESTLINE( "BoardThickness" ) )
        {
            BIU thickn = biuParse( line + SZ( "BoardThickness" ) );
689
            m_board->GetDesignSettings().SetBoardThickness( thickn );
690 691 692 693 694 695 696 697 698 699 700 701
        }

        /*
        else if( TESTLINE( "Links" ) )
        {
            // Info only, do nothing, but only for a short while.
        }
        */

        else if( TESTLINE( "NoConn" ) )
        {
            int tmp = intParse( line + SZ( "NoConn" ) );
702
            m_board->SetUnconnectedNetCount( tmp );
703 704 705 706 707 708 709 710 711 712 713 714 715 716
        }

        else if( TESTLINE( "Di" ) )
        {
            BIU x1 = biuParse( line + SZ( "Di" ), &data );
            BIU y1 = biuParse( data, &data );
            BIU x2 = biuParse( data, &data );
            BIU y2 = biuParse( data );

            EDA_RECT bbbox( wxPoint( x1, y1 ), wxSize( x2-x1, y2-y1 ) );

            m_board->SetBoundingBox( bbbox );
        }

717 718
        /* This is no more usefull, so this info is no more parsed
        // Read the number of segments of type DRAW, TRACK, ZONE
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
        else if( TESTLINE( "Ndraw" ) )
        {
            NbDraw = intParse( line + SZ( "Ndraw" ) );
        }

        else if( TESTLINE( "Ntrack" ) )
        {
            NbTrack = intParse( line + SZ( "Ntrack" ) );
        }

        else if( TESTLINE( "Nzone" ) )
        {
            NbZone = intParse( line + SZ( "Nzone" ) );
        }

        else if( TESTLINE( "Nmodule" ) )
        {
            NbMod = intParse( line + SZ( "Nmodule" ) );
737
        }*/
738 739 740

        else if( TESTLINE( "Nnets" ) )
        {
741
            m_netCodes.resize( intParse( line + SZ( "Nnets" ) ) );
742 743
        }

744 745 746 747 748
        else if( TESTLINE( "Nn" ) )     // id "Nnets" for old .brd files
        {
            m_netCodes.resize( intParse( line + SZ( "Nn" ) ) );
        }

749 750 751 752 753 754 755 756 757 758 759 760
        else if( TESTLINE( "$EndGENERAL" ) )
            return;     // preferred exit
    }

    THROW_IO_ERROR( "Missing '$EndGENERAL'" );
}


void LEGACY_PLUGIN::loadSHEET()
{
    char        buf[260];
    TITLE_BLOCK tb;
761
    char*       line;
762
    char*       saveptr;
763

764
    while( ( line = READLINE( m_reader ) ) != NULL )
765 766 767 768 769 770 771
    {
        if( TESTLINE( "Sheet" ) )
        {
            // e.g. "Sheet A3 16535 11700"
            // width and height are in 1/1000th of an inch, always

            PAGE_INFO   page;
772
            char*       sname  = strtok_r( line + SZ( "Sheet" ), delims, &saveptr );
773 774 775 776 777 778 779 780 781 782 783

            if( sname )
            {
                wxString wname = FROM_UTF8( sname );
                if( !page.SetType( wname ) )
                {
                    m_error.Printf( _( "Unknown sheet type '%s' on line:%d" ),
                                wname.GetData(), m_reader->LineNumber() );
                    THROW_IO_ERROR( m_error );
                }

784 785 786
                char*   width  = strtok_r( NULL, delims, &saveptr );
                char*   height = strtok_r( NULL, delims, &saveptr );
                char*   orient = strtok_r( NULL, delims, &saveptr );
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872

                // only parse the width and height if page size is custom ("User")
                if( wname == PAGE_INFO::Custom )
                {
                    if( width && height )
                    {
                        // legacy disk file describes paper in mils
                        // (1/1000th of an inch)
                        int w = intParse( width );
                        int h = intParse( height );

                        page.SetWidthMils(  w );
                        page.SetHeightMils( h );
                    }
                }

                if( orient && !strcmp( orient, "portrait" ) )
                {
                    page.SetPortrait( true );
                }

                m_board->SetPageSettings( page );
            }
        }

        else if( TESTLINE( "Title" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetTitle( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Date" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetDate( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Rev" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetRevision( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Comp" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetCompany( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Comment1" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetComment1( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Comment2" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetComment2( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Comment3" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetComment3( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Comment4" ) )
        {
            ReadDelimitedText( buf, line, sizeof(buf) );
            tb.SetComment4( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "$EndSHEETDESCR" ) )
        {
            m_board->SetTitleBlock( tb );
            return;             // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$EndSHEETDESCR'" );
}


void LEGACY_PLUGIN::loadSETUP()
{
873
    NETCLASSPTR             netclass_default = m_board->GetDesignSettings().GetDefault();
874 875
    // TODO Orson: is it really necessary to first operate on a copy and then apply it?
    // would not it be better to use reference here and apply all the changes instantly?
876 877
    BOARD_DESIGN_SETTINGS   bds = m_board->GetDesignSettings();
    ZONE_SETTINGS           zs  = m_board->GetZoneSettings();
878
    char*                   line;
879
    char*                   saveptr;
880

881
    while( ( line = READLINE( m_reader ) ) != NULL )
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
    {
        const char* data;

        if( TESTLINE( "PcbPlotParams" ) )
        {
            PCB_PLOT_PARAMS plot_opts;

            PCB_PLOT_PARAMS_PARSER parser( line + SZ( "PcbPlotParams" ), m_reader->GetSource() );

            plot_opts.Parse( &parser );

            m_board->SetPlotOptions( plot_opts );
        }

        else if( TESTLINE( "AuxiliaryAxisOrg" ) )
        {
            BIU gx = biuParse( line + SZ( "AuxiliaryAxisOrg" ), &data );
            BIU gy = biuParse( data );

901 902
            // m_board->SetAuxOrigin( wxPoint( gx, gy ) ); gets overwritten by SetDesignSettings() below
            bds.m_AuxOrigin = wxPoint( gx, gy );
903 904
        }

905
        /* Done from $General above's "LayerCount"
906 907 908 909
        else if( TESTLINE( "Layers" ) )
        {
            int tmp = intParse( line + SZ( "Layers" ) );
            m_board->SetCopperLayerCount( tmp );
910 911

            m_cu_count = tmp;
912
        }
913
        */
914 915 916 917 918

        else if( TESTSUBSTR( "Layer[" ) )
        {
            // eg: "Layer[n]  <a_Layer_name_with_no_spaces> <LAYER_T>"

Dick Hollenbeck's avatar
Dick Hollenbeck committed
919
            LAYER_NUM   layer_num = layerParse( line + SZ( "Layer[" ), &data );
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
            LAYER_ID    layer_id  = leg_layer2new( m_cu_count, layer_num );

            /*
            switch( layer_num )
            {
            case LAYER_N_BACK:
                layer_id = B_Cu;
                break;

            case LAYER_N_FRONT:
                layer_id = F_Cu;
                break;

            default:
                layer_id = LAYER_ID( layer_num );
            }
            */
937

938
            data = strtok_r( (char*) data+1, delims, &saveptr );    // +1 for ']'
939 940 941
            if( data )
            {
                wxString layerName = FROM_UTF8( data );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
942
                m_board->SetLayerName( layer_id, layerName );
943

944
                data = strtok_r( NULL, delims, &saveptr );
945 946 947
                if( data )  // optional in old board files
                {
                    LAYER_T type = LAYER::ParseType( data );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
948
                    m_board->SetLayerType( layer_id, type );
949 950 951 952 953 954 955
                }
            }
        }

        else if( TESTLINE( "TrackWidthList" ) )
        {
            BIU tmp = biuParse( line + SZ( "TrackWidthList" ) );
956
            bds.m_TrackWidthList.push_back( tmp );
957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
        }

        else if( TESTLINE( "TrackClearence" ) )
        {
            BIU tmp = biuParse( line + SZ( "TrackClearence" ) );
            netclass_default->SetClearance( tmp );
        }

        else if( TESTLINE( "TrackMinWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "TrackMinWidth" ) );
            bds.m_TrackMinWidth = tmp;
        }

        else if( TESTLINE( "ZoneClearence" ) )
        {
            BIU tmp = biuParse( line + SZ( "ZoneClearence" ) );
            zs.m_ZoneClearance = tmp;
        }

        else if( TESTLINE( "Zone_45_Only" ) )
        {
            bool tmp = (bool) intParse( line + SZ( "Zone_45_Only" ) );
            zs.m_Zone_45_Only = tmp;
        }

        else if( TESTLINE( "DrawSegmWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "DrawSegmWidth" ) );
            bds.m_DrawSegmentWidth = tmp;
        }

        else if( TESTLINE( "EdgeSegmWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "EdgeSegmWidth" ) );
            bds.m_EdgeSegmentWidth = tmp;
        }

        else if( TESTLINE( "ViaMinSize" ) )
        {
            BIU tmp = biuParse( line + SZ( "ViaMinSize" ) );
            bds.m_ViasMinSize = tmp;
        }

        else if( TESTLINE( "MicroViaMinSize" ) )
        {
            BIU tmp = biuParse( line + SZ( "MicroViaMinSize" ) );
            bds.m_MicroViasMinSize = tmp;
        }

        else if( TESTLINE( "ViaSizeList" ) )
        {
            // e.g.  "ViaSizeList DIAMETER [DRILL]"

            BIU drill    = 0;
            BIU diameter = biuParse( line + SZ( "ViaSizeList" ), &data );

1014
            data = strtok_r( (char*) data, delims, &saveptr );
1015 1016 1017
            if( data )  // DRILL may not be present ?
                drill = biuParse( data );

1018 1019
            bds.m_ViasDimensionsList.push_back( VIA_DIMENSION( diameter,
                                                                                        drill ) );
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
        }

        else if( TESTLINE( "ViaDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "ViaDrill" ) );
            netclass_default->SetViaDrill( tmp );
        }

        else if( TESTLINE( "ViaMinDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "ViaMinDrill" ) );
            bds.m_ViasMinDrill = tmp;
        }

        else if( TESTLINE( "MicroViaDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "MicroViaDrill" ) );
            netclass_default->SetuViaDrill( tmp );
        }

        else if( TESTLINE( "MicroViaMinDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "MicroViaMinDrill" ) );
            bds.m_MicroViasMinDrill = tmp;
        }

        else if( TESTLINE( "MicroViasAllowed" ) )
        {
            int tmp = intParse( line + SZ( "MicroViasAllowed" ) );
            bds.m_MicroViasAllowed = tmp;
        }

        else if( TESTLINE( "TextPcbWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "TextPcbWidth" ) );
            bds.m_PcbTextWidth = tmp;
        }

        else if( TESTLINE( "TextPcbSize" ) )
        {
            BIU x = biuParse( line + SZ( "TextPcbSize" ), &data );
            BIU y = biuParse( data );

            bds.m_PcbTextSize = wxSize( x, y );
        }

        else if( TESTLINE( "EdgeModWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "EdgeModWidth" ) );
            bds.m_ModuleSegmentWidth = tmp;
        }

        else if( TESTLINE( "TextModWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "TextModWidth" ) );
            bds.m_ModuleTextWidth = tmp;
        }

        else if( TESTLINE( "TextModSize" ) )
        {
            BIU x = biuParse( line + SZ( "TextModSize" ), &data );
            BIU y = biuParse( data );

            bds.m_ModuleTextSize = wxSize( x, y );
        }

        else if( TESTLINE( "PadSize" ) )
        {
            BIU x = biuParse( line + SZ( "PadSize" ), &data );
            BIU y = biuParse( data );

            bds.m_Pad_Master.SetSize( wxSize( x, y ) );
        }

        else if( TESTLINE( "PadDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "PadDrill" ) );
            bds.m_Pad_Master.SetDrillSize( wxSize( tmp, tmp ) );
        }

        else if( TESTLINE( "Pad2MaskClearance" ) )
        {
            BIU tmp = biuParse( line + SZ( "Pad2MaskClearance" ) );
            bds.m_SolderMaskMargin = tmp;
        }

1106 1107 1108 1109 1110 1111
        else if( TESTLINE( "SolderMaskMinWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "SolderMaskMinWidth" ) );
            bds.m_SolderMaskMinWidth = tmp;
        }

1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
        else if( TESTLINE( "Pad2PasteClearance" ) )
        {
            BIU tmp = biuParse( line + SZ( "Pad2PasteClearance" ) );
            bds.m_SolderPasteMargin = tmp;
        }

        else if( TESTLINE( "Pad2PasteClearanceRatio" ) )
        {
            double ratio = atof( line + SZ( "Pad2PasteClearanceRatio" ) );
            bds.m_SolderPasteMarginRatio = ratio;
        }

        else if( TESTLINE( "GridOrigin" ) )
        {
1126 1127
            BIU x = biuParse( line + SZ( "GridOrigin" ), &data );
            BIU y = biuParse( data );
1128

1129 1130
            // m_board->SetGridOrigin( wxPoint( x, y ) ); gets overwritten by SetDesignSettings() below
            bds.m_GridOrigin = wxPoint( x, y );
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
        }

        else if( TESTLINE( "VisibleElements" ) )
        {
            int visibleElements = hexParse( line + SZ( "VisibleElements" ) );
            bds.SetVisibleElements( visibleElements );
        }

        else if( TESTLINE( "$EndSETUP" ) )
        {
            m_board->SetDesignSettings( bds );
            m_board->SetZoneSettings( zs );

            // Until such time as the *.brd file does not have the
            // global parameters:
            // "TrackWidth", "TrackMinWidth", "ViaSize", "ViaDrill",
            // "ViaMinSize", and "TrackClearence", put those same global
            // values into the default NETCLASS until later board load
            // code should override them.  *.brd files which have been
            // saved with knowledge of NETCLASSes will override these
            // defaults, old boards will not.
            //
            // @todo: I expect that at some point we can remove said global
            //        parameters from the *.brd file since the ones in the
            //        default netclass serve the same purpose.  If needed
            //        at all, the global defaults should go into a preferences
            //        file instead so they are there to start new board
            //        projects.
1159
            m_board->GetDesignSettings().GetDefault()->SetParams( m_board->GetDesignSettings() );
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171

            return;     // preferred exit
        }
    }

    // @todo: this code is currently unreachable, would need a goto, to get here.
    // that may be better handled with an #ifdef

    /* Ensure tracks and vias sizes lists are ok:
     * Sort lists by by increasing value and remove duplicates
     * (the first value is not tested, because it is the netclass value
     */
1172 1173 1174
    BOARD_DESIGN_SETTINGS& designSettings = m_board->GetDesignSettings();
    sort( designSettings.m_ViasDimensionsList.begin() + 1, designSettings.m_ViasDimensionsList.end() );
    sort( designSettings.m_TrackWidthList.begin() + 1, designSettings.m_TrackWidthList.end() );
1175

1176
    for( unsigned ii = 1; ii < designSettings.m_ViasDimensionsList.size() - 1; ii++ )
1177
    {
1178
        if( designSettings.m_ViasDimensionsList[ii] == designSettings.m_ViasDimensionsList[ii + 1] )
1179
        {
1180
            designSettings.m_ViasDimensionsList.erase( designSettings.m_ViasDimensionsList.begin() + ii );
1181 1182 1183 1184
            ii--;
        }
    }

1185
    for( unsigned ii = 1; ii < designSettings.m_TrackWidthList.size() - 1; ii++ )
1186
    {
1187
        if( designSettings.m_TrackWidthList[ii] == designSettings.m_TrackWidthList[ii + 1] )
1188
        {
1189
            designSettings.m_TrackWidthList.erase( designSettings.m_TrackWidthList.begin() + ii );
1190 1191 1192 1193 1194 1195
            ii--;
        }
    }
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
1196
void LEGACY_PLUGIN::loadMODULE( MODULE* aModule )
1197
{
1198 1199
    char*   line;
    char*   saveptr;
1200

1201
    while( ( line = READLINE( m_reader ) ) != NULL )
1202
    {
1203 1204
        const char* data;

1205 1206
        // most frequently encountered ones at the top

1207
        if( TESTSUBSTR( "D" ) && strchr( "SCAP", line[1] ) )  // read a drawing item, e.g. "DS"
1208
        {
1209
            loadMODULE_EDGE( aModule );
1210 1211 1212 1213
        }

        else if( TESTLINE( "$PAD" ) )
        {
1214
            loadPAD( aModule );
1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
        }

        // Read a footprint text description (ref, value, or drawing)
        else if( TESTSUBSTR( "T" ) )
        {
            // e.g. "T1 6940 -16220 350 300 900 60 M I 20 N "CFCARD"\r\n"

            int tnum = intParse( line + SZ( "T" ) );

            TEXTE_MODULE* textm;

1226 1227 1228
            switch( tnum )
            {
            case TEXTE_MODULE::TEXT_is_REFERENCE:
1229
                textm = &aModule->Reference();
1230 1231 1232
                break;

            case TEXTE_MODULE::TEXT_is_VALUE:
1233
                textm = &aModule->Value();
1234 1235 1236
                break;

            default:
1237
                // text is a drawing
1238 1239
                textm = new TEXTE_MODULE( aModule );
                aModule->GraphicalItems().PushBack( textm );
1240
            }
1241

1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253
            loadMODULE_TEXT( textm );
        }

        else if( TESTLINE( "Po" ) )
        {
            // e.g. "Po 19120 39260 900 0 4E823D06 46EAAFA5 ~~\r\n"

            // sscanf( PtLine, "%d %d %d %d %lX %lX %s", &m_Pos.x, &m_Pos.y, &m_Orient, &m_Layer, &m_LastEdit_Time, &m_TimeStamp, BufCar1 );

            BIU pos_x  = biuParse( line + SZ( "Po" ), &data );
            BIU pos_y  = biuParse( data, &data );
            int orient = intParse( data, &data );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1254 1255 1256

            LAYER_NUM layer_num = layerParse( data, &data );
            LAYER_ID  layer_id  = leg_layer2new( m_cu_count,  layer_num );
1257 1258

            long edittime  = hexParse( data, &data );
1259
            time_t timestamp = hexParse( data, &data );
1260

1261
            data = strtok_r( (char*) data+1, delims, &saveptr );
1262 1263

            // data is now a two character long string
1264 1265
            // Note: some old files do not have this field
            if( data && data[0] == 'F' )
1266
                aModule->SetLocked( true );
1267

1268
            if( data && data[1] == 'P' )
1269
                aModule->SetIsPlaced( true );
1270

1271
            aModule->SetPosition( wxPoint( pos_x, pos_y ) );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1272
            aModule->SetLayer( layer_id );
1273 1274 1275
            aModule->SetOrientation( orient );
            aModule->SetTimeStamp( timestamp );
            aModule->SetLastEditTime( edittime );
1276 1277
        }

1278
        /* footprint name set earlier, immediately after MODULE construction
1279 1280
        else if( TESTLINE( "Li" ) )         // Library name of footprint
        {
1281 1282
            // There can be whitespace in the footprint name on some old libraries.
            // Grab everything after "Li" up to end of line:
1283
            //aModule->SetFPID( FROM_UTF8( StrPurge( line + SZ( "Li" ) ) ) );
1284
        }
1285
        */
1286 1287 1288

        else if( TESTLINE( "Sc" ) )         // timestamp
        {
1289
            time_t timestamp = hexParse( line + SZ( "Sc" ) );
1290
            aModule->SetTimeStamp( timestamp );
1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
        }

        else if( TESTLINE( "Op" ) )         // (Op)tions for auto placement
        {
            int itmp1 = hexParse( line + SZ( "Op" ), &data );
            int itmp2 = hexParse( data );

            int cntRot180 = itmp2 & 0x0F;
            if( cntRot180 > 10 )
                cntRot180 = 10;

1302
            aModule->SetPlacementCost180( cntRot180 );
1303 1304 1305 1306 1307 1308 1309 1310 1311

            int cntRot90  = itmp1 & 0x0F;
            if( cntRot90 > 10 )
                cntRot90 = 0;

            itmp1 = (itmp1 >> 4) & 0x0F;
            if( itmp1 > 10 )
                itmp1 = 0;

1312
            aModule->SetPlacementCost90( (itmp1 << 4) | cntRot90 );
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
        }

        else if( TESTLINE( "At" ) )         // (At)tributes of module
        {
            int attrs = MOD_DEFAULT;

            data = line + SZ( "At" );

            if( strstr( data, "SMD" ) )
                attrs |= MOD_CMS;

            if( strstr( data, "VIRTUAL" ) )
                attrs |= MOD_VIRTUAL;

1327
            aModule->SetAttributes( attrs );
1328 1329 1330 1331 1332
        }

        else if( TESTLINE( "AR" ) )         // Alternate Reference
        {
            // e.g. "AR /47BA2624/45525076"
1333
            data = strtok_r( line + SZ( "AR" ), delims, &saveptr );
1334 1335
            if( data )
                aModule->SetPath( FROM_UTF8( data ) );
1336 1337 1338 1339
        }

        else if( TESTLINE( "$SHAPE3D" ) )
        {
1340
            load3D( aModule );
1341 1342 1343 1344 1345
        }

        else if( TESTLINE( "Cd" ) )
        {
            // e.g. "Cd Double rangee de contacts 2 x 4 pins\r\n"
1346
            aModule->SetDescription( FROM_UTF8( StrPurge( line + SZ( "Cd" ) ) ) );
1347 1348 1349 1350
        }

        else if( TESTLINE( "Kw" ) )         // Key words
        {
1351
            aModule->SetKeywords( FROM_UTF8( StrPurge( line + SZ( "Kw" ) ) ) );
1352 1353 1354 1355 1356
        }

        else if( TESTLINE( ".SolderPasteRatio" ) )
        {
            double tmp = atof( line + SZ( ".SolderPasteRatio" ) );
1357 1358 1359 1360 1361 1362 1363 1364
            // Due to a bug in dialog editor in Modedit, fixed in BZR version 3565
            // this parameter can be broken.
            // It should be >= -50% (no solder paste) and <= 0% (full area of the pad)

            if( tmp < -0.50 )
                tmp = -0.50;
            if( tmp > 0.0 )
                tmp = 0.0;
1365
            aModule->SetLocalSolderPasteMarginRatio( tmp );
1366 1367 1368 1369 1370
        }

        else if( TESTLINE( ".SolderPaste" ) )
        {
            BIU tmp = biuParse( line + SZ( ".SolderPaste" ) );
1371
            aModule->SetLocalSolderPasteMargin( tmp );
1372 1373 1374 1375 1376
        }

        else if( TESTLINE( ".SolderMask" ) )
        {
            BIU tmp = biuParse( line + SZ( ".SolderMask" ) );
1377
            aModule->SetLocalSolderMaskMargin( tmp );
1378 1379 1380 1381 1382
        }

        else if( TESTLINE( ".LocalClearance" ) )
        {
            BIU tmp = biuParse( line + SZ( ".LocalClearance" ) );
1383
            aModule->SetLocalClearance( tmp );
1384 1385 1386 1387 1388
        }

        else if( TESTLINE( ".ZoneConnection" ) )
        {
            int tmp = intParse( line + SZ( ".ZoneConnection" ) );
1389
            aModule->SetZoneConnection( (ZoneConnection)tmp );
1390 1391 1392 1393 1394
        }

        else if( TESTLINE( ".ThermalWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( ".ThermalWidth" ) );
1395
            aModule->SetThermalWidth( tmp );
1396 1397 1398 1399 1400
        }

        else if( TESTLINE( ".ThermalGap" ) )
        {
            BIU tmp = biuParse( line + SZ( ".ThermalGap" ) );
1401
            aModule->SetThermalGap( tmp );
1402 1403 1404 1405
        }

        else if( TESTLINE( "$EndMODULE" ) )
        {
1406
            aModule->CalculateBoundingBox();
1407

1408
            return;     // preferred exit
1409 1410 1411
        }
    }

1412 1413 1414
    wxString msg = wxString::Format(
        wxT( "Missing '$EndMODULE' for MODULE '%s'" ),
        GetChars( aModule->GetFPID().GetFootprintName() ) );
1415 1416

    THROW_IO_ERROR( msg );
1417 1418 1419 1420 1421
}


void LEGACY_PLUGIN::loadPAD( MODULE* aModule )
{
1422
    auto_ptr<D_PAD> pad( new D_PAD( aModule ) );
1423
    char*           line;
1424
    char*           saveptr;
1425

1426
    while( ( line = READLINE( m_reader ) ) != NULL )
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
    {
        const char* data;

        if( TESTLINE( "Sh" ) )              // (Sh)ape and padname
        {
            // e.g. "Sh "A2" C 520 520 0 0 900"
            // or   "Sh "1" R 157 1378 0 0 900"

            // mypadname is LATIN1/CRYLIC for BOARD_FORMAT_VERSION 1,
            // but for BOARD_FORMAT_VERSION 2, it is UTF8 from disk.
            // So we have to go through two code paths.  Moving forward
            // padnames will be in UTF8 on disk, as are all KiCad strings on disk.
            char        mypadname[50];

            data = line + SZ( "Sh" ) + 1;   // +1 skips trailing whitespace

            data = data + ReadDelimitedText( mypadname, data, sizeof(mypadname) ) + 1;  // +1 trailing whitespace

            // sscanf( PtLine, " %s %d %d %d %d %d", BufCar, &m_Size.x, &m_Size.y, &m_DeltaSize.x, &m_DeltaSize.y, &m_Orient );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1446 1447
            while( isSpace( *data ) )
                ++data;
1448 1449 1450

            unsigned char   padchar = (unsigned char) *data++;
            int             padshape;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1451

1452 1453 1454 1455 1456 1457
            BIU     size_x   = biuParse( data, &data );
            BIU     size_y   = biuParse( data, &data );
            BIU     delta_x  = biuParse( data, &data );
            BIU     delta_y  = biuParse( data, &data );
            double  orient   = degParse( data );

1458
            switch( padchar )
1459 1460 1461 1462 1463 1464
            {
            case 'C':   padshape = PAD_CIRCLE;      break;
            case 'R':   padshape = PAD_RECT;        break;
            case 'O':   padshape = PAD_OVAL;        break;
            case 'T':   padshape = PAD_TRAPEZOID;   break;
            default:
1465
                m_error.Printf( _( "Unknown padshape '%c=0x%02x' on line: %d of module: '%s'" ),
1466 1467 1468
                                padchar,
                                padchar,
                                m_reader->LineNumber(),
1469
                                GetChars( aModule->GetFPID().GetFootprintName() )
1470
                    );
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
                THROW_IO_ERROR( m_error );
            }

            // go through a wxString to establish a universal character set properly
            wxString    padname;

            if( m_loading_format_version == 1 )
            {
                // add 8 bit bytes, file format 1 was KiCad font type byte,
                // simply promote those 8 bit bytes up into UNICODE. (subset of LATIN1)
                const unsigned char* cp = (unsigned char*) mypadname;
                while( *cp )
                {
                    padname += *cp++;  // unsigned, ls 8 bits only
                }
            }
            else
            {
                // version 2, which is UTF8.
                padname = FROM_UTF8( mypadname );
            }
            // chances are both were ASCII, but why take chances?

            pad->SetPadName( padname );
            pad->SetShape( PAD_SHAPE_T( padshape ) );
            pad->SetSize( wxSize( size_x, size_y ) );
            pad->SetDelta( wxSize( delta_x, delta_y ) );
            pad->SetOrientation( orient );
        }

        else if( TESTLINE( "Dr" ) )         // (Dr)ill
        {
            // e.g. "Dr 350 0 0" or "Dr 0 0 0 O 0 0"
            // sscanf( PtLine, "%d %d %d %s %d %d", &m_Drill.x, &m_Offset.x, &m_Offset.y, BufCar, &dx, &dy );

            BIU drill_x = biuParse( line + SZ( "Dr" ), &data );
            BIU drill_y = drill_x;
            BIU offs_x  = biuParse( data, &data );
            BIU offs_y  = biuParse( data, &data );

1511
            PAD_DRILL_SHAPE_T drShape = PAD_DRILL_CIRCLE;
1512

1513
            data = strtok_r( (char*) data, delims, &saveptr );
1514 1515 1516 1517
            if( data )  // optional shape
            {
                if( data[0] == 'O' )
                {
1518
                    drShape = PAD_DRILL_OBLONG;
1519

1520
                    data    = strtok_r( NULL, delims, &saveptr );
1521 1522
                    drill_x = biuParse( data );

1523
                    data    = strtok_r( NULL, delims, &saveptr );
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539
                    drill_y = biuParse( data );
                }
            }

            pad->SetDrillShape( drShape );
            pad->SetOffset( wxPoint( offs_x, offs_y ) );
            pad->SetDrillSize( wxSize( drill_x, drill_y ) );
        }

        else if( TESTLINE( "At" ) )         // (At)tribute
        {
            // e.g. "At SMD N 00888000"
            // sscanf( PtLine, "%s %s %X", BufLine, BufCar, &m_layerMask );

            PAD_ATTR_T  attribute;

1540
            data = strtok_r( line + SZ( "At" ), delims, &saveptr );
1541 1542 1543 1544 1545 1546 1547 1548 1549 1550

            if( !strcmp( data, "SMD" ) )
                attribute = PAD_SMD;
            else if( !strcmp( data, "CONN" ) )
                attribute = PAD_CONN;
            else if( !strcmp( data, "HOLE" ) )
                attribute = PAD_HOLE_NOT_PLATED;
            else
                attribute = PAD_STANDARD;

1551 1552
            data = strtok_r( NULL, delims, &saveptr );  // skip BufCar
            data = strtok_r( NULL, delims, &saveptr );
1553

1554
            LEG_MASK layer_mask = hexParse( data );
1555

Dick Hollenbeck's avatar
Dick Hollenbeck committed
1556
            pad->SetLayerSet( leg_mask2new( m_cu_count, layer_mask ) );
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
            pad->SetAttribute( attribute );
        }

        else if( TESTLINE( "Ne" ) )         // (Ne)tname
        {
            // e.g. "Ne 461 "V5.0"

            char    buf[1024];  // can be fairly long
            int     netcode = intParse( line + SZ( "Ne" ), &data );

1567
            // Store the new code mapping
1568
            pad->SetNetCode( getNetCode( netcode ) );
1569 1570 1571

            // read Netname
            ReadDelimitedText( buf, data, sizeof(buf) );
1572 1573
#ifndef NDEBUG
            if( m_board )
1574
                assert( m_board->FindNet( getNetCode( netcode ) )->GetNetname() ==
1575
                        FROM_UTF8( StrPurge( buf ) ) );
1576
#endif /* NDEBUG */
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
        }

        else if( TESTLINE( "Po" ) )         // (Po)sition
        {
            // e.g. "Po 500 -500"
            wxPoint pos;

            pos.x = biuParse( line + SZ( "Po" ), &data );
            pos.y = biuParse( data );

            pad->SetPos0( pos );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1588
            // pad->SetPosition( pos ); set at function return
1589 1590 1591 1592 1593
        }

        else if( TESTLINE( "Le" ) )
        {
            BIU tmp = biuParse( line + SZ( "Le" ) );
1594
            pad->SetPadToDieLength( tmp );
1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640
        }

        else if( TESTLINE( ".SolderMask" ) )
        {
            BIU tmp = biuParse( line + SZ( ".SolderMask" ) );
            pad->SetLocalSolderMaskMargin( tmp );
        }

        else if( TESTLINE( ".SolderPasteRatio" ) )
        {
            double tmp = atof( line + SZ( ".SolderPasteRatio" ) );
            pad->SetLocalSolderPasteMarginRatio( tmp );
        }

        else if( TESTLINE( ".SolderPaste" ) )
        {
            BIU tmp = biuParse( line + SZ( ".SolderPaste" ) );
            pad->SetLocalSolderPasteMargin( tmp );
        }

        else if( TESTLINE( ".LocalClearance" ) )
        {
            BIU tmp = biuParse( line + SZ( ".LocalClearance" ) );
            pad->SetLocalClearance( tmp );
        }

        else if( TESTLINE( ".ZoneConnection" ) )
        {
            int tmp = intParse( line + SZ( ".ZoneConnection" ) );
            pad->SetZoneConnection( (ZoneConnection)tmp );
        }

        else if( TESTLINE( ".ThermalWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( ".ThermalWidth" ) );
            pad->SetThermalWidth( tmp );
        }

        else if( TESTLINE( ".ThermalGap" ) )
        {
            BIU tmp = biuParse( line + SZ( ".ThermalGap" ) );
            pad->SetThermalGap( tmp );
        }

        else if( TESTLINE( "$EndPAD" ) )
        {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1641 1642 1643 1644
            // pad's "Position" is not relative to the module's,
            // whereas Pos0 is relative to the module's but is the unrotated coordinate.

            wxPoint padpos = pad->GetPos0();
1645 1646 1647 1648 1649

            RotatePoint( &padpos, aModule->GetOrientation() );

            pad->SetPosition( padpos + aModule->GetPosition() );

1650
            aModule->Pads().PushBack( pad.release() );
1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
            return;     // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$EndPAD'" );
}


void LEGACY_PLUGIN::loadMODULE_EDGE( MODULE* aModule )
{
1661 1662
    STROKE_T    shape;
    char*       line = m_reader->Line();     // obtain current (old) line
1663 1664 1665 1666 1667 1668 1669 1670

    switch( line[1] )
    {
    case 'S':   shape = S_SEGMENT;   break;
    case 'C':   shape = S_CIRCLE;    break;
    case 'A':   shape = S_ARC;       break;
    case 'P':   shape = S_POLYGON;   break;
    default:
1671 1672 1673 1674
        m_error.Printf( wxT( "Unknown EDGE_MODULE type:'%c=0x%02x' on line:%d of module:'%s'" ),
                        (unsigned char) line[1],
                        (unsigned char) line[1],
                        m_reader->LineNumber(),
1675
                        GetChars( aModule->GetFPID().GetFootprintName() )
1676
                        );
1677 1678 1679
        THROW_IO_ERROR( m_error );
    }

1680
    auto_ptr<EDGE_MODULE> dwg( new EDGE_MODULE( aModule, shape ) );    // a drawing
1681 1682 1683 1684

    const char* data;

    // common to all cases, and we have to check their values uniformly at end
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1685 1686
    BIU         width = 1;
    LAYER_NUM   layer = FIRST_NON_COPPER_LAYER;
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699

    switch( shape )
    {
    case S_ARC:
        {
            // sscanf( Line + 3, "%d %d %d %d %d %d %d", &m_Start0.x, &m_Start0.y, &m_End0.x, &m_End0.y, &m_Angle, &m_Width, &m_Layer );
            BIU     start0_x = biuParse( line + SZ( "DA" ), &data );
            BIU     start0_y = biuParse( data, &data );
            BIU     end0_x   = biuParse( data, &data );
            BIU     end0_y   = biuParse( data, &data );
            double  angle    = degParse( data, &data );

            width   = biuParse( data, &data );
1700
            layer   = layerParse( data );
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719

            dwg->SetAngle( angle );
            dwg->m_Start0 = wxPoint( start0_x, start0_y );
            dwg->m_End0   = wxPoint( end0_x, end0_y );
        }
        break;

    case S_SEGMENT:
    case S_CIRCLE:
        {
            // e.g. "DS -7874 -10630 7874 -10630 50 20\r\n"
            // sscanf( Line + 3, "%d %d %d %d %d %d", &m_Start0.x, &m_Start0.y, &m_End0.x, &m_End0.y, &m_Width, &m_Layer );

            BIU     start0_x = biuParse( line + SZ( "DS" ), &data );
            BIU     start0_y = biuParse( data, &data );
            BIU     end0_x   = biuParse( data, &data );
            BIU     end0_y   = biuParse( data, &data );

            width   = biuParse( data, &data );
1720
            layer   = layerParse( data );
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738

            dwg->m_Start0 = wxPoint( start0_x, start0_y );
            dwg->m_End0   = wxPoint( end0_x, end0_y );
        }
        break;

    case S_POLYGON:
        {
            // e.g. "DP %d %d %d %d %d %d %d\n"
            // sscanf( Line + 3, "%d %d %d %d %d %d %d", &m_Start0.x, &m_Start0.y, &m_End0.x, &m_End0.y, &pointCount, &m_Width, &m_Layer );

            BIU start0_x = biuParse( line + SZ( "DP" ), &data );
            BIU start0_y = biuParse( data, &data );
            BIU end0_x   = biuParse( data, &data );
            BIU end0_y   = biuParse( data, &data );
            int ptCount  = intParse( data, &data );

            width   = biuParse( data, &data );
1739
            layer   = layerParse( data );
1740 1741 1742 1743 1744 1745 1746 1747 1748

            dwg->m_Start0 = wxPoint( start0_x, start0_y );
            dwg->m_End0   = wxPoint( end0_x, end0_y );

            std::vector<wxPoint> pts;
            pts.reserve( ptCount );

            for( int ii = 0;  ii<ptCount;  ++ii )
            {
1749
                if( ( line = READLINE( m_reader ) ) == NULL )
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
                {
                    THROW_IO_ERROR( "S_POLGON point count mismatch." );
                }

                // e.g. "Dl 23 44\n"

                if( !TESTLINE( "Dl" ) )
                {
                    THROW_IO_ERROR( "Missing Dl point def" );
                }

                BIU x = biuParse( line + SZ( "Dl" ), &data );
                BIU y = biuParse( data );

                pts.push_back( wxPoint( x, y ) );
            }

            dwg->SetPolyPoints( pts );
        }
        break;

    default:
        // first switch code above prevents us from getting here.
        break;
    }

    // Check for a reasonable width:

    /* @todo no MAX_WIDTH in out of reach header.
    if( width <= 1 )
        width = 1;
    else if( width > MAX_WIDTH )
        width = MAX_WIDTH;
    */

    // Check for a reasonable layer:
    // m_Layer must be >= FIRST_NON_COPPER_LAYER, but because microwave footprints
    // can use the copper layers m_Layer < FIRST_NON_COPPER_LAYER is allowed.
    // @todo: changes use of EDGE_MODULE these footprints and allows only
    // m_Layer >= FIRST_NON_COPPER_LAYER
1790
    if( layer < FIRST_LAYER || layer > LAST_NON_COPPER_LAYER )
1791 1792 1793
        layer = SILKSCREEN_N_FRONT;

    dwg->SetWidth( width );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1794
    dwg->SetLayer( leg_layer2new( m_cu_count,  layer ) );
1795 1796 1797

    EDGE_MODULE* em = dwg.release();

1798
    aModule->GraphicalItems().PushBack( em );
1799 1800 1801 1802 1803 1804 1805 1806 1807 1808

    // this had been done at the MODULE level before, presumably because the
    // EDGE_MODULE needs to be already added to a module before this function will work.
    em->SetDrawCoord();
}


void LEGACY_PLUGIN::loadMODULE_TEXT( TEXTE_MODULE* aText )
{
    const char* data;
1809 1810
    const char* txt_end;
    const char* line = m_reader->Line();     // current (old) line
1811
    char*       saveptr;
1812

1813 1814 1815
    // sscanf( line + 1, "%d %d %d %d %d %d %d %s %s %d %s",
    //  &type, &m_Pos0.x, &m_Pos0.y, &m_Size.y, &m_Size.x,
    //  &m_Orient, &m_Thickness, BufCar1, BufCar2, &layer, BufCar3 ) >= 10 )
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835

    // e.g. "T1 6940 -16220 350 300 900 60 M I 20 N "CFCARD"\r\n"
    // or    T1 0 500 600 400 900 80 M V 20 N"74LS245"
    // ouch, the last example has no space between N and "74LS245" !
    // that is an older version.

    int     type    = intParse( line+1, &data );
    BIU     pos0_x  = biuParse( data, &data );
    BIU     pos0_y  = biuParse( data, &data );
    BIU     size0_y = biuParse( data, &data );
    BIU     size0_x = biuParse( data, &data );
    double  orient  = degParse( data, &data );
    BIU     thickn  = biuParse( data, &data );

    // read the quoted text before the first call to strtok() which introduces
    // NULs into the string and chops it into mutliple C strings, something
    // ReadDelimitedText() cannot traverse.

    // convert the "quoted, escaped, UTF8, text" to a wxString, find it by skipping
    // as far forward as needed until the first double quote.
1836 1837 1838 1839 1840 1841 1842 1843 1844
    txt_end = data + ReadDelimitedText( &m_field, data );

#if 1 && defined(DEBUG)
    if( m_field == wxT( "ARM_C8" ) )
    {
        int breakhere = 1;
        (void) breakhere;
    }
#endif
1845 1846 1847 1848 1849

    aText->SetText( m_field );

    // after switching to strtok, there's no easy coming back because of the
    // embedded nul(s?) placed to the right of the current field.
1850
    // (that's the reason why strtok was deprecated...)
1851 1852 1853
    char*   mirror  = strtok_r( (char*) data, delims, &saveptr );
    char*   hide    = strtok_r( NULL, delims, &saveptr );
    char*   tmp     = strtok_r( NULL, delims, &saveptr );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
1854 1855 1856

    LAYER_NUM layer_num = tmp ? layerParse( tmp ) : SILKSCREEN_N_FRONT;

1857
    char*   italic  = strtok_r( NULL, delims, &saveptr );
1858

1859 1860
    char*   hjust   = strtok_r( (char*) txt_end, delims, &saveptr );
    char*   vjust   = strtok_r( NULL, delims, &saveptr );
1861

1862
    if( type != TEXTE_MODULE::TEXT_is_REFERENCE
1863 1864
     && type != TEXTE_MODULE::TEXT_is_VALUE )
        type = TEXTE_MODULE::TEXT_is_DIVERS;
1865

1866
    aText->SetType( static_cast<TEXTE_MODULE::TEXT_TYPE>( type ) );
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879

    aText->SetPos0( wxPoint( pos0_x, pos0_y ) );
    aText->SetSize( wxSize( size0_x, size0_y ) );

    orient -= ( (MODULE*) aText->GetParent() )->GetOrientation();

    aText->SetOrientation( orient );

    // @todo put in accessors?
    // Set a reasonable width:
    if( thickn < 1 )
        thickn = 1;

1880
    /*  this is better left to the dialogs UIs
1881 1882
    aText->SetThickness( Clamp_Text_PenSize( thickn, aText->GetSize() ) );
    */
1883

1884 1885 1886 1887 1888 1889 1890 1891
    aText->SetThickness( thickn );

    aText->SetMirrored( mirror && *mirror == 'M' );

    aText->SetVisible( !(hide && *hide == 'I') );

    aText->SetItalic( italic && *italic == 'I' );

1892
    if( hjust )
1893
        aText->SetHorizJustify( horizJustify( hjust ) );
1894 1895

    if( vjust )
1896
        aText->SetVertJustify( vertJustify( vjust ) );
1897

Dick Hollenbeck's avatar
Dick Hollenbeck committed
1898 1899 1900 1901 1902 1903 1904 1905
    if( layer_num < FIRST_LAYER )
        layer_num = FIRST_LAYER;
    else if( layer_num > LAST_NON_COPPER_LAYER )
        layer_num = LAST_NON_COPPER_LAYER;
    else if( layer_num == LAYER_N_BACK )
        layer_num = SILKSCREEN_N_BACK;
    else if( layer_num == LAYER_N_FRONT )
        layer_num = SILKSCREEN_N_FRONT;
1906

Dick Hollenbeck's avatar
Dick Hollenbeck committed
1907
    aText->SetLayer( leg_layer2new( m_cu_count,  layer_num ) );
1908 1909 1910 1911 1912 1913 1914 1915

    // Calculate the actual position.
    aText->SetDrawCoord();
}


void LEGACY_PLUGIN::load3D( MODULE* aModule )
{
1916
    S3D_MASTER* t3D = aModule->Models();
1917

1918
    if( !t3D->GetShape3DName().IsEmpty() )
1919 1920 1921
    {
        S3D_MASTER* n3D = new S3D_MASTER( aModule );

1922
        aModule->Models().PushBack( n3D );
1923 1924 1925 1926

        t3D = n3D;
    }

1927 1928
    char*   line;
    while( ( line = READLINE( m_reader ) ) != NULL )
1929 1930 1931 1932 1933
    {
        if( TESTLINE( "Na" ) )     // Shape File Name
        {
            char    buf[512];
            ReadDelimitedText( buf, line + SZ( "Na" ), sizeof(buf) );
1934
            t3D->SetShape3DName( FROM_UTF8( buf ) );
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
        }

        else if( TESTLINE( "Sc" ) )     // Scale
        {
            sscanf( line + SZ( "Sc" ), "%lf %lf %lf\n",
                    &t3D->m_MatScale.x,
                    &t3D->m_MatScale.y,
                    &t3D->m_MatScale.z );
        }

        else if( TESTLINE( "Of" ) )     // Offset
        {
            sscanf( line + SZ( "Of" ), "%lf %lf %lf\n",
                    &t3D->m_MatPosition.x,
                    &t3D->m_MatPosition.y,
                    &t3D->m_MatPosition.z );
        }

        else if( TESTLINE( "Ro" ) )     // Rotation
        {
            sscanf( line + SZ( "Ro" ), "%lf %lf %lf\n",
                    &t3D->m_MatRotation.x,
                    &t3D->m_MatRotation.y,
                    &t3D->m_MatRotation.z );
        }

        else if( TESTLINE( "$EndSHAPE3D" ) )
            return;         // preferred exit
    }

    THROW_IO_ERROR( "Missing '$EndSHAPE3D'" );
}


void LEGACY_PLUGIN::loadPCB_LINE()
{
    /* example:
        $DRAWSEGMENT
        Po 0 57500 -1000 57500 0 150
        De 24 0 900 0 0
        $EndDRAWSEGMENT
    */

1978
    auto_ptr<DRAWSEGMENT>   dseg( new DRAWSEGMENT( m_board ) );
1979 1980 1981

    char*   line;
    char*   saveptr;
1982

1983
    while( ( line = READLINE( m_reader ) ) != NULL )
1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999
    {
        const char* data;

        if( TESTLINE( "Po" ) )
        {
            // sscanf( line + 2, " %d %d %d %d %d %d", &m_Shape, &m_Start.x, &m_Start.y, &m_End.x, &m_End.y, &m_Width );
            int shape   = intParse( line + SZ( "Po" ), &data );
            BIU start_x = biuParse( data, &data );
            BIU start_y = biuParse( data, &data );
            BIU end_x   = biuParse( data, &data );
            BIU end_y   = biuParse( data, &data );
            BIU width   = biuParse( data );

            if( width < 0 )
                width = 0;

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2000
            dseg->SetShape( STROKE_T( shape ) );
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010
            dseg->SetWidth( width );
            dseg->SetStart( wxPoint( start_x, start_y ) );
            dseg->SetEnd( wxPoint( end_x, end_y ) );
        }

        else if( TESTLINE( "De" ) )
        {
            BIU     x = 0;
            BIU     y;

2011 2012
            data = strtok_r( line + SZ( "De" ), delims, &saveptr );
            for( int i = 0;  data;  ++i, data = strtok_r( NULL, delims, &saveptr ) )
2013 2014 2015 2016
            {
                switch( i )
                {
                case 0:
2017 2018
                    LAYER_NUM layer;
                    layer = layerParse( data );
2019

2020 2021
                    if( layer < FIRST_NON_COPPER_LAYER )
                        layer = FIRST_NON_COPPER_LAYER;
2022

2023 2024
                    else if( layer > LAST_NON_COPPER_LAYER )
                        layer = LAST_NON_COPPER_LAYER;
2025

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2026
                    dseg->SetLayer( leg_layer2new( m_cu_count,  layer ) );
2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038
                    break;
                case 1:
                    int mtype;
                    mtype = intParse( data );
                    dseg->SetType( mtype );   // m_Type
                    break;
                case 2:
                    double angle;
                    angle = degParse( data );
                    dseg->SetAngle( angle );    // m_Angle
                    break;
                case 3:
2039
                    time_t timestamp;
2040 2041 2042 2043
                    timestamp = hexParse( data );
                    dseg->SetTimeStamp( timestamp );
                    break;
                case 4:
2044 2045
                    STATUS_FLAGS state;
                    state = static_cast<STATUS_FLAGS>( hexParse( data ) );
2046
                    dseg->SetState( state, true );
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
                    break;

                    // Bezier Control Points
                case 5:
                    x = biuParse( data );
                    break;
                case 6:
                    y = biuParse( data );
                    dseg->SetBezControl1( wxPoint( x, y ) );
                    break;

                case 7:
                    x = biuParse( data );
                    break;
                case 8:
                    y = biuParse( data );
                    dseg->SetBezControl2( wxPoint( x, y ) );
                    break;

                default:
                    break;
                }
            }
        }

        else if( TESTLINE( "$EndDRAWSEGMENT" ) )
        {
            m_board->Add( dseg.release(), ADD_APPEND );
            return;     // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$EndDRAWSEGMENT'" );
}

void LEGACY_PLUGIN::loadNETINFO_ITEM()
{
    char  buf[1024];

Maciej Suminski's avatar
Maciej Suminski committed
2086
    NETINFO_ITEM*   net = NULL;
2087
    char*           line;
2088
    int             netCode = 0;
2089

2090
    while( ( line = READLINE( m_reader ) ) != NULL )
2091 2092 2093 2094 2095 2096 2097
    {
        const char* data;

        if( TESTLINE( "Na" ) )
        {
            // e.g. "Na 58 "/cpu.sch/PAD7"\r\n"

2098
            netCode = intParse( line + SZ( "Na" ), &data );
2099 2100

            ReadDelimitedText( buf, data, sizeof(buf) );
2101
            net = new NETINFO_ITEM( m_board, FROM_UTF8( buf ), netCode );
2102 2103 2104
        }

        else if( TESTLINE( "$EndEQUIPOT" ) )
2105 2106 2107
        {
            // net 0 should be already in list, so store this net
            // if it is not the net 0, or if the net 0 does not exists.
Maciej Suminski's avatar
Maciej Suminski committed
2108
            if( net != NULL && ( net->GetNet() > 0 || m_board->FindNet( 0 ) == NULL ) )
2109
            {
2110
                m_board->AppendNet( net );
2111 2112 2113 2114 2115

                // Be sure we have room to store the net in m_netCodes
                if( (int)m_netCodes.size() <= netCode )
                    m_netCodes.resize( netCode+1 );

2116 2117
                m_netCodes[netCode] = net->GetNet();
            }
2118
            else
2119
            {
2120
                delete net;
2121 2122
            }

2123
            return;     // preferred exit
2124
        }
2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155
    }

    THROW_IO_ERROR( "Missing '$EndEQUIPOT'" );
}


void LEGACY_PLUGIN::loadPCB_TEXT()
{
    /*  examples:
        For a single line text:
        ----------------------
        $TEXTPCB
        Te "Text example"
        Po 66750 53450 600 800 150 0
        From 24 1 0 Italic
        $EndTEXTPCB

        For a multi line text:
        ---------------------
        $TEXTPCB
        Te "Text example"
        Nl "Line 2"
        Po 66750 53450 600 800 150 0
        From 24 1 0 Italic
        $EndTEXTPCB
        Nl "line nn" is a line added to the current text
    */

    char    text[1024];

    // maybe someday a constructor that takes all this data in one call?
2156
    TEXTE_PCB*  pcbtxt = new TEXTE_PCB( m_board );
2157 2158
    m_board->Add( pcbtxt, ADD_APPEND );

2159 2160
    char*   line;
    char*   saveptr;
2161 2162

    while( ( line = READLINE( m_reader ) ) != NULL )
2163 2164 2165 2166 2167
    {
        const char* data;

        if( TESTLINE( "Te" ) )          // Text line (or first line for multi line texts)
        {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2168
            ReadDelimitedText( text, line + SZ( "Te" ), sizeof(text) );
2169 2170 2171 2172 2173 2174
            pcbtxt->SetText( FROM_UTF8( text ) );
        }

        else if( TESTLINE( "nl" ) )     // next line of the current text
        {
            ReadDelimitedText( text, line + SZ( "nl" ), sizeof(text) );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2175
            pcbtxt->SetText( pcbtxt->GetText() + wxChar( '\n' ) +  FROM_UTF8( text ) );
2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212
        }

        else if( TESTLINE( "Po" ) )
        {
            // sscanf( line + 2, " %d %d %d %d %d %d", &m_Pos.x, &m_Pos.y, &m_Size.x, &m_Size.y, &m_Thickness, &m_Orient );
            wxSize  size;

            BIU pos_x   = biuParse( line + SZ( "Po" ), &data );
            BIU pos_y   = biuParse( data, &data );
            size.x      = biuParse( data, &data );
            size.y      = biuParse( data, &data );
            BIU thickn  = biuParse( data, &data );
            double angle = degParse( data );

            // Ensure the text has minimal size to see this text on screen:

            /* @todo wait until we are firmly in the nanometer world
            if( sz.x < 5 )
                sz.x = 5;

            if( sz.y < 5 )
                sz.y = 5;
            */

            pcbtxt->SetSize( size );

            /* @todo move into an accessor
            // Set a reasonable width:
            if( thickn < 1 )
                thickn = 1;

            thickn = Clamp_Text_PenSize( thickn, size );
            */

            pcbtxt->SetThickness( thickn );
            pcbtxt->SetOrientation( angle );

2213
            pcbtxt->SetTextPosition( wxPoint( pos_x, pos_y ) );
2214 2215 2216 2217 2218 2219 2220
        }

        else if( TESTLINE( "De" ) )
        {
            // e.g. "De 21 1 0 Normal C\r\n"
            // sscanf( line + 2, " %d %d %lX %s %c\n", &m_Layer, &normal_display, &m_TimeStamp, style, &hJustify );

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2221
            LAYER_NUM layer_num = layerParse( line + SZ( "De" ), &data );
2222
            int     notMirrored = intParse( data, &data );
2223
            time_t  timestamp   = hexParse( data, &data );
2224 2225 2226
            char*   style       = strtok_r( (char*) data, delims, &saveptr );
            char*   hJustify    = strtok_r( NULL, delims, &saveptr );
            char*   vJustify    = strtok_r( NULL, delims, &saveptr );
2227 2228 2229 2230 2231 2232

            pcbtxt->SetMirrored( !notMirrored );
            pcbtxt->SetTimeStamp( timestamp );
            pcbtxt->SetItalic( !strcmp( style, "Italic" ) );

            if( hJustify )
2233
                pcbtxt->SetHorizJustify( horizJustify( hJustify ) );
2234 2235
            else
            {
2236 2237
                // boom, somebody changed a constructor, I was relying on this:
                wxASSERT( pcbtxt->GetHorizJustify() == GR_TEXT_HJUSTIFY_CENTER );
2238 2239
            }

2240
            if( vJustify )
2241
                pcbtxt->SetVertJustify( vertJustify( vJustify ) );
2242

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2243 2244 2245 2246
            if( layer_num < FIRST_COPPER_LAYER )
                layer_num = FIRST_COPPER_LAYER;
            else if( layer_num > LAST_NON_COPPER_LAYER )
                layer_num = LAST_NON_COPPER_LAYER;
2247

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2248
            pcbtxt->SetLayer( leg_layer2new( m_cu_count,  layer_num ) );
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
        }

        else if( TESTLINE( "$EndTEXTPCB" ) )
        {
            return;     // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$EndTEXTPCB'" );
}


2261
void LEGACY_PLUGIN::loadTrackList( int aStructType )
2262
{
2263
    char*   line;
2264
    char*   saveptr;
2265 2266

    while( ( line = READLINE( m_reader ) ) != NULL )
2267 2268 2269
    {
        // read two lines per loop iteration, each loop is one TRACK or VIA
        // example first line:
2270 2271
        // e.g. "Po 0 23994 28800 24400 28800 150 -1"  for a track
        // e.g. "Po 3 21086 17586 21086 17586 180 -1"  for a via (uses sames start and end)
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281

        const char* data;

        if( line[0] == '$' )    // $EndTRACK
            return;             // preferred exit

        // int arg_count = sscanf( line + 2, " %d %d %d %d %d %d %d", &shape, &tempStartX, &tempStartY, &tempEndX, &tempEndY, &width, &drill );

        assert( TESTLINE( "Po" ) );

2282
        VIATYPE_T viatype = static_cast<VIATYPE_T>( intParse( line + SZ( "Po" ), &data ));
2283 2284 2285 2286 2287 2288 2289
        BIU start_x = biuParse( data, &data );
        BIU start_y = biuParse( data, &data );
        BIU end_x   = biuParse( data, &data );
        BIU end_y   = biuParse( data, &data );
        BIU width   = biuParse( data, &data );

        // optional 7th drill parameter (must be optional in an old format?)
2290
        data = strtok_r( (char*) data, delims, &saveptr );
2291

2292
        BIU drill   = data ? biuParse( data ) : -1;     // SetDefault() if < 0
2293 2294 2295 2296 2297 2298

        // Read the 2nd line to determine the exact type, one of:
        // PCB_TRACE_T, PCB_VIA_T, or PCB_ZONE_T.  The type field in 2nd line
        // differentiates between PCB_TRACE_T and PCB_VIA_T.  With virtual
        // functions in use, it is critical to instantiate the PCB_VIA_T
        // exactly.
2299
        READLINE( m_reader );
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316

        line = m_reader->Line();

        // example second line:
        // "De 0 0 463 0 800000\r\n"

#if 1
        assert( TESTLINE( "De" ) );
#else
        if( !TESTLINE( "De" ) )
        {
            // mandatory 2nd line is missing
            THROW_IO_ERROR( "Missing 2nd line of a TRACK def" );
        }
#endif

        int         makeType;
2317
        time_t      timeStamp;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2318 2319
        LAYER_NUM   layer_num;
        int         type, net_code, flags_int;
2320 2321

        // parse the 2nd line to determine the type of object
2322
        // e.g. "De 15 1 7 0 0"   for a via
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2323
        sscanf( line + SZ( "De" ), " %d %d %d %lX %X", &layer_num, &type, &net_code,
2324
                &timeStamp, &flags_int );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2325

2326
        STATUS_FLAGS flags;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2327

2328
        flags = static_cast<STATUS_FLAGS>( flags_int );
2329 2330 2331 2332 2333 2334

        if( aStructType==PCB_TRACE_T && type==1 )
            makeType = PCB_VIA_T;
        else
            makeType = aStructType;

2335
        TRACK* newTrack;
2336 2337 2338 2339 2340 2341 2342 2343 2344

        switch( makeType )
        {
        default:
        case PCB_TRACE_T:
            newTrack = new TRACK( m_board );
            break;

        case PCB_VIA_T:
2345
            newTrack = new VIA( m_board );
2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
            break;

        case PCB_ZONE_T:     // this is now deprecated, but exist in old boards
            newTrack = new SEGZONE( m_board );
            break;
        }

        newTrack->SetTimeStamp( timeStamp );

        newTrack->SetPosition( wxPoint( start_x, start_y ) );
        newTrack->SetEnd( wxPoint( end_x, end_y ) );

        newTrack->SetWidth( width );

        if( makeType == PCB_VIA_T )     // Ensure layers are OK when possible:
        {
2362 2363 2364 2365 2366 2367 2368 2369 2370
            VIA *via = static_cast<VIA*>( newTrack );
            via->SetViaType( viatype );

            if( drill < 0 )
                via->SetDrillDefault();
            else
                via->SetDrill( drill );

            if( via->GetViaType() == VIA_THROUGH )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2371
                via->SetLayerPair( F_Cu, B_Cu );
2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382
            else
            {
                LAYER_ID  back  = leg_layer2new( m_cu_count, (layer_num >> 4) & 0xf );
                LAYER_ID  front = leg_layer2new( m_cu_count, layer_num & 0xf );

                via->SetLayerPair( front, back );
            }
        }
        else
        {
            newTrack->SetLayer( leg_layer2new( m_cu_count, layer_num ) );
2383 2384
        }

2385
        newTrack->SetNetCode( getNetCode( net_code ) );
2386
        newTrack->SetState( flags, true );
2387 2388

        m_board->Add( newTrack );
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
    }

    THROW_IO_ERROR( "Missing '$EndTRACK'" );
}


void LEGACY_PLUGIN::loadNETCLASS()
{
    char        buf[1024];
    wxString    netname;
2399
    char*       line;
2400 2401 2402

    // create an empty NETCLASS without a name, but do not add it to the BOARD
    // yet since that would bypass duplicate netclass name checking within the BOARD.
2403
    // store it temporarily in an auto_ptr until successfully inserted into the BOARD
2404
    // just before returning.
2405
    NETCLASSPTR nc = boost::make_shared<NETCLASS>( wxEmptyString );
2406

2407
    while( ( line = READLINE( m_reader ) ) != NULL )
2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466
    {
        if( TESTLINE( "AddNet" ) )      // most frequent type of line
        {
            // e.g. "AddNet "V3.3D"\n"
            ReadDelimitedText( buf, line + SZ( "AddNet" ), sizeof(buf) );
            netname = FROM_UTF8( buf );
            nc->Add( netname );
        }

        else if( TESTLINE( "Clearance" ) )
        {
            BIU tmp = biuParse( line + SZ( "Clearance" ) );
            nc->SetClearance( tmp );
        }

        else if( TESTLINE( "TrackWidth" ) )
        {
            BIU tmp = biuParse( line + SZ( "TrackWidth" ) );
            nc->SetTrackWidth( tmp );
        }

        else if( TESTLINE( "ViaDia" ) )
        {
            BIU tmp = biuParse( line + SZ( "ViaDia" ) );
            nc->SetViaDiameter( tmp );
        }

        else if( TESTLINE( "ViaDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "ViaDrill" ) );
            nc->SetViaDrill( tmp );
        }

        else if( TESTLINE( "uViaDia" ) )
        {
            BIU tmp = biuParse( line + SZ( "uViaDia" ) );
            nc->SetuViaDiameter( tmp );
        }

        else if( TESTLINE( "uViaDrill" ) )
        {
            BIU tmp = biuParse( line + SZ( "uViaDrill" ) );
            nc->SetuViaDrill( tmp );
        }

        else if( TESTLINE( "Name" ) )
        {
            ReadDelimitedText( buf, line + SZ( "Name" ), sizeof(buf) );
            nc->SetName( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "Desc" ) )
        {
            ReadDelimitedText( buf, line + SZ( "Desc" ), sizeof(buf) );
            nc->SetDescription( FROM_UTF8( buf ) );
        }

        else if( TESTLINE( "$EndNCLASS" ) )
        {
2467
            if( !m_board->GetDesignSettings().m_NetClasses.Add( nc ) )
2468 2469 2470 2471
            {
                // Must have been a name conflict, this is a bad board file.
                // User may have done a hand edit to the file.

2472
                // auto_ptr will delete nc on this code path
2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487

                m_error.Printf( _( "duplicate NETCLASS name '%s'" ), nc->GetName().GetData() );
                THROW_IO_ERROR( m_error );
            }

            return;     // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$EndNCLASS'" );
}


void LEGACY_PLUGIN::loadZONE_CONTAINER()
{
2488
    auto_ptr<ZONE_CONTAINER> zc( new ZONE_CONTAINER( m_board ) );
2489

2490
    CPolyLine::HATCH_STYLE outline_hatch = CPolyLine::NO_HATCH;
2491 2492
    bool    sawCorner = false;
    char    buf[1024];
2493
    char*   line;
2494
    char*   saveptr;
2495

2496
    while( ( line = READLINE( m_reader ) ) != NULL )
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
    {
        const char* data;

        if( TESTLINE( "ZCorner" ) )         // new corner found
        {
            // e.g. "ZCorner 25650 49500 0"
            BIU x    = biuParse( line + SZ( "ZCorner" ), &data );
            BIU y    = biuParse( data, &data );
            int flag = intParse( data );

            if( !sawCorner )
2508
                zc->Outline()->Start( zc->GetLayer(), x, y, outline_hatch );
2509 2510 2511 2512 2513 2514
            else
                zc->AppendCorner( wxPoint( x, y ) );

            sawCorner = true;

            if( flag )
2515
                zc->Outline()->CloseLastContour();
2516 2517 2518 2519 2520
        }

        else if( TESTLINE( "ZInfo" ) )      // general info found
        {
            // e.g. 'ZInfo 479194B1 310 "COMMON"'
2521
            time_t  timestamp = hexParse( line + SZ( "ZInfo" ), &data );
2522 2523 2524 2525 2526 2527 2528 2529
            int     netcode   = intParse( data, &data );

            if( ReadDelimitedText( buf, data, sizeof(buf) ) > (int) sizeof(buf) )
            {
                THROW_IO_ERROR( "ZInfo netname too long" );
            }

            zc->SetTimeStamp( timestamp );
2530 2531 2532
            // Init the net code only, not the netname, to be sure
            // the zone net name is the name read in file.
            // (When mismatch, the user will be prompted in DRC, to fix the actual name)
2533
            zc->BOARD_CONNECTED_ITEM::SetNetCode( getNetCode( netcode ) );
2534 2535 2536 2537
        }

        else if( TESTLINE( "ZLayer" ) )     // layer found
        {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2538 2539
            LAYER_NUM layer_num = layerParse( line + SZ( "ZLayer" ) );
            zc->SetLayer( leg_layer2new( m_cu_count,  layer_num ) );
2540 2541 2542 2543 2544 2545
        }

        else if( TESTLINE( "ZAux" ) )       // aux info found
        {
            // e.g. "ZAux 7 E"
            int     ignore = intParse( line + SZ( "ZAux" ), &data );
2546
            char*   hopt   = strtok_r( (char*) data, delims, &saveptr );
2547 2548 2549

            if( !hopt )
            {
Maciej Suminski's avatar
Maciej Suminski committed
2550
                m_error.Printf( wxT( "Bad ZAux for CZONE_CONTAINER '%s'" ), zc->GetNetname().GetData() );
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
                THROW_IO_ERROR( m_error );
            }

            switch( *hopt )   // upper case required
            {
            case 'N':   outline_hatch = CPolyLine::NO_HATCH;        break;
            case 'E':   outline_hatch = CPolyLine::DIAGONAL_EDGE;   break;
            case 'F':   outline_hatch = CPolyLine::DIAGONAL_FULL;   break;

            default:
Maciej Suminski's avatar
Maciej Suminski committed
2561
                m_error.Printf( wxT( "Bad ZAux for CZONE_CONTAINER '%s'" ), zc->GetNetname().GetData() );
2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577
                THROW_IO_ERROR( m_error );
            }

            (void) ignore;

            // Set hatch mode later, after reading corner outline data
        }

        else if( TESTLINE( "ZSmoothing" ) )
        {
            // e.g. "ZSmoothing 0 0"
            int     smoothing    = intParse( line + SZ( "ZSmoothing" ), &data );
            BIU     cornerRadius = biuParse( data );

            if( smoothing >= ZONE_SETTINGS::SMOOTHING_LAST || smoothing < 0 )
            {
Maciej Suminski's avatar
Maciej Suminski committed
2578
                m_error.Printf( wxT( "Bad ZSmoothing for CZONE_CONTAINER '%s'" ), zc->GetNetname().GetData() );
2579 2580 2581 2582 2583 2584 2585
                THROW_IO_ERROR( m_error );
            }

            zc->SetCornerSmoothingType( smoothing );
            zc->SetCornerRadius( cornerRadius );
        }

2586 2587 2588 2589
        else if( TESTLINE( "ZKeepout" ) )
        {
            zc->SetIsKeepout( true );
            // e.g. "ZKeepout tracks N vias N pads Y"
2590
           data = strtok_r( line + SZ( "ZKeepout" ), delims, &saveptr );
2591 2592 2593 2594 2595

            while( data )
            {
                if( !strcmp( data, "tracks" ) )
                {
2596
                    data = strtok_r( NULL, delims, &saveptr );
2597 2598 2599 2600
                    zc->SetDoNotAllowTracks( data && *data == 'N' );
                }
                else if( !strcmp( data, "vias" ) )
                {
2601
                    data = strtok_r( NULL, delims, &saveptr );
2602 2603
                    zc->SetDoNotAllowVias( data && *data == 'N' );
                }
2604
                else if( !strcmp( data, "copperpour" ) )
2605
                {
2606
                    data = strtok_r( NULL, delims, &saveptr );
2607
                    zc->SetDoNotAllowCopperPour( data && *data == 'N' );
2608 2609
                }

2610
                data = strtok_r( NULL, delims, &saveptr );
2611 2612 2613
            }
        }

2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630
        else if( TESTLINE( "ZOptions" ) )
        {
            // e.g. "ZOptions 0 32 F 200 200"
            int     fillmode    = intParse( line + SZ( "ZOptions" ), &data );
            int     arcsegcount = intParse( data, &data );
            char    fillstate   = data[1];      // here e.g. " F"
            BIU     thermalReliefGap = biuParse( data += 2 , &data );  // +=2 for " F"
            BIU     thermalReliefCopperBridge = biuParse( data );

            zc->SetFillMode( fillmode ? 1 : 0 );

            // @todo ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF: don't really want pcbnew.h
            // in here, after all, its a PLUGIN and global data is evil.
            // put in accessor
            if( arcsegcount >= 32 )
                arcsegcount = 32;

2631
            zc->SetArcSegmentCount( arcsegcount );
2632
            zc->SetIsFilled( fillstate == 'S' );
2633 2634 2635 2636 2637 2638 2639 2640
            zc->SetThermalReliefGap( thermalReliefGap );
            zc->SetThermalReliefCopperBridge( thermalReliefCopperBridge );
        }

        else if( TESTLINE( "ZClearance" ) )     // Clearance and pad options info found
        {
            // e.g. "ZClearance 40 I"
            BIU     clearance = biuParse( line + SZ( "ZClearance" ), &data );
2641
            char*   padoption = strtok_r( (char*) data, delims, &saveptr );  // data: " I"
2642 2643 2644 2645 2646 2647

            ZoneConnection popt;
            switch( *padoption )
            {
            case 'I':   popt = PAD_IN_ZONE;        break;
            case 'T':   popt = THERMAL_PAD;        break;
2648
            case 'H':   popt = THT_THERMAL;        break;
2649 2650 2651 2652
            case 'X':   popt = PAD_NOT_IN_ZONE;    break;

            default:
                m_error.Printf( wxT( "Bad ZClearance padoption for CZONE_CONTAINER '%s'" ),
Maciej Suminski's avatar
Maciej Suminski committed
2653
                    zc->GetNetname().GetData() );
2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675
                THROW_IO_ERROR( m_error );
            }

            zc->SetZoneClearance( clearance );
            zc->SetPadConnection( popt );
        }

        else if( TESTLINE( "ZMinThickness" ) )
        {
            BIU thickness = biuParse( line + SZ( "ZMinThickness" ) );
            zc->SetMinThickness( thickness );
        }

        else if( TESTLINE( "ZPriority" ) )
        {
            int priority = intParse( line + SZ( "ZPriority" ) );
            zc->SetPriority( priority );
        }

        else if( TESTLINE( "$POLYSCORNERS" ) )
        {
            // Read the PolysList (polygons used for fill areas in the zone)
2676
            CPOLYGONS_LIST polysList;
2677

2678
            while( ( line = READLINE( m_reader ) ) != NULL )
2679 2680 2681 2682 2683 2684 2685 2686 2687
            {
                if( TESTLINE( "$endPOLYSCORNERS" ) )
                    break;

                // e.g. "39610 43440 0 0"
                BIU     x = biuParse( line, &data );
                BIU     y = biuParse( data, &data );

                bool    end_contour = intParse( data, &data );  // end_countour was a bool when file saved, so '0' or '1' here
2688
                int     cornerUtilityFlg  = intParse( data );
2689

2690
               polysList.Append( CPolyPt( x, y, end_contour, cornerUtilityFlg ) );
2691
            }
2692
            zc->AddFilledPolysList( polysList );
2693 2694 2695 2696
        }

        else if( TESTLINE( "$FILLSEGMENTS" ) )
        {
2697
            while( ( line = READLINE( m_reader ) ) != NULL )
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707
            {
                if( TESTLINE( "$endFILLSEGMENTS" ) )
                    break;

                // e.g. ""%d %d %d %d\n"
                BIU sx = biuParse( line, &data );
                BIU sy = biuParse( data, &data );
                BIU ex = biuParse( data, &data );
                BIU ey = biuParse( data );

2708
                zc->FillSegments().push_back( SEGMENT( wxPoint( sx, sy ), wxPoint( ex, ey ) ) );
2709 2710 2711 2712 2713
            }
        }

        else if( TESTLINE( "$endCZONE_OUTLINE" ) )
        {
2714 2715 2716
            // Ensure keepout does not have a net
            // (which have no sense for a keepout zone)
            if( zc->GetIsKeepout() )
2717
                zc->SetNetCode( NETINFO_LIST::UNCONNECTED );
2718

2719 2720 2721 2722 2723 2724 2725 2726
            // should always occur, but who knows, a zone without two corners
            // is no zone at all, it's a spot?

            if( zc->GetNumCorners() > 2 )
            {
                if( !zc->IsOnCopperLayer() )
                {
                    zc->SetFillMode( 0 );
2727
                    zc->SetNetCode( NETINFO_LIST::UNCONNECTED );
2728 2729
                }

2730
                // Hatch here, after outlines corners are read
2731
                // Set hatch here, after outlines corners are read
2732 2733 2734
                zc->Outline()->SetHatch( outline_hatch,
                                         Mils2iu( CPolyLine::GetDefaultHatchPitchMils() ),
                                         true );
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748

                m_board->Add( zc.release() );
            }

            return;     // preferred exit
        }
    }

    THROW_IO_ERROR( "Missing '$endCZONE_OUTLINE'" );
}


void LEGACY_PLUGIN::loadDIMENSION()
{
2749
    auto_ptr<DIMENSION> dim( new DIMENSION( m_board ) );
2750 2751 2752

    char*   line;
    char*   saveptr;
2753

2754
    while( ( line = READLINE( m_reader ) ) != NULL )
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766
    {
        const char*  data;

        if( TESTLINE( "$endCOTATION" ) )
        {
            m_board->Add( dim.release(), ADD_APPEND );
            return;     // preferred exit
        }

        else if( TESTLINE( "Va" ) )
        {
            BIU value = biuParse( line + SZ( "Va" ) );
2767
            dim->SetValue( value );
2768 2769 2770 2771
        }

        else if( TESTLINE( "Ge" ) )
        {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2772
            LAYER_NUM layer_num;
2773
            time_t  timestamp;
2774
            int     shape;
2775
            int     ilayer;
2776

2777
            sscanf( line + SZ( "Ge" ), " %d %d %lX", &shape, &ilayer, &timestamp );
2778

2779
            if( ilayer < FIRST_NON_COPPER_LAYER )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2780
                layer_num = FIRST_NON_COPPER_LAYER;
2781
            else if( ilayer > LAST_NON_COPPER_LAYER )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2782 2783 2784
                layer_num = LAST_NON_COPPER_LAYER;
            else
                layer_num = ilayer;
2785

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2786
            dim->SetLayer( leg_layer2new( m_cu_count,  layer_num ) );
2787 2788 2789 2790 2791 2792 2793 2794 2795
            dim->SetTimeStamp( timestamp );
            dim->SetShape( shape );
        }

        else if( TESTLINE( "Te" ) )
        {
            char  buf[2048];

            ReadDelimitedText( buf, line + SZ( "Te" ), sizeof(buf) );
2796
            dim->SetText( FROM_UTF8( buf ) );
2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809
        }

        else if( TESTLINE( "Po" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d %d", &m_Text->m_Pos.x, &m_Text->m_Pos.y,
            // &m_Text->m_Size.x, &m_Text->m_Size.y, &thickness, &orientation, &normal_display );

            BIU     pos_x  = biuParse( line + SZ( "Po" ), &data );
            BIU     pos_y  = biuParse( data, &data );
            BIU     width  = biuParse( data, &data );
            BIU     height = biuParse( data, &data );
            BIU     thickn = biuParse( data, &data );
            double  orient = degParse( data, &data );
2810
            char*   mirror = strtok_r( (char*) data, delims, &saveptr );
2811 2812 2813 2814 2815 2816

            // This sets both DIMENSION's position and internal m_Text's.
            // @todo: But why do we even know about internal m_Text?
            dim->SetPosition( wxPoint( pos_x, pos_y ) );
            dim->SetTextSize( wxSize( width, height ) );

2817 2818 2819
            dim->Text().SetMirrored( mirror && *mirror == '0' );
            dim->Text().SetThickness( thickn );
            dim->Text().SetOrientation( orient );
2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832
        }

        else if( TESTLINE( "Sb" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_crossBarOx, &m_crossBarOy, &m_crossBarFx, &m_crossBarFy, &m_Width );

            int ignore     = biuParse( line + SZ( "Sb" ), &data );
            BIU crossBarOx = biuParse( data, &data );
            BIU crossBarOy = biuParse( data, &data );
            BIU crossBarFx = biuParse( data, &data );
            BIU crossBarFy = biuParse( data, &data );
            BIU width      = biuParse( data );

2833 2834 2835 2836
            dim->m_crossBarO.x = crossBarOx;
            dim->m_crossBarO.y = crossBarOy;
            dim->m_crossBarF.x = crossBarFx;
            dim->m_crossBarF.y = crossBarFy;
2837
            dim->SetWidth( width );
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850
            (void) ignore;
        }

        else if( TESTLINE( "Sd" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_featureLineDOx, &m_featureLineDOy, &m_featureLineDFx, &m_featureLineDFy, &Dummy );

            int ignore         = intParse( line + SZ( "Sd" ), &data );
            BIU featureLineDOx = biuParse( data, &data );
            BIU featureLineDOy = biuParse( data, &data );
            BIU featureLineDFx = biuParse( data, &data );
            BIU featureLineDFy = biuParse( data );

2851 2852 2853 2854
            dim->m_featureLineDO.x = featureLineDOx;
            dim->m_featureLineDO.y = featureLineDOy;
            dim->m_featureLineDF.x = featureLineDFx;
            dim->m_featureLineDF.y = featureLineDFy;
2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867
            (void) ignore;
        }

        else if( TESTLINE( "Sg" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_featureLineGOx, &m_featureLineGOy, &m_featureLineGFx, &m_featureLineGFy, &Dummy );

            int ignore         = intParse( line + SZ( "Sg" ), &data );
            BIU featureLineGOx = biuParse( data, &data );
            BIU featureLineGOy = biuParse( data, &data );
            BIU featureLineGFx = biuParse( data, &data );
            BIU featureLineGFy = biuParse( data );

2868 2869 2870 2871
            dim->m_featureLineGO.x = featureLineGOx;
            dim->m_featureLineGO.y = featureLineGOy;
            dim->m_featureLineGF.x = featureLineGFx;
            dim->m_featureLineGF.y = featureLineGFy;
2872 2873 2874 2875 2876 2877 2878 2879
            (void) ignore;
        }

        else if( TESTLINE( "S1" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_arrowD1Ox, &m_arrowD1Oy, &m_arrowD1Fx, &m_arrowD1Fy, &Dummy );

            int ignore      = intParse( line + SZ( "S1" ), &data );
2880 2881
            biuParse( data, &data );    // skipping excessive data
            biuParse( data, &data );    // skipping excessive data
2882 2883 2884
            BIU arrowD1Fx   = biuParse( data, &data );
            BIU arrowD1Fy   = biuParse( data );

2885 2886
            dim->m_arrowD1F.x = arrowD1Fx;
            dim->m_arrowD1F.y = arrowD1Fy;
2887 2888 2889 2890 2891 2892 2893 2894
            (void) ignore;
        }

        else if( TESTLINE( "S2" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_arrowD2Ox, &m_arrowD2Oy, &m_arrowD2Fx, &m_arrowD2Fy, &Dummy );

            int ignore    = intParse( line + SZ( "S2" ), &data );
2895 2896
            biuParse( data, &data );    // skipping excessive data
            biuParse( data, &data );    // skipping excessive data
2897 2898 2899
            BIU arrowD2Fx = biuParse( data, &data );
            BIU arrowD2Fy = biuParse( data, &data );

2900 2901
            dim->m_arrowD2F.x = arrowD2Fx;
            dim->m_arrowD2F.y = arrowD2Fy;
2902 2903 2904 2905 2906 2907 2908
            (void) ignore;
        }

        else if( TESTLINE( "S3" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d\n", &Dummy, &m_arrowG1Ox, &m_arrowG1Oy, &m_arrowG1Fx, &m_arrowG1Fy, &Dummy );
            int ignore    = intParse( line + SZ( "S3" ), &data );
2909 2910
            biuParse( data, &data );    // skipping excessive data
            biuParse( data, &data );    // skipping excessive data
2911 2912 2913
            BIU arrowG1Fx = biuParse( data, &data );
            BIU arrowG1Fy = biuParse( data, &data );

2914 2915
            dim->m_arrowG1F.x = arrowG1Fx;
            dim->m_arrowG1F.y = arrowG1Fy;
2916 2917 2918 2919 2920 2921 2922
            (void) ignore;
        }

        else if( TESTLINE( "S4" ) )
        {
            // sscanf( Line + 2, " %d %d %d %d %d %d", &Dummy, &m_arrowG2Ox, &m_arrowG2Oy, &m_arrowG2Fx, &m_arrowG2Fy, &Dummy );
            int ignore    = intParse( line + SZ( "S4" ), &data );
2923 2924
            biuParse( data, &data );    // skipping excessive data
            biuParse( data, &data );    // skipping excessive data
2925 2926 2927
            BIU arrowG2Fx = biuParse( data, &data );
            BIU arrowG2Fy = biuParse( data, &data );

2928 2929
            dim->m_arrowG2F.x = arrowG2Fx;
            dim->m_arrowG2F.y = arrowG2Fy;
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939
            (void) ignore;
        }
    }

    THROW_IO_ERROR( "Missing '$endCOTATION'" );
}


void LEGACY_PLUGIN::loadPCB_TARGET()
{
2940 2941 2942
    char* line;

    while( ( line = READLINE( m_reader ) ) != NULL )
2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955
    {
        const char* data;

        if( TESTLINE( "$EndPCB_TARGET" ) || TESTLINE( "$EndMIREPCB" ) )
        {
            return;     // preferred exit
        }

        else if( TESTLINE( "Po" ) )
        {
            // sscanf( Line + 2, " %X %d %d %d %d %d %lX", &m_Shape, &m_Layer, &m_Pos.x, &m_Pos.y, &m_Size, &m_Width, &m_TimeStamp );

            int shape = intParse( line + SZ( "Po" ), &data );
Dick Hollenbeck's avatar
Dick Hollenbeck committed
2956 2957 2958

            LAYER_NUM layer_num = layerParse( data, &data );

2959 2960 2961 2962
            BIU pos_x = biuParse( data, &data );
            BIU pos_y = biuParse( data, &data );
            BIU size  = biuParse( data, &data );
            BIU width = biuParse( data, &data );
2963
            time_t timestamp = hexParse( data );
2964

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2965 2966
            if( layer_num < FIRST_NON_COPPER_LAYER )
                layer_num = FIRST_NON_COPPER_LAYER;
2967

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2968 2969
            else if( layer_num > LAST_NON_COPPER_LAYER )
                layer_num = LAST_NON_COPPER_LAYER;
2970

Dick Hollenbeck's avatar
Dick Hollenbeck committed
2971 2972
            PCB_TARGET* t = new PCB_TARGET( m_board, shape, leg_layer2new( m_cu_count,  layer_num ),
                                    wxPoint( pos_x, pos_y ), size, width );
2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988
            m_board->Add( t, ADD_APPEND );

            t->SetTimeStamp( timestamp );
        }
    }

    THROW_IO_ERROR( "Missing '$EndDIMENSION'" );
}


BIU LEGACY_PLUGIN::biuParse( const char* aValue, const char** nptrptr )
{
    char*   nptr;

    errno = 0;

2989
    double fval = strtod( aValue, &nptr );
2990 2991 2992

    if( errno )
    {
2993
        m_error.Printf( _( "invalid float number in file: '%s'\nline: %d, offset: %d" ),
2994 2995
            m_reader->GetSource().GetData(),
            m_reader->LineNumber(), aValue - m_reader->Line() + 1 );
2996 2997 2998 2999 3000 3001

        THROW_IO_ERROR( m_error );
    }

    if( aValue == nptr )
    {
3002
        m_error.Printf( _( "missing float number in file: '%s'\nline: %d, offset: %d" ),
3003 3004
            m_reader->GetSource().GetData(),
            m_reader->LineNumber(), aValue - m_reader->Line() + 1 );
3005 3006 3007 3008 3009 3010 3011

        THROW_IO_ERROR( m_error );
    }

    if( nptrptr )
        *nptrptr = nptr;

3012
    fval *= diskToBiu;
3013

3014 3015
    // fval is up into the whole number realm here, and should be bounded
    // within INT_MIN to INT_MAX since BIU's are nanometers.
3016
    return KiROUND( fval );
3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029
}


double LEGACY_PLUGIN::degParse( const char* aValue, const char** nptrptr )
{
    char*   nptr;

    errno = 0;

    double fval = strtod( aValue, &nptr );

    if( errno )
    {
3030
        m_error.Printf( _( "invalid float number in file: '%s'\nline: %d, offset: %d" ),
3031 3032 3033 3034 3035 3036 3037
            m_reader->GetSource().GetData(), m_reader->LineNumber(), aValue - m_reader->Line() + 1 );

        THROW_IO_ERROR( m_error );
    }

    if( aValue == nptr )
    {
3038
        m_error.Printf( _( "missing float number in file: '%s'\nline: %d, offset: %d" ),
3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050
            m_reader->GetSource().GetData(), m_reader->LineNumber(), aValue - m_reader->Line() + 1 );

        THROW_IO_ERROR( m_error );
    }

    if( nptrptr )
        *nptrptr = nptr;

    return fval;
}


3051
void LEGACY_PLUGIN::init( const PROPERTIES* aProperties )
3052
{
Dick Hollenbeck's avatar
Dick Hollenbeck committed
3053
    m_cu_count = 16;
3054
    m_board = NULL;
3055 3056 3057
    m_props = aProperties;

    // conversion factor for saving RAM BIUs to KICAD legacy file format.
3058
    biuToDisk = 1.0/IU_PER_MM;      // BIUs are nanometers & file is mm
3059

3060
    // Conversion factor for loading KICAD legacy file format into BIUs in RAM
3061
    // Start by assuming the *.brd file is in deci-mils.
3062
    // If we see "Units mm" in the $GENERAL section, set diskToBiu to 1000000.0
3063
    // then, during the file loading process, to start a conversion from
3064 3065
    // mm to nanometers.  The deci-mil legacy files have no such "Units" marker
    // so we must assume the file is in deci-mils until told otherwise.
3066

3067
    diskToBiu = IU_PER_DECIMILS;    // BIUs are nanometers
3068 3069 3070
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120
void LEGACY_PLUGIN::SaveModule3D( const MODULE* me ) const
{
    for( S3D_MASTER* t3D = me->Models();  t3D;  t3D = t3D->Next() )
    {
        if( !t3D->GetShape3DName().IsEmpty() )
        {
            fprintf( m_fp, "$SHAPE3D\n" );

            fprintf( m_fp, "Na %s\n", EscapedUTF8( t3D->GetShape3DName() ).c_str() );

            fprintf(m_fp,
#if defined(DEBUG)
                    // use old formats for testing, just to verify compatibility
                    // using "diff", then switch to more concise form for release builds.
                    "Sc %lf %lf %lf\n",
#else
                    "Sc %.10g %.10g %.10g\n",
#endif
                    t3D->m_MatScale.x,
                    t3D->m_MatScale.y,
                    t3D->m_MatScale.z );

            fprintf(m_fp,
#if defined(DEBUG)
                    "Of %lf %lf %lf\n",
#else
                    "Of %.10g %.10g %.10g\n",
#endif
                    t3D->m_MatPosition.x,
                    t3D->m_MatPosition.y,
                    t3D->m_MatPosition.z );

            fprintf(m_fp,
#if defined(DEBUG)
                    "Ro %lf %lf %lf\n",
#else
                    "Ro %.10g %.10g %.10g\n",
#endif
                    t3D->m_MatRotation.x,
                    t3D->m_MatRotation.y,
                    t3D->m_MatRotation.z );

            fprintf( m_fp, "$EndSHAPE3D\n" );
        }
    }
}


#if 0

3121
//-----<BOARD Save Functions>---------------------------------------------------
3122

Dick Hollenbeck's avatar
Dick Hollenbeck committed
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192
#define SPBUFZ  50      // wire all usages of this together.

int LEGACY_PLUGIN::biuSprintf( char* buf, BIU aValue ) const
{
    double  engUnits = biuToDisk * aValue;
    int     len;

    if( engUnits != 0.0 && fabsl( engUnits ) <= 0.0001 )
    {
        len = snprintf( buf, SPBUFZ, "%.10f", engUnits );

        while( --len > 0 && buf[len] == '0' )
            buf[len] = '\0';

        ++len;
    }
    else
    {
        // The %.10g is about optimal since we are dealing with a bounded
        // range on aValue, and we can be sure that there will never
        // be a reason to have more than 6 digits to the right of the
        // decimal point because we are converting from integer
        // (signed whole numbers) nanometers to mm.  A value of
        // 0.000001 is one nanometer, the smallest positive nonzero value
        // that we can ever have here.  If you ever see a board file with
        // more digits to the right of the decimal point than 6, this is a
        // possibly a bug in a formatting string nearby.
        len = snprintf( buf, SPBUFZ, "%.10g", engUnits );
    }
    return len;
}


std::string LEGACY_PLUGIN::fmtBIU( BIU aValue ) const
{
    char    temp[SPBUFZ];

    int len = biuSprintf( temp, aValue );

    return std::string( temp, len );
}


std::string LEGACY_PLUGIN::fmtDEG( double aAngle ) const
{
    char    temp[50];

    // @todo a hook site to convert from tenths degrees to degrees for BOARD_FORMAT_VERSION 2.

    // MINGW: snprintf() comes from gcc folks, sprintf() comes from Microsoft.
    int len = snprintf( temp, sizeof( temp ), "%.10g", aAngle );

    return std::string( temp, len );
}


std::string LEGACY_PLUGIN::fmtBIUPair( BIU first, BIU second ) const
{
    char    temp[2*SPBUFZ+2];
    char*   cp = temp;

    cp += biuSprintf( cp, first );

    *cp++ = ' ';

    cp += biuSprintf( cp, second );

    return std::string( temp, cp - temp );
}

3193
void LEGACY_PLUGIN::Save( const wxString& aFileName, BOARD* aBoard, const PROPERTIES* aProperties )
3194 3195 3196
{
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.

3197
    init( aProperties );
3198

3199
    FILE* fp = wxFopen( aFileName, wxT( "w" ) );
3200 3201
    if( !fp )
    {
3202
        m_error.Printf( _( "Unable to open file '%s'" ), aFileName.GetData() );
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212
        THROW_IO_ERROR( m_error );
    }

    m_filename = aFileName;

    // wxf now owns fp, will close on exception or return
    wxFFile wxf( fp );

    m_fp = fp;          // member function accessibility

3213 3214 3215 3216 3217 3218 3219 3220
    wxString header = wxString::Format(
        wxT( "PCBNEW-BOARD Version %d date %s\n\n# Created by Pcbnew%s\n\n" ),
        LEGACY_BOARD_FILE_VERSION, DateAndTime().GetData(),
        GetBuildVersion().GetData() );

    // save a file header, if caller provided one (with trailing \n hopefully).
    fprintf( m_fp, "%s", TO_UTF8( header ) );

3221
    SaveBOARD( aBoard );
3222 3223 3224 3225 3226
}


wxString LEGACY_PLUGIN::writeError() const
{
3227
    return wxString::Format( _( "error writing to file '%s'" ), m_filename.GetData() );
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238
}

#define CHECK_WRITE_ERROR() \
do { \
    if( ferror( m_fp ) ) \
    { \
        THROW_IO_ERROR( writeError() ); \
    } \
} while(0)


Dick Hollenbeck's avatar
Dick Hollenbeck committed
3239 3240 3241
// With the advent of the LSET expansion it was agreed to abort the legacy save since
// we'd have to expand the old format in order to suppor the new LAYER_IDs.

3242
void LEGACY_PLUGIN::SaveBOARD( const BOARD* aBoard ) const
3243
{
3244 3245
    m_mapping->SetBoard( aBoard );

3246
    saveGENERAL( aBoard );
3247

3248
    saveSHEET( aBoard );
3249

3250
    saveSETUP( aBoard );
3251

3252
    saveBOARD_ITEMS( aBoard );
3253 3254 3255
}


3256
void LEGACY_PLUGIN::saveGENERAL( const BOARD* aBoard ) const
3257 3258 3259 3260 3261 3262 3263 3264
{
    fprintf( m_fp, "$GENERAL\n" );
    fprintf( m_fp, "encoding utf-8\n" );

    // tell folks the units used within the file, as early as possible here.
    fprintf( m_fp, "Units mm\n" );

    // Write copper layer count
3265
    fprintf( m_fp, "LayerCount %d\n", aBoard->GetCopperLayerCount() );
3266 3267 3268 3269 3270 3271 3272 3273

    /*  No, EnabledLayers has this information, plus g_TabAllCopperLayerMask is
        global and globals are not allowed in a plugin.
    fprintf( m_fp,
             "Ly %8X\n",
             g_TabAllCopperLayerMask[NbLayers - 1] | ALL_NO_CU_LAYERS );
    */

3274
    fprintf( m_fp, "EnabledLayers %08X\n",  aBoard->GetEnabledLayers() );
3275

3276 3277
    if( aBoard->GetEnabledLayers() != aBoard->GetVisibleLayers() )
        fprintf( m_fp, "VisibleLayers %08X\n", aBoard->GetVisibleLayers() );
3278

3279
    fprintf( m_fp, "Links %d\n",            aBoard->GetRatsnestsCount() );
3280
    fprintf( m_fp, "NoConn %d\n",           aBoard->GetUnconnectedNetCount() );
3281 3282

    // Write Bounding box info
3283 3284
    EDA_RECT bbbox = ((BOARD*)aBoard)->ComputeBoundingBox();

3285 3286 3287 3288
    fprintf( m_fp,  "Di %s %s\n",
                    fmtBIUPair( bbbox.GetX(), bbbox.GetY() ).c_str(),
                    fmtBIUPair( bbbox.GetRight(), bbbox.GetBottom() ).c_str() );

3289 3290 3291
    fprintf( m_fp, "Ndraw %d\n",            aBoard->m_Drawings.GetCount() );
    fprintf( m_fp, "Ntrack %d\n",           aBoard->GetNumSegmTrack() );
    fprintf( m_fp, "Nzone %d\n",            aBoard->GetNumSegmZone() );
3292
    fprintf( m_fp, "BoardThickness %s\n",   fmtBIU( aBoard->GetDesignSettings().GetBoardThickness() ).c_str() );
3293
    fprintf( m_fp, "Nmodule %d\n",          aBoard->m_Modules.GetCount() );
3294
    fprintf( m_fp, "Nnets %d\n",            m_mapping->GetSize() );
3295 3296 3297 3298
    fprintf( m_fp, "$EndGENERAL\n\n" );
}


3299
void LEGACY_PLUGIN::saveSHEET( const BOARD* aBoard ) const
3300
{
3301 3302
    const PAGE_INFO&    pageInfo = aBoard->GetPageSettings();
    const TITLE_BLOCK&  tb = ((BOARD*)aBoard)->GetTitleBlock();
3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326

    fprintf( m_fp, "$SHEETDESCR\n" );

    // paper is described in mils
    fprintf( m_fp,  "Sheet %s %d %d%s\n",
                    TO_UTF8( pageInfo.GetType() ),
                    pageInfo.GetWidthMils(),
                    pageInfo.GetHeightMils(),
                    !pageInfo.IsCustom() && pageInfo.IsPortrait() ?
                        " portrait" : ""
                    );

    fprintf( m_fp, "Title %s\n",        EscapedUTF8( tb.GetTitle() ).c_str() );
    fprintf( m_fp, "Date %s\n",         EscapedUTF8( tb.GetDate() ).c_str() );
    fprintf( m_fp, "Rev %s\n",          EscapedUTF8( tb.GetRevision() ).c_str() );
    fprintf( m_fp, "Comp %s\n",         EscapedUTF8( tb.GetCompany() ).c_str() );
    fprintf( m_fp, "Comment1 %s\n",     EscapedUTF8( tb.GetComment1() ).c_str() );
    fprintf( m_fp, "Comment2 %s\n",     EscapedUTF8( tb.GetComment2() ).c_str() );
    fprintf( m_fp, "Comment3 %s\n",     EscapedUTF8( tb.GetComment3() ).c_str() );
    fprintf( m_fp, "Comment4 %s\n",     EscapedUTF8( tb.GetComment4() ).c_str() );
    fprintf( m_fp, "$EndSHEETDESCR\n\n" );
}


3327
void LEGACY_PLUGIN::saveSETUP( const BOARD* aBoard ) const
3328
{
3329
    const BOARD_DESIGN_SETTINGS& bds = aBoard->GetDesignSettings();
3330
    NETCLASSPTR netclass_default     = bds.GetDefault();
3331 3332 3333 3334 3335

    fprintf( m_fp, "$SETUP\n" );

    /*  Internal units are nobody's business, they are internal.
        Units used in the file are now in the "Units" attribute of $GENERAL.
3336
    fprintf( m_fp,, "InternalUnit %f INCH\n", 1.0 / PCB_LEGACY_INTERNAL_UNIT );
3337 3338
    */

3339
    fprintf( m_fp, "Layers %d\n", aBoard->GetCopperLayerCount() );
3340

3341
    unsigned layerMask = ALL_CU_LAYERS & aBoard->GetEnabledLayers();
3342

3343
    for( LAYER_NUM layer = FIRST_LAYER; layer <= LAST_COPPER_LAYER; ++layer )
3344
    {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
3345
        if( layerMask & MASK( layer ) )
3346 3347
        {
            fprintf( m_fp, "Layer[%d] %s %s\n", layer,
3348 3349
                     TO_UTF8( aBoard->GetLayerName( layer ) ),
                     LAYER::ShowType( aBoard->GetLayerType( layer ) ) );
3350 3351 3352 3353
        }
    }

    // Save current default track width, for compatibility with older Pcbnew version;
3354 3355
    fprintf( m_fp, "TrackWidth %s\n",
             fmtBIU( aBoard->GetDesignSettings().GetCurrentTrackWidth() ).c_str() );
3356 3357

    // Save custom tracks width list (the first is not saved here: this is the netclass value
3358 3359
    for( unsigned ii = 1; ii < aBoard->GetDesignSettings().m_TrackWidthList.size(); ii++ )
        fprintf( m_fp, "TrackWidthList %s\n", fmtBIU( aBoard->GetDesignSettings().m_TrackWidthList[ii] ).c_str() );
3360 3361 3362 3363

    fprintf( m_fp, "TrackClearence %s\n",  fmtBIU( netclass_default->GetClearance() ).c_str() );

    // ZONE_SETTINGS
3364 3365
    fprintf( m_fp, "ZoneClearence %s\n", fmtBIU( aBoard->GetZoneSettings().m_ZoneClearance ).c_str() );
    fprintf( m_fp, "Zone_45_Only %d\n", aBoard->GetZoneSettings().m_Zone_45_Only );
3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379

    fprintf( m_fp, "TrackMinWidth %s\n", fmtBIU( bds.m_TrackMinWidth ).c_str() );

    fprintf( m_fp, "DrawSegmWidth %s\n", fmtBIU( bds.m_DrawSegmentWidth ).c_str() );
    fprintf( m_fp, "EdgeSegmWidth %s\n", fmtBIU( bds.m_EdgeSegmentWidth ).c_str() );

    // Save current default via size, for compatibility with older Pcbnew version;
    fprintf( m_fp, "ViaSize %s\n",  fmtBIU( netclass_default->GetViaDiameter() ).c_str() );
    fprintf( m_fp, "ViaDrill %s\n", fmtBIU( netclass_default->GetViaDrill() ).c_str() );
    fprintf( m_fp, "ViaMinSize %s\n", fmtBIU( bds.m_ViasMinSize ).c_str() );
    fprintf( m_fp, "ViaMinDrill %s\n", fmtBIU( bds.m_ViasMinDrill ).c_str() );

    // Save custom vias diameters list (the first is not saved here: this is
    // the netclass value
3380
    for( unsigned ii = 1; ii < aBoard->GetDesignSettings().m_ViasDimensionsList.size(); ii++ )
3381
        fprintf( m_fp, "ViaSizeList %s %s\n",
3382 3383
                 fmtBIU( aBoard->GetDesignSettings().m_ViasDimensionsList[ii].m_Diameter ).c_str(),
                 fmtBIU( aBoard->GetDesignSettings().m_ViasDimensionsList[ii].m_Drill ).c_str() );
3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402

    // for old versions compatibility:
    fprintf( m_fp, "MicroViaSize %s\n", fmtBIU( netclass_default->GetuViaDiameter() ).c_str() );
    fprintf( m_fp, "MicroViaDrill %s\n", fmtBIU( netclass_default->GetuViaDrill() ).c_str() );
    fprintf( m_fp, "MicroViasAllowed %s\n", fmtBIU( bds.m_MicroViasAllowed ).c_str() );
    fprintf( m_fp, "MicroViaMinSize %s\n", fmtBIU( bds.m_MicroViasMinSize ).c_str() );
    fprintf( m_fp, "MicroViaMinDrill %s\n", fmtBIU( bds.m_MicroViasMinDrill ).c_str() );

    fprintf( m_fp, "TextPcbWidth %s\n", fmtBIU( bds.m_PcbTextWidth ).c_str() );
    fprintf( m_fp, "TextPcbSize %s\n",  fmtBIUSize( bds.m_PcbTextSize ).c_str() );

    fprintf( m_fp, "EdgeModWidth %s\n", fmtBIU( bds.m_ModuleSegmentWidth ).c_str() );
    fprintf( m_fp, "TextModSize %s\n", fmtBIUSize( bds.m_ModuleTextSize ).c_str() );
    fprintf( m_fp, "TextModWidth %s\n", fmtBIU( bds.m_ModuleTextWidth ).c_str() );

    fprintf( m_fp, "PadSize %s\n", fmtBIUSize( bds.m_Pad_Master.GetSize() ).c_str() );
    fprintf( m_fp, "PadDrill %s\n", fmtBIU( bds.m_Pad_Master.GetDrillSize().x ).c_str() );

    fprintf( m_fp, "Pad2MaskClearance %s\n", fmtBIU( bds.m_SolderMaskMargin ).c_str() );
3403
    fprintf( m_fp, "SolderMaskMinWidth %s\n", fmtBIU( bds.m_SolderMaskMinWidth ).c_str() );
3404 3405 3406 3407 3408 3409 3410

    if( bds.m_SolderPasteMargin != 0 )
        fprintf( m_fp, "Pad2PasteClearance %s\n", fmtBIU( bds.m_SolderPasteMargin ).c_str() );

    if( bds.m_SolderPasteMarginRatio != 0 )
        fprintf( m_fp, "Pad2PasteClearanceRatio %g\n", bds.m_SolderPasteMarginRatio );

3411 3412
    fprintf( m_fp, "GridOrigin %s\n", fmtBIUPoint( aBoard->GetGridOrigin() ).c_str() );
    fprintf( m_fp, "AuxiliaryAxisOrg %s\n", fmtBIUPoint( aBoard->GetAuxOrigin() ).c_str() );
3413

3414 3415
    fprintf( m_fp, "VisibleElements %X\n", bds.GetVisibleElements() );

3416 3417 3418
    {
        STRING_FORMATTER sf;

3419
        aBoard->GetPlotOptions().Format( &sf, 0 );
3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432

        wxString record = FROM_UTF8( sf.GetString().c_str() );

        record.Replace( wxT("\n"), wxT(""), true );
        record.Replace( wxT("  "), wxT(" "), true);

        fprintf( m_fp, "PcbPlotParams %s\n", TO_UTF8( record ) );
    }

    fprintf( m_fp, "$EndSETUP\n\n" );
}


3433
void LEGACY_PLUGIN::saveBOARD_ITEMS( const BOARD* aBoard ) const
3434 3435
{
    // save the nets
3436 3437 3438 3439 3440
    for( NETINFO_MAPPING::iterator net = m_mapping->begin(), netEnd = m_mapping->end();
            net != netEnd; ++net )
    {
        saveNETINFO_ITEM( *net );
    }
3441 3442

    // Saved nets do not include netclass names, so save netclasses after nets.
3443
    saveNETCLASSES( &aBoard->GetDesignSettings().m_NetClasses );
3444 3445

    // save the modules
3446
    for( MODULE* m = aBoard->m_Modules;  m;  m = (MODULE*) m->Next() )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
3447
        saveMODULE( m );
3448 3449

    // save the graphics owned by the board (not owned by a module)
3450
    for( BOARD_ITEM* gr = aBoard->m_Drawings;  gr;  gr = gr->Next() )
3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463
    {
        switch( gr->Type() )
        {
        case PCB_TEXT_T:
            savePCB_TEXT( (TEXTE_PCB*) gr );
            break;
        case PCB_LINE_T:
            savePCB_LINE( (DRAWSEGMENT*) gr );
            break;
        case PCB_TARGET_T:
            savePCB_TARGET( (PCB_TARGET*) gr );
            break;
        case PCB_DIMENSION_T:
3464
            saveDIMENSION( (DIMENSION*) gr );
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474
            break;
        default:
            THROW_IO_ERROR( wxString::Format( UNKNOWN_GRAPHIC_FORMAT, gr->Type() ) );
        }
    }

    // do not save MARKER_PCBs, they can be regenerated easily

    // save the tracks & vias
    fprintf( m_fp, "$TRACK\n" );
3475
    for( TRACK* track = aBoard->m_Track;  track; track = track->Next() )
3476 3477 3478 3479 3480
        saveTRACK( track );
    fprintf( m_fp, "$EndTRACK\n" );

    // save the old obsolete zones which were done by segments (tracks)
    fprintf( m_fp, "$ZONE\n" );
3481
    for( SEGZONE* zone = aBoard->m_Zone;  zone;  zone = zone->Next() )
3482 3483 3484 3485
        saveTRACK( zone );
    fprintf( m_fp, "$EndZONE\n" );

    // save the polygon (which are the newer technology) zones
3486 3487
    for( int i=0;  i < aBoard->GetAreaCount();  ++i )
        saveZONE_CONTAINER( aBoard->GetArea( i ) );
3488 3489 3490 3491 3492 3493 3494 3495 3496 3497

    fprintf( m_fp, "$EndBOARD\n" );

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::saveNETINFO_ITEM( const NETINFO_ITEM* aNet ) const
{
    fprintf( m_fp, "$EQUIPOT\n" );
3498 3499
    fprintf( m_fp, "Na %d %s\n", m_mapping->Translate( aNet->GetNet() ),
                                 EscapedUTF8( aNet->GetNetname() ).c_str() );
3500 3501 3502 3503 3504 3505 3506
    fprintf( m_fp, "St %s\n", "~" );
    fprintf( m_fp, "$EndEQUIPOT\n" );

    CHECK_WRITE_ERROR();
}


3507
void LEGACY_PLUGIN::saveNETCLASSES( const NETCLASSES* aNetClasses ) const
3508 3509
{
    // save the default first.
3510
    saveNETCLASS( aNetClasses->GetDefault() );
3511 3512

    // the rest will be alphabetical in the *.brd file.
3513
    for( NETCLASSES::const_iterator it = aNetClasses->begin();  it != aNetClasses->end();  ++it )
3514
    {
3515
        NETCLASSPTR   netclass = it->second;
3516 3517 3518 3519 3520 3521 3522
        saveNETCLASS( netclass );
    }

    CHECK_WRITE_ERROR();
}


3523
void LEGACY_PLUGIN::saveNETCLASS( const NETCLASSPTR nc ) const
3524 3525 3526 3527 3528
{
    fprintf( m_fp, "$NCLASS\n" );
    fprintf( m_fp, "Name %s\n", EscapedUTF8( nc->GetName() ).c_str() );
    fprintf( m_fp, "Desc %s\n", EscapedUTF8( nc->GetDescription() ).c_str() );

3529 3530
    fprintf( m_fp, "Clearance %s\n",    fmtBIU( nc->GetClearance() ).c_str() );
    fprintf( m_fp, "TrackWidth %s\n",   fmtBIU( nc->GetTrackWidth() ).c_str() );
3531

3532 3533
    fprintf( m_fp, "ViaDia %s\n",       fmtBIU( nc->GetViaDiameter() ).c_str() );
    fprintf( m_fp, "ViaDrill %s\n",     fmtBIU( nc->GetViaDrill() ).c_str() );
3534

3535 3536
    fprintf( m_fp, "uViaDia %s\n",      fmtBIU( nc->GetuViaDiameter() ).c_str() );
    fprintf( m_fp, "uViaDrill %s\n",    fmtBIU( nc->GetuViaDrill() ).c_str() );
3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558

    for( NETCLASS::const_iterator it = nc->begin();  it!=nc->end();  ++it )
        fprintf( m_fp, "AddNet %s\n", EscapedUTF8( *it ).c_str() );

    fprintf( m_fp, "$EndNCLASS\n" );

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::saveMODULE_TEXT( const TEXTE_MODULE* me ) const
{
    MODULE* parent = (MODULE*) me->GetParent();
    double  orient = me->GetOrientation();

    // Due to the Pcbnew history, m_Orient is saved in screen value
    // but it is handled as relative to its parent footprint
    if( parent )
        orient += parent->GetOrientation();

    wxString txt = me->GetText();

3559
    fprintf( m_fp,  "T%d %s %s %s %s %c %c %d %c %s",
3560 3561
                    me->GetType(),
                    fmtBIUPoint( me->GetPos0() ).c_str(),   // m_Pos0.x, m_Pos0.y,
3562 3563 3564 3565

                    // legacy has goofed reversed order: ( y, x )
                    fmtBIUPair( me->GetSize().y, me->GetSize().x ).c_str(),

3566 3567 3568 3569 3570 3571 3572 3573 3574
                    fmtDEG( orient ).c_str(),
                    fmtBIU( me->GetThickness() ).c_str(),   // m_Thickness,
                    me->IsMirrored() ? 'M' : 'N',
                    me->IsVisible() ? 'V' : 'I',
                    me->GetLayer(),
                    me->IsItalic() ? 'I' : 'N',
                    EscapedUTF8( txt ).c_str()
                    );

3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585
    if( me->GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER ||
        me->GetVertJustify()  != GR_TEXT_VJUSTIFY_CENTER )
    {
        fprintf( m_fp,  " %s %s\n",
                        ShowHorizJustify( me->GetHorizJustify() ),
                        ShowVertJustify( me->GetVertJustify() )
                        );
    }
    else
        fprintf( m_fp, "\n" );

3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693
    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::saveMODULE_EDGE( const EDGE_MODULE* me ) const
{
    switch( me->GetShape() )
    {
    case S_SEGMENT:
        fprintf( m_fp,  "DS %s %s %s %d\n",
                        fmtBIUPoint( me->m_Start0 ).c_str(),
                        fmtBIUPoint( me->m_End0 ).c_str(),
                        fmtBIU( me->GetWidth() ).c_str(),
                        me->GetLayer() );
        break;

    case S_CIRCLE:
        fprintf( m_fp,  "DC %s %s %s %d\n",
                        fmtBIUPoint( me->m_Start0 ).c_str(),
                        fmtBIUPoint( me->m_End0 ).c_str(),
                        fmtBIU( me->GetWidth() ).c_str(),
                        me->GetLayer() );
        break;

    case S_ARC:
        fprintf( m_fp,  "DA %s %s %s %s %d\n",
                        fmtBIUPoint( me->m_Start0 ).c_str(),
                        fmtBIUPoint( me->m_End0 ).c_str(),
                        fmtDEG( me->GetAngle() ).c_str(),
                        fmtBIU( me->GetWidth() ).c_str(),
                        me->GetLayer() );
        break;

    case S_POLYGON:
        {
            const std::vector<wxPoint>& polyPoints = me->GetPolyPoints();

            fprintf(    m_fp, "DP %s %s %d %s %d\n",
                        fmtBIUPoint( me->m_Start0 ).c_str(),
                        fmtBIUPoint( me->m_End0 ).c_str(),
                        (int) polyPoints.size(),
                        fmtBIU( me->GetWidth() ).c_str(),
                        me->GetLayer() );

            for( unsigned i = 0;  i<polyPoints.size();  ++i )
                fprintf( m_fp, "Dl %s\n", fmtBIUPoint( polyPoints[i] ).c_str() );
        }
        break;

    default:
        THROW_IO_ERROR( wxString::Format( UNKNOWN_GRAPHIC_FORMAT, me->GetShape() ) );
    }

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::savePAD( const D_PAD* me ) const
{
    fprintf( m_fp, "$PAD\n" );

    int cshape;

    switch( me->GetShape() )
    {
    case PAD_CIRCLE:    cshape = 'C';   break;
    case PAD_RECT:      cshape = 'R';   break;
    case PAD_OVAL:      cshape = 'O';   break;
    case PAD_TRAPEZOID: cshape = 'T';   break;

    default:
        THROW_IO_ERROR( wxString::Format( UNKNOWN_PAD_FORMAT, me->GetShape() ) );
    }

#if BOARD_FORMAT_VERSION == 1       // saving mode is a compile time option

    wxString    wpadname = me->GetPadName();    // universal character set padname
    std::string spadname;

    for( unsigned i = 0; wpadname.size(); ++i )
    {
        // truncate from universal character down to 8 bit foreign jibber
        // jabber byte.  This basically duplicates what was done in the old
        // BOARD_FORMAT_VERSION 1 code.  Any characters that were in the 8 bit
        // character space were OK.
        spadname += (char) wpadname[i];
    }

    fprintf( m_fp,  "Sh \"%s\" %c %s %s %s\n",
                    spadname.c_str(),  // probably ASCII, but possibly jibber jabber
#else

    fprintf( m_fp,  "Sh %s %c %s %s %s\n",
                    // legacy VERSION 2 simply uses UTF8, wrapped in quotes,
                    // and 99.99 % of the time there is no difference between 1 & 2,
                    // since ASCII is a subset of UTF8.  But if they were not using
                    // ASCII pad names, then there is a difference in the file.
                    EscapedUTF8( me->GetPadName() ).c_str(),
#endif
                    cshape,
                    fmtBIUSize( me->GetSize() ).c_str(),
                    fmtBIUSize( me->GetDelta() ).c_str(),
                    fmtDEG( me->GetOrientation() ).c_str() );

    fprintf( m_fp,  "Dr %s %s",
                    fmtBIU( me->GetDrillSize().x ).c_str(),
                    fmtBIUPoint( me->GetOffset() ).c_str() );

3694
    if( me->GetDrillShape() == PAD_DRILL_OBLONG )
3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713
    {
        fprintf( m_fp, " %c %s", 'O', fmtBIUSize( me->GetDrillSize() ).c_str() );
    }

    fprintf( m_fp, "\n" );

    const char* texttype;

    switch( me->GetAttribute() )
    {
    case PAD_STANDARD:          texttype = "STD";       break;
    case PAD_SMD:               texttype = "SMD";       break;
    case PAD_CONN:              texttype = "CONN";      break;
    case PAD_HOLE_NOT_PLATED:   texttype = "HOLE";      break;

    default:
        THROW_IO_ERROR( wxString::Format( UNKNOWN_PAD_ATTRIBUTE, me->GetAttribute() ) );
    }

Dick Hollenbeck's avatar
Dick Hollenbeck committed
3714
    fprintf( m_fp, "At %s N %08X\n", texttype, me->GetLayerSet() );
3715

3716 3717
    fprintf( m_fp, "Ne %d %s\n", m_mapping->Translate( me->GetNetCode() ),
             EscapedUTF8( me->GetNetname() ).c_str() );
3718 3719 3720

    fprintf( m_fp, "Po %s\n", fmtBIUPoint( me->GetPos0() ).c_str() );

3721 3722
    if( me->GetPadToDieLength() != 0 )
        fprintf( m_fp, "Le %s\n", fmtBIU( me->GetPadToDieLength() ).c_str() );
3723 3724 3725 3726 3727 3728 3729

    if( me->GetLocalSolderMaskMargin() != 0 )
        fprintf( m_fp, ".SolderMask %s\n", fmtBIU( me->GetLocalSolderMaskMargin() ).c_str() );

    if( me->GetLocalSolderPasteMargin() != 0 )
        fprintf( m_fp, ".SolderPaste %s\n", fmtBIU( me->GetLocalSolderPasteMargin() ).c_str() );

3730 3731 3732
    double ratio = me->GetLocalSolderPasteMarginRatio();
    if( ratio != 0.0 )
        fprintf( m_fp, ".SolderPasteRatio %g\n", ratio );
3733 3734 3735 3736 3737 3738 3739 3740

    if( me->GetLocalClearance() != 0 )
        fprintf( m_fp, ".LocalClearance %s\n", fmtBIU( me->GetLocalClearance( ) ).c_str() );

    if( me->GetZoneConnection() != UNDEFINED_CONNECTION )
        fprintf( m_fp, ".ZoneConnection %d\n", me->GetZoneConnection() );

    if( me->GetThermalWidth() != 0 )
3741
        fprintf( m_fp, ".ThermalWidth %s\n", fmtBIU( me->GetThermalWidth() ).c_str() );
3742 3743

    if( me->GetThermalGap() != 0 )
3744
        fprintf( m_fp, ".ThermalGap %s\n", fmtBIU( me->GetThermalGap() ).c_str() );
3745 3746 3747 3748 3749 3750 3751

    fprintf( m_fp, "$EndPAD\n" );

    CHECK_WRITE_ERROR();
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
3752
void LEGACY_PLUGIN::saveMODULE( const MODULE* me ) const
3753 3754 3755 3756
{
    char        statusTxt[3];
    double      orient = me->GetOrientation();

3757 3758 3759
    // Do not save full FPID.  Only the footprint name.  The legacy file format should
    // never support FPIDs.
    fprintf( m_fp, "$MODULE %s\n", me->GetFPID().GetFootprintName().c_str() );
3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772

    statusTxt[0] = me->IsLocked() ? 'F' : '~';
    statusTxt[1] = me->IsPlaced() ? 'P' : '~';
    statusTxt[2] = '\0';

    fprintf( m_fp,  "Po %s %s %d %08lX %08lX %s\n",
                    fmtBIUPoint( me->GetPosition() ).c_str(),    // m_Pos.x, m_Pos.y,
                    fmtDEG( orient ).c_str(),
                    me->GetLayer(),
                    me->GetLastEditTime(),
                    me->GetTimeStamp(),
                    statusTxt );

3773
    fprintf( m_fp, "Li %s\n", me->GetFPID().GetFootprintName().c_str() );
3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786

    if( !me->GetDescription().IsEmpty() )
    {
        fprintf( m_fp, "Cd %s\n", TO_UTF8( me->GetDescription() ) );
    }

    if( !me->GetKeywords().IsEmpty() )
    {
        fprintf( m_fp, "Kw %s\n", TO_UTF8( me->GetKeywords() ) );
    }

    fprintf( m_fp, "Sc %lX\n", me->GetTimeStamp() );
    fprintf( m_fp, "AR %s\n", TO_UTF8( me->GetPath() ) );
3787
    fprintf( m_fp, "Op %X %X 0\n", me->GetPlacementCost90(), me->GetPlacementCost180() );
3788 3789 3790 3791 3792 3793 3794

    if( me->GetLocalSolderMaskMargin() != 0 )
        fprintf( m_fp, ".SolderMask %s\n", fmtBIU( me->GetLocalSolderMaskMargin() ).c_str() );

    if( me->GetLocalSolderPasteMargin() != 0 )
        fprintf( m_fp, ".SolderPaste %s\n", fmtBIU( me->GetLocalSolderPasteMargin() ).c_str() );

3795 3796 3797
    double ratio = me->GetLocalSolderPasteMarginRatio();
    if( ratio != 0.0 )
        fprintf( m_fp, ".SolderPasteRatio %g\n", ratio );
3798 3799 3800 3801 3802 3803 3804 3805

    if( me->GetLocalClearance() != 0 )
        fprintf( m_fp, ".LocalClearance %s\n", fmtBIU( me->GetLocalClearance( ) ).c_str() );

    if( me->GetZoneConnection() != UNDEFINED_CONNECTION )
        fprintf( m_fp, ".ZoneConnection %d\n", me->GetZoneConnection() );

    if( me->GetThermalWidth() != 0 )
3806
        fprintf( m_fp, ".ThermalWidth %s\n", fmtBIU( me->GetThermalWidth() ).c_str() );
3807 3808

    if( me->GetThermalGap() != 0 )
3809
        fprintf( m_fp, ".ThermalGap %s\n", fmtBIU( me->GetThermalGap() ).c_str() );
3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824

    // attributes
    if( me->GetAttributes() != MOD_DEFAULT )
    {
        fprintf( m_fp, "At" );

        if( me->GetAttributes() & MOD_CMS )
            fprintf( m_fp, " SMD" );

        if( me->GetAttributes() & MOD_VIRTUAL )
            fprintf( m_fp, " VIRTUAL" );

        fprintf( m_fp, "\n" );
    }

3825
    saveMODULE_TEXT( &me->Reference() );
3826

3827
    saveMODULE_TEXT( &me->Value() );
3828 3829

    // save drawing elements
3830
    for( BOARD_ITEM* gr = me->GraphicalItems();  gr;  gr = gr->Next() )
3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844
    {
        switch( gr->Type() )
        {
        case PCB_MODULE_TEXT_T:
            saveMODULE_TEXT( (TEXTE_MODULE*) gr );
            break;
        case PCB_MODULE_EDGE_T:
            saveMODULE_EDGE( (EDGE_MODULE*) gr );
            break;
        default:
            THROW_IO_ERROR( wxString::Format( UNKNOWN_GRAPHIC_FORMAT, gr->Type() ) );
        }
    }

3845
    for( D_PAD* pad = me->Pads();  pad;  pad = pad->Next() )
3846 3847
        savePAD( pad );

3848
    SaveModule3D( me );
3849

3850
    fprintf( m_fp, "$EndMODULE %s\n", me->GetFPID().GetFootprintName().c_str() );
3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::savePCB_TARGET( const PCB_TARGET* me ) const
{
    fprintf( m_fp, "$PCB_TARGET\n" );

    fprintf( m_fp, "Po %X %d %s %s %s %lX\n",
             me->GetShape(),
             me->GetLayer(),
             fmtBIUPoint( me->GetPosition() ).c_str(),
             fmtBIU( me->GetSize() ).c_str(),
             fmtBIU( me->GetWidth() ).c_str(),
             me->GetTimeStamp()
             );

    fprintf( m_fp, "$EndPCB_TARGET\n" );

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::savePCB_LINE( const DRAWSEGMENT* me ) const
{
    fprintf( m_fp, "$DRAWSEGMENT\n" );

    fprintf( m_fp, "Po %d %s %s %s\n",
             me->GetShape(),
             fmtBIUPoint( me->GetStart() ).c_str(),
             fmtBIUPoint( me->GetEnd() ).c_str(),
             fmtBIU( me->GetWidth() ).c_str()
             );

    if( me->GetType() != S_CURVE )
    {
        fprintf( m_fp, "De %d %d %s %lX %X\n",
                 me->GetLayer(),
                 me->GetType(),
                 fmtDEG( me->GetAngle() ).c_str(),
                 me->GetTimeStamp(),
                 me->GetStatus()
                 );
    }
    else
    {
        fprintf( m_fp, "De %d %d %s %lX %X %s %s\n",
                 me->GetLayer(),
                 me->GetType(),
                 fmtDEG( me->GetAngle() ).c_str(),
                 me->GetTimeStamp(),
                 me->GetStatus(),
                 fmtBIUPoint( me->GetBezControl1() ).c_str(),
                 fmtBIUPoint( me->GetBezControl2() ).c_str()
                 );
    }

    fprintf( m_fp, "$EndDRAWSEGMENT\n" );
}


void LEGACY_PLUGIN::saveTRACK( const TRACK* me ) const
{
    int type = 0;
3916 3917
    VIATYPE_T viatype = VIA_NOT_DEFINED;
    int drill = UNDEFINED_DRILL_DIAMETER;
3918 3919

    if( me->Type() == PCB_VIA_T )
3920 3921
    {
        const VIA *via = static_cast<const VIA *>(me);
3922
        type = 1;
3923 3924 3925
        viatype = via->GetViaType();
        drill = via->GetDrill();
    }
3926 3927

    fprintf(m_fp, "Po %d %s %s %s %s\n",
3928
            viatype,
3929 3930 3931
            fmtBIUPoint( me->GetStart() ).c_str(),
            fmtBIUPoint( me->GetEnd() ).c_str(),
            fmtBIU( me->GetWidth() ).c_str(),
3932 3933
            drill == UNDEFINED_DRILL_DIAMETER ?
                "-1" :  fmtBIU( drill ).c_str() );
3934 3935

    fprintf(m_fp, "De %d %d %d %lX %X\n",
3936
            me->GetLayer(), type, m_mapping->Translate( me->GetNetCode() ),
3937 3938 3939 3940 3941 3942 3943 3944 3945
            me->GetTimeStamp(), me->GetStatus() );
}


void LEGACY_PLUGIN::saveZONE_CONTAINER( const ZONE_CONTAINER* me ) const
{
    fprintf( m_fp, "$CZONE_OUTLINE\n" );

    // Save the outline main info
3946 3947
    // For keepout zones, net code and net name are irrelevant, so we store a dummy value
    // just for ZONE_CONTAINER compatibility
3948
    fprintf( m_fp,  "ZInfo %lX %d %s\n",
3949
                    me->GetTimeStamp(),
3950
                    me->GetIsKeepout() ? 0 : m_mapping->Translate( me->GetNetCode() ),
Maciej Suminski's avatar
Maciej Suminski committed
3951
                    EscapedUTF8( me->GetIsKeepout() ? wxT("") : me->GetNetname() ).c_str() );
3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979

    // Save the outline layer info
    fprintf( m_fp, "ZLayer %d\n", me->GetLayer() );

    // Save the outline aux info
    int outline_hatch;

    switch( me->GetHatchStyle() )
    {
    default:
    case CPolyLine::NO_HATCH:       outline_hatch = 'N';    break;
    case CPolyLine::DIAGONAL_EDGE:  outline_hatch = 'E';    break;
    case CPolyLine::DIAGONAL_FULL:  outline_hatch = 'F';    break;
    }

    fprintf( m_fp, "ZAux %d %c\n", me->GetNumCorners(), outline_hatch );

    if( me->GetPriority() > 0 )
        fprintf( m_fp, "ZPriority %d\n", me->GetPriority() );

    // Save pad option and clearance
    char padoption;

    switch( me->GetPadConnection() )
    {
    default:
    case PAD_IN_ZONE:       padoption = 'I';  break;
    case THERMAL_PAD:       padoption = 'T';  break;
3980
    case THT_THERMAL:       padoption = 'H';  break; // H is for 'hole' since it reliefs holes only
3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991
    case PAD_NOT_IN_ZONE:   padoption = 'X';  break;
    }

    fprintf( m_fp,  "ZClearance %s %c\n",
                    fmtBIU( me->GetZoneClearance() ).c_str(),
                    padoption );

    fprintf( m_fp, "ZMinThickness %s\n", fmtBIU( me->GetMinThickness() ).c_str() );

    fprintf( m_fp,  "ZOptions %d %d %c %s %s\n",
                    me->GetFillMode(),
3992
                    me->GetArcSegmentCount(),
3993 3994 3995 3996
                    me->IsFilled() ? 'S' : 'F',
                    fmtBIU( me->GetThermalReliefGap() ).c_str(),
                    fmtBIU( me->GetThermalReliefCopperBridge() ).c_str() );

3997 3998
    if( me->GetIsKeepout() )
    {
3999
        fprintf( m_fp,  "ZKeepout tracks %c vias %c copperpour %c\n",
4000 4001
                        me->GetDoNotAllowTracks() ? 'N' : 'Y',
                        me->GetDoNotAllowVias() ? 'N' : 'Y',
4002
                        me->GetDoNotAllowCopperPour() ? 'N' : 'Y' );
4003 4004
    }

4005 4006 4007 4008 4009
    fprintf( m_fp,  "ZSmoothing %d %s\n",
                    me->GetCornerSmoothingType(),
                    fmtBIU( me->GetCornerRadius() ).c_str() );

    // Save the corner list
4010
    const CPOLYGONS_LIST& cv = me->Outline()->m_CornersList;
4011

4012
    for( unsigned it = 0; it < cv.GetCornersCount(); ++it )
4013 4014
    {
        fprintf( m_fp,  "ZCorner %s %d\n",
4015 4016
                        fmtBIUPair( cv.GetX( it ), cv.GetY( it ) ).c_str(),
                        cv.IsEndContour( it ) );
4017 4018 4019
    }

    // Save the PolysList
4020
    const CPOLYGONS_LIST& fv = me->GetFilledPolysList();
4021
    if( fv.GetCornersCount() )
4022 4023 4024
    {
        fprintf( m_fp, "$POLYSCORNERS\n" );

4025
        for( unsigned it = 0; it < fv.GetCornersCount(); ++it )
4026 4027
        {
            fprintf( m_fp, "%s %d %d\n",
4028 4029 4030
                           fmtBIUPair( fv.GetX( it ), fv.GetY( it ) ).c_str(),
                           fv.IsEndContour( it ),
                           fv.GetUtility( it )  );
4031 4032 4033 4034 4035 4036 4037 4038
        }

        fprintf( m_fp, "$endPOLYSCORNERS\n" );
    }

    typedef std::vector< SEGMENT > SEGMENTS;

    // Save the filling segments list
4039 4040
    const SEGMENTS& segs = me->FillSegments();

4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060
    if( segs.size() )
    {
        fprintf( m_fp, "$FILLSEGMENTS\n" );

        for( SEGMENTS::const_iterator it = segs.begin();  it != segs.end();  ++it )
        {
            fprintf( m_fp, "%s %s\n",
                           fmtBIUPoint( it->m_Start ).c_str(),
                           fmtBIUPoint( it->m_End ).c_str() );
        }

        fprintf( m_fp, "$endFILLSEGMENTS\n" );
    }

    fprintf( m_fp, "$endCZONE_OUTLINE\n" );

    CHECK_WRITE_ERROR();
}


4061
void LEGACY_PLUGIN::saveDIMENSION( const DIMENSION* me ) const
4062 4063 4064 4065 4066 4067 4068
{
    // note: COTATION was the previous name of DIMENSION
    // this old keyword is used here for compatibility
    fprintf( m_fp, "$COTATION\n" );

    fprintf( m_fp, "Ge %d %d %lX\n", me->GetShape(), me->GetLayer(), me->GetTimeStamp() );

4069
    fprintf( m_fp, "Va %s\n", fmtBIU( me->GetValue() ).c_str() );
4070

4071 4072
    if( !me->GetText().IsEmpty() )
        fprintf( m_fp, "Te %s\n", EscapedUTF8( me->GetText() ).c_str() );
4073 4074 4075 4076
    else
        fprintf( m_fp, "Te \"?\"\n" );

    fprintf( m_fp,  "Po %s %s %s %s %d\n",
4077
                    fmtBIUPoint( me->Text().GetTextPosition() ).c_str(),
4078 4079 4080 4081
                    fmtBIUSize( me->Text().GetSize() ).c_str(),
                    fmtBIU( me->Text().GetThickness() ).c_str(),
                    fmtDEG( me->Text().GetOrientation() ).c_str(),
                    me->Text().IsMirrored() ? 0 : 1     // strange but true
4082 4083 4084
                    );

    fprintf( m_fp,  "Sb %d %s %s %s\n", S_SEGMENT,
4085 4086
                    fmtBIUPair( me->m_crossBarO.x, me->m_crossBarO.y ).c_str(),
                    fmtBIUPair( me->m_crossBarF.x, me->m_crossBarF.y ).c_str(),
4087 4088 4089
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "Sd %d %s %s %s\n", S_SEGMENT,
4090 4091
                    fmtBIUPair( me->m_featureLineDO.x, me->m_featureLineDO.y ).c_str(),
                    fmtBIUPair( me->m_featureLineDF.x, me->m_featureLineDF.y ).c_str(),
4092 4093 4094
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "Sg %d %s %s %s\n", S_SEGMENT,
4095 4096
                    fmtBIUPair( me->m_featureLineGO.x, me->m_featureLineGO.y ).c_str(),
                    fmtBIUPair( me->m_featureLineGF.x, me->m_featureLineGF.y ).c_str(),
4097 4098 4099
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "S1 %d %s %s %s\n", S_SEGMENT,
4100
                    fmtBIUPair( me->m_crossBarF.x, me->m_crossBarF.y ).c_str(),
4101
                    fmtBIUPair( me->m_arrowD1F.x, me->m_arrowD1F.y ).c_str(),
4102 4103 4104
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "S2 %d %s %s %s\n", S_SEGMENT,
4105
                    fmtBIUPair( me->m_crossBarF.x, me->m_crossBarF.y ).c_str(),
4106
                    fmtBIUPair( me->m_arrowD2F.x, me->m_arrowD2F.y ).c_str(),
4107 4108 4109
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "S3 %d %s %s %s\n", S_SEGMENT,
4110
                    fmtBIUPair( me->m_crossBarO.x, me->m_crossBarO.y ).c_str(),
4111
                    fmtBIUPair( me->m_arrowG1F.x, me->m_arrowG1F.y ).c_str(),
4112 4113 4114
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp,  "S4 %d %s %s %s\n", S_SEGMENT,
4115
                    fmtBIUPair( me->m_crossBarO.x, me->m_crossBarO.y ).c_str(),
4116
                    fmtBIUPair( me->m_arrowG2F.x, me->m_arrowG2F.y ).c_str(),
4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146
                    fmtBIU( me->GetWidth() ).c_str() );

    fprintf( m_fp, "$endCOTATION\n" );

    CHECK_WRITE_ERROR();
}


void LEGACY_PLUGIN::savePCB_TEXT( const TEXTE_PCB* me ) const
{
    if( me->GetText().IsEmpty() )
        return;

    fprintf( m_fp, "$TEXTPCB\n" );

    wxArrayString* list = wxStringSplit( me->GetText(), '\n' );

    for( unsigned ii = 0; ii < list->Count(); ii++ )
    {
        wxString txt  = list->Item( ii );

        if ( ii == 0 )
            fprintf( m_fp, "Te %s\n", EscapedUTF8( txt ).c_str() );
        else
            fprintf( m_fp, "nl %s\n", EscapedUTF8( txt ).c_str() );
    }

    delete list;

    fprintf( m_fp,  "Po %s %s %s %s\n",
4147
                    fmtBIUPoint( me->GetTextPosition() ).c_str(),
4148 4149 4150 4151
                    fmtBIUSize( me->GetSize() ).c_str(),
                    fmtBIU( me->GetThickness() ).c_str(),
                    fmtDEG( me->GetOrientation() ).c_str() );

4152
    fprintf( m_fp,  "De %d %d %lX %s",
4153 4154 4155
                    me->GetLayer(),
                    !me->IsMirrored(),
                    me->GetTimeStamp(),
4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167
                    me->IsItalic() ? "Italic" : "Normal" );

    if( me->GetHorizJustify() != GR_TEXT_HJUSTIFY_CENTER ||
        me->GetVertJustify()  != GR_TEXT_VJUSTIFY_CENTER )
    {
        fprintf( m_fp,  " %s %s\n",
                        ShowHorizJustify( me->GetHorizJustify() ),
                        ShowVertJustify( me->GetVertJustify() )
                        );
    }
    else
        fprintf( m_fp, "\n" );
4168 4169 4170

    fprintf( m_fp, "$EndTEXTPCB\n" );
}
4171

Dick Hollenbeck's avatar
Dick Hollenbeck committed
4172 4173
#endif  // NO LEGACY_PLUGIN::Save()

4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185

//-----<FOOTPRINT LIBRARY FUNCTIONS>--------------------------------------------

/*

    The legacy file format is being obsoleted and this code will have a short
    lifetime, so it only needs to be good enough for a short duration of time.
    Caching all the MODULEs is a bit memory intensive, but it is a considerably
    faster way of fulfilling the API contract. Otherwise, without the cache, you
    would have to re-read the file when searching for any MODULE, and this would
    be very problematic filling a FOOTPRINT_LIST via this PLUGIN API. If memory
    becomes a concern, consider the cache lifetime policy, which determines the
4186
    time that a LP_CACHE is in RAM. Note PLUGIN lifetime also plays a role in
4187 4188 4189 4190 4191 4192
    cache lifetime.

*/


#include <boost/ptr_container/ptr_map.hpp>
4193
#include <wx/filename.h>
4194

4195
typedef boost::ptr_map< std::string, MODULE >   MODULE_MAP;
4196 4197 4198 4199 4200
typedef MODULE_MAP::iterator                    MODULE_ITER;
typedef MODULE_MAP::const_iterator              MODULE_CITER;


/**
4201
 * Class LP_CACHE
4202 4203 4204 4205
 * assists only for the footprint portion of the PLUGIN API, and only for the
 * LEGACY_PLUGIN, so therefore is private to this implementation file, i.e. not placed
 * into a header.
 */
4206
struct LP_CACHE
4207
{
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4208
    LEGACY_PLUGIN*  m_owner;        // my owner, I need its LEGACY_PLUGIN::loadMODULE()
4209
    wxString        m_lib_path;
4210
    wxDateTime      m_mod_time;
4211
    MODULE_MAP      m_modules;      // map or tuple of footprint_name vs. MODULE*
4212 4213
    bool            m_writable;

4214
    LP_CACHE( LEGACY_PLUGIN* aOwner, const wxString& aLibraryPath );
4215

4216 4217
    // Most all functions in this class throw IO_ERROR exceptions.  There are no
    // error codes nor user interface calls from here, nor in any PLUGIN.
4218 4219
    // Catch these exceptions higher up please.

4220
    /// save the entire legacy library to m_lib_path;
4221 4222 4223 4224 4225 4226 4227 4228
    void Save();

    void SaveHeader( FILE* aFile );

    void SaveIndex( FILE* aFile );

    void SaveModules( FILE* aFile );

4229 4230 4231 4232
    void SaveEndOfFile( FILE* aFile )
    {
        fprintf( aFile, "$EndLIBRARY\n" );
    }
4233

4234
    void Load();
4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245

    void ReadAndVerifyHeader( LINE_READER* aReader );

    void SkipIndex( LINE_READER* aReader );

    void LoadModules( LINE_READER* aReader );

    wxDateTime  GetLibModificationTime();
};


4246
LP_CACHE::LP_CACHE( LEGACY_PLUGIN* aOwner, const wxString& aLibraryPath ) :
4247
    m_owner( aOwner ),
4248
    m_lib_path( aLibraryPath ),
4249
    m_writable( true )
4250 4251 4252 4253
{
}


4254
wxDateTime LP_CACHE::GetLibModificationTime()
4255
{
4256
    wxFileName  fn( m_lib_path );
4257

4258 4259
    // update the writable flag while we have a wxFileName, in a network this
    // is possibly quite dynamic anyway.
4260 4261 4262 4263 4264 4265
    m_writable = fn.IsFileWritable();

    return fn.GetModificationTime();
}


4266
void LP_CACHE::Load()
4267
{
4268
    FILE_LINE_READER    reader( m_lib_path );
4269 4270 4271 4272

    ReadAndVerifyHeader( &reader );
    SkipIndex( &reader );
    LoadModules( &reader );
4273 4274 4275 4276 4277 4278 4279 4280

    // Remember the file modification time of library file when the
    // cache snapshot was made, so that in a networked environment we will
    // reload the cache as needed.
    m_mod_time = GetLibModificationTime();
}


4281
void LP_CACHE::ReadAndVerifyHeader( LINE_READER* aReader )
4282
{
4283
    char* line = aReader->ReadLine();
4284
    char* saveptr;
4285

4286
    if( !line )
4287 4288 4289 4290 4291
        goto L_bad_library;

    if( !TESTLINE( "PCBNEW-LibModule-V1" ) )
        goto L_bad_library;

4292
    while( ( line = aReader->ReadLine() ) != NULL )
4293
    {
4294 4295
        if( TESTLINE( "Units" ) )
        {
4296
            const char* units = strtok_r( line + SZ( "Units" ), delims, &saveptr );
4297

4298 4299
            if( !strcmp( units, "mm" ) )
            {
4300
                m_owner->diskToBiu = IU_PER_MM;
4301 4302 4303 4304 4305 4306 4307 4308
            }

        }
        else if( TESTLINE( "$INDEX" ) )
            return;
    }

L_bad_library:
4309
    THROW_IO_ERROR( wxString::Format( _( "File '%s' is empty or is not a legacy library" ),
4310
        m_lib_path.GetData() ) );
4311 4312 4313
}


4314
void LP_CACHE::SkipIndex( LINE_READER* aReader )
4315 4316 4317 4318
{
    // Some broken INDEX sections have more than one section, due to prior bugs.
    // So we must read the next line after $EndINDEX tag,
    // to see if this is not a new $INDEX tag.
4319 4320
    bool    exit = false;
    char*   line = aReader->Line();
4321

4322
    do
4323 4324 4325 4326 4327
    {
        if( TESTLINE( "$INDEX" ) )
        {
            exit = false;

4328
            while( ( line = aReader->ReadLine() ) != NULL )
4329 4330 4331 4332 4333 4334 4335 4336 4337 4338
            {
                if( TESTLINE( "$EndINDEX" ) )
                {
                    exit = true;
                    break;
                }
            }
        }
        else if( exit )
            break;
4339
    } while( ( line = aReader->ReadLine() ) != NULL );
4340 4341 4342
}


4343
void LP_CACHE::LoadModules( LINE_READER* aReader )
4344 4345 4346
{
    m_owner->SetReader( aReader );

4347 4348
    char*   line = aReader->Line();

4349 4350 4351 4352 4353
    do
    {
        // test first for the $MODULE, even before reading because of INDEX bug.
        if( TESTLINE( "$MODULE" ) )
        {
4354 4355 4356 4357
            auto_ptr<MODULE>    module( new MODULE( m_owner->m_board ) );

            std::string         footprintName = StrPurge( line + SZ( "$MODULE" ) );

4358 4359 4360 4361
            // The footprint names in legacy libraries can contain the '/' and ':'
            // characters which will cause the FPID parser to choke.
            ReplaceIllegalFileNameChars( &footprintName );

4362
            // set the footprint name first thing, so exceptions can use name.
4363
            module->SetFPID( FPID( footprintName ) );
4364 4365 4366 4367 4368 4369 4370 4371 4372 4373

#if 0 && defined( DEBUG )
            printf( "%s\n", footprintName.c_str() );
            if( footprintName == "QFN40" )
            {
                int breakhere = 1;
                (void) breakhere;
            }
#endif

Dick Hollenbeck's avatar
Dick Hollenbeck committed
4374
            m_owner->loadMODULE( module.get() );
4375 4376

            MODULE* m = module.release();   // exceptions after this are not expected.
4377

4378 4379 4380
            // Not sure why this is asserting on debug builds.  The debugger shows the
            // strings are the same.  If it's not really needed maybe it can be removed.
//            wxASSERT( footprintName == m->GetFPID().GetFootprintName() );
4381

4382
            /*
4383

4384 4385 4386 4387 4388 4389 4390 4391
            There was a bug in old legacy library management code
            (pre-LEGACY_PLUGIN) which was introducing duplicate footprint names
            in legacy libraries without notification. To best recover from such
            bad libraries, and use them to their fullest, there are a few
            strategies that could be used. (Note: footprints must have unique
            names to be accepted into this cache.) The strategy used here is to
            append a differentiating version counter to the end of the name as:
            _v2, _v3, etc.
4392

4393 4394 4395 4396 4397
            */

            MODULE_CITER it = m_modules.find( footprintName );

            if( it == m_modules.end() )  // footprintName is not present in cache yet.
4398
            {
4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410
                std::pair<MODULE_ITER, bool> r = m_modules.insert( footprintName, m );

                wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
                (void) r;
            }

            // Bad library has a duplicate of this footprintName, generate a
            // unique footprint name and load it anyway.
            else
            {
                bool    nameOK = false;
                int     version = 2;
4411
                char    buf[48];
4412 4413 4414

                while( !nameOK )
                {
4415 4416 4417 4418 4419
                    std::string newName = footprintName;

                    newName += "_v";
                    sprintf( buf, "%d", version++ );
                    newName += buf;
4420 4421 4422 4423 4424 4425 4426

                    it = m_modules.find( newName );

                    if( it == m_modules.end() )
                    {
                        nameOK = true;

4427
                        m->SetFPID( FPID( newName ) );
4428 4429 4430 4431 4432 4433
                        std::pair<MODULE_ITER, bool> r = m_modules.insert( newName, m );

                        wxASSERT_MSG( r.second, wxT( "error doing cache insert using guaranteed unique name" ) );
                        (void) r;
                    }
                }
4434 4435 4436
            }
        }

4437
    } while( ( line = aReader->ReadLine() ) != NULL );
4438 4439 4440
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
4441
#if 0
4442
void LP_CACHE::Save()
4443 4444 4445 4446
{
    if( !m_writable )
    {
        THROW_IO_ERROR( wxString::Format(
4447
            _( "Legacy library file '%s' is read only" ), m_lib_path.GetData() ) );
4448 4449
    }

4450
    wxString tempFileName;
4451

4452
    // a block {} scope to fire wxFFile wxf()'s destructor
4453
    {
4454
        // CreateTempFileName works better with an absolute path
4455
        wxFileName abs_lib_name( m_lib_path );
4456 4457 4458 4459

        abs_lib_name.MakeAbsolute();
        tempFileName = wxFileName::CreateTempFileName( abs_lib_name.GetFullPath() );

4460
        //wxLogDebug( wxT( "tempFileName:'%s'  m_lib_path:'%s'\n" ), TO_UTF8( tempFileName ), TO_UTF8( m_lib_path ) );
4461

4462 4463 4464 4465
        FILE* fp = wxFopen( tempFileName, wxT( "w" ) );
        if( !fp )
        {
            THROW_IO_ERROR( wxString::Format(
4466
                _( "Unable to open or create legacy library file '%s'" ),
4467
                m_lib_path.GetData() ) );
4468
        }
4469

4470 4471 4472 4473 4474
        // wxf now owns fp, will close on exception or exit from
        // this block {} scope
        wxFFile wxf( fp );

        SaveHeader( fp );
4475
        SaveIndex( fp );
4476 4477 4478
        SaveModules( fp );
        SaveEndOfFile( fp );
    }
4479

4480
    // fp is now closed here, and that seems proper before trying to rename
4481
    // the temporary file to m_lib_path.
4482

4483
    wxRemove( m_lib_path );     // it is not an error if this does not exist
4484

4485 4486 4487 4488
    // Even on linux you can see an _intermittent_ error when calling wxRename(),
    // and it is fully inexplicable.  See if this dodges the error.
    wxMilliSleep( 250L );

4489
    if( wxRename( tempFileName, m_lib_path ) )
4490 4491
    {
        THROW_IO_ERROR( wxString::Format(
4492
            _( "Unable to rename tempfile '%s' to library file '%s'" ),
4493
            tempFileName.GetData(),
4494
            m_lib_path.GetData() ) );
4495
    }
4496 4497 4498
}


4499
void LP_CACHE::SaveHeader( FILE* aFile )
4500 4501 4502
{
    fprintf( aFile, "%s  %s\n", FOOTPRINT_LIBRARY_HEADER, TO_UTF8( DateAndTime() ) );
    fprintf( aFile, "# encoding utf-8\n" );
4503
    fprintf( aFile, "Units mm\n" );
4504 4505 4506
}


4507
void LP_CACHE::SaveIndex( FILE* aFile )
4508 4509 4510 4511 4512
{
    fprintf( aFile, "$INDEX\n" );

    for( MODULE_CITER it = m_modules.begin();  it != m_modules.end();  ++it )
    {
4513
        fprintf( aFile, "%s\n", it->first.c_str() );
4514 4515 4516 4517 4518 4519
    }

    fprintf( aFile, "$EndINDEX\n" );
}


4520
void LP_CACHE::SaveModules( FILE* aFile )
4521
{
4522 4523 4524 4525
    m_owner->SetFilePtr( aFile );

    for( MODULE_CITER it = m_modules.begin();  it != m_modules.end();  ++it )
    {
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4526
        m_owner->saveMODULE( it->second );
4527
    }
4528
}
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4529
#endif
4530 4531 4532

void LEGACY_PLUGIN::cacheLib( const wxString& aLibraryPath )
{
4533
    if( !m_cache || m_cache->m_lib_path != aLibraryPath ||
4534
        // somebody else on a network touched the library:
4535 4536
        m_cache->m_mod_time != m_cache->GetLibModificationTime() )
    {
4537
        // a spectacular episode in memory management:
4538
        delete m_cache;
4539
        m_cache = new LP_CACHE( this, aLibraryPath );
4540
        m_cache->Load();
4541 4542 4543 4544
    }
}


4545
wxArrayString LEGACY_PLUGIN::FootprintEnumerate( const wxString& aLibraryPath, const PROPERTIES* aProperties )
4546
{
4547
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.
4548 4549 4550 4551 4552 4553 4554

    init( aProperties );

    cacheLib( aLibraryPath );

    const MODULE_MAP&   mods = m_cache->m_modules;

4555 4556
    wxArrayString   ret;

4557 4558
    for( MODULE_CITER it = mods.begin();  it != mods.end();  ++it )
    {
4559
        ret.Add( FROM_UTF8( it->first.c_str() ) );
4560 4561 4562 4563 4564 4565
    }

    return ret;
}


4566 4567
MODULE* LEGACY_PLUGIN::FootprintLoad( const wxString& aLibraryPath,
        const wxString& aFootprintName, const PROPERTIES* aProperties )
4568
{
4569 4570
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.

4571 4572 4573 4574 4575 4576
    init( aProperties );

    cacheLib( aLibraryPath );

    const MODULE_MAP&   mods = m_cache->m_modules;

4577
    MODULE_CITER it = mods.find( TO_UTF8( aFootprintName ) );
4578 4579 4580

    if( it == mods.end() )
    {
4581
        /*
4582 4583
        THROW_IO_ERROR( wxString::Format( _( "No '%s' footprint in library '%s'" ),
            aFootprintName.GetData(), aLibraryPath.GetData() ) );
4584 4585 4586
        */

        return NULL;
4587 4588 4589 4590 4591 4592 4593
    }

    // copy constructor to clone the already loaded MODULE
    return new MODULE( *it->second );
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
4594 4595
#if 0   // omit FootprintSave()

4596 4597
void LEGACY_PLUGIN::FootprintSave( const wxString& aLibraryPath,
        const MODULE* aFootprint, const PROPERTIES* aProperties )
4598
{
4599 4600
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.

4601 4602 4603 4604 4605 4606
    init( aProperties );

    cacheLib( aLibraryPath );

    if( !m_cache->m_writable )
    {
4607
        THROW_IO_ERROR( wxString::Format( _( "Library '%s' is read only" ), aLibraryPath.GetData() ) );
4608 4609
    }

4610
    std::string footprintName = aFootprint->GetFPID().GetFootprintName();
4611 4612 4613 4614

    MODULE_MAP&  mods = m_cache->m_modules;

    // quietly overwrite any by same name.
4615
    MODULE_CITER it = mods.find( footprintName );
4616 4617
    if( it != mods.end() )
    {
4618
        mods.erase( footprintName );
4619 4620
    }

4621 4622 4623 4624 4625
    // I need my own copy for the cache
    MODULE* my_module = new MODULE( *aFootprint );

    // and it's time stamp must be 0, it should have no parent, orientation should
    // be zero, and it should be on the front layer.
4626

4627 4628 4629 4630 4631
    my_module->SetTimeStamp( 0 );
    my_module->SetParent( 0 );

    my_module->SetOrientation( 0 );

Dick Hollenbeck's avatar
Dick Hollenbeck committed
4632
    if( my_module->GetLayer() != F_Cu )
4633 4634 4635
        my_module->Flip( my_module->GetPosition() );

    mods.insert( footprintName, my_module );
4636 4637 4638 4639 4640

    m_cache->Save();
}


4641 4642
void LEGACY_PLUGIN::FootprintDelete( const wxString& aLibraryPath,
        const wxString& aFootprintName, const PROPERTIES* aProperties )
4643
{
4644 4645
    LOCALE_IO   toggle;     // toggles on, then off, the C locale.

4646 4647 4648 4649 4650 4651
    init( NULL );

    cacheLib( aLibraryPath );

    if( !m_cache->m_writable )
    {
4652
        THROW_IO_ERROR( wxString::Format( _( "Library '%s' is read only" ), aLibraryPath.GetData() ) );
4653 4654
    }

4655 4656 4657
    std::string footprintName = TO_UTF8( aFootprintName );

    size_t erasedCount = m_cache->m_modules.erase( footprintName );
4658 4659 4660 4661

    if( erasedCount != 1 )
    {
        THROW_IO_ERROR( wxString::Format(
4662
            _( "library '%s' has no footprint '%s' to delete" ),
4663 4664 4665 4666 4667 4668 4669
            aLibraryPath.GetData(), aFootprintName.GetData() ) );
    }

    m_cache->Save();
}


4670
void LEGACY_PLUGIN::FootprintLibCreate( const wxString& aLibraryPath, const PROPERTIES* aProperties )
4671
{
4672 4673 4674
    if( wxFileExists( aLibraryPath ) )
    {
        THROW_IO_ERROR( wxString::Format(
4675
            _( "library '%s' already exists, will not create a new" ),
4676 4677 4678 4679 4680 4681 4682 4683
            aLibraryPath.GetData() ) );
    }

    LOCALE_IO   toggle;

    init( NULL );

    delete m_cache;
4684
    m_cache = new LP_CACHE( this, aLibraryPath );
4685 4686 4687 4688
    m_cache->Save();
    m_cache->Load();    // update m_writable and m_mod_time
}

Dick Hollenbeck's avatar
Dick Hollenbeck committed
4689 4690
#endif  // omit FootprintSave()

4691

4692
bool LEGACY_PLUGIN::FootprintLibDelete( const wxString& aLibraryPath, const PROPERTIES* aProperties )
4693 4694 4695 4696
{
    wxFileName fn = aLibraryPath;

    if( !fn.FileExists() )
4697
        return false;
4698 4699 4700 4701 4702 4703

    // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
    // we don't want that.  we want bare metal portability with no UI here.
    if( wxRemove( aLibraryPath ) )
    {
        THROW_IO_ERROR( wxString::Format(
4704
            _( "library '%s' cannot be deleted" ),
4705 4706
            aLibraryPath.GetData() ) );
    }
4707

4708
    if( m_cache && m_cache->m_lib_path == aLibraryPath )
4709 4710 4711 4712
    {
        delete m_cache;
        m_cache = 0;
    }
4713 4714

    return true;
4715 4716 4717 4718 4719
}


bool LEGACY_PLUGIN::IsFootprintLibWritable( const wxString& aLibraryPath )
{
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4720 4721 4722
#if 0   // no support for 32 Cu layers in legacy format
    return false;
#else
4723 4724
    LOCALE_IO   toggle;

4725 4726 4727 4728 4729
    init( NULL );

    cacheLib( aLibraryPath );

    return m_cache->m_writable;
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4730
#endif
4731 4732 4733
}


Dick Hollenbeck's avatar
Dick Hollenbeck committed
4734
LEGACY_PLUGIN::LEGACY_PLUGIN() :
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4735
    m_cu_count( 16 ),               // for FootprintLoad()
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4736 4737 4738 4739
    m_board( 0 ),
    m_props( 0 ),
    m_reader( 0 ),
    m_fp( 0 ),
4740 4741
    m_cache( 0 ),
    m_mapping( new NETINFO_MAPPING() )
Dick Hollenbeck's avatar
Dick Hollenbeck committed
4742 4743 4744 4745 4746
{
    init( NULL );
}


4747 4748 4749
LEGACY_PLUGIN::~LEGACY_PLUGIN()
{
    delete m_cache;
4750
    delete m_mapping;
4751
}