haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Envrionment variable dialog improvments. 

* Remove ENVIRONMENT_VARIABLE_CHAR_VALIDATOR::OnChar() because it was skipping
  the filtering of the first character.  Not sure what was going but this seemed to fix the issue.
* Added environment variable name test to DIALOG_ENV_VAR_CONFIG::TransferDataFromWindow
  because apparently validators do not get called in wxGrids even whe the extend window style
  wxWS_EX_VALIDATE_RECURSIVELY is set.
* Set the default button using wxFormBuilder since the OK button is not part of a wxStdDialogButtonSizer.
* Minor improvements to the HTML help dialog.
* Fix assertion when calling HTML help dialog.  Apparently any dialog derived from DIALOG_SHIM must
  have a KIWAY top level window as a parent.
This commit is contained in:
Wayne Stambaugh 2015-08-16 20:30:29 -04:00
parent c63f6aa3c5
commit b384c94e46
5 changed files with 76 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
common/dialogs/dialog_env_var_config.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2015 Kicad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2015 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
@ -31,6 +31,8 @@
#include <validators.h>
#include <html_messagebox.h>
#include <wx/regex.h>
DIALOG_ENV_VAR_CONFIG::DIALOG_ENV_VAR_CONFIG( wxWindow* aParent, const ENV_VAR_MAP& aEnvVarMap ) :
DIALOG_ENV_VAR_CONFIG_BASE( aParent )
@ -52,11 +54,6 @@ DIALOG_ENV_VAR_CONFIG::DIALOG_ENV_VAR_CONFIG( wxWindow* aParent, const ENV_VAR_M
editor->SetValidator( pathValidator );
m_grid->SetCellEditor( (int) row, 1, editor );
}
wxButton* okButton = (wxButton*) FindWindowById( wxID_OK );
if( okButton )
SetDefaultItem( okButton );
}
@ -97,8 +94,6 @@ bool DIALOG_ENV_VAR_CONFIG::TransferDataToWindow()
bool DIALOG_ENV_VAR_CONFIG::TransferDataFromWindow()
{
wxString nums( wxT( "0123456789" ) );
if( !wxDialog::TransferDataFromWindow() )
return false;
@ -115,40 +110,58 @@ bool DIALOG_ENV_VAR_CONFIG::TransferDataFromWindow()
if( name.IsEmpty() && value.IsEmpty() )
continue;
// Check for empty cells.
wxLogDebug( wxT( "Row %d, name: %s, value %s." ), row,
GetChars( name ), GetChars( value ) );
// Name cannot be empty.
if( name.IsEmpty() )
{
wxMessageBox( _( "Path configuration name cannot be empty." ), caption,
wxOK | wxICON_ERROR, this );
return false;
}
if( value.IsEmpty() )
{
wxMessageBox( _( "Path configuration value cannot be empty." ), caption,
wxOK | wxICON_ERROR, this );
wxMessageBox( _( "Cannot have duplicate environment variable name cannot be empty." ),
caption, wxOK | wxICON_ERROR, this );
m_grid->GoToCell( row, 0 );
m_grid->SetGridCursor( row, 0 );
return false;
}
// First character of environment variable name cannot be a number.
if( nums.Find( name[0] ) != wxNOT_FOUND )
// Value cannot be empty.
if( value.IsEmpty() )
{
wxMessageBox( _( "Path configuration names cannot have a number as the first "
"character." ), caption, wxOK | wxICON_ERROR, this );
wxMessageBox( _( "Cannot have environment variable value cannot be empty." ), caption,
wxOK | wxICON_ERROR, this );
m_grid->GoToCell( row, 1 );
m_grid->SetGridCursor( row, 1 );
m_grid->SetFocus();
return false;
}
// First character of the environment variable name cannot be a digit (0-9).
if( name.Left( 1 ).IsNumber() )
{
wxMessageBox( _( "The first character of an environment variable name cannot be "
"a digit (0-9)." ), caption, wxOK | wxICON_ERROR, this );
m_grid->GoToCell( row, 0 );
m_grid->SetGridCursor( row, 0 );
m_grid->SelectBlock( row, 0, row, 0 );
m_grid->SetFocus();
return false;
}
// Check for duplicate environment variable names.
if( envVarNames.Index( name ) != wxNOT_FOUND )
{
wxMessageBox( _( "Cannot have duplicate configuration names." ), caption,
wxMessageBox( _( "Cannot have duplicate environment variable names." ), caption,
wxOK | wxICON_ERROR, this );
m_grid->GoToCell( row, 0 );
m_grid->SetGridCursor( row, 0 );
m_grid->SelectRow( row );
m_grid->SetFocus();
return false;
}
envVarNames.Add( name );
}
// Add new entries and update any modified entries..
// Add new entries and update any modified entries.
for( row = 0; row < m_grid->GetNumberRows(); row++ )
{
wxString name = m_grid->GetCellValue( row, 0 );
@ -159,7 +172,7 @@ bool DIALOG_ENV_VAR_CONFIG::TransferDataFromWindow()
{
ENV_VAR_ITEM item( value, wxGetEnv( name, NULL ) );
// Add new envrionment variable.
// Add new environment variable.
m_envVarMap[ name ] = item;
}
else if( it->second.GetValue() != value )
@ -206,13 +219,17 @@ void DIALOG_ENV_VAR_CONFIG::OnAddRow( wxCommandEvent& aEvent )
int row = m_grid->GetNumberRows() - 1;
wxGridCellTextEditor* editor = new wxGridCellTextEditor;
ENVIRONMENT_VARIABLE_CHAR_VALIDATOR envVarValidator;
editor->SetValidator( envVarValidator );
ENVIRONMENT_VARIABLE_CHAR_VALIDATOR envVarNameValidator;
editor->SetValidator( envVarNameValidator );
m_grid->SetCellEditor( row, 0, editor );
editor = new wxGridCellTextEditor;
FILE_NAME_WITH_PATH_CHAR_VALIDATOR pathValidator;
editor->SetValidator( pathValidator );
m_grid->SetCellEditor( row, 1, editor );
m_grid->GoToCell( row, 0 );
m_grid->SetGridCursor( row, 0 );
m_grid->SetFocus();
}
@ -235,36 +252,34 @@ void DIALOG_ENV_VAR_CONFIG::OnDeleteSelectedRows( wxCommandEvent& aEvent )
void DIALOG_ENV_VAR_CONFIG::OnHelpRequest( wxCommandEvent& aEvent )
{
wxString msg = _( "Enter the names and paths for each path.<br><br>"
"<i>Grey enteries are names that have been defined externally</i> "
"as system or user level environment variables." );
wxString msg = _( "Enter the name and path for each environment variable. Grey entries "
"are names that have been defined externally at the system or user "
"level. Environment variables defined at the system or user level "
"take precedence over the ones defined in this table. This means the "
"values in this table are ignored." );
msg << wxT( "<br><br><b>" );
msg << _( "To avoid issues, names accept only upper case letters and digits." );
msg << _( "To ensure environment variable names are valid on all platforms, the name field "
"will only accept upper case letters, digits, and the underscore characters." );
msg << wxT( "</b><br><br>" );
msg << _( "<b><i>KIGITHUB</b></i> is often used in Kicad packages to define "
"the URL of the repository of our official libraries." );
msg << wxT( "<br>" );
msg << _( "<b><i>KISYS3DMOD</b></i> is the base path of footprint 3D shapes (.3Dshapes folders)." );
msg << wxT( "<br>" );
msg << _( "<b><i>KISYSMOD</b></i> is the base path of local footprint libraries (.pretty folders)." );
msg << _( "<b>KIGITHUB</b> is used by KiCad to define the URL of the repository "
"of the official KiCad libraries." );
msg << wxT( "<br><br>" );
msg << _( "A other environment variable is automatically defined by Kicad (cannot be edited):" );
msg << wxT( "<br>" );
msg << _( "<b><i>KIPRJMOD</b></i> is the absolute path of the current project" );
msg << wxT( "<br>" );
msg << _( "For instance, ${KIPRJMOD}/libs/footprints.pretty is the folder "
"libs/footprints.pretty located in the current project." );
msg << _( "<b>KISYS3DMOD</b> is the base path of system footprint 3D "
"shapes (.3Dshapes folders)." );
msg << wxT( "<br><br>" );
msg << _( "Auxiliary environment variable name used by Kicad if exists:" );
msg << wxT( "<br>" );
msg << _( "<i>KICAD_PTEMPLATES</i> can be defined if you want to create "
"and use project templates (specific folders containing the template files) "
"in a given master folder" );
msg << wxT( "<br>" );
msg << _( "It is the base path of these project template folders" );
msg << _( "<b>KISYSMOD</b> is the base path of locally installed system "
"footprint libraries (.pretty folders)." );
msg << wxT( "<br><br>" );
msg << _( "<b>KIPRJMOD</b> is internally defined by KiCad (cannot be edited) and is set "
"to the absolute path of the currently loaded project file. This environment "
"variable can be used to define files and paths relative to the currently loaded "
"project. For instance, ${KIPRJMOD}/libs/footprints.pretty can be defined as a "
"folder containing a project specific footprint library named footprints.pretty." );
msg << wxT( "<br><br>" );
msg << _( "<b>KICAD_PTEMPLATES</b> is optional and can be defined if you want to "
"create your own project templates folder." );
HTML_MESSAGE_BOX dlg( this, _( "Paths Definition" ), wxDefaultPosition,
wxSize( 650, 450 ) );
HTML_MESSAGE_BOX dlg( GetParent(), _( "Environment Variable Help" ) );
dlg.AddHTML_Text( msg );
dlg.ShowModal();
}

2
common/dialogs/dialog_env_var_config_base.cpp
View File

@ -71,7 +71,7 @@ DIALOG_ENV_VAR_CONFIG_BASE::DIALOG_ENV_VAR_CONFIG_BASE( wxWindow* parent, wxWind
bSizer2->Add( m_buttonDelete, 0, wxBOTTOM|wxLEFT|wxRIGHT, 5 );
m_buttonHelp = new wxButton( this, wxID_ANY, _("Help"), wxDefaultPosition, wxDefaultSize, 0 );
bSizer2->Add( m_buttonHelp, 0, wxALL, 5 );
bSizer2->Add( m_buttonHelp, 0, wxBOTTOM|wxLEFT|wxRIGHT, 5 );
mainSizer->Add( bSizer2, 0, wxEXPAND, 5 );

2
common/dialogs/dialog_env_var_config_base.fbp
View File

@ -610,7 +610,7 @@
</object>
<object class="sizeritem" expanded="1">
<property name="border">5</property>
<property name="flag">wxALL</property>
<property name="flag">wxBOTTOM|wxLEFT|wxRIGHT</property>
<property name="proportion">0</property>
<object class="wxButton" expanded="1">
<property name="BottomDockable">1</property>

38
common/validators.cpp
View File

@ -30,6 +30,9 @@
#include <kicad_string.h>
#include <validators.h>
#include <wx/textentry.h>
#include <wx/log.h>
FILE_NAME_CHAR_VALIDATOR::FILE_NAME_CHAR_VALIDATOR( wxString* aValue ) :
wxTextValidator( wxFILTER_EXCLUDE_CHAR_LIST, aValue )
@ -49,7 +52,7 @@ FILE_NAME_CHAR_VALIDATOR::FILE_NAME_CHAR_VALIDATOR( wxString* aValue ) :
FILE_NAME_WITH_PATH_CHAR_VALIDATOR::FILE_NAME_WITH_PATH_CHAR_VALIDATOR( wxString* aValue ) :
wxTextValidator( wxFILTER_EXCLUDE_CHAR_LIST, 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
@ -75,39 +78,8 @@ FILE_NAME_WITH_PATH_CHAR_VALIDATOR::FILE_NAME_WITH_PATH_CHAR_VALIDATOR( wxString
ENVIRONMENT_VARIABLE_CHAR_VALIDATOR::ENVIRONMENT_VARIABLE_CHAR_VALIDATOR( wxString* aValue ) :
wxTextValidator( wxFILTER_INCLUDE_CHAR_LIST, aValue )
wxTextValidator( wxFILTER_INCLUDE_CHAR_LIST | wxFILTER_EMPTY, aValue )
{
wxString includeChars( wxT( "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_" ) );
SetCharIncludes( includeChars );
}
void ENVIRONMENT_VARIABLE_CHAR_VALIDATOR::OnChar( wxKeyEvent& aEvent )
{
wxTextValidator::OnChar( aEvent );
// Special key or error in valid character check already occurred.
if( aEvent.GetSkipped() )
return;
// Check if first character is valid. Cannot be number.
int keyCode = aEvent.GetKeyCode();
wxString str( (wxUniChar)keyCode, 1 );
wxString numbers( wxT( "0123456789" ) );
if( (m_stringValue->IsEmpty() && numbers.Contains( str ))
|| (!m_stringValue->IsEmpty() && numbers.Contains( m_stringValue[0])) )
{
if( !wxValidator::IsSilent() )
wxBell();
// eat message
return;
}
else
{
aEvent.Skip();
}
}

5
include/validators.h
View File

@ -46,6 +46,7 @@ public:
FILE_NAME_CHAR_VALIDATOR( wxString* aValue = NULL );
};
/**
* Class FILE_NAME_WITH_PATH_CHAR_VALIDATOR
*
@ -60,6 +61,7 @@ public:
FILE_NAME_WITH_PATH_CHAR_VALIDATOR( wxString* aValue = NULL );
};
/**
* Class ENVIRONMENT_VARIABLE_CHAR_VALIDATOR
*
@ -74,9 +76,6 @@ class ENVIRONMENT_VARIABLE_CHAR_VALIDATOR : public wxTextValidator
{
public:
ENVIRONMENT_VARIABLE_CHAR_VALIDATOR( wxString* aValue = NULL );
protected:
void OnChar( wxKeyEvent& aEvent );
};
#endif // #ifndef VALIDATORS_H