dialog_plot_schematic.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2018 Jean-Pierre Charras jp.charras at wanadoo.fr
 * Copyright (C) 1992-2010 Lorenzo Marcantonio
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */
 
#include <bitmaps.h>
#include <common.h>     // For ExpandEnvVarSubstitutions
#include "string_utils.h"
#include "widgets/wx_html_report_panel.h"
#include <widgets/std_bitmap_button.h>
#include <dialog_plot_schematic.h>
#include <eeschema_settings.h>
#include <kiface_base.h>
#include <locale_io.h>
#include <plotters/plotter_dxf.h>
#include <plotters/plotters_pslike.h>
#include <reporter.h>
#include <trace_helpers.h>
#include <settings/settings_manager.h>
#include <wx_filename.h>
#include <pgm_base.h>
#include <sch_edit_frame.h>
#include <sch_painter.h>
 
#include <wx/dirdlg.h>
#include <wx/msgdlg.h>
#include <kiplatform/environment.h>
#include <wx/log.h>
 
#include <jobs/job_export_sch_plot.h>
 
 
// static members (static to remember last state):
int DIALOG_PLOT_SCHEMATIC::m_pageSizeSelect = PAGE_SIZE_AUTO;
 
 
DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC( SCH_EDIT_FRAME* aEditFrame ) :
        DIALOG_PLOT_SCHEMATIC( aEditFrame, aEditFrame )
{
}
 
 
DIALOG_PLOT_SCHEMATIC::DIALOG_PLOT_SCHEMATIC( SCH_EDIT_FRAME* aEditFrame, wxWindow* aParent,
                                              JOB_EXPORT_SCH_PLOT* aJob ) :
        DIALOG_PLOT_SCHEMATIC_BASE( aEditFrame ),
        m_editFrame( aEditFrame ),
        m_plotFormat( PLOT_FORMAT::UNDEFINED ),
        m_defaultLineWidth( aEditFrame, m_lineWidthLabel, m_lineWidthCtrl, m_lineWidthUnits ),
        m_job( aJob )
{
    m_configChanged = false;
 
    if( !m_job )
    {
        m_browseButton->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
        m_MessagesBox->SetFileName( Prj().GetProjectPath() + wxT( "report.txt" ) );
        SetupStandardButtons( { { wxID_OK, _( "Plot All Pages" ) },
                                { wxID_APPLY, _( "Plot Current Page" ) },
                                { wxID_CANCEL, _( "Close" ) } } );
    }
    else
    {
        SetTitle( m_job->GetSettingsDialogTitle() );
 
        m_browseButton->Hide();
        m_MessagesBox->Hide();
 
        m_sdbSizer1Apply->Hide();
        m_openFileAfterPlot->Hide();
 
        SetupStandardButtons();
    }
 
    // DIALOG_SHIM needs a unique hash_key because classname will be the same for both job and
    // non-job versions (which have different sizes).
    m_hash_key = TO_UTF8( GetTitle() );
 
    initDlg();
 
    // Now all widgets have the size fixed, call FinishDialogSettings
    finishDialogSettings();
}
 
 
void DIALOG_PLOT_SCHEMATIC::initDlg()
{
    auto cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
    wxASSERT( cfg );
 
    if( !m_job )
    {
        if( cfg )
        {
            for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
            {
                int idx = m_colorTheme->Append( settings->GetName(),
                                                static_cast<void*>( settings ) );
 
                if( settings->GetFilename() == cfg->m_PlotPanel.color_theme )
                    m_colorTheme->SetSelection( idx );
            }
 
            m_colorTheme->Enable( cfg->m_PlotPanel.color );
 
            m_plotBackgroundColor->Enable( cfg->m_PlotPanel.color );
            m_plotBackgroundColor->SetValue( cfg->m_PlotPanel.background_color );
 
            // Set color or B&W plot option
            setModeColor( cfg->m_PlotPanel.color );
 
            // Set plot or not frame reference option
            setPlotDrawingSheet( cfg->m_PlotPanel.frame_reference );
 
            setOpenFileAfterPlot( cfg->m_PlotPanel.open_file_after_plot );
 
            m_plotPDFPropertyPopups->SetValue( cfg->m_PlotPanel.pdf_property_popups );
            m_plotPDFHierarchicalLinks->SetValue( cfg->m_PlotPanel.pdf_hierarchical_links );
            m_plotPDFMetadata->SetValue( cfg->m_PlotPanel.pdf_metadata );
 
            // Switch to the last save plot format
            PLOT_FORMAT fmt = static_cast<PLOT_FORMAT>( cfg->m_PlotPanel.format );
 
            switch( fmt )
            {
            default:
            case PLOT_FORMAT::POST: m_plotFormatOpt->SetSelection( 0 ); break;
            case PLOT_FORMAT::PDF:  m_plotFormatOpt->SetSelection( 1 ); break;
            case PLOT_FORMAT::SVG:  m_plotFormatOpt->SetSelection( 2 ); break;
            case PLOT_FORMAT::DXF:  m_plotFormatOpt->SetSelection( 3 ); break;
            case PLOT_FORMAT::HPGL: /* no longer supported */           break;
            }
 
            if( fmt == PLOT_FORMAT::DXF )
                m_plotBackgroundColor->Disable();
 
            // Set the default line width (pen width which should be used for
            // items that do not have a pen size defined (like frame ref)
            // the default line width is stored in mils in config
            m_defaultLineWidth.SetValue( schIUScale.MilsToIU( cfg->m_Drawing.default_line_thickness ) );
        }
 
        // Plot directory
        SCHEMATIC_SETTINGS& settings = m_editFrame->Schematic().Settings();
        wxString            path = settings.m_PlotDirectoryName;
#ifdef __WINDOWS__
        path.Replace( '/', '\\' );
#endif
        m_outputPath->SetValue( path );
    }
    else if( m_job )
    {
        for( COLOR_SETTINGS* settings : Pgm().GetSettingsManager().GetColorSettingsList() )
        {
            int idx = m_colorTheme->Append( settings->GetName(), static_cast<void*>( settings ) );
 
            if( settings->GetName() == m_job->m_theme )
                m_colorTheme->SetSelection( idx );
        }
 
        if( m_colorTheme->GetSelection() == wxNOT_FOUND )
            m_colorTheme->SetSelection( 0 );
 
        m_plotBackgroundColor->SetValue( m_job->m_useBackgroundColor );
        m_defaultLineWidth.SetValue( m_job->m_minPenWidth );
        m_plotPDFPropertyPopups->SetValue( m_job->m_PDFPropertyPopups );
        m_plotPDFHierarchicalLinks->SetValue( m_job->m_PDFHierarchicalLinks );
        m_plotPDFMetadata->SetValue( m_job->m_PDFMetadata );
        m_pageSizeSelect = static_cast<int>( m_job->m_pageSizeSelect );
        m_plotDrawingSheet->SetValue( m_job->m_plotDrawingSheet );
        setModeColor( !m_job->m_blackAndWhite );
 
        // Set the plot format
        switch( m_job->m_plotFormat )
        {
        default:
        case SCH_PLOT_FORMAT::POST: m_plotFormatOpt->SetSelection( 0 ); break;
        case SCH_PLOT_FORMAT::PDF:  m_plotFormatOpt->SetSelection( 1 ); break;
        case SCH_PLOT_FORMAT::SVG:  m_plotFormatOpt->SetSelection( 2 ); break;
        case SCH_PLOT_FORMAT::DXF:  m_plotFormatOpt->SetSelection( 3 ); break;
        case SCH_PLOT_FORMAT::HPGL: /* no longer supported */           break;
        }
 
        // And then hide it
        m_plotFormatOpt->Hide();
 
        m_outputPath->SetValue( m_job->GetConfiguredOutputPath() );
    }
}
 
 
void DIALOG_PLOT_SCHEMATIC::onOutputDirectoryBrowseClicked( wxCommandEvent& event )
{
    // Build the absolute path of current output directory to preselect it in the file browser.
    wxString path = ExpandEnvVarSubstitutions( m_outputPath->GetValue(), &Prj() );
 
    // When editing a schematic that is not part of a project in the stand alone mode, the
    // project path is not defined so point to the users document path to save the plot files.
    if( Prj().IsNullProject() )
    {
        path = KIPLATFORM::ENV::GetDocumentsPath();
    }
    else
    {
        // Build the absolute path of current output directory to preselect it in the file browser.
        path = ExpandEnvVarSubstitutions( m_outputPath->GetValue(), &Prj() );
        path = Prj().AbsolutePath( path );
    }
 
    wxDirDialog dirDialog( this, _( "Select Output Directory" ), path );
 
    if( dirDialog.ShowModal() == wxID_CANCEL )
        return;
 
    wxFileName dirName = wxFileName::DirName( dirDialog.GetPath() );
 
    wxFileName fn( Prj().AbsolutePath( m_editFrame->Schematic().Root().GetFileName() ) );
    wxString defaultPath = fn.GetPathWithSep();
    wxString msg;
    wxFileName relPathTest; // Used to test if we can make the path relative
 
    relPathTest.Assign( dirDialog.GetPath() );
 
    // Test if making the path relative is possible before asking the user if they want to do it
    if( relPathTest.MakeRelativeTo( defaultPath ) )
    {
        msg.Printf( _( "Do you want to use a path relative to\n'%s'?" ), defaultPath );
 
        wxMessageDialog dialog( this, msg, _( "Plot Output Directory" ),
                                wxYES_NO | wxICON_QUESTION | wxYES_DEFAULT );
 
        if( dialog.ShowModal() == wxID_YES )
            dirName.MakeRelativeTo( defaultPath );
    }
 
    m_outputPath->SetValue( dirName.GetFullPath() );
}
 
 
PLOT_FORMAT DIALOG_PLOT_SCHEMATIC::GetPlotFileFormat()
{
    switch( m_plotFormatOpt->GetSelection() )
    {
    case 0: return PLOT_FORMAT::POST;
    default:
    case 1: return PLOT_FORMAT::PDF;
    case 2: return PLOT_FORMAT::SVG;
    case 3: return PLOT_FORMAT::DXF;
    }
}
 
 
void DIALOG_PLOT_SCHEMATIC::OnPageSizeSelected( wxCommandEvent& event )
{
    m_pageSizeSelect = m_paperSizeOption->GetSelection();
}
 
 
void DIALOG_PLOT_SCHEMATIC::OnUpdateUI( wxUpdateUIEvent& event )
{
    PLOT_FORMAT fmt = GetPlotFileFormat();
 
    if( fmt != m_plotFormat )
    {
        m_plotFormat = fmt;
 
        wxArrayString paperSizes;
        paperSizes.push_back( _( "Schematic size" ) );
 
        int selection;
 
        paperSizes.push_back( _( "A4" ) );
        paperSizes.push_back( _( "A" ) );
 
        selection = m_pageSizeSelect;
 
        m_openFileAfterPlot->Enable( fmt == PLOT_FORMAT::PDF );
        m_plotPDFPropertyPopups->Enable( fmt == PLOT_FORMAT::PDF );
        m_plotPDFHierarchicalLinks->Enable( fmt == PLOT_FORMAT::PDF );
        m_plotPDFMetadata->Enable( fmt == PLOT_FORMAT::PDF );
 
        m_paperSizeOption->Set( paperSizes );
        m_paperSizeOption->SetSelection( selection );
 
        m_defaultLineWidth.Enable( fmt == PLOT_FORMAT::POST
                                   || fmt == PLOT_FORMAT::PDF
                                   || fmt == PLOT_FORMAT::SVG );
 
        m_plotBackgroundColor->Enable( fmt == PLOT_FORMAT::POST
                                       || fmt == PLOT_FORMAT::PDF
                                       || fmt == PLOT_FORMAT::SVG );
    }
}
 
 
void DIALOG_PLOT_SCHEMATIC::getPlotOptions( RENDER_SETTINGS* aSettings )
{
    EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() );
    wxASSERT( cfg );
 
    COLOR_SETTINGS* colors = getColorSettings();
 
    if( cfg )
    {
        cfg->m_PlotPanel.background_color = m_plotBackgroundColor->GetValue();
        cfg->m_PlotPanel.color            = getModeColor();
        cfg->m_PlotPanel.color_theme      = colors->GetFilename();
        cfg->m_PlotPanel.frame_reference  = getPlotDrawingSheet();
        cfg->m_PlotPanel.format           = static_cast<int>( GetPlotFileFormat() );
        cfg->m_PlotPanel.pdf_property_popups    = m_plotPDFPropertyPopups->GetValue();
        cfg->m_PlotPanel.pdf_hierarchical_links = m_plotPDFHierarchicalLinks->GetValue();
        cfg->m_PlotPanel.pdf_metadata           = m_plotPDFMetadata->GetValue();
        cfg->m_PlotPanel.open_file_after_plot   = getOpenFileAfterPlot();
 
        aSettings->SetDefaultFont( cfg->m_Appearance.default_font );
    }
 
    aSettings->LoadColors( colors );
    aSettings->SetMinPenWidth( (int) m_defaultLineWidth.GetValue() );
 
    if( m_plotBackgroundColor->GetValue() )
        aSettings->SetBackgroundColor( colors->GetColor( LAYER_SCHEMATIC_BACKGROUND ) );
    else
        aSettings->SetBackgroundColor( COLOR4D::UNSPECIFIED );
 
    // Plot directory
    wxString path = m_outputPath->GetValue();
    path.Replace( '\\', '/' );
 
    SCHEMATIC_SETTINGS& settings = m_editFrame->Schematic().Settings();
 
    if( settings.m_PlotDirectoryName != path )
        m_configChanged = true;
 
    settings.m_PlotDirectoryName = path;
}
 
 
COLOR_SETTINGS* DIALOG_PLOT_SCHEMATIC::getColorSettings()
{
    int selection = m_colorTheme->GetSelection();
 
    if( selection < 0 )
        return ::GetColorSettings( COLOR_SETTINGS::COLOR_BUILTIN_DEFAULT );
 
    return static_cast<COLOR_SETTINGS*>( m_colorTheme->GetClientData( selection ) );
}
 
 
void DIALOG_PLOT_SCHEMATIC::OnPlotCurrent( wxCommandEvent& event )
{
    plotSchematic( false );
}
 
 
void DIALOG_PLOT_SCHEMATIC::OnPlotAll( wxCommandEvent& event )
{
    if( !m_job )
    {
        plotSchematic( true );
    }
    else
    {
        m_job->m_blackAndWhite = !getModeColor();
        m_job->m_useBackgroundColor = m_plotBackgroundColor->GetValue();
        m_job->m_minPenWidth = m_defaultLineWidth.GetIntValue();
 
        m_job->m_pageSizeSelect = static_cast<JOB_PAGE_SIZE>( m_pageSizeSelect );
        m_job->m_PDFPropertyPopups = m_plotPDFPropertyPopups->GetValue();
        m_job->m_PDFHierarchicalLinks = m_plotPDFHierarchicalLinks->GetValue();
        m_job->m_PDFMetadata = m_plotPDFMetadata->GetValue();
        m_job->m_plotDrawingSheet = m_plotDrawingSheet->GetValue();
        m_job->m_plotAll = true;
        m_job->SetConfiguredOutputPath( m_outputPath->GetValue() );
 
        COLOR_SETTINGS* colors = getColorSettings();
        m_job->m_theme = colors->GetName();
 
        event.Skip();   // Allow normal close action
    }
}
 
 
void DIALOG_PLOT_SCHEMATIC::plotSchematic( bool aPlotAll )
{
    wxBusyCursor dummy;
 
    SCH_RENDER_SETTINGS renderSettings( *m_editFrame->GetRenderSettings() );
    renderSettings.m_ShowHiddenPins = false;
    renderSettings.m_ShowHiddenFields = false;
 
    getPlotOptions( &renderSettings );
 
    std::unique_ptr<SCH_PLOTTER> schPlotter = std::make_unique<SCH_PLOTTER>( m_editFrame );
 
    COLOR_SETTINGS*   colors = getColorSettings();
 
    SCH_PLOT_OPTS plotOpts;
    plotOpts.m_plotDrawingSheet = getPlotDrawingSheet();
    plotOpts.m_plotAll = aPlotAll;
    plotOpts.m_blackAndWhite = !getModeColor();
    plotOpts.m_useBackgroundColor = m_plotBackgroundColor->GetValue();
    plotOpts.m_theme = colors->GetFilename();
    plotOpts.m_PDFPropertyPopups = m_plotPDFPropertyPopups->GetValue();
    plotOpts.m_PDFHierarchicalLinks = m_plotPDFHierarchicalLinks->GetValue();
    plotOpts.m_PDFMetadata = m_plotPDFMetadata->GetValue();
    plotOpts.m_outputDirectory = getOutputPath();
    plotOpts.m_pageSizeSelect = m_pageSizeSelect;
    plotOpts.m_plotHopOver = m_editFrame->Schematic().Settings().m_HopOverScale > 0.0;
 
    schPlotter->Plot( GetPlotFileFormat(), plotOpts, &renderSettings, &m_MessagesBox->Reporter() );
 
    if( GetPlotFileFormat() == PLOT_FORMAT::PDF && getOpenFileAfterPlot() )
        wxLaunchDefaultApplication( schPlotter->GetLastOutputFilePath() );
}
 
 
wxString DIALOG_PLOT_SCHEMATIC::getOutputPath()
{
    wxString msg;
    wxString extMsg;
    wxFileName fn;
 
    extMsg.Printf( _( "Falling back to user path '%s'." ), KIPLATFORM::ENV::GetDocumentsPath() );
 
    // Build the absolute path of current output directory to preselect it in the file browser.
    std::function<bool( wxString* )> textResolver =
            [&]( wxString* token ) -> bool
            {
                SCHEMATIC& schematic = m_editFrame->Schematic();
                return schematic.ResolveTextVar( &schematic.CurrentSheet(), token, 0 );
            };
 
    wxString path = m_outputPath->GetValue();
    path = ExpandTextVars( path, &textResolver );
    path = ExpandEnvVarSubstitutions( path, &Prj() );
 
    fn.SetPath( path );
 
    // If the contents of the path edit control results in an absolute path, return it as is.
    if( fn.IsAbsolute() )
        return path;
 
    // When editing a schematic that is not part of a project in the stand alone mode, the
    // project path is not defined.
    if( Prj().IsNullProject() )
    {
        SCH_SCREEN* screen = m_editFrame->Schematic().RootScreen();
 
        if( screen && !screen->GetFileName().IsEmpty() )
        {
            fn = screen->GetFileName();
            msg.Printf( _( "Cannot normalize path '%s%s'." ), fn.GetPathWithSep(), path );
            fn.SetPath( fn.GetPathWithSep() + path );
 
            // Normalize always returns true for a non-empty file name so clear the file name
            // and extension so that only the path is normalized.
            fn.SetName( wxEmptyString );
            fn.SetExt( wxEmptyString );
 
            if( fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) )
            {
                path = fn.GetPath();
            }
            else
            {
                wxMessageDialog dlg( this, msg, _( "Warning" ), wxOK | wxCENTER | wxRESIZE_BORDER
                                     | wxICON_EXCLAMATION | wxSTAY_ON_TOP );
 
                dlg.SetExtendedMessage( extMsg );
                dlg.ShowModal();
 
                path = KIPLATFORM::ENV::GetDocumentsPath();
            }
        }
        else
        {
            msg = _( "No project or path defined for the current schematic." );
 
            wxMessageDialog dlg( this, msg, _( "Warning" ), wxOK | wxCENTER | wxRESIZE_BORDER
                                 | wxICON_EXCLAMATION | wxSTAY_ON_TOP );
            dlg.SetExtendedMessage( extMsg );
            dlg.ShowModal();
 
            // Always fall back to user's document path if no other absolute path can be normalized.
            path = KIPLATFORM::ENV::GetDocumentsPath();
        }
    }
    else
    {
        msg.Printf( _( "Cannot normalize path '%s%s'." ), Prj().GetProjectPath(), path );
 
        // Build the absolute path of current output directory and the project path.
        fn.SetPath( Prj().GetProjectPath() + path );
 
        if( fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) )
        {
            path = fn.GetPath();
        }
        else
        {
            wxMessageDialog dlg( this, msg, _( "Warning" ),
                                 wxOK | wxCENTER | wxRESIZE_BORDER | wxICON_EXCLAMATION |
                                 wxSTAY_ON_TOP );
 
            dlg.SetExtendedMessage( extMsg );
            dlg.ShowModal();
 
            path = KIPLATFORM::ENV::GetDocumentsPath();
        }
    }
 
    return path;
}