pl_editor.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2013 CERN
 * Copyright (C) 2021 KiCad Developers, see AUTHORS.txt for contributors.
 * @author Jean-Pierre Charras, jp.charras at wanadoo.fr
 *
 * 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 <wx/file.h>
#include <wx/snglinst.h>

#include <kiface_base.h>
#include <confirm.h>
#include <gestfich.h>
#include <pgm_base.h>
#include <settings/settings_manager.h>

#include "pl_editor_frame.h"
#include "pl_editor_settings.h"


namespace PGE {

static struct IFACE : public KIFACE_BASE
{
 // Of course all are virtual overloads, implementations of the KIFACE.

 IFACE( const char* aName, KIWAY::FACE_T aType ) :
 KIFACE_BASE( aName, aType )
 {}

 bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) override;

 void OnKifaceEnd() override;

 wxWindow* CreateWindow( wxWindow* aParent, int aClassId, KIWAY* aKiway,
 int aCtlBits = 0 ) override
 {
 switch( aClassId )
 {
 case FRAME_PL_EDITOR:
 {
 PL_EDITOR_FRAME* frame = new PL_EDITOR_FRAME( aKiway, aParent );
 return frame;
 break;
 }

 default:
 ;
 }

 return nullptr;
 }

 void* IfaceOrAddress( int aDataId ) override
 {
 return nullptr;
 }

 void SaveFileAs( const wxString& aProjectBasePath, const wxString& aSrcProjectName,
 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
 const wxString& aSrcFilePath, wxString& aErrors ) override;

} kiface( "pl_editor", KIWAY::FACE_PL_EDITOR );

} // namespace


using namespace PGE;


static PGM_BASE* process;


KIFACE_BASE& Kiface() { return kiface; }


// KIFACE_GETTER's actual spelling is a substitution macro found in kiway.h.
// KIFACE_GETTER will not have name mangling due to declaration in kiway.h.
MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKiwayVersion, PGM_BASE* aProgram )
{
 process = (PGM_BASE*) aProgram;
 return &kiface;
}


PGM_BASE& Pgm()
{
 wxASSERT( process ); // KIFACE_GETTER has already been called.
 return *process;
}


// Similar to PGM_BASE& Pgm(), but return nullptr when a *.ki_face is run from a python script.
PGM_BASE* PgmOrNull()
{
 return process;
}

bool IFACE::OnKifaceStart( PGM_BASE* aProgram, int aCtlBits )
{
 InitSettings( new PL_EDITOR_SETTINGS );
 aProgram->GetSettingsManager().RegisterSettings( KifaceSettings() );
 start_common( aCtlBits );
 return true;
}


void IFACE::OnKifaceEnd()
{
 end_common();
}


void IFACE::SaveFileAs( const wxString& aProjectBasePath, const wxString& aSrcProjectName,
 const wxString& aNewProjectBasePath, const wxString& aNewProjectName,
 const wxString& aSrcFilePath, wxString& aErrors )
{
 wxFileName destFile( aSrcFilePath );
 wxString destPath = destFile.GetPathWithSep();
 wxUniChar pathSep = wxFileName::GetPathSeparator();
 wxString ext = destFile.GetExt();

 if( destPath.StartsWith( aProjectBasePath + pathSep ) )
 {
 destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
 destFile.SetPath( destPath );
 }

 if( ext == "kicad_wks" )
 {
 if( destFile.GetName() == aSrcProjectName )
 destFile.SetName( aNewProjectName );

 KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
 }
 else
 {
 wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
 }
}