idf_outlines.cpp 100 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014  Cirilo Bernardo
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#include <iostream>
#include <iomanip>
#include <sstream>
#include <cmath>

#include <idf_helpers.h>
#include <idf_outlines.h>
#include <idf_parser.h>

using namespace IDF3;
using namespace std;


37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
static std::string GetOutlineTypeString( IDF3::OUTLINE_TYPE aOutlineType )
{
    switch( aOutlineType )
    {
        case OTLN_BOARD:
            return ".BOARD_OUTLINE";

        case OTLN_OTHER:
            return ".OTHER_OUTLINE";

        case OTLN_PLACE:
            return ".PLACEMENT_OUTLINE";

        case OTLN_ROUTE:
            return ".ROUTE_OUTLINE";

        case OTLN_PLACE_KEEPOUT:
            return ".PLACE_KEEPOUT";

        case OTLN_ROUTE_KEEPOUT:
            return ".ROUTE_KEEPOUT";

        case OTLN_VIA_KEEPOUT:
            return ".VIA_KEEPOUT";

        case OTLN_GROUP_PLACE:
            return ".PLACE_REGION";

        case OTLN_COMPONENT:
            return "COMPONENT OUTLINE";

        default:
            break;
    }

    std::ostringstream ostr;
    ostr << "[INVALID OUTLINE TYPE VALUE]:" << aOutlineType;

    return ostr.str();
}

#ifndef DISABLE_IDF_OWNERSHIP
static bool CheckOwnership( int aSourceLine, const char* aSourceFunc,
                            IDF3_BOARD* aParent, IDF3::KEY_OWNER aOwnerCAD,
                            IDF3::OUTLINE_TYPE aOutlineType, std::string& aErrorString )
{
    if( aParent == NULL )
    {
        ostringstream ostr;
        ostr << "* " << __FILE__ << ":" << aSourceLine << ":" << aSourceFunc << "():\n";
        ostr << "* BUG: outline's parent not set; cannot enforce ownership rules\n";
        ostr << "* outline type: " << GetOutlineTypeString( aOutlineType );
        aErrorString = ostr.str();

        return false;
    }

    // note: component outlines have no owner so we don't care about
    // who modifies them
    if( aOwnerCAD == UNOWNED || aOutlineType == IDF3::OTLN_COMPONENT )
        return true;

    IDF3::CAD_TYPE parentCAD = aParent->GetCadType();

    if( aOwnerCAD == MCAD && parentCAD == CAD_MECH )
        return true;

    if( aOwnerCAD == ECAD && parentCAD == CAD_ELEC )
        return true;

    do
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << aSourceLine << ":" << aSourceFunc << "():\n";
        ostr << "* ownership violation; CAD type is ";

        if( parentCAD == CAD_MECH )
            ostr << "MCAD ";
        else
            ostr << "ECAD ";

        ostr << "while outline owner is " << GetOwnerString( aOwnerCAD ) << "\n";
        ostr << "* outline type: " << GetOutlineTypeString( aOutlineType );
        aErrorString = ostr.str();

    } while( 0 );

    return false;
}
#endif


129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
/*
 * CLASS: BOARD OUTLINE
 */
BOARD_OUTLINE::BOARD_OUTLINE()
{
    outlineType = OTLN_BOARD;
    single = false;
    owner = UNOWNED;
    parent = NULL;
    thickness = 0.0;
    unit = UNIT_MM;
    return;
}

BOARD_OUTLINE::~BOARD_OUTLINE()
{
145
    clear();
146 147 148 149 150 151 152 153
    return;
}

IDF3::OUTLINE_TYPE BOARD_OUTLINE::GetOutlineType( void )
{
    return outlineType;
}

154
void BOARD_OUTLINE::readOutlines( std::ifstream& aBoardFile, IDF3::IDF_VERSION aIdfVersion )
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
{
    // reads the outline data from a file
    double x, y, ang;
    double dLoc  = 1e-5;    // distances are equal when closer than 0.1 micron
    bool comment = false;
    bool quoted  = false;
    bool closed  = false;
    int idx      = 0;
    int loopidx  = -1;
    int tmp      = 0;
    int npts     = 0;
    std::string iline;
    std::string entry;
    std::stringstream tstr;
    IDF_OUTLINE* op = NULL;
    IDF_SEGMENT* sp = NULL;
    IDF_POINT prePt;
    IDF_POINT curPt;
    std::streampos pos;

    // destroy any existing outline data
176
    clearOutlines();
177 178 179 180 181 182 183 184 185 186 187

    while( aBoardFile.good() )
    {
        if( !FetchIDFLine( aBoardFile, iline, comment, pos ) )
            continue;

        idx = 0;
        GetIDFString( iline, entry, quoted, idx );

        if( quoted )
        {
188 189 190 191 192 193 194
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
            ostr << " is quoted\n";
            ostr << "* line: '" << iline << "'";

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
195 196 197 198 199 200 201 202
        }

        // check for the end of the section
        if( entry.size() >= 5 && CompareToken( ".END_", entry.substr( 0, 5 ) ) )
        {
            // rewind to the start of the last line; the routine invoking
            // this is responsible for checking that the current '.END_ ...'
            // matches the section header.
203 204 205
            if(aBoardFile.eof())
                aBoardFile.clear();

206 207 208 209 210 211
            aBoardFile.seekg( pos );

            if( outlines.size() > 0 )
            {
                if( npts > 0 && !closed )
                {
212 213 214 215 216
                    ostringstream ostr;
                    ostr << "invalid outline (not closed)\n";
                    ostr << "* file position: " << pos;

                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
217 218 219 220 221 222 223 224
                }

                // verify winding
                if( !single )
                {
                    if( !outlines.front()->IsCCW() )
                    {
                        ERROR_IDF << "invalid IDF3 file (BOARD_OUTLINE)\n";
225 226
                        cerr << "* WARNING: first outline is not in CCW order\n";
                        return;
227 228 229 230 231
                    }

                    if( outlines.size() > 1 && outlines.back()->IsCCW() && !outlines.back()->IsCircle() )
                    {
                        ERROR_IDF << "invalid IDF3 file (BOARD_OUTLINE)\n";
232 233 234
                        cerr << "* WARNING: final cutout does not have points in CW order\n";
                        cerr << "* file position: " << pos << "\n";
                        return;
235 236 237 238
                    }
                }
            }

239
            return;
240 241 242 243 244 245 246 247 248 249 250
        }

        tstr.clear();
        tstr << entry;

        tstr >> tmp;
        if( tstr.fail() )
        {
            if( outlineType == OTLN_COMPONENT && CompareToken( "PROP", entry ) )
            {
                aBoardFile.seekg( pos );
251
                return;
252 253
            }

254 255 256 257 258 259 260 261 262 263 264
            do{
                ostringstream ostr;

                ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
                ostr << " is not numeric\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );

            } while( 0 );
265 266 267 268 269
        }

        if( tmp != loopidx )
        {
            // index change
270 271 272 273 274 275 276 277
            if( npts > 0 && !closed )
            {
                ostringstream ostr;
                ostr << "invalid outline ( outline # " << loopidx << " not closed)\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            }
278 279 280

            if( tmp < 0 )
            {
281 282 283 284 285 286 287 288
                ostringstream ostr;

                ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
                ostr << " is invalid\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
289 290 291 292 293 294 295 296 297 298 299
            }

            if( loopidx == -1 )
            {
                // first outline
                if( single )
                {
                    // outline may have a Loop Index of 0 or 1
                    if( tmp == 0 || tmp == 1 )
                    {
                        op = new IDF_OUTLINE;
300

301 302
                        if( op == NULL )
                        {
303 304 305
                            clearOutlines();
                            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                                              "memory allocation failed" ) );
306
                        }
307

308 309 310 311 312
                        outlines.push_back( op );
                        loopidx = tmp;
                    }
                    else
                    {
313 314 315 316 317 318 319 320
                        ostringstream ostr;

                        ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
                        ostr << " is invalid (must be 0 or 1)\n";
                        ostr << "* line: '" << iline << "'\n";
                        ostr << "* file position: " << pos;

                        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
321 322 323 324 325 326 327
                    }
                }
                else
                {
                    // outline *MUST* have a Loop Index of 0
                    if( tmp != 0 )
                    {
328 329 330 331 332 333 334 335
                        ostringstream ostr;

                        ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
                        ostr << " is invalid (must be 0)\n";
                        ostr << "* line: '" << iline << "'\n";
                        ostr << "* file position: " << pos;

                        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
336 337 338 339 340 341
                    }

                    op = new IDF_OUTLINE;

                    if( op == NULL )
                    {
342 343 344
                        clearOutlines();
                        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                                          "memory allocation failed" ) );
345 346 347 348 349 350 351 352 353 354 355 356
                    }

                    outlines.push_back( op );
                    loopidx = tmp;
                }
                // end of block for first outline
            }
            else
            {
                // outline for cutout
                if( single )
                {
357 358 359 360 361 362 363 364
                    ostringstream ostr;

                    ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType );
                    ostr << " section may only have one outline\n";
                    ostr << "* line: '" << iline << "'\n";
                    ostr << "* file position: " << pos;

                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
365 366 367 368
                }

                if( tmp - loopidx != 1 )
                {
369 370 371 372 373 374 375 376
                    ostringstream ostr;

                    ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType );
                    ostr << " section must have cutouts in numeric order from 1 onwards\n";
                    ostr << "* line: '" << iline << "'\n";
                    ostr << "* file position: " << pos;

                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
377 378 379 380 381 382
                }

                // verify winding of previous outline
                if( ( loopidx = 0 && !op->IsCCW() )
                    || ( loopidx > 0 && op->IsCCW() ) )
                {
383 384 385 386 387 388 389 390
                    ostringstream ostr;

                    ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
                    ostr << "* violation of loop point order rules by Loop Index " << loopidx << "\n";
                    ostr << "* line: '" << iline << "'\n";
                    ostr << "* file position: " << pos;

                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
391 392 393 394 395 396
                }

                op = new IDF_OUTLINE;

                if( op == NULL )
                {
397 398 399
                    clearOutlines();
                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                                      "memory allocation failed" ) );
400 401 402 403 404 405 406 407 408 409 410 411
                }

                outlines.push_back( op );
                loopidx = tmp;
            }
            // end of index change code
            npts = 0;
            closed = false;
        }

        if( op == NULL )
        {
412 413 414 415 416 417 418 419
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 1 of " << GetOutlineTypeString( outlineType );
            ostr << " is invalid\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
420 421 422 423
        }

        if( !GetIDFString( iline, entry, quoted, idx ) )
        {
424 425 426 427 428 429 430 431
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 2 of ";
            ostr << GetOutlineTypeString( outlineType ) << " does not exist\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
432 433 434 435
        }

        if( quoted )
        {
436 437 438 439 440 441 442 443
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 2 of ";
            ostr << GetOutlineTypeString( outlineType ) << " must not be in quotes\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
444 445 446 447 448 449 450 451
        }

        tstr.clear();
        tstr << entry;

        tstr >> x;
        if( tstr.fail() )
        {
452 453 454 455 456 457 458 459
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 2 of ";
            ostr << GetOutlineTypeString( outlineType ) << " is an invalid X value\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
460 461 462 463
        }

        if( !GetIDFString( iline, entry, quoted, idx ) )
        {
464 465 466 467 468 469 470 471
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 3 of ";
            ostr << GetOutlineTypeString( outlineType ) << " does not exist\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
472 473 474 475
        }

        if( quoted )
        {
476 477 478 479 480 481 482 483
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 3 of ";
            ostr << GetOutlineTypeString( outlineType ) << " must not be in quotes\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
484 485 486 487 488 489 490 491
        }

        tstr.clear();
        tstr << entry;

        tstr >> y;
        if( tstr.fail() )
        {
492 493 494 495 496 497 498 499
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 3 of ";
            ostr << GetOutlineTypeString( outlineType ) << " is an invalid Y value\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
500 501 502 503
        }

        if( !GetIDFString( iline, entry, quoted, idx ) )
        {
504 505 506 507 508 509 510 511
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 4 of ";
            ostr << GetOutlineTypeString( outlineType ) << " does not exist\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
512 513 514 515
        }

        if( quoted )
        {
516 517 518 519 520 521 522 523
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 4 of ";
            ostr << GetOutlineTypeString( outlineType ) << " must not be in quotes\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
524 525 526 527 528 529 530 531
        }

        tstr.clear();
        tstr << entry;

        tstr >> ang;
        if( tstr.fail() )
        {
532 533 534 535 536 537 538 539
            ostringstream ostr;

            ostr << "\n* invalid outline: RECORD 3, FIELD 4 of ";
            ostr << GetOutlineTypeString( outlineType ) << " is not a valid angle\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
540 541 542 543 544
        }

        // the line was successfully read; convert to mm if necessary
        if( unit == UNIT_THOU )
        {
545 546 547 548 549 550 551 552 553 554 555 556 557 558
            x *= IDF_THOU_TO_MM;
            y *= IDF_THOU_TO_MM;
        }
        else if( ( aIdfVersion == IDF_V2 ) && ( unit == UNIT_TNM ) )
        {
            x *= IDF_TNM_TO_MM;
            y *= IDF_TNM_TO_MM;
        }
        else if( unit != UNIT_MM )
        {
            ostringstream ostr;
            ostr << "\n* BUG: invalid UNIT type: " << unit;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
559 560 561 562 563 564 565 566 567 568 569
        }

        if( npts++ == 0 )
        {
            // first point
            prePt.x = x;
            prePt.y = y;

            // ensure that the first point is not an arc specification
            if( ang < -MIN_ANG || ang > MIN_ANG )
            {
570 571 572 573 574 575 576 577 578
                ostringstream ostr;

                ostr << "\n* invalid outline: RECORD 3 of ";
                ostr << GetOutlineTypeString( outlineType ) << "\n";
                ostr << "* violation: first point of an outline has a non-zero angle\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
579 580 581 582 583 584 585
            }
        }
        else
        {
            // Nth point
            if( closed )
            {
586 587 588 589 590 591 592 593 594
                ostringstream ostr;

                ostr << "\n* invalid outline: RECORD 3 of ";
                ostr << GetOutlineTypeString( outlineType ) << "\n";
                ostr << "* violation: adding a segment to a closed outline\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
            }

            curPt.x = x;
            curPt.y = y;

            if( ang > -MIN_ANG && ang < MIN_ANG )
            {
                sp = new IDF_SEGMENT( prePt, curPt );
            }
            else
            {
                sp = new IDF_SEGMENT( prePt, curPt, ang, false );
            }

            if( sp == NULL )
            {
611 612 613
                clearOutlines();
                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                                  "memory allocation failed" ) );
614 615 616 617 618 619 620 621
            }

            if( sp->IsCircle() )
            {
                // this is  a circle; the loop is closed
                if( op->size() != 0 )
                {
                    delete sp;
622 623 624 625 626 627 628 629 630 631

                    ostringstream ostr;

                    ostr << "\n* invalid outline: RECORD 3 of ";
                    ostr << GetOutlineTypeString( outlineType ) << "\n";
                    ostr << "* violation: adding a circle to a non-empty outline\n";
                    ostr << "* line: '" << iline << "'\n";
                    ostr << "* file position: " << pos;

                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
                }

                closed = true;
            }
            else if( op->size() != 0 )
            {
                if( curPt.Matches( op->front()->startPoint, dLoc ) )
                    closed = true;
            }

            op->push( sp );
            prePt.x = x;
            prePt.y = y;
        }
    }   //  while( aBoardFile.good() )

    // NOTE:
649
    // 1. ideally we would ensure that there are no arcs with a radius of 0
650

651 652 653 654
    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                      "problems reading file (premature end of outline)" ) );

    return;
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
}

bool BOARD_OUTLINE::writeComments( std::ofstream& aBoardFile )
{
    if( comments.empty() )
        return true;

    list< string >::const_iterator itS = comments.begin();
    list< string >::const_iterator itE = comments.end();

    while( itS != itE )
    {
        aBoardFile << "# " << *itS << "\n";
        ++itS;
    }

    return !aBoardFile.fail();
}

bool BOARD_OUTLINE::writeOwner( std::ofstream& aBoardFile )
{
    switch( owner )
    {
        case ECAD:
            aBoardFile << "ECAD\n";
            break;

        case MCAD:
            aBoardFile << "MCAD\n";
            break;

        default:
            aBoardFile << "UNOWNED\n";
            break;
    }

    return !aBoardFile.fail();
}

694
void BOARD_OUTLINE::writeOutline( std::ofstream& aBoardFile, IDF_OUTLINE* aOutline, size_t aIndex )
695 696 697 698
{
    std::list<IDF_SEGMENT*>::iterator bo;
    std::list<IDF_SEGMENT*>::iterator eo;

699 700 701 702
    if( !aOutline )
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: NULL outline pointer" ) );

703 704 705
    if( aOutline->size() == 1 )
    {
        if( !aOutline->front()->IsCircle() )
706 707
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "bad outline (single segment item, not circle)" ) );
708 709 710 711 712 713

        if( single )
            aIndex = 0;

        // NOTE: a circle always has an angle of 360, never -360,
        // otherwise SolidWorks chokes on the file.
714
        if( unit != UNIT_THOU )
715 716 717 718 719 720 721 722 723 724 725 726
        {
            aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
            << aOutline->front()->startPoint.x << " "
            << aOutline->front()->startPoint.y << " 0\n";

            aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
            << aOutline->front()->endPoint.x << " "
            << aOutline->front()->endPoint.y << " 360\n";
        }
        else
        {
            aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
727 728
            << (aOutline->front()->startPoint.x / IDF_THOU_TO_MM) << " "
            << (aOutline->front()->startPoint.y / IDF_THOU_TO_MM) << " 0\n";
729 730

            aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
731 732
            << (aOutline->front()->endPoint.x / IDF_THOU_TO_MM) << " "
            << (aOutline->front()->endPoint.y / IDF_THOU_TO_MM) << " 360\n";
733 734
        }

735
        return;
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
    }

    // ensure that the very last point is the same as the very first point
    aOutline->back()-> endPoint = aOutline->front()->startPoint;

    if( single )
    {
        // only indices 0 (CCW) and 1 (CW) are valid; set the index according to
        // the outline's winding
        if( aOutline->IsCCW() )
            aIndex = 0;
        else
            aIndex = 1;
    }

    // check if we must reverse things
    if( ( aOutline->IsCCW() && ( aIndex > 0 ) )
        || ( ( !aOutline->IsCCW() ) && ( aIndex == 0 ) ) )
    {
        eo  = aOutline->begin();
        bo  = aOutline->end();
        --bo;

        // for the first item we write out both points
760
        if( unit != UNIT_THOU )
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
        {
            if( aOutline->front()->angle < MIN_ANG && aOutline->front()->angle > -MIN_ANG )
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << aOutline->front()->endPoint.x << " "
                << aOutline->front()->endPoint.y << " 0\n";

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << aOutline->front()->startPoint.x << " "
                << aOutline->front()->startPoint.y << " 0\n";
            }
            else
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << aOutline->front()->endPoint.x << " "
                << aOutline->front()->endPoint.y << " 0\n";

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << aOutline->front()->startPoint.x << " "
                << aOutline->front()->startPoint.y << " "
unknown's avatar
unknown committed
781
                << setprecision(2) << -aOutline->front()->angle << "\n";
782 783 784 785 786 787 788
            }
        }
        else
        {
            if( aOutline->front()->angle < MIN_ANG && aOutline->front()->angle > -MIN_ANG )
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
789 790
                << (aOutline->front()->endPoint.x / IDF_THOU_TO_MM) << " "
                << (aOutline->front()->endPoint.y / IDF_THOU_TO_MM) << " 0\n";
791 792

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
793 794
                << (aOutline->front()->startPoint.x / IDF_THOU_TO_MM) << " "
                << (aOutline->front()->startPoint.y / IDF_THOU_TO_MM) << " 0\n";
795 796 797 798
            }
            else
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
799 800
                << (aOutline->front()->endPoint.x / IDF_THOU_TO_MM) << " "
                << (aOutline->front()->endPoint.y / IDF_THOU_TO_MM) << " 0\n";
801 802

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
803 804
                << (aOutline->front()->startPoint.x / IDF_THOU_TO_MM) << " "
                << (aOutline->front()->startPoint.y / IDF_THOU_TO_MM) << " "
unknown's avatar
unknown committed
805
                << setprecision(2) << -aOutline->front()->angle << "\n";
806 807 808 809 810 811
            }
        }

        // for all other segments we only write out the start point
        while( bo != eo )
        {
812
            if( unit != UNIT_THOU )
813 814 815 816 817 818 819 820 821 822 823 824
            {
                if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                    << (*bo)->startPoint.x << " "
                    << (*bo)->startPoint.y << " 0\n";
                }
                else
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                    << (*bo)->startPoint.x << " "
                    << (*bo)->startPoint.y << " "
unknown's avatar
unknown committed
825
                    << setprecision(2) << -(*bo)->angle << "\n";
826 827 828 829 830 831 832
                }
            }
            else
            {
                if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
833 834
                    << ((*bo)->startPoint.x / IDF_THOU_TO_MM) << " "
                    << ((*bo)->startPoint.y / IDF_THOU_TO_MM) << " 0\n";
835 836 837 838
                }
                else
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
839 840
                    << ((*bo)->startPoint.x / IDF_THOU_TO_MM) << " "
                    << ((*bo)->startPoint.y / IDF_THOU_TO_MM) << " "
unknown's avatar
unknown committed
841
                    << setprecision(2) << -(*bo)->angle << "\n";
842 843 844 845 846 847 848 849 850 851 852 853
                }
            }

            --bo;
        }
    }
    else
    {
        bo  = aOutline->begin();
        eo  = aOutline->end();

        // for the first item we write out both points
854
        if( unit != UNIT_THOU )
855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
        {
            if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << (*bo)->startPoint.x << " "
                << (*bo)->startPoint.y << " 0\n";

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << (*bo)->endPoint.x << " "
                << (*bo)->endPoint.y << " 0\n";
            }
            else
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << (*bo)->startPoint.x << " "
                << (*bo)->startPoint.y << " 0\n";

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                << (*bo)->endPoint.x << " "
                << (*bo)->endPoint.y << " "
unknown's avatar
unknown committed
875
                << setprecision(2) << (*bo)->angle << "\n";
876 877 878 879 880 881 882
            }
        }
        else
        {
            if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
883 884
                << ((*bo)->startPoint.x / IDF_THOU_TO_MM) << " "
                << ((*bo)->startPoint.y / IDF_THOU_TO_MM) << " 0\n";
885 886

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
887 888
                << ((*bo)->endPoint.x / IDF_THOU_TO_MM) << " "
                << ((*bo)->endPoint.y / IDF_THOU_TO_MM) << " 0\n";
889 890 891 892
            }
            else
            {
                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
893 894
                << ((*bo)->startPoint.x / IDF_THOU_TO_MM) << " "
                << ((*bo)->startPoint.y / IDF_THOU_TO_MM) << " 0\n";
895 896

                aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
897 898
                << ((*bo)->endPoint.x / IDF_THOU_TO_MM) << " "
                << ((*bo)->endPoint.y / IDF_THOU_TO_MM) << " "
unknown's avatar
unknown committed
899
                << setprecision(2) << (*bo)->angle << "\n";
900 901 902 903 904 905 906 907
            }
        }

        ++bo;

        // for all other segments we only write out the last point
        while( bo != eo )
        {
908
            if( unit != UNIT_THOU )
909 910 911 912 913 914 915 916 917 918 919 920
            {
                if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                    << (*bo)->endPoint.x << " "
                    << (*bo)->endPoint.y << " 0\n";
                }
                else
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(5)
                    << (*bo)->endPoint.x << " "
                    << (*bo)->endPoint.y << " "
unknown's avatar
unknown committed
921
                    << setprecision(2) << (*bo)->angle << "\n";
922 923 924 925 926 927 928
                }
            }
            else
            {
                if( (*bo)->angle < MIN_ANG && (*bo)->angle > -MIN_ANG )
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
929 930
                    << ((*bo)->endPoint.x / IDF_THOU_TO_MM) << " "
                    << ((*bo)->endPoint.y / IDF_THOU_TO_MM) << " 0\n";
931 932 933 934
                }
                else
                {
                    aBoardFile << aIndex << " " << setiosflags(ios::fixed) << setprecision(1)
935 936
                    << ((*bo)->endPoint.x / IDF_THOU_TO_MM) << " "
                    << ((*bo)->endPoint.y / IDF_THOU_TO_MM) << " "
unknown's avatar
unknown committed
937
                    << setprecision(2) << (*bo)->angle << "\n";
938 939 940 941 942 943 944
                }
            }

            ++bo;
        }
    }

945
    return;
946 947
}

948
void BOARD_OUTLINE::writeOutlines( std::ofstream& aBoardFile )
949 950
{
    if( outlines.empty() )
951
        return;
952 953 954 955 956 957 958

    int idx = 0;
    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();
    std::list< IDF_OUTLINE* >::iterator itE = outlines.end();

    while( itS != itE )
    {
959
        writeOutline( aBoardFile, *itS, idx++ );
960 961 962
        ++itS;
    }

963
    return;
964 965
}

966
bool BOARD_OUTLINE::SetUnit( IDF3::IDF_UNIT aUnit )
967
{
968 969 970 971 972 973 974 975 976 977 978 979 980
    // note: although UNIT_TNM is accepted here without reservation,
    // this can only affect data being read from a file.
    if( aUnit != UNIT_MM && aUnit != UNIT_THOU && aUnit != UNIT_TNM )
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr << "* BUG: invalid IDF UNIT (must be one of UNIT_MM or UNIT_THOU): " << aUnit << "\n";
        ostr << "* outline type: " << GetOutlineTypeString( outlineType );
        errormsg = ostr.str();

        return false;
    }

981
    unit = aUnit;
982
    return true;
983 984 985 986 987 988 989
}

IDF3::IDF_UNIT BOARD_OUTLINE::GetUnit( void )
{
    return unit;
}

990
bool BOARD_OUTLINE::setThickness( double aThickness )
991 992
{
    if( aThickness < 0.0 )
993 994 995 996 997 998 999
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr << "* BUG: aThickness < 0.0\n";
        ostr << "* outline type: " << GetOutlineTypeString( outlineType );
        errormsg = ostr.str();

1000
        return false;
1001
    }
1002 1003 1004 1005 1006

    thickness = aThickness;
    return true;
}

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
bool BOARD_OUTLINE::SetThickness( double aThickness )
{
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    return setThickness( aThickness );
}

1017 1018 1019 1020 1021
double BOARD_OUTLINE::GetThickness( void )
{
    return thickness;
}

1022 1023
void BOARD_OUTLINE::readData( std::ifstream& aBoardFile, const std::string& aHeader,
                              IDF3::IDF_VERSION aIdfVersion )
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
{
    //  BOARD_OUTLINE (PANEL_OUTLINE)
    //      .BOARD_OUTLINE  [OWNER]
    //      [thickness]
    //      [outlines]

    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
1034 1035 1036
    std::streampos pos;

    pos = aBoardFile.tellg();
1037 1038

    if( !GetIDFString( aHeader, token, quoted, idx ) )
1039
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, "invalid invocation: blank header line" ) );
1040 1041 1042

    if( quoted )
    {
1043 1044 1045 1046 1047 1048 1049 1050
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section names may not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1051 1052 1053 1054
    }

    if( !CompareToken( ".BOARD_OUTLINE", token ) )
    {
1055 1056 1057 1058 1059 1060 1061 1062
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: not a board outline\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1063 1064 1065 1066
    }

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
1067 1068 1069
        if( aIdfVersion > IDF_V2 )
            ERROR_IDF << "no OWNER; setting to UNOWNED\n";

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
        owner = UNOWNED;
    }
    else
    {
        if( !ParseOwner( token, owner ) )
        {
            ERROR_IDF << "invalid OWNER (reverting to UNOWNED): " << token << "\n";
            owner = UNOWNED;
        }
    }

    // check RECORD 2
    std::string iline;
    bool comment = false;
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && !aBoardFile.eof() ) || iline.empty() )
    {
1088 1089 1090 1091 1092 1093 1094
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1095 1096 1097 1098 1099
    }

    idx = 0;
    if( comment )
    {
1100 1101 1102 1103 1104 1105 1106 1107
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within .BOARD_OUTLINE section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1108 1109 1110 1111
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
1112 1113 1114 1115 1116 1117 1118
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no thickness specified\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1119 1120 1121 1122 1123 1124 1125 1126
    }

    std::stringstream teststr;
    teststr << token;

    teststr >> thickness;
    if( teststr.fail() )
    {
1127 1128 1129 1130 1131 1132 1133 1134
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: invalid RECORD 2 (thickness)\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1135 1136 1137
    }

    if( unit == UNIT_THOU )
1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
    {
        thickness *= IDF_THOU_TO_MM;
    }
    else if( ( aIdfVersion == IDF_V2 ) && ( unit == UNIT_TNM ) )
    {
        thickness *= IDF_TNM_TO_MM;
    }
    else if( unit != UNIT_MM )
    {
        ostringstream ostr;
        ostr << "\n* BUG: invalid UNIT type: " << unit;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
    }

    // for some unknown reason IDF allows 0 or negative thickness, but this
    // is a problem so we fix it here
    if( thickness <= 0.0 )
    {
        if( thickness == 0.0 )
        {
            ERROR_IDF << "\n* WARNING: setting board thickness to default 1.6mm (";
            cerr << thickness << ")\n";
            thickness = 1.6;
        }
        else
        {
            thickness = -thickness;
            ERROR_IDF << "\n* WARNING: setting board thickness to positive number (";
            cerr << thickness << ")\n";
        }
    }
1170 1171

    // read RECORD 3 values
1172
    readOutlines( aBoardFile, aIdfVersion );
1173 1174 1175 1176 1177 1178

    // check RECORD 4
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
    {
1179 1180 1181 1182 1183 1184 1185
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1186 1187 1188 1189 1190
    }

    idx = 0;
    if( comment )
    {
1191 1192 1193 1194 1195 1196 1197 1198
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1199 1200 1201 1202
    }

    if( !CompareToken( ".END_BOARD_OUTLINE", iline ) )
    {
1203 1204 1205 1206 1207 1208 1209
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no .END_BOARD_OUTLINE found\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1210 1211
    }

1212
    return;
1213 1214
}

1215 1216

void BOARD_OUTLINE::writeData( std::ofstream& aBoardFile )
1217 1218 1219 1220 1221 1222 1223 1224
{
    writeComments( aBoardFile );

    // note: a BOARD_OUTLINE section is required, even if it is empty
    aBoardFile << ".BOARD_OUTLINE ";

    writeOwner( aBoardFile );

1225
    if( unit != UNIT_THOU )
1226 1227
        aBoardFile << setiosflags(ios::fixed) << setprecision(5) << thickness << "\n";
    else
1228
        aBoardFile << setiosflags(ios::fixed) << setprecision(1) << (thickness / IDF_THOU_TO_MM) << "\n";
1229

1230
    writeOutlines( aBoardFile );
1231 1232 1233

    aBoardFile << ".END_BOARD_OUTLINE\n\n";

1234
    return;
1235 1236
}

1237
void BOARD_OUTLINE::clear( void )
1238 1239
{
    comments.clear();
1240
    clearOutlines();
1241 1242 1243 1244 1245

    owner = UNOWNED;
    return;
}

1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
bool BOARD_OUTLINE::Clear( void )
{
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();

    return true;
}

void BOARD_OUTLINE::setParent( IDF3_BOARD* aParent )
1259 1260 1261 1262 1263 1264 1265 1266 1267
{
    parent = aParent;
}

IDF3_BOARD* BOARD_OUTLINE::GetParent( void )
{
    return parent;
}

1268
bool BOARD_OUTLINE::addOutline( IDF_OUTLINE* aOutline )
1269 1270 1271 1272
{
    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();
    std::list< IDF_OUTLINE* >::iterator itE = outlines.end();

1273
    try
1274
    {
1275 1276 1277 1278 1279
        while( itS != itE )
        {
            if( *itS == aOutline )
                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                                  "duplicate outline pointer" ) );
1280

1281 1282 1283 1284 1285 1286
            ++itS;
        }

        outlines.push_back( aOutline );

    }
unknown's avatar
unknown committed
1287
    catch( const std::exception& e )
1288 1289 1290 1291
    {
        errormsg = e.what();

        return false;
1292 1293 1294 1295 1296
    }

    return true;
}

1297 1298 1299 1300 1301 1302 1303 1304 1305 1306
bool BOARD_OUTLINE::AddOutline( IDF_OUTLINE* aOutline )
{
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    return addOutline( aOutline );
}

1307 1308 1309 1310 1311
bool BOARD_OUTLINE::DelOutline( IDF_OUTLINE* aOutline )
{
    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();
    std::list< IDF_OUTLINE* >::iterator itE = outlines.end();

1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
    if( !aOutline )
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr << "* BUG: NULL aOutline pointer\n";
        ostr << "* outline type: " << GetOutlineTypeString( outlineType );
        errormsg = ostr.str();

        return false;
    }

1323
    if( outlines.empty() )
1324 1325
    {
        errormsg.clear();
1326
        return false;
1327
    }
1328 1329 1330 1331 1332 1333 1334

    // if there are more than 1 outlines it makes no sense to delete
    // the first outline (board outline) since that would have the
    // undesirable effect of substituting a cutout outline as the board outline
    if( aOutline == outlines.front() )
    {
        if( outlines.size() > 1 )
1335 1336 1337 1338 1339 1340 1341
        {
            ostringstream ostr;
            ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
            ostr << "* BUG: attempting to delete first outline in list\n";
            ostr << "* outline type: " << GetOutlineTypeString( outlineType );
            errormsg = ostr.str();

1342
            return false;
1343
        }
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359

        outlines.clear();
        return true;
    }

    while( itS != itE )
    {
        if( *itS == aOutline )
        {
            outlines.erase( itS );
            return true;
        }

        ++itS;
    }

1360
    errormsg.clear();
1361 1362 1363
    return false;
}

1364

1365 1366 1367 1368 1369
bool BOARD_OUTLINE::DelOutline( size_t aIndex )
{
    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();

    if( outlines.empty() )
1370 1371
    {
        errormsg.clear();
1372
        return false;
1373
    }
1374 1375

    if( aIndex >= outlines.size() )
1376 1377 1378 1379 1380 1381 1382
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr << "* BUG: index out of bounds (" << aIndex << " / " << outlines.size() << ")\n";
        ostr << "* outline type: " << GetOutlineTypeString( outlineType );
        errormsg = ostr.str();

1383
        return false;
1384
    }
1385 1386 1387 1388 1389 1390 1391

    if( aIndex == 0 )
    {
        // if there are more than 1 outlines it makes no sense to delete
        // the first outline (board outline) since that would have the
        // undesirable effect of substituting a cutout outline as the board outline
        if( outlines.size() > 1 )
1392 1393 1394 1395 1396 1397 1398
        {
            ostringstream ostr;
            ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
            ostr << "* BUG: attempting to delete first outline in list\n";
            ostr << "* outline type: " << GetOutlineTypeString( outlineType );
            errormsg = ostr.str();

1399
            return false;
1400
        }
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429

        delete *itS;
        outlines.clear();

        return true;
    }

    for( ; aIndex > 0; --aIndex )
        ++itS;

    delete *itS;
    outlines.erase( itS );

    return true;
}

const std::list< IDF_OUTLINE* >*const BOARD_OUTLINE::GetOutlines( void )
{
    return &outlines;
}

size_t BOARD_OUTLINE::OutlinesSize( void )
{
    return outlines.size();
}

IDF_OUTLINE* BOARD_OUTLINE::GetOutline( size_t aIndex )
{
    if( aIndex >= outlines.size() )
1430 1431 1432 1433 1434 1435
    {
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr <<  "* aIndex (" << aIndex << ") is out of range (" << outlines.size() << ")";
        errormsg = ostr.str();

1436
        return NULL;
1437
    }
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453

    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();

    for( ; aIndex > 0; --aIndex )
        ++itS;

    return *itS;
}

IDF3::KEY_OWNER BOARD_OUTLINE::GetOwner( void )
{
    return owner;
}

bool BOARD_OUTLINE::SetOwner( IDF3::KEY_OWNER aOwner )
{
1454 1455 1456 1457
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif
1458

1459 1460
    owner = aOwner;
    return true;
1461 1462 1463 1464 1465 1466 1467
}

bool BOARD_OUTLINE::IsSingle( void )
{
    return single;
}

1468
void BOARD_OUTLINE::clearOutlines( void )
1469 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 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
{
    std::list< IDF_OUTLINE* >::iterator itS = outlines.begin();
    std::list< IDF_OUTLINE* >::iterator itE = outlines.end();

    while( itS != itE )
    {
        delete *itS;
        ++itS;
    }

    outlines.clear();
    return;
}

void BOARD_OUTLINE::AddComment( const std::string& aComment )
{
    if( aComment.empty() )
        return;

    comments.push_back( aComment );
    return;
}

size_t BOARD_OUTLINE::CommentsSize( void )
{
    return comments.size();
}

std::list< std::string >* BOARD_OUTLINE::GetComments( void )
{
    return &comments;
}

const std::string* BOARD_OUTLINE::GetComment( size_t aIndex )
{
    if( aIndex >= comments.size() )
        return NULL;

    std::list< std::string >::iterator itS = comments.begin();

    for( ; aIndex > 0; --aIndex )
        ++itS;

    return &(*itS);
}

bool  BOARD_OUTLINE::DeleteComment( size_t aIndex )
{
    if( aIndex >= comments.size() )
        return false;

    std::list< std::string >::iterator itS = comments.begin();

    for( ; aIndex > 0; --aIndex )
        ++itS;

    comments.erase( itS );
    return true;
}

void  BOARD_OUTLINE::ClearComments( void )
{
    comments.clear();
    return;
}


/*
 * CLASS: OTHER_OUTLINE
 */
1539
OTHER_OUTLINE::OTHER_OUTLINE( IDF3_BOARD* aParent )
1540
{
1541
    setParent( aParent );
1542 1543
    outlineType = OTLN_OTHER;
    side = LYR_INVALID;
1544
    single = false;
1545 1546 1547 1548

    return;
}

1549
bool OTHER_OUTLINE::SetOutlineIdentifier( const std::string aUniqueID )
1550
{
1551 1552 1553 1554 1555
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

1556
    uniqueID = aUniqueID;
1557 1558

    return true;
1559 1560 1561 1562 1563 1564 1565 1566 1567
}

const std::string& OTHER_OUTLINE::GetOutlineIdentifier( void )
{
    return uniqueID;
}

bool OTHER_OUTLINE::SetSide( IDF3::IDF_LAYER aSide )
{
1568 1569 1570 1571 1572
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

1573 1574 1575 1576 1577 1578 1579 1580
    switch( aSide )
    {
        case LYR_TOP:
        case LYR_BOTTOM:
            side = aSide;
            break;

        default:
1581 1582 1583 1584 1585 1586 1587 1588
            do{
                ostringstream ostr;
                ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
                ostr << "* BUG: invalid side (" << aSide << "); must be one of TOP/BOTTOM\n";
                ostr << "* outline type: " << GetOutlineTypeString( outlineType );
                errormsg = ostr.str();
            } while( 0 );

1589 1590
            side = LYR_INVALID;
            return false;
1591

1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
            break;
    }

    return true;
}

IDF3::IDF_LAYER OTHER_OUTLINE::GetSide( void )
{
    return side;
}

1603 1604
void OTHER_OUTLINE::readData( std::ifstream& aBoardFile, const std::string& aHeader,
                              IDF3::IDF_VERSION aIdfVersion )
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
{
    // OTHER_OUTLINE/VIA_KEEPOUT
    //     .OTHER_OUTLINE  [OWNER]
    //     [outline identifier] [thickness] [board side: Top/Bot] {not present in VA\IA KEEPOUT}
    //     [outline]

    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
1615
    std::streampos pos = aBoardFile.tellg();
1616 1617 1618

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
1619 1620 1621 1622
        ostringstream ostr;
        ostr << "\n* BUG: invalid invocation: blank header line\n";

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1623 1624 1625 1626
    }

    if( quoted )
    {
1627 1628 1629 1630 1631 1632 1633 1634
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section names must not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1635 1636 1637 1638 1639 1640
    }

    if( outlineType == OTLN_OTHER )
    {
        if( !CompareToken( ".OTHER_OUTLINE", token ) )
        {
1641 1642 1643 1644 1645 1646
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* BUG: not an .OTHER outline\n";

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1647 1648 1649 1650 1651 1652
        }
    }
    else
    {
        if( !CompareToken( ".VIA_KEEPOUT", token ) )
        {
1653 1654 1655 1656 1657 1658
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* BUG: not a .VIA_KEEPOUT outline\n";

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1659 1660 1661 1662 1663
        }
    }

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
1664 1665 1666
        if( aIdfVersion > IDF_V2 )
            ERROR_IDF << "no OWNER; setting to UNOWNED\n";

1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688
        owner = UNOWNED;
    }
    else
    {
        if( !ParseOwner( token, owner ) )
        {
            ERROR_IDF << "invalid OWNER (reverting to UNOWNED): " << token << "\n";
            owner = UNOWNED;
        }
    }

    std::string iline;
    bool comment = false;

    if( outlineType == OTLN_OTHER )
    {
        // check RECORD 2
        // [outline identifier] [thickness] [board side: Top/Bot]
        while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

        if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
        {
1689 1690 1691 1692 1693 1694 1695
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: premature end\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1696 1697 1698 1699 1700
        }

        idx = 0;
        if( comment )
        {
1701 1702 1703 1704 1705 1706 1707 1708
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: comment within .OTHER_OUTLINE section\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1709 1710 1711 1712
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
1713 1714 1715 1716 1717 1718 1719 1720
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no outline identifier\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1721 1722 1723 1724 1725 1726
        }

        uniqueID = token;

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
1727 1728 1729 1730 1731 1732 1733 1734
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no thickness\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1735 1736 1737 1738 1739 1740 1741 1742
        }

        std::stringstream teststr;
        teststr << token;

        teststr >> thickness;
        if( teststr.fail() )
        {
1743 1744 1745 1746 1747 1748 1749 1750
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: invalid thickness\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1751 1752 1753 1754
        }

        if( unit == UNIT_THOU )
        {
1755
            thickness *= IDF_THOU_TO_MM;
1756
        }
1757 1758 1759 1760 1761 1762 1763 1764
        else if( ( aIdfVersion == IDF_V2 ) && ( unit == UNIT_TNM ) )
        {
            thickness *= IDF_TNM_TO_MM;
        }
        else if( unit != UNIT_MM )
        {
            ostringstream ostr;
            ostr << "\n* BUG: invalid UNIT type: " << unit;
1765

1766 1767 1768 1769
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( aIdfVersion == IDF_V2 )
1770
        {
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797
            side = LYR_TOP;
        }
        else
        {
            if( !GetIDFString( iline, token, quoted, idx ) )
            {
                ostringstream ostr;

                ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
                ostr << "* violation: no board side\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            }

            if( !ParseIDFLayer( token, side ) || ( side != LYR_TOP && side != LYR_BOTTOM ) )
            {
                ostringstream ostr;

                ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
                ostr << "* violation: invalid side (must be TOP or BOTTOM only)\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            }
1798
        }
1799

1800 1801 1802
    }

    // read RECORD 3 values
1803
    readOutlines( aBoardFile, aIdfVersion );
1804 1805 1806 1807 1808 1809

    // check RECORD 4
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
    {
1810 1811 1812 1813 1814 1815 1816
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1817 1818 1819 1820 1821
    }

    idx = 0;
    if( comment )
    {
1822 1823 1824 1825 1826 1827 1828 1829
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1830 1831 1832 1833 1834 1835
    }

    if( outlineType == OTLN_OTHER )
    {
        if( !CompareToken( ".END_OTHER_OUTLINE", iline ) )
        {
1836 1837 1838 1839 1840 1841 1842
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_OTHER_OUTLINE found\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1843 1844 1845 1846 1847 1848
        }
    }
    else
    {
        if( !CompareToken( ".END_VIA_KEEPOUT", iline ) )
        {
1849 1850 1851 1852 1853 1854 1855
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_VIA_KEEPOUT found\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1856 1857 1858
        }
    }

1859
    return;
1860 1861
}

1862
void OTHER_OUTLINE::writeData( std::ofstream& aBoardFile )
1863 1864 1865
{
    // this section is optional; do not write if not required
    if( outlines.empty() )
1866
        return;
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882

    writeComments( aBoardFile );

    // write RECORD 1
    if( outlineType == OTLN_OTHER )
        aBoardFile << ".OTHER_OUTLINE ";
    else
        aBoardFile << ".VIA_KEEPOUT ";

    writeOwner( aBoardFile );

    // write RECORD 2
    if( outlineType == OTLN_OTHER )
    {
        aBoardFile << "\"" << uniqueID << "\" ";

1883
        if( unit != UNIT_THOU )
1884 1885
            aBoardFile << setiosflags(ios::fixed) << setprecision(5) << thickness << " ";
        else
1886
            aBoardFile << setiosflags(ios::fixed) << setprecision(1) << (thickness / IDF_THOU_TO_MM) << " ";
1887 1888 1889 1890 1891 1892 1893 1894 1895

        switch( side )
        {
            case LYR_TOP:
            case LYR_BOTTOM:
                WriteLayersText( aBoardFile, side );
                break;

            default:
1896 1897 1898 1899 1900 1901 1902
                do{
                    ostringstream ostr;
                    ostr << "\n* invalid OTHER_OUTLINE side (neither top nor bottom): ";
                    ostr << side;
                    throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
                } while( 0 );

1903 1904 1905 1906 1907
                break;
        }
    }

    // write RECORD 3
1908
    writeOutlines( aBoardFile );
1909 1910 1911 1912 1913 1914 1915

    // write RECORD 4
    if( outlineType == OTLN_OTHER )
        aBoardFile << ".END_OTHER_OUTLINE\n\n";
    else
        aBoardFile << ".END_VIA_KEEPOUT\n\n";

1916
    return;
1917 1918
}

1919 1920

bool OTHER_OUTLINE::Clear( void )
1921
{
1922 1923 1924 1925 1926 1927
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();
1928 1929 1930
    side = LYR_INVALID;
    uniqueID.clear();

1931
    return true;
1932 1933 1934 1935 1936 1937
}


/*
 * CLASS: ROUTE_OUTLINE
 */
1938
ROUTE_OUTLINE::ROUTE_OUTLINE( IDF3_BOARD* aParent )
1939
{
1940
    setParent( aParent );
1941 1942 1943 1944 1945
    outlineType = OTLN_ROUTE;
    single = true;
    layers = LYR_INVALID;
}

1946
bool ROUTE_OUTLINE::SetLayers( IDF3::IDF_LAYER aLayer )
1947
{
1948 1949 1950 1951 1952
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

1953
    layers = aLayer;
1954 1955

    return true;
1956 1957 1958 1959 1960 1961 1962
}

IDF3::IDF_LAYER ROUTE_OUTLINE::GetLayers( void )
{
    return layers;
}

1963 1964
void ROUTE_OUTLINE::readData( std::ifstream& aBoardFile, const std::string& aHeader,
                              IDF3::IDF_VERSION aIdfVersion )
1965 1966 1967 1968 1969 1970 1971 1972 1973 1974
{
    //  ROUTE_OUTLINE (or ROUTE_KEEPOUT)
    //      .ROUTE_OUTLINE [OWNER]
    //      [layers]
    //      [outline]

    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
1975
    std::streampos pos = aBoardFile.tellg();
1976 1977 1978

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
1979 1980
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: invalid invocation; blank header line" ) );
1981 1982 1983 1984
    }

    if( quoted )
    {
1985 1986 1987 1988 1989 1990 1991 1992
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section names must not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
1993 1994 1995 1996 1997
    }

    if( outlineType == OTLN_ROUTE )
    {
        if( !CompareToken( ".ROUTE_OUTLINE", token ) )
1998 1999
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "\n* BUG: not a ROUTE outline" ) );
2000 2001 2002 2003
    }
    else
    {
        if( !CompareToken( ".ROUTE_KEEPOUT", token ) )
2004 2005
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "\n* BUG: not a ROUTE KEEPOUT outline" ) );
2006 2007 2008 2009
    }

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
2010 2011 2012
        if( aIdfVersion > IDF_V2 )
            ERROR_IDF << "no OWNER; setting to UNOWNED\n";

2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028
        owner = UNOWNED;
    }
    else
    {
        if( !ParseOwner( token, owner ) )
        {
            ERROR_IDF << "invalid OWNER (reverting to UNOWNED): " << token << "\n";
            owner = UNOWNED;
        }
    }

    // check RECORD 2
    // [layers: TOP, BOTTOM, BOTH, INNER, ALL]
    std::string iline;
    bool comment = false;

2029
    if( aIdfVersion > IDF_V2 || outlineType == OTLN_ROUTE_KEEPOUT )
2030
    {
2031
        while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );
2032

2033 2034 2035
        if( !aBoardFile.good() )
        {
            ostringstream ostr;
2036

2037 2038 2039
            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: premature end\n";
            ostr << "* file position: " << pos;
2040

2041 2042 2043 2044 2045 2046 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 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        idx = 0;
        if( comment )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: comment within a section\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no layers specification\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( quoted )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: layers specification must not be in quotes\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( !ParseIDFLayer( token, layers ) )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: invalid layers specification\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( aIdfVersion == IDF_V2 )
        {
            if( layers == LYR_INNER || layers == LYR_ALL )
            {
                ostringstream ostr;

                ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
                ostr << "* violation: IDFv2 allows only TOP/BOTTOM/BOTH; layer was '";
                ostr << token << "'\n";
                ostr << "* line: '" << iline << "'\n";
                ostr << "* file position: " << pos;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            }
        }
2108

2109 2110
    }   // RECORD 2, conditional > IDFv2 or ROUTE_KO_OUTLINE
    else
2111
    {
2112
        layers = LYR_ALL;
2113 2114 2115
    }

    // read RECORD 3 values
2116
    readOutlines( aBoardFile, aIdfVersion );
2117 2118 2119 2120 2121 2122

    // check RECORD 4
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
    {
2123 2124 2125 2126 2127 2128 2129
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2130 2131 2132 2133 2134
    }

    idx = 0;
    if( comment )
    {
2135 2136 2137 2138 2139 2140 2141 2142
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2143 2144 2145 2146 2147 2148
    }

    if( outlineType == OTLN_ROUTE )
    {
        if( !CompareToken( ".END_ROUTE_OUTLINE", iline ) )
        {
2149 2150 2151 2152 2153 2154 2155
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_ROUTE_OUTLINE found\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2156 2157 2158 2159 2160 2161
        }
    }
    else
    {
        if( !CompareToken( ".END_ROUTE_KEEPOUT", iline ) )
        {
2162 2163 2164 2165 2166 2167 2168
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_ROUTE_KEEPOUT found\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2169 2170 2171
        }
    }

2172
    return;
2173 2174 2175
}


2176
void ROUTE_OUTLINE::writeData( std::ofstream& aBoardFile )
2177 2178 2179
{
    // this section is optional; do not write if not required
    if( outlines.empty() )
2180
        return;
2181 2182

    if( layers == LYR_INVALID )
2183 2184
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "layer not specified" ) );
2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200

    writeComments( aBoardFile );

    // write RECORD 1
    if( outlineType == OTLN_ROUTE )
        aBoardFile << ".ROUTE_OUTLINE ";
    else
        aBoardFile << ".ROUTE_KEEPOUT ";

    writeOwner( aBoardFile );

    // write RECORD 2
    WriteLayersText( aBoardFile, layers );
    aBoardFile << "\n";

    // write RECORD 3
2201
    writeOutlines( aBoardFile );
2202 2203 2204 2205 2206 2207 2208

    // write RECORD 4
    if( outlineType == OTLN_ROUTE )
        aBoardFile << ".END_ROUTE_OUTLINE\n\n";
    else
        aBoardFile << ".END_ROUTE_KEEPOUT\n\n";

2209
    return;
2210 2211 2212
}


2213
bool ROUTE_OUTLINE::Clear( void )
2214
{
2215 2216 2217 2218 2219 2220
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();
2221
    layers = LYR_INVALID;
2222 2223

    return true;
2224 2225 2226 2227 2228 2229
}


/*
 * CLASS: PLACE_OUTLINE
 */
2230
PLACE_OUTLINE::PLACE_OUTLINE( IDF3_BOARD* aParent )
2231
{
2232
    setParent( aParent );
2233 2234 2235 2236 2237 2238
    outlineType = OTLN_PLACE;
    single = true;
    thickness = 0.0;
    side = LYR_INVALID;
}

2239
bool PLACE_OUTLINE::SetSide( IDF3::IDF_LAYER aSide )
2240
{
2241 2242 2243 2244 2245
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

2246 2247 2248 2249 2250 2251 2252 2253 2254
    switch( aSide )
    {
        case LYR_TOP:
        case LYR_BOTTOM:
        case LYR_BOTH:
            side = aSide;
            break;

        default:
2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265
            do{
                side = LYR_INVALID;
                ostringstream ostr;
                ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
                ostr << "* BUG: invalid layer (" << aSide << "): must be one of TOP/BOTTOM/BOTH\n";
                ostr << "* outline type: " << GetOutlineTypeString( outlineType );
                errormsg = ostr.str();

                return false;
            } while( 0 );

2266 2267 2268
            break;
    }

2269
    return true;
2270 2271
}

2272

2273 2274 2275 2276 2277
IDF3::IDF_LAYER PLACE_OUTLINE::GetSide( void )
{
    return side;
}

2278 2279

bool PLACE_OUTLINE::SetMaxHeight( double aHeight )
2280
{
2281 2282 2283 2284 2285
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

2286 2287 2288
    if( aHeight < 0.0 )
    {
        thickness = 0.0;
2289 2290 2291 2292 2293 2294 2295 2296 2297 2298

        do{
            ostringstream ostr;
            ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
            ostr << "* BUG: invalid height (" << aHeight << "): must be >= 0.0";
            ostr << "* outline type: " << GetOutlineTypeString( outlineType );
            errormsg = ostr.str();

            return false;
        } while( 0 );
2299 2300 2301
    }

    thickness = aHeight;
2302
    return true;
2303 2304 2305 2306 2307 2308 2309
}

double PLACE_OUTLINE::GetMaxHeight( void )
{
    return thickness;
}

2310 2311
void PLACE_OUTLINE::readData( std::ifstream& aBoardFile, const std::string& aHeader,
                              IDF3::IDF_VERSION aIdfVersion )
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
{
    //  PLACE_OUTLINE/KEEPOUT
    //      .PLACE_OUTLINE [OWNER]
    //      [board side: Top/Bot/Both] [height]
    //      [outline]

    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
2322
    std::streampos pos = aBoardFile.tellg();
2323 2324

    if( !GetIDFString( aHeader, token, quoted, idx ) )
2325 2326
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: invalid invocation: blank header line\n" ) );
2327 2328 2329

    if( quoted )
    {
2330 2331 2332 2333 2334 2335 2336 2337
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section name must not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2338 2339 2340 2341 2342
    }

    if( outlineType == OTLN_PLACE )
    {
        if( !CompareToken( ".PLACE_OUTLINE", token ) )
2343 2344
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "\n* BUG: not a .PLACE_OUTLINE" ) );
2345 2346 2347 2348
    }
    else
    {
        if( !CompareToken( ".PLACE_KEEPOUT", token ) )
2349 2350
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "\n* BUG: not a .PLACE_KEEPOUT" ) );
2351 2352 2353 2354
    }

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
2355 2356 2357
        if( aIdfVersion > IDF_V2 )
            ERROR_IDF << "no OWNER; setting to UNOWNED\n";

2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373
        owner = UNOWNED;
    }
    else
    {
        if( !ParseOwner( token, owner ) )
        {
            ERROR_IDF << "invalid OWNER (reverting to UNOWNED): " << token << "\n";
            owner = UNOWNED;
        }
    }

    // check RECORD 2
    // [board side: Top/Bot/Both] [height]
    std::string iline;
    bool comment = false;

2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 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
    if( aIdfVersion > IDF_V2 || outlineType == OTLN_PLACE_KEEPOUT )
    {
        while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

        if( !aBoardFile.good() )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: premature end\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        idx = 0;
        if( comment )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: comment within the section\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no board side information\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( !ParseIDFLayer( token, side ) ||
            ( side != LYR_TOP && side != LYR_BOTTOM && side != LYR_BOTH ) )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: invalid board side: must be one of TOP/BOTTOM/BOTH\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no height specified\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }

        std::stringstream teststr;
        teststr << token;

        teststr >> thickness;
        if( teststr.fail() )
        {
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: invalid height\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;
2451

2452 2453
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }
2454

2455 2456 2457
        if( thickness < 0.0 )
        {
            ostringstream ostr;
2458

2459 2460 2461 2462
            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: thickness < 0\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;
2463

2464 2465
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }
2466

2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
        if( unit == UNIT_THOU )
        {
            thickness *= IDF_THOU_TO_MM;
        }
        else if( ( aIdfVersion == IDF_V2 ) && ( unit == UNIT_TNM ) )
        {
            thickness *= IDF_TNM_TO_MM;
        }
        else if( unit != UNIT_MM )
        {
            ostringstream ostr;
            ostr << "\n* BUG: invalid UNIT type: " << unit;
2479

2480 2481
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
        }
2482

2483 2484 2485 2486
        if( thickness < 0.0 )
            thickness = 0.0;
    }
    else
2487
    {
2488 2489
        side = LYR_TOP;
        thickness = 0.0;
2490 2491 2492
    }

    // read RECORD 3 values
2493
    readOutlines( aBoardFile, aIdfVersion );
2494 2495 2496 2497 2498 2499

    // check RECORD 4
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
    {
2500 2501 2502 2503 2504 2505 2506
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2507 2508 2509 2510 2511
    }

    idx = 0;
    if( comment )
    {
2512 2513 2514 2515 2516 2517 2518 2519
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2520 2521 2522 2523 2524 2525
    }

    if( outlineType == OTLN_PLACE )
    {
        if( !GetIDFString( iline, token, quoted, idx )
            || !CompareToken( ".END_PLACE_OUTLINE", token ) )
2526 2527
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "invalid .PLACE_OUTLINE section: no .END_PLACE_OUTLINE found" ) );
2528 2529 2530 2531 2532
    }
    else
    {
        if( !GetIDFString( iline, token, quoted, idx )
            || !CompareToken( ".END_PLACE_KEEPOUT", token ) )
2533 2534
            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                              "invalid .PLACE_KEEPOUT section: no .END_PLACE_KEEPOUT found" ) );
2535 2536
    }

2537
    return;
2538 2539
}

2540
void PLACE_OUTLINE::writeData( std::ofstream& aBoardFile )
2541 2542 2543
{
    // this section is optional; do not write if not required
    if( outlines.empty() )
2544
        return;
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565

    writeComments( aBoardFile );

    // write RECORD 1
    if( outlineType == OTLN_PLACE )
        aBoardFile << ".PLACE_OUTLINE ";
    else
        aBoardFile << ".PLACE_KEEPOUT ";

    writeOwner( aBoardFile );

    // write RECORD 2
    switch( side )
    {
        case LYR_TOP:
        case LYR_BOTTOM:
        case LYR_BOTH:
            WriteLayersText( aBoardFile, side );
            break;

        default:
2566 2567 2568 2569 2570 2571 2572 2573
            do
            {
                ostringstream ostr;
                ostr << "\n* invalid PLACE_OUTLINE/KEEPOUT side (";
                ostr << side << "); must be one of TOP/BOTTOM/BOTH";
                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            } while( 0 );

2574 2575 2576 2577 2578
            break;
    }

    aBoardFile << " ";

2579
    if( unit != UNIT_THOU )
2580 2581
        aBoardFile << setiosflags(ios::fixed) << setprecision(5) << thickness << "\n";
    else
2582
        aBoardFile << setiosflags(ios::fixed) << setprecision(1) << (thickness / IDF_THOU_TO_MM) << "\n";
2583 2584

    // write RECORD 3
2585
    writeOutlines( aBoardFile );
2586 2587 2588 2589 2590 2591 2592

    // write RECORD 4
    if( outlineType == OTLN_PLACE )
        aBoardFile << ".END_PLACE_OUTLINE\n\n";
    else
        aBoardFile << ".END_PLACE_KEEPOUT\n\n";

2593
    return;
2594 2595
}

2596 2597

bool PLACE_OUTLINE::Clear( void )
2598
{
2599 2600 2601 2602 2603 2604
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();
2605 2606
    thickness = 0.0;
    side = LYR_INVALID;
2607 2608

    return true;
2609 2610 2611 2612 2613 2614
}


/*
 * CLASS: ROUTE_KEEPOUT
 */
2615 2616
ROUTE_KO_OUTLINE::ROUTE_KO_OUTLINE( IDF3_BOARD* aParent )
    : ROUTE_OUTLINE( aParent )
2617 2618 2619 2620 2621 2622 2623 2624 2625
{
    outlineType = OTLN_ROUTE_KEEPOUT;
    return;
}


/*
 * CLASS: PLACE_KEEPOUT
 */
2626 2627
PLACE_KO_OUTLINE::PLACE_KO_OUTLINE( IDF3_BOARD* aParent )
    : PLACE_OUTLINE( aParent )
2628 2629 2630 2631 2632 2633 2634 2635 2636
{
    outlineType = OTLN_PLACE_KEEPOUT;
    return;
}


/*
 * CLASS: VIA_KEEPOUT
 */
2637 2638
VIA_KO_OUTLINE::VIA_KO_OUTLINE( IDF3_BOARD* aParent )
    : OTHER_OUTLINE( aParent )
2639
{
2640
    single = true;
2641 2642 2643 2644 2645 2646 2647
    outlineType = OTLN_VIA_KEEPOUT;
}


/*
 * CLASS: PLACEMENT GROUP (PLACE_REGION)
 */
2648
GROUP_OUTLINE::GROUP_OUTLINE( IDF3_BOARD* aParent )
2649
{
2650
    setParent( aParent );
2651 2652 2653 2654 2655 2656 2657
    outlineType = OTLN_GROUP_PLACE;
    thickness = 0.0;
    side = LYR_INVALID;
    single = true;
    return;
}

2658 2659

bool GROUP_OUTLINE::SetSide( IDF3::IDF_LAYER aSide )
2660
{
2661 2662 2663 2664 2665
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

2666 2667 2668 2669 2670 2671 2672 2673 2674
    switch( aSide )
    {
        case LYR_TOP:
        case LYR_BOTTOM:
        case LYR_BOTH:
            side = aSide;
            break;

        default:
2675 2676 2677 2678 2679 2680 2681 2682 2683
            do{
                ostringstream ostr;
                ostr << "invalid side (" << aSide << "); must be one of TOP/BOTTOM/BOTH\n";
                ostr << "* outline type: " << GetOutlineTypeString( outlineType );
                errormsg = ostr.str();

                return false;
            } while( 0 );

2684 2685 2686
            break;
    }

2687
    return true;
2688 2689
}

2690

2691 2692 2693 2694 2695
IDF3::IDF_LAYER GROUP_OUTLINE::GetSide( void )
{
    return side;
}

2696 2697

bool GROUP_OUTLINE::SetGroupName( std::string aGroupName )
2698
{
2699 2700 2701 2702 2703
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

2704
    groupName = aGroupName;
2705 2706

    return true;
2707 2708
}

2709

2710 2711 2712 2713 2714
const std::string& GROUP_OUTLINE::GetGroupName( void )
{
    return groupName;
}

2715 2716 2717

void GROUP_OUTLINE::readData( std::ifstream& aBoardFile, const std::string& aHeader,
                              IDF3::IDF_VERSION aIdfVersion )
2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
{
    //  Placement Group
    //      .PLACE_REGION [OWNER]
    //      [side: Top/Bot/Both ] [component group name]
    //      [outline]

    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
2728
    std::streampos pos = aBoardFile.tellg();
2729 2730

    if( !GetIDFString( aHeader, token, quoted, idx ) )
2731 2732
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: invalid invocation: blank header line" ) );
2733 2734 2735

    if( quoted )
    {
2736 2737 2738 2739 2740 2741 2742 2743
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section name must not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2744 2745 2746
    }

    if( !CompareToken( ".PLACE_REGION", token ) )
2747 2748
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: not a .PLACE_REGION" ) );
2749 2750 2751

    if( !GetIDFString( aHeader, token, quoted, idx ) )
    {
2752 2753 2754
        if( aIdfVersion > IDF_V2 )
            ERROR_IDF << "no OWNER; setting to UNOWNED\n";

2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774
        owner = UNOWNED;
    }
    else
    {
        if( !ParseOwner( token, owner ) )
        {
            ERROR_IDF << "invalid OWNER (reverting to UNOWNED): " << token << "\n";
            owner = UNOWNED;
        }
    }

    std::string iline;
    bool comment = false;

    // check RECORD 2
    // [side: Top/Bot/Both ] [component group name]
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( !aBoardFile.good() )
    {
2775 2776 2777 2778 2779 2780 2781
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2782 2783 2784 2785 2786
    }

    idx = 0;
    if( comment )
    {
2787 2788 2789 2790 2791 2792 2793 2794
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2795 2796 2797 2798
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
2799 2800 2801 2802 2803 2804 2805 2806
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no board side specified\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2807 2808 2809 2810 2811
    }

    if( !ParseIDFLayer( token, side ) ||
        ( side != LYR_TOP && side != LYR_BOTTOM && side != LYR_BOTH ) )
    {
2812 2813 2814 2815 2816 2817 2818 2819
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: invalid board side, must be one of TOP/BOTTOM/BOTH\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2820 2821 2822 2823
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
2824 2825 2826 2827 2828 2829 2830 2831
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no outline identifier\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2832 2833 2834 2835 2836
    }

    groupName = token;

    // read RECORD 3 values
2837
    readOutlines( aBoardFile, aIdfVersion );
2838 2839 2840 2841 2842 2843

    // check RECORD 4
    while( aBoardFile.good() && !FetchIDFLine( aBoardFile, iline, comment, pos ) );

    if( ( !aBoardFile.good() && aBoardFile.eof() ) || iline.empty() )
    {
2844 2845 2846 2847 2848 2849 2850
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2851 2852 2853 2854 2855
    }

    idx = 0;
    if( comment )
    {
2856 2857 2858 2859 2860 2861 2862 2863
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2864 2865 2866 2867
    }

    if( !GetIDFString( iline, token, quoted, idx )
        || !CompareToken( ".END_PLACE_REGION", token ) )
2868 2869
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* invalid .PLACE_REGION section: no .END_PLACE_REGION found" ) );
2870

2871
    return;
2872 2873
}

2874 2875

void GROUP_OUTLINE::writeData( std::ofstream& aBoardFile )
2876 2877 2878
{
    // this section is optional; do not write if not required
    if( outlines.empty() )
2879
        return;
2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897

    writeComments( aBoardFile );

    // write RECORD 1
    aBoardFile << ".PLACE_REGION ";

    writeOwner( aBoardFile );

    // write RECORD 2
    switch( side )
    {
        case LYR_TOP:
        case LYR_BOTTOM:
        case LYR_BOTH:
            WriteLayersText( aBoardFile, side );
            break;

        default:
2898 2899 2900 2901 2902 2903 2904 2905
            do{
                ostringstream ostr;
                ostr << "\n* invalid PLACE_REGION side (must be TOP/BOTTOM/BOTH): ";
                ostr << side;

                throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
            } while( 0 );

2906 2907 2908 2909 2910 2911
            break;
    }

    aBoardFile << " \"" << groupName << "\"\n";

    // write RECORD 3
2912
    writeOutlines( aBoardFile );
2913 2914 2915 2916

    // write RECORD 4
    aBoardFile << ".END_PLACE_REGION\n\n";

2917
    return;
2918 2919
}

2920
bool GROUP_OUTLINE::Clear( void )
2921
{
2922 2923 2924 2925 2926 2927
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();
2928 2929 2930
    thickness = 0.0;
    side = LYR_INVALID;
    groupName.clear();
2931 2932

    return true;
2933 2934 2935 2936 2937
}

/*
 * CLASS: COMPONENT OUTLINE
 */
2938
IDF3_COMP_OUTLINE::IDF3_COMP_OUTLINE( IDF3_BOARD* aParent )
2939
{
2940
    setParent( aParent );
2941 2942 2943 2944 2945 2946 2947
    single = true;
    outlineType = OTLN_COMPONENT;
    compType = COMP_INVALID;
    refNum = 0;
    return;
}

2948
void IDF3_COMP_OUTLINE::readProperties( std::ifstream& aLibFile )
2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
{
    bool quoted = false;
    bool comment = false;
    std::string iline;
    std::string token;
    std::streampos pos;
    std::string pname;      // property name
    std::string pval;       // property value
    int idx = 0;

    while( aLibFile.good() )
    {
        if( !FetchIDFLine( aLibFile, iline, comment, pos ) )
            continue;

        idx = 0;
2965

2966 2967
        if( comment )
        {
2968 2969 2970 2971 2972 2973 2974 2975
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: comment within section\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2976 2977 2978 2979
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
2980 2981 2982 2983 2984 2985 2986 2987
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: bad property section (no PROP)\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
2988 2989 2990 2991
        }

        if( quoted )
        {
2992 2993 2994 2995 2996 2997 2998 2999
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: PROP or .END must not be quoted\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3000 3001 3002 3003
        }

        if( token.size() >= 5 && CompareToken( ".END_", token.substr( 0, 5 ) ) )
        {
3004 3005 3006
            if(aLibFile.eof())
                aLibFile.clear();

3007
            aLibFile.seekg( pos );
3008
            return;
3009 3010 3011 3012
        }

        if( !CompareToken( "PROP", token ) )
        {
3013 3014 3015 3016 3017 3018 3019 3020
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: expecting PROP or .END_ELECTRICAL\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3021 3022 3023 3024
        }

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
3025 3026 3027 3028 3029 3030 3031 3032
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no PROP name\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3033 3034 3035 3036 3037 3038
        }

        pname = token;

        if( !GetIDFString( iline, token, quoted, idx ) )
        {
3039 3040 3041 3042 3043 3044 3045 3046
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no PROP value\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3047 3048 3049 3050 3051 3052
        }

        pval = token;

        if( props.insert( pair< string, string >(pname, pval) ).second == false )
        {
3053 3054 3055 3056 3057 3058 3059 3060
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: duplicate property name \"" << pname << "\"\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3061 3062 3063
        }
    }

3064
    return;
3065 3066
}

3067

3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084
bool IDF3_COMP_OUTLINE::writeProperties( std::ofstream& aLibFile )
{
    if( props.empty() )
        return true;
    std::map< std::string, std::string >::const_iterator itS = props.begin();
    std::map< std::string, std::string >::const_iterator itE = props.end();

    while( itS != itE )
    {
        aLibFile << "PROP " << "\"" << itS->first << "\" \""
        << itS->second << "\"\n";
        ++itS;
    }

    return !aLibFile.fail();
}

3085 3086
void IDF3_COMP_OUTLINE::readData( std::ifstream& aLibFile, const std::string& aHeader,
                                  IDF3::IDF_VERSION aIdfVersion )
3087 3088 3089 3090 3091 3092 3093 3094 3095
{
    //  .ELECTRICAL/.MECHANICAL
    //  [GEOM] [PART] [UNIT] [HEIGHT]
    //  [outline]
    //  [PROP] [prop name] [prop value]
    // check RECORD 1
    std::string token;
    bool quoted = false;
    int  idx = 0;
3096
    std::streampos pos = aLibFile.tellg();
3097 3098

    if( !GetIDFString( aHeader, token, quoted, idx ) )
3099 3100
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__,
                          "\n* BUG: invalid invocation: blank header line" ) );
3101 3102 3103

    if( quoted )
    {
3104 3105 3106 3107 3108 3109 3110 3111
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: section name must not be in quotes\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123
    }

    if( CompareToken( ".ELECTRICAL", token ) )
    {
        compType = COMP_ELEC;
    }
    else if( CompareToken( ".MECHANICAL", token ) )
    {
        compType = COMP_MECH;
    }
    else
    {
3124 3125 3126 3127 3128 3129 3130 3131
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: expecting .ELECTRICAL or .MECHANICAL header\n";
        ostr << "* line: '" << aHeader << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
    }

    // check RECORD 2
    // [GEOM] [PART] [UNIT] [HEIGHT]
    std::string iline;
    bool comment = false;

    while( aLibFile.good() && !FetchIDFLine( aLibFile, iline, comment, pos ) );

    if( !aLibFile.good() )
    {
3143 3144 3145 3146 3147 3148 3149
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3150 3151 3152 3153 3154
    }

    idx = 0;
    if( comment )
    {
3155 3156 3157 3158 3159 3160 3161 3162
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3163 3164 3165 3166
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
3167 3168 3169 3170 3171 3172 3173 3174
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no GEOMETRY NAME\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3175 3176 3177 3178 3179 3180
    }

    geometry = token;

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
3181 3182 3183 3184 3185 3186 3187 3188
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no PART NAME\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3189 3190 3191 3192 3193 3194
    }

    part = token;

    if( part.empty() && geometry.empty() )
    {
3195 3196 3197 3198 3199 3200 3201 3202
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: both GEOMETRY and PART names are empty\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3203 3204 3205 3206
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
3207 3208 3209 3210 3211 3212 3213 3214
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no UNIT type\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224
    }

    if( CompareToken( "MM", token ) )
    {
        unit = UNIT_MM;
    }
    else if( CompareToken( "THOU", token ) )
    {
        unit = UNIT_THOU;
    }
3225 3226 3227 3228
    else if( aIdfVersion == IDF_V2 && !CompareToken( "TNM", token ) )
    {
        unit = UNIT_TNM;
    }
3229 3230
    else
    {
3231 3232 3233 3234 3235 3236 3237 3238
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: invalid UNIT '" << token << "': must be one of MM or THOU\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3239 3240 3241 3242
    }

    if( !GetIDFString( iline, token, quoted, idx ) )
    {
3243 3244 3245 3246 3247 3248 3249 3250
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: no height specified\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3251 3252 3253 3254 3255 3256 3257 3258
    }

    std::istringstream teststr;
    teststr.str( token );

    teststr >> thickness;
    if( teststr.fail() )
    {
3259 3260 3261 3262 3263 3264 3265 3266
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: invalid height '" << token << "'\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3267 3268 3269
    }

    if( unit == UNIT_THOU )
3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283
    {
        thickness *= IDF_THOU_TO_MM;
    }
    else if( ( aIdfVersion == IDF_V2 ) && ( unit == UNIT_TNM ) )
    {
        thickness *= IDF_TNM_TO_MM;
    }
    else if( unit != UNIT_MM )
    {
        ostringstream ostr;
        ostr << "\n* BUG: invalid UNIT type: " << unit;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
    }
3284 3285

    // read RECORD 3 values
3286
    readOutlines( aLibFile, aIdfVersion );
3287

3288 3289
    if( compType == COMP_ELEC && aIdfVersion > IDF_V2 )
        readProperties( aLibFile );
3290 3291 3292 3293 3294 3295

    // check RECORD 4
    while( aLibFile.good() && !FetchIDFLine( aLibFile, iline, comment, pos ) );

    if( ( !aLibFile.good() && aLibFile.eof() ) || iline.empty() )
    {
3296 3297 3298 3299 3300 3301 3302
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: premature end\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3303 3304 3305 3306 3307
    }

    idx = 0;
    if( comment )
    {
3308 3309 3310 3311 3312 3313 3314 3315
        ostringstream ostr;

        ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
        ostr << "* violation: comment within section\n";
        ostr << "* line: '" << iline << "'\n";
        ostr << "* file position: " << pos;

        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3316 3317 3318 3319 3320 3321
    }

    if( compType == COMP_ELEC )
    {
        if( !CompareToken( ".END_ELECTRICAL", iline ) )
        {
3322 3323 3324 3325 3326 3327 3328 3329
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_ELECTRICAL found\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3330 3331 3332 3333 3334 3335
        }
    }
    else
    {
        if( !CompareToken( ".END_MECHANICAL", iline ) )
        {
3336 3337 3338 3339 3340 3341 3342 3343
            ostringstream ostr;

            ostr << "\n* invalid outline: " << GetOutlineTypeString( outlineType ) << "\n";
            ostr << "* violation: no .END_MECHANICAL found\n";
            ostr << "* line: '" << iline << "'\n";
            ostr << "* file position: " << pos;

            throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
3344 3345 3346
        }
    }

3347
    return;
3348 3349
}

3350 3351

void IDF3_COMP_OUTLINE::writeData( std::ofstream& aLibFile )
3352
{
3353 3354 3355
    if( refNum == 0 )
        return;    // nothing to do

3356 3357
    if( compType != COMP_ELEC && compType != COMP_MECH )
    {
3358 3359
        ostringstream ostr;
        ostr << "\n* component type not set or invalid: " << compType;
3360

3361 3362
        throw( IDF_ERROR( __FILE__, __FUNCTION__, __LINE__, ostr.str() ) );
    }
3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375

    writeComments( aLibFile );

    // note: the outline section is required, even if it is empty
    if( compType == COMP_ELEC )
        aLibFile << ".ELECTRICAL\n";
    else
        aLibFile << ".MECHANICAL\n";

    // RECORD 2
    // [GEOM] [PART] [UNIT] [HEIGHT]
    aLibFile << "\"" << geometry << "\" \"" << part << "\" ";

3376
    if( unit != UNIT_THOU )
3377 3378
        aLibFile << "MM " << setiosflags(ios::fixed) << setprecision(5) << thickness << "\n";
    else
3379
        aLibFile << "THOU " << setiosflags(ios::fixed) << setprecision(1) << (thickness / IDF_THOU_TO_MM) << "\n";
3380

3381
    writeOutlines( aLibFile );
3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392

    if( compType == COMP_ELEC )
    {
        writeProperties( aLibFile );
        aLibFile << ".END_ELECTRICAL\n\n";
    }
    else
    {
        aLibFile << ".END_MECHANICAL\n\n";
    }

3393
    return;
3394 3395
}

3396 3397

bool IDF3_COMP_OUTLINE::Clear( void )
3398
{
3399 3400 3401 3402 3403 3404
#ifndef DISABLE_IDF_OWNERSHIP
    if( !CheckOwnership( __LINE__, __FUNCTION__, parent, owner, outlineType, errormsg ) )
        return false;
#endif

    clear();
3405 3406 3407 3408 3409 3410
    uid.clear();
    geometry.clear();
    part.clear();
    compType = COMP_INVALID;
    refNum = 0;
    props.clear();
3411 3412

    return true;
3413 3414
}

3415
bool IDF3_COMP_OUTLINE::SetComponentClass( IDF3::COMP_TYPE aCompClass )
3416 3417 3418 3419 3420 3421 3422 3423 3424
{
    switch( aCompClass )
    {
        case COMP_ELEC:
        case COMP_MECH:
            compType = aCompClass;
            break;

        default:
3425 3426 3427 3428 3429 3430 3431 3432 3433 3434
            do{
                ostringstream ostr;
                ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
                ostr << "* BUG: invalid component class (must be ELECTRICAL or MECHANICAL): ";
                ostr << aCompClass << "\n";
                errormsg = ostr.str();

                return false;
            } while( 0 );

3435 3436 3437
            break;
    }

3438
    return true;
3439 3440
}

3441

3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485
IDF3::COMP_TYPE IDF3_COMP_OUTLINE::GetComponentClass( void )
{
    return compType;
}


void IDF3_COMP_OUTLINE::SetGeomName( const std::string& aGeomName )
{
    geometry = aGeomName;
    uid.clear();
    return;
}

const std::string& IDF3_COMP_OUTLINE::GetGeomName( void )
{
    return geometry;
}

void IDF3_COMP_OUTLINE::SetPartName( const std::string& aPartName )
{
    part = aPartName;
    uid.clear();
    return;
}

const std::string& IDF3_COMP_OUTLINE::GetPartName( void )
{
    return part;
}

const std::string& IDF3_COMP_OUTLINE::GetUID( void )
{
    if( !uid.empty() )
        return uid;

    if( geometry.empty() && part.empty() )
        return uid;

    uid = geometry + "_" + part;

    return uid;
}


3486
int IDF3_COMP_OUTLINE::incrementRef( void )
3487 3488 3489 3490
{
    return ++refNum;
}

3491
int IDF3_COMP_OUTLINE::decrementRef( void )
3492 3493 3494
{
    if( refNum == 0 )
    {
3495 3496 3497 3498 3499 3500
        ostringstream ostr;
        ostr << __FILE__ << ":" << __LINE__ << ":" << __FUNCTION__ << "():\n";
        ostr << "* BUG:  decrementing refNum beyond 0";
        errormsg = ostr.str();

        return -1;
3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585
    }

    --refNum;
    return refNum;
}

bool IDF3_COMP_OUTLINE::CreateDefaultOutline( const std::string &aGeom, const std::string &aPart )
{
    Clear();

    if( aGeom.empty() && aPart.empty() )
    {
        geometry  = "NOGEOM";
        part      = "NOPART";
        uid       = "NOGEOM_NOPART";
    }
    else
    {
        geometry  = aGeom;
        part      = aPart;
        uid       = aGeom + "_" + aPart;
    }

    compType  = COMP_ELEC;
    thickness = 5.0;
    unit      = UNIT_MM;

    // Create a star shape 5mm high with points on 5 and 3 mm circles
    double a, da;
    da = M_PI / 5.0;
    a = da / 2.0;

    IDF_POINT p1, p2;
    IDF_OUTLINE* ol = new IDF_OUTLINE;
    IDF_SEGMENT* sp;

    p1.x = 1.5 * cos( a );
    p1.y = 1.5 * sin( a );

    if( ol == NULL )
        return false;

    for( int i = 0; i < 10; ++i )
    {
        if( i & 1 )
        {
            p2.x = 2.5 * cos( a );
            p2.y = 2.5 * sin( a );
        }
        else
        {
            p2.x = 1.5 * cos( a );
            p2.y = 1.5 * sin( a );
        }

        sp = new IDF_SEGMENT( p1, p2 );

        if( sp == NULL )
        {
            Clear();
            return false;
        }

        ol->push( sp );
        a += da;
        p1 = p2;
    }

    a = da / 2.0;
    p2.x = 1.5 * cos( a );
    p2.y = 1.5 * sin( a );

    sp = new IDF_SEGMENT( p1, p2 );

    if( sp == NULL )
    {
        Clear();
        return false;
    }

    ol->push( sp );
    outlines.push_back( ol );

    return true;
}