io_mgr.cpp 4.28 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
/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2011 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
 * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */


#include <io_mgr.h>
#include <kicad_plugin.h>


30 31
// Some day plugins might be in separate DLL/DSOs, simply because of numbers of them
// and code size.  Until then, use the simplest method:
32 33

// This implementation is one of two which could be done.
34
// The other one would cater to DLL/DSO's.  But since it would be nearly
35
// impossible to link a KICAD type DLL/DSO right now without pulling in all
36
// ::Draw() functions, I forgo that option temporarily.
37

38 39
// Some day it may be possible to have some built in AND some DLL/DSO
// plugins coexisting.
40

41

42
// static KICAD_PLUGIN kicad_plugin;       // a secret
43 44 45 46
//static EAGLE_PLUGIN eagle_plugin;

PLUGIN* IO_MGR::PluginFind( PCB_FILE_T aFileType )
{
47 48 49
    // This implementation is subject to change, any magic is allowed here.
    // The public IO_MGR API is the only pertinent public information.

50 51
    switch( aFileType )
    {
52 53 54
    case KICAD:
        return new KICAD_PLUGIN();

55

56 57 58 59
/*
    case EAGLE:
        return &eagle_plugin;
*/
60 61 62 63 64 65 66 67 68 69 70
    }

    return NULL;
}


void IO_MGR::PluginRelease( PLUGIN* aPlugin )
{
    // This function is a place holder for a future point in time where
    // the plugin is a DLL/DSO.  It could do reference counting, and then
    // unload the DLL/DSO when count goes to zero.
71 72

    delete aPlugin;
73 74 75
}


76
const wxString IO_MGR::ShowType( PCB_FILE_T aFileType )
77 78 79 80
{
    switch( aFileType )
    {
    default:
81 82 83 84
        return wxString::Format( _( "Unknown PCB_FILE_T value: %d" ), aFileType );

    case KICAD:
        return wxString( wxT( "KiCad" ) );
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
    }
}


BOARD* IO_MGR::Load( PCB_FILE_T aFileType, const wxString& aFileName,
                    BOARD* aAppendToMe, PROPERTIES* aProperties )
{
    // release the PLUGIN even if an exception is thrown.
    PLUGIN::RELEASER pi = PluginFind( aFileType );

    if( (PLUGIN*) pi )  // test pi->plugin
    {
        return pi->Load( aFileName, aAppendToMe, aProperties );  // virtual
    }

100
    THROW_IO_ERROR( wxString::Format( _( "Plugin type '%s' is not found." ), ShowType( aFileType ).GetData() ) );
101 102 103
}


104 105 106 107 108 109 110 111 112 113 114
void IO_MGR::Save( PCB_FILE_T aFileType, const wxString& aFileName, BOARD* aBoard, PROPERTIES* aProperties )
{
    // release the PLUGIN even if an exception is thrown.
    PLUGIN::RELEASER pi = PluginFind( aFileType );

    if( (PLUGIN*) pi )  // test pi->plugin
    {
        pi->Save( aFileName, aBoard, aProperties );  // virtual
        return;
    }

115
    THROW_IO_ERROR( wxString::Format( _( "Plugin type '%s' is not found." ), ShowType( aFileType ).GetData() ) );
116 117 118
}


119 120 121 122 123
BOARD* PLUGIN::Load( const wxString& aFileName, BOARD* aAppendToMe, PROPERTIES* aProperties )
{
    // not pure virtual so that plugins only have to implement subset of the PLUGIN interface,
    // e.g. Load() or Save() but not both.

124 125
    THROW_IO_ERROR( wxString::Format(
        _( "Plugin %s does not implement the BOARD Load() function." ), PluginName().GetData() ) );
126 127 128
}


129
void PLUGIN::Save( const wxString& aFileName, BOARD* aBoard, PROPERTIES* aProperties )
130 131 132 133
{
    // not pure virtual so that plugins only have to implement subset of the PLUGIN interface,
    // e.g. Load() or Save() but not both.

134 135
    THROW_IO_ERROR( wxString::Format(
        _( "Plugin %s does not implement the BOARD Save() function." ), PluginName().GetData() ) );
136
}