validators.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 Wayne Stambaugh <[email protected]>
 * Copyright (C) 2004-2019 KiCad Developers, see change_log.txt for contributors.
 * Copyright (C) 2018 CERN
 *
 * 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 <string_utils.h>
#include <confirm.h>
#include <validators.h>

#include <wx/grid.h>
#include <wx/textctrl.h>
#include <wx/textentry.h>
#include <wx/log.h>
#include <wx/combo.h>

GRID_CELL_TEXT_EDITOR::GRID_CELL_TEXT_EDITOR() : wxGridCellTextEditor()
{
}


void GRID_CELL_TEXT_EDITOR::SetValidator( const wxValidator& validator )
{
 // keep our own copy because wxGridCellTextEditor's is annoyingly private
 m_validator.reset( static_cast<wxValidator*>( validator.Clone() ) );

 wxGridCellTextEditor::SetValidator( *m_validator );
}


void GRID_CELL_TEXT_EDITOR::StartingKey( wxKeyEvent& event )
{
 if( m_validator )
 {
 m_validator.get()->SetWindow( Text() );
 m_validator.get()->ProcessEvent( event );
 }

 if( event.GetSkipped() )
 {
 wxGridCellTextEditor::StartingKey( event );
 event.Skip( false );
 }
}


FOOTPRINT_NAME_VALIDATOR::FOOTPRINT_NAME_VALIDATOR( wxString* aValue ) :
 wxTextValidator( wxFILTER_EXCLUDE_CHAR_LIST, aValue )
{
 // This list of characters follows the string from footprint.cpp which, in turn mimics the
 // strings from lib_id.cpp
 // TODO: Unify forbidden character lists
 wxString illegalChars = "%$<>\t\n\r\"\\/:";
 SetCharExcludes( illegalChars );
 }


FILE_NAME_WITH_PATH_CHAR_VALIDATOR::FILE_NAME_WITH_PATH_CHAR_VALIDATOR( wxString* aValue ) :
 wxTextValidator( wxFILTER_EXCLUDE_CHAR_LIST | wxFILTER_EMPTY, aValue )
{
 // The Windows (DOS) file system forbidden characters already include the forbidden
 // file name characters for both Posix and OSX systems. The characters *?|"<> are
 // illegal and filtered by the validator, but /\: are valid (\ and : only on Windows.
 wxString illegalChars = wxFileName::GetForbiddenChars( wxPATH_DOS );
 wxTextValidator nameValidator( wxFILTER_EXCLUDE_CHAR_LIST );
 wxArrayString illegalCharList;

 for( unsigned i = 0; i < illegalChars.size(); i++ )
 {
 if( illegalChars[i] == '/' )
 continue;

#if defined (__WINDOWS__)
 if( illegalChars[i] == '\\' || illegalChars[i] == ':' )
 continue;
#endif
 illegalCharList.Add( wxString( illegalChars[i] ) );
 }

 SetExcludes( illegalCharList );
}


ENV_VAR_NAME_VALIDATOR::ENV_VAR_NAME_VALIDATOR( wxString* aValue ) :
 wxTextValidator()
{
 Connect( wxEVT_CHAR, wxKeyEventHandler( ENV_VAR_NAME_VALIDATOR::OnChar ) );
}


ENV_VAR_NAME_VALIDATOR::ENV_VAR_NAME_VALIDATOR( const ENV_VAR_NAME_VALIDATOR& val )
 : wxTextValidator()
{
 wxValidator::Copy( val );

 Connect( wxEVT_CHAR, wxKeyEventHandler( ENV_VAR_NAME_VALIDATOR::OnChar ) );
}


ENV_VAR_NAME_VALIDATOR::~ENV_VAR_NAME_VALIDATOR()
{
 Disconnect( wxEVT_CHAR, wxKeyEventHandler( ENV_VAR_NAME_VALIDATOR::OnChar ) );
}


void ENV_VAR_NAME_VALIDATOR::OnChar( wxKeyEvent& aEvent )
{
 if( !m_validatorWindow )
 {
 aEvent.Skip();
 return;
 }

 int keyCode = aEvent.GetKeyCode();

 // we don't filter special keys and delete
 if( keyCode < WXK_SPACE || keyCode == WXK_DELETE || keyCode >= WXK_START )
 {
 aEvent.Skip();
 return;
 }

 wxUniChar c = (wxUChar) keyCode;

 if( c == wxT( '_' ) )
 {
 // OK anywhere
 aEvent.Skip();
 }
 else if( wxIsdigit( c ) )
 {
 // not as first character
 long from, to;
 GetTextEntry()->GetSelection( &from, &to );

 if( from < 1 )
 wxBell();
 else
 aEvent.Skip();
 }
 else if( wxIsalpha( c ) )
 {
 // Capitals only.

 if( wxIslower( c ) )
 {
 // You may wonder why this scope is so twisted, so make yourself comfortable and read:
 // 1. Changing the keyCode and/or uniChar in the event and passing it on
 // doesn't work. Some platforms look at the original copy as long as the event
 // isn't vetoed.
 // 2. Inserting characters by hand does not move the cursor, meaning either you insert
 // text backwards (lp:#1798869) or always append, no matter where is the cursor.
 // wxTextEntry::{Get/Set}InsertionPoint() do not work at all here.
 // 3. There is wxTextEntry::ForceUpper(), but it is not yet available in common
 // wxWidgets packages.
 //
 // So here we are, with a command event handler that converts
 // the text to upper case upon every change.
 wxTextCtrl* textCtrl = dynamic_cast<wxTextCtrl*>( GetTextEntry() );

 if( textCtrl )
 {
 textCtrl->Connect( textCtrl->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
 wxCommandEventHandler( ENV_VAR_NAME_VALIDATOR::OnTextChanged ) );
 }
 }

 aEvent.Skip();
 }
 else
 {
 wxBell();
 }
}


void ENV_VAR_NAME_VALIDATOR::OnTextChanged( wxCommandEvent& event )
{
 wxTextCtrl* textCtrl = dynamic_cast<wxTextCtrl*>( event.GetEventObject() );

 if( textCtrl )
 {
 if( !textCtrl->IsModified() )
 return;

 long insertionPoint = textCtrl->GetInsertionPoint();
 textCtrl->ChangeValue( textCtrl->GetValue().Upper() );
 textCtrl->SetInsertionPoint( insertionPoint );
 textCtrl->Disconnect( textCtrl->GetId(), wxEVT_COMMAND_TEXT_UPDATED );
 }

 event.Skip();
}


bool REGEX_VALIDATOR::Validate( wxWindow* aParent )
{
 // If window is disabled, simply return
 if( !m_validatorWindow->IsEnabled() )
 return true;

 wxTextEntry* const textEntry = GetTextEntry();

 if( !textEntry )
 return false;

 bool valid = true;
 const wxString& value = textEntry->GetValue();

 if( m_regEx.Matches( value ) )
 {
 size_t start, len;
 m_regEx.GetMatch( &start, &len );

 if( start != 0 || len != value.Length() ) // whole string must match
 valid = false;
 }
 else // no match at all
 {
 valid = false;
 }

 if( !valid )
 {
 m_validatorWindow->SetFocus();
 DisplayError( aParent, wxString::Format( _( "Incorrect value: %s" ), value ) );
 return false;
 }

 return true;
}


void REGEX_VALIDATOR::compileRegEx( const wxString& aRegEx, int aFlags )
{
 if( !m_regEx.Compile( aRegEx, aFlags ) )
 {
 throw std::runtime_error( "REGEX_VALIDATOR: Invalid regular expression: "
 + aRegEx.ToStdString() );
 }

 m_regExString = aRegEx;
 m_regExFlags = aFlags;
}


bool LIB_ID_VALIDATOR::Validate( wxWindow *aParent )
{
 LIB_ID dummy;

 // If window is disabled, simply return
 if( !m_validatorWindow->IsEnabled() )
 return true;

 wxTextEntry* const text = GetTextEntry();

 if( !text )
 return false;

 wxString msg;
 wxString val( text->GetValue() );
 wxString tmp = val.Clone(); // For trailing and leading white space tests.

 // Allow empty string if empty filter not set to allow clearing the LIB_ID.
 if( !(GetStyle() & wxFILTER_EMPTY) && val.IsEmpty() )
 return true;

 if( tmp.Trim() != val ) // Trailing white space.
 {
 msg = _( "Entry contains trailing white space." );
 }
 else if( tmp.Trim( false ) != val ) // Leading white space.
 {
 msg = _( "Entry contains leading white space." );
 }
 else if( dummy.Parse( val ) != -1 || !dummy.IsValid() ) // Is valid LIB_ID.
 {
 msg.Printf( _( "'%s' is not a valid library identifier format." ), val );
 }

 if( !msg.empty() )
 {
 m_validatorWindow->SetFocus();

 wxMessageBox( msg, _( "Library Identifier Validation Error" ),
 wxOK | wxICON_EXCLAMATION, aParent );

 return false;
 }

 return true;
}


NETNAME_VALIDATOR::NETNAME_VALIDATOR( wxString *aVal ) :
 wxTextValidator(),
 m_allowSpaces( false )
{
}


NETNAME_VALIDATOR::NETNAME_VALIDATOR( const NETNAME_VALIDATOR& aValidator ) :
 wxTextValidator( aValidator ),
 m_allowSpaces( aValidator.m_allowSpaces )
{
}


NETNAME_VALIDATOR::NETNAME_VALIDATOR( bool aAllowSpaces ) :
 wxTextValidator(),
 m_allowSpaces( aAllowSpaces )
{
}


bool NETNAME_VALIDATOR::Validate( wxWindow *aParent )
{
 // If window is disabled, simply return
 if ( !m_validatorWindow->IsEnabled() )
 return true;

 wxTextEntry * const text = GetTextEntry();

 if ( !text )
 return false;

 const wxString& errormsg = IsValid( text->GetValue() );

 if( !errormsg.empty() )
 {
 m_validatorWindow->SetFocus();
 wxMessageBox( errormsg, _( "Invalid signal name" ), wxOK | wxICON_EXCLAMATION, aParent );
 return false;
 }

 return true;
}


wxString NETNAME_VALIDATOR::IsValid( const wxString& str ) const
{
 if( str.Contains( '\r' ) || str.Contains( '\n' ) )
 return _( "Signal names cannot contain CR or LF characters" );

 if( !m_allowSpaces && ( str.Contains( ' ' ) || str.Contains( '\t' ) ) )
 return _( "Signal names cannot contain spaces" );

 return wxString();
}


void KIUI::ValidatorTransferToWindowWithoutEvents( wxValidator& aValidator )
{
 wxWindow* ctrl = aValidator.GetWindow();

 wxCHECK_RET( ctrl != nullptr, wxT( "Transferring validator data without a control" ) );

 wxEventBlocker orient_update_blocker( ctrl, wxEVT_ANY );
 aValidator.TransferToWindow();
}