unit_binder.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014-2015 CERN
 * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
 * Author: Maciej Suminski <[email protected]>
 *
 * 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/clipbrd.h>
#include <wx/stattext.h>
#include <wx/textentry.h>
#include <limits>
#include <base_units.h>
#include <eda_draw_frame.h>
#include <confirm.h>

#include "widgets/unit_binder.h"


wxDEFINE_EVENT( DELAY_FOCUS, wxCommandEvent );


UNIT_BINDER::UNIT_BINDER( EDA_DRAW_FRAME* aParent, wxStaticText* aLabel, wxWindow* aValueCtrl,
 wxStaticText* aUnitLabel, bool allowEval ) :
 m_frame( aParent ),
 m_label( aLabel ),
 m_valueCtrl( aValueCtrl ),
 m_unitLabel( aUnitLabel ),
 m_negativeZero( false ),
 m_dataType( EDA_DATA_TYPE::DISTANCE ),
 m_precision( 0 ),
 m_eval( aParent->GetUserUnits() ),
 m_originTransforms( aParent->GetOriginTransforms() ),
 m_coordType( ORIGIN_TRANSFORMS::NOT_A_COORD )
{
 m_units = aParent->GetUserUnits();
 m_allowEval = allowEval && dynamic_cast<wxTextEntry*>( m_valueCtrl );
 m_needsEval = false;
 m_selStart = 0;
 m_selEnd = 0;

 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );

 if( textEntry )
 {
 // Use ChangeValue() instead of SetValue() so we don't generate events.
 if( m_negativeZero )
 textEntry->ChangeValue( wxT( "-0" ) );
 else
 textEntry->ChangeValue( wxT( "0" ) );
 }

 if( m_unitLabel )
 m_unitLabel->SetLabel( GetAbbreviatedUnitsLabel( m_units, m_dataType ) );

 m_valueCtrl->Connect( wxEVT_SET_FOCUS, wxFocusEventHandler( UNIT_BINDER::onSetFocus ),
 nullptr, this );
 m_valueCtrl->Connect( wxEVT_KILL_FOCUS, wxFocusEventHandler( UNIT_BINDER::onKillFocus ),
 nullptr, this );
 Connect( DELAY_FOCUS, wxCommandEventHandler( UNIT_BINDER::delayedFocusHandler ), nullptr,
 this );

 m_frame->Connect( UNITS_CHANGED, wxCommandEventHandler( UNIT_BINDER::onUnitsChanged ),
 nullptr, this );
}


UNIT_BINDER::~UNIT_BINDER()
{
 m_frame->Disconnect( UNITS_CHANGED, wxCommandEventHandler( UNIT_BINDER::onUnitsChanged ),
 nullptr, this );
}


void UNIT_BINDER::SetUnits( EDA_UNITS aUnits )
{
 m_units = aUnits;

 if( m_unitLabel )
 m_unitLabel->SetLabel( GetAbbreviatedUnitsLabel( m_units, m_dataType ) );
}


void UNIT_BINDER::SetPrecision( int aLength )
{
 m_precision = std::min( aLength, 6 );
}


void UNIT_BINDER::SetDataType( EDA_DATA_TYPE aDataType )
{
 m_dataType = aDataType;

 if( m_unitLabel )
 m_unitLabel->SetLabel( GetAbbreviatedUnitsLabel( m_units, m_dataType ) );
}


void UNIT_BINDER::onUnitsChanged( wxCommandEvent& aEvent )
{
 int temp = (int) GetValue();

 SetUnits( m_frame->GetUserUnits() );

 SetValue( temp );

 aEvent.Skip();
}


void UNIT_BINDER::onSetFocus( wxFocusEvent& aEvent )
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );

 if( m_allowEval && textEntry )
 {
 wxString oldStr = m_eval.OriginalText();

 if( oldStr.length() && oldStr != textEntry->GetValue() )
 {
 textEntry->SetValue( oldStr );
 textEntry->SetSelection( m_selStart, m_selEnd );
 }

 m_needsEval = true;
 }

 aEvent.Skip();
}


void UNIT_BINDER::onKillFocus( wxFocusEvent& aEvent )
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );

 if( m_allowEval && textEntry )
 {
 if( m_eval.Process( textEntry->GetValue() ) )
 {
 textEntry->GetSelection( &m_selStart, &m_selEnd );
 wxString sel = textEntry->GetStringSelection();

 textEntry->ChangeValue( m_eval.Result() );

#ifdef __WXGTK__
 // Manually copy the selected text to the primary selection clipboard
 if( wxTheClipboard->Open() )
 {
 bool clipTarget = wxTheClipboard->IsUsingPrimarySelection();
 wxTheClipboard->UsePrimarySelection( true );
 wxTheClipboard->SetData( new wxTextDataObject( sel ) );
 wxTheClipboard->UsePrimarySelection( clipTarget );
 wxTheClipboard->Close();
 }
#endif
 }

 m_needsEval = false;
 }

 aEvent.Skip();
}


wxString valueDescriptionFromLabel( wxStaticText* aLabel )
{
 wxString desc = aLabel->GetLabel();

 desc.EndsWith( wxT( ":" ), &desc );
 return desc;
}


void UNIT_BINDER::delayedFocusHandler( wxCommandEvent& )
{
 if( !m_errorMessage.IsEmpty() )
 DisplayError( m_valueCtrl->GetParent(), m_errorMessage );

 m_errorMessage = wxEmptyString;
 m_valueCtrl->SetFocus();
}


bool UNIT_BINDER::Validate( double aMin, double aMax, EDA_UNITS aUnits )
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );

 if( !textEntry
 || textEntry->GetValue() == INDETERMINATE_ACTION
 || textEntry->GetValue() == INDETERMINATE_STATE )
 {
 return true;
 }

 // TODO: Validate() does not currently support m_dataType being anything other than DISTANCE
 // Note: aMin and aMax are not always given in internal units
 if( GetValue() < From_User_Unit( aUnits, aMin ) )
 {
 double val_min_iu = From_User_Unit( aUnits, aMin );
 m_errorMessage = wxString::Format( _( "%s must be at least %s." ),
 valueDescriptionFromLabel( m_label ),
 StringFromValue( m_units, val_min_iu, true ) );

 textEntry->SelectAll();

 // Don't focus directly; we might be inside a KillFocus event handler
 wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) );

 return false;
 }

 if( GetValue() > From_User_Unit( aUnits, aMax ) )
 {
 double val_max_iu = From_User_Unit( aUnits, aMax );
 m_errorMessage = wxString::Format( _( "%s must be less than %s." ),
 valueDescriptionFromLabel( m_label ),
 StringFromValue( m_units, val_max_iu, true ) );

 textEntry->SelectAll();

 // Don't focus directly; we might be inside a KillFocus event handler
 wxPostEvent( this, wxCommandEvent( DELAY_FOCUS ) );

 return false;
 }

 return true;
}


void UNIT_BINDER::SetValue( int aValue )
{
 double value = aValue;
 double displayValue = m_originTransforms.ToDisplay( value, m_coordType );

 if( displayValue == 0 && m_negativeZero )
 SetValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
 else
 SetValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
}


void UNIT_BINDER::SetDoubleValue( double aValue )
{
 double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType );
 displayValue = setPrecision( displayValue, false );

 if( displayValue == 0 && m_negativeZero )
 SetValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
 else
 SetValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
}


void UNIT_BINDER::SetValue( const wxString& aValue )
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
 wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );

 if( textEntry )
 textEntry->SetValue( aValue );
 else if( staticText )
 staticText->SetLabel( aValue );

 if( m_allowEval )
 m_eval.Clear();

 if( m_unitLabel )
 m_unitLabel->SetLabel( GetAbbreviatedUnitsLabel( m_units, m_dataType ) );
}


void UNIT_BINDER::ChangeValue( int aValue )
{
 double value = aValue;
 double displayValue = m_originTransforms.ToDisplay( value, m_coordType );

 if( displayValue == 0 && m_negativeZero )
 ChangeValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false ) );
 else
 ChangeValue( StringFromValue( m_units, displayValue, false ) );
}


void UNIT_BINDER::ChangeDoubleValue( double aValue )
{
 double displayValue = m_originTransforms.ToDisplay( aValue, m_coordType );
 displayValue = setPrecision( displayValue, false );

 if( displayValue == 0 && m_negativeZero )
 ChangeValue( wxT( "-" ) + StringFromValue( m_units, displayValue, false, m_dataType ) );
 else
 ChangeValue( StringFromValue( m_units, displayValue, false, m_dataType ) );
}


void UNIT_BINDER::ChangeValue( const wxString& aValue )
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
 wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );

 if( textEntry )
 textEntry->ChangeValue( aValue );
 else if( staticText )
 staticText->SetLabel( aValue );

 if( m_allowEval )
 m_eval.Clear();

 if( m_unitLabel )
 m_unitLabel->SetLabel( GetAbbreviatedUnitsLabel( m_units, m_dataType ) );
}


long long int UNIT_BINDER::GetValue()
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
 wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
 wxString value;

 if( textEntry )
 {
 if( m_needsEval && m_eval.Process( textEntry->GetValue() ) )
 value = m_eval.Result();
 else
 value = textEntry->GetValue();
 }
 else if( staticText )
 {
 value = staticText->GetLabel();
 }
 else
 {
 return 0;
 }

 long long int displayValue = ValueFromString( m_units, value, m_dataType );
 return m_originTransforms.FromDisplay( displayValue, m_coordType );
}


double UNIT_BINDER::setPrecision( double aValue, bool aValueUsesUserUnits )
{
 if( m_precision > 1 )
 {
 int scale = pow( 10, m_precision );
 long long tmp = aValueUsesUserUnits ? aValue : To_User_Unit( m_units, aValue ) * scale;
 aValue = static_cast<double>( tmp ) / scale;

 if( !aValueUsesUserUnits )
 aValue = From_User_Unit( m_units, aValue );
 }

 return aValue;
}


double UNIT_BINDER::GetDoubleValue()
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
 wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );
 wxString value;

 if( textEntry )
 {
 if( m_needsEval && m_eval.Process( textEntry->GetValue() ) )
 value = m_eval.Result();
 else
 value = textEntry->GetValue();
 }
 else if( staticText )
 {
 value = staticText->GetLabel();
 }
 else
 {
 return 0.0;
 }

 double displayValue = DoubleValueFromString( m_units, value, m_dataType );
 displayValue = setPrecision( displayValue, false );

 return m_originTransforms.FromDisplay( displayValue, m_coordType );
}


bool UNIT_BINDER::IsIndeterminate() const
{
 wxTextEntry* te = dynamic_cast<wxTextEntry*>( m_valueCtrl );

 if( te )
 return te->GetValue() == INDETERMINATE_STATE || te->GetValue() == INDETERMINATE_ACTION;

 return false;
}


wxString UNIT_BINDER::GetOriginalText() const
{
 wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( m_valueCtrl );
 wxStaticText* staticText = dynamic_cast<wxStaticText*>( m_valueCtrl );

 if( m_allowEval )
 return m_eval.OriginalText();
 else if( textEntry )
 return textEntry->GetValue();
 else if( staticText )
 return staticText->GetLabel();
 else
 return wxEmptyString;
}


void UNIT_BINDER::SetLabel( const wxString& aLabel )
{
 m_label->SetLabel( aLabel );
}


void UNIT_BINDER::Enable( bool aEnable )
{
 m_label->Enable( aEnable );
 m_valueCtrl->Enable( aEnable );

 if( m_unitLabel )
 m_unitLabel->Enable( aEnable );
}


void UNIT_BINDER::Show( bool aShow, bool aResize )
{
 m_label->Show( aShow );
 m_valueCtrl->Show( aShow );

 if( m_unitLabel )
 m_unitLabel->Show( aShow );

 if( aResize )
 {
 if( aShow )
 {
 m_label->SetSize( -1, -1 );
 m_valueCtrl->SetSize( -1, -1 );

 if( m_unitLabel )
 m_unitLabel->SetSize( -1, -1 );
 }
 else
 {
 m_label->SetSize( 0, 0 );
 m_valueCtrl->SetSize( 0, 0 );

 if( m_unitLabel )
 m_unitLabel->SetSize( 0, 0 );
 }
 }
}