drc_re_custom_rule_panel.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2024 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "drc_re_custom_rule_panel.h"
 
#include <stack>
 
#include <drc/drc_rule.h>
#include <drc/drc_rule_parser.h>
#include <ki_exception.h>
#include <reporter.h>
#include <scintilla_tricks.h>
#include <dialogs/rule_editor_dialog_base.h>
#include <wx/button.h>
#include <wx/sizer.h>
#include <wx/stc/stc.h>
#include <wx/tipwin.h>
 
DRC_RE_CUSTOM_RULE_PANEL::DRC_RE_CUSTOM_RULE_PANEL(
        wxWindow* aParent, std::shared_ptr<DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA> aConstraintData ) :
        wxPanel( aParent ),
        m_constraintData( aConstraintData ),
        m_textCtrl( nullptr ),
        m_checkSyntaxBtn( nullptr )
{
    wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
 
    m_textCtrl = new wxStyledTextCtrl( this, wxID_ANY );
    m_textCtrl->SetToolTip( _( "Complete rule text in the DRC rule language" ) );
    sizer->Add( m_textCtrl, 1, wxEXPAND | wxALL, 5 );
 
    m_checkSyntaxBtn = new wxButton( this, wxID_ANY, _( "Check Syntax" ) );
    sizer->Add( m_checkSyntaxBtn, 0, wxALIGN_RIGHT | wxRIGHT | wxBOTTOM, 5 );
 
    SetSizer( sizer );
 
    m_textCtrl->Bind( wxEVT_STC_CHANGE,
                      [this]( wxStyledTextEvent& )
                      {
                          RULE_EDITOR_DIALOG_BASE* dlg = RULE_EDITOR_DIALOG_BASE::GetDialog( this );
 
                          if( dlg )
                              dlg->SetModified();
                      } );
 
    m_scintillaTricks = std::make_unique<SCINTILLA_TRICKS>(
            m_textCtrl, wxT( "()" ), false,
            // onAcceptFn
            []( wxKeyEvent& aEvent )
            {
                aEvent.Skip();
            },
            // onCharFn
            [this]( wxStyledTextEvent& aEvent )
            {
                onScintillaCharAdded( aEvent );
            } );
 
    m_textCtrl->AutoCompSetSeparator( '|' );
 
    m_checkSyntaxBtn->Bind( wxEVT_BUTTON, &DRC_RE_CUSTOM_RULE_PANEL::onCheckSyntax, this );
}
 
 
DRC_RE_CUSTOM_RULE_PANEL::~DRC_RE_CUSTOM_RULE_PANEL()
{
}
 
 
bool DRC_RE_CUSTOM_RULE_PANEL::TransferDataToWindow()
{
    if( m_constraintData )
    {
        wxString text = m_constraintData->GetRuleText();
 
        if( text.IsEmpty() )
        {
            text = wxS( "   (constraint clearance (min 0.2mm))" );
        }
 
        m_textCtrl->SetValue( text );
    }
 
    return true;
}
 
 
bool DRC_RE_CUSTOM_RULE_PANEL::TransferDataFromWindow()
{
    if( m_constraintData )
        m_constraintData->SetRuleText( m_textCtrl->GetValue() );
 
    return true;
}
 
 
bool DRC_RE_CUSTOM_RULE_PANEL::ValidateInputs( int* aErrorCount, wxString* aValidationMessage )
{
    (void) aErrorCount;
    (void) aValidationMessage;
    return true;
}
 
 
wxString DRC_RE_CUSTOM_RULE_PANEL::GenerateRule( const RULE_GENERATION_CONTEXT& aContext )
{
    wxString body;
 
    if( m_textCtrl )
        body = m_textCtrl->GetValue();
    else if( m_constraintData )
        body = m_constraintData->GetRuleText();
 
    if( body.Trim().IsEmpty() )
        return wxEmptyString;
 
    wxString ruleName = aContext.ruleName;
    ruleName.Replace( wxS( "\"" ), wxS( "\\\"" ) );
 
    wxString rule;
    rule << wxS( "(rule \"" ) << ruleName << wxS( "\"\n" );
 
    if( !aContext.comment.IsEmpty() )
    {
        wxArrayString lines = wxSplit( aContext.comment, '\n', '\0' );
 
        for( const wxString& line : lines )
        {
            if( line.IsEmpty() )
                continue;
 
            rule << wxS( "\t# " ) << line << wxS( "\n" );
        }
    }
 
    rule << body << wxS( ")" );
 
    return rule;
}
 
 
void DRC_RE_CUSTOM_RULE_PANEL::UpdateRuleName( const wxString& aName )
{
    if( m_constraintData )
        m_constraintData->SetRuleName( aName );
}
 
 
void DRC_RE_CUSTOM_RULE_PANEL::onScintillaCharAdded( wxStyledTextEvent& aEvent )
{
    if( aEvent.GetModifiers() == wxMOD_CONTROL && aEvent.GetKey() == ' ' )
    {
        // Short-cut for do-auto-complete
    }
 
    m_textCtrl->SearchAnchor();
 
    wxString rules = m_textCtrl->GetText();
    int      currentPos = m_textCtrl->GetCurrentPos();
    int      startPos = 0;
 
    enum class EXPR_CONTEXT_T : int
    {
        NONE,
        STRING,
        SEXPR_OPEN,
        SEXPR_TOKEN,
    };
 
    std::stack<wxString> sexprs;
    wxString             partial;
    EXPR_CONTEXT_T       context = EXPR_CONTEXT_T::NONE;
 
    for( int i = startPos; i < currentPos; ++i )
    {
        wxChar c = m_textCtrl->GetCharAt( i );
 
        if( c == '\\' )
        {
            i++; // skip escaped char
        }
        else if( context == EXPR_CONTEXT_T::STRING )
        {
            if( c == '"' )
                context = EXPR_CONTEXT_T::NONE;
        }
        else if( c == '"' )
        {
            partial = wxEmptyString;
            context = EXPR_CONTEXT_T::STRING;
        }
        else if( c == '(' )
        {
            if( context == EXPR_CONTEXT_T::SEXPR_OPEN && !partial.IsEmpty() )
            {
                m_textCtrl->AutoCompCancel();
                sexprs.push( partial );
            }
 
            partial = wxEmptyString;
            context = EXPR_CONTEXT_T::SEXPR_OPEN;
        }
        else if( c == ')' )
        {
            if( !sexprs.empty() )
                sexprs.pop();
 
            context = EXPR_CONTEXT_T::NONE;
        }
        else if( c == ' ' )
        {
            if( context == EXPR_CONTEXT_T::SEXPR_OPEN && !partial.IsEmpty() )
            {
                m_textCtrl->AutoCompCancel();
                sexprs.push( partial );
                context = EXPR_CONTEXT_T::SEXPR_TOKEN;
                partial = wxEmptyString;
                continue;
            }
 
            context = EXPR_CONTEXT_T::NONE;
        }
        else
        {
            partial += c;
        }
    }
 
    wxString tokens;
 
    if( context == EXPR_CONTEXT_T::SEXPR_OPEN )
    {
        if( sexprs.empty() )
        {
            tokens = wxT( "condition|constraint|layer|severity" );
        }
        else if( sexprs.top() == wxT( "rule" ) )
        {
            // Inside (rule ...) - suggest sub-expressions
            tokens = wxT( "condition|constraint|layer|severity" );
        }
        else if( sexprs.top() == wxT( "constraint" ) )
        {
            // Inside (constraint ...) - suggest constraint parameters
            tokens = wxT( "min|max|opt" );
        }
    }
    else if( context == EXPR_CONTEXT_T::SEXPR_TOKEN )
    {
        if( !sexprs.empty() && sexprs.top() == wxT( "constraint" ) )
        {
            // After (constraint - suggest constraint types
            tokens = wxT( "annular_width|"
                          "assertion|"
                          "clearance|"
                          "connection_width|"
                          "courtyard_clearance|"
                          "creepage|"
                          "diff_pair_gap|"
                          "diff_pair_uncoupled|"
                          "disallow|"
                          "edge_clearance|"
                          "hole_clearance|"
                          "hole_size|"
                          "hole_to_hole|"
                          "length|"
                          "max_error|"
                          "min_resolved_spokes|"
                          "physical_clearance|"
                          "physical_hole_clearance|"
                          "silk_clearance|"
                          "skew|"
                          "text_height|"
                          "text_thickness|"
                          "thermal_relief_gap|"
                          "thermal_spoke_width|"
                          "track_angle|"
                          "track_segment_length|"
                          "track_width|"
                          "via_count|"
                          "via_diameter|"
                          "zone_connection" );
        }
        else if( !sexprs.empty() && sexprs.top() == wxT( "layer" ) )
        {
            // After (layer - suggest layer keywords
            tokens = wxT( "inner|outer" );
        }
        else if( !sexprs.empty() && sexprs.top() == wxT( "severity" ) )
        {
            // After (severity - suggest severity levels
            tokens = wxT( "error|warning|ignore|exclusion" );
        }
    }
 
    if( !tokens.IsEmpty() )
        m_scintillaTricks->DoAutocomplete( partial, wxSplit( tokens, '|' ) );
}
 
 
void DRC_RE_CUSTOM_RULE_PANEL::onCheckSyntax( wxCommandEvent& aEvent )
{
    // Close any existing tip window
    if( m_tipWindow )
    {
        m_tipWindow->Close();
        m_tipWindow = nullptr;
    }
 
    wxString body = m_textCtrl->GetText();
    wxString ruleName = m_constraintData ? m_constraintData->GetRuleName() : wxString( wxS( "test" ) );
    ruleName.Replace( wxS( "\"" ), wxS( "\\\"" ) );
    wxString rulesText = wxString::Format( wxS( "(version 2)\n(rule \"%s\"\n%s)" ), ruleName, body );
 
    if( body.Trim().IsEmpty() )
    {
#if wxCHECK_VERSION( 3, 3, 2 )
        m_tipWindow = wxTipWindow::New( this, _( "No rule text to check." ) );
#else
        m_tipWindow = new wxTipWindow( this, _( "No rule text to check." ) );
        m_tipWindow->SetTipWindowPtr( &m_tipWindow );
#endif
        return;
    }
 
    WX_STRING_REPORTER reporter;
 
    try
    {
        std::vector<std::shared_ptr<DRC_RULE>> dummyRules;
        DRC_RULES_PARSER parser( rulesText, _( "Custom rule" ) );
 
        parser.Parse( dummyRules, &reporter );
    }
    catch( PARSE_ERROR& pe )
    {
        reporter.Report( wxString::Format( _( "ERROR at line %d, column %d: %s" ),
                                           pe.lineNumber,
                                           pe.byteIndex,
                                           pe.ParseProblem() ),
                         RPT_SEVERITY_ERROR );
    }
 
    wxString message;
 
    if( reporter.HasMessageOfSeverity( RPT_SEVERITY_ERROR ) )
    {
        message = reporter.GetMessages();
    }
    else if( reporter.HasMessage() )
    {
        message = _( "Syntax check passed with warnings:\n" ) + reporter.GetMessages();
    }
    else
    {
        message = _( "Syntax OK" );
    }
 
#if wxCHECK_VERSION( 3, 3, 2 )
    m_tipWindow = wxTipWindow::New( this, message );
#else
    m_tipWindow = new wxTipWindow( this, message );
    m_tipWindow->SetTipWindowPtr( &m_tipWindow );
#endif
}