drc_rule_editor_utils.h

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/>.
 */
 
#ifndef DRC_RULE_EDITOR_UTILS_H_
#define DRC_RULE_EDITOR_UTILS_H_
 
#include <wx/wx.h>
#include <wx/object.h>
 
#include <optional>
#include <memory>
#include <vector>
#include <bitmaps.h>
 
#include "drc_rule_editor_enums.h"
#include "drc_re_base_constraint_data.h"
 
class BOARD;
class DRC_RULE;
class DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA;
 
class DRC_RULE_EDITOR_UTILS
{
public:
    using RuleConverter = std::function<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>( const std::shared_ptr<DRC_RULE>& )>;
 
    static void RegisterRuleConverter( RuleConverter aConverter );
 
    static bool IsBoolInputType( const DRC_RULE_EDITOR_CONSTRAINT_NAME& aConstraintType );
 
    static bool IsNumericInputType( const DRC_RULE_EDITOR_CONSTRAINT_NAME& aConstraintType );
 
    static std::shared_ptr<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA> CreateNumericConstraintData( DRC_RULE_EDITOR_CONSTRAINT_NAME aType );
 
    static std::shared_ptr<DRC_RE_NUMERIC_INPUT_CONSTRAINT_DATA>
                            CreateNumericConstraintData( DRC_RULE_EDITOR_CONSTRAINT_NAME aType,
                            const DRC_RE_BASE_CONSTRAINT_DATA& aBase );
 
    static wxString FormatErrorMessage( int aErrorCount, const wxString& aErrorMessage );
 
    static std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>> ParseRules( const wxString& aRules );
 
    static bool SaveRules( const wxString& aFilename,
                           const std::vector<std::shared_ptr<DRC_RE_BASE_CONSTRAINT_DATA>>& aRules,
                           const BOARD* aBoard );

    static wxString GetConstraintCode( DRC_RULE_EDITOR_CONSTRAINT_NAME aConstraintType );

    static std::optional<DRC_RULE_EDITOR_CONSTRAINT_NAME> GetConstraintTypeFromCode( const wxString& aCode );

    static wxString ConstraintToKicadDrc( DRC_RULE_EDITOR_CONSTRAINT_NAME aType );

    static bool ConstraintFromKicadDrc( const wxString& aCode, DRC_RE_BASE_CONSTRAINT_DATA* aData );

    static bool ValidateNumericCtrl( wxTextCtrl* aTextCtrl, const wxString& aLabel, bool aCanBeZero, int* aErrorCount,
                                     wxString* aValidationMessage );

    static bool ValidateIntegerCtrl( wxTextCtrl* aTextCtrl, const wxString& aLabel, bool aCanBeZero, int* aErrorCount,
                                     wxString* aValidationMessage );

    static bool ValidateComboCtrl( wxComboBox* aComboBox, const wxString& aLabel, int* aErrorCount,
                                   wxString* aValidationMessage );

    static bool ValidateMinMaxCtrl( wxTextCtrl* aMinTextCtrl, wxTextCtrl* aMaxTextCtrl, const wxString& aMinLabel,
                                    const wxString& aMaxLabel, int* aErrorCount, wxString* aValidationMessage );

    static bool ValidateMinPreferredMaxCtrl( wxTextCtrl* aMinTextCtrl, wxTextCtrl* aPreferredTextCtrl,
                                             wxTextCtrl* aMaxTextCtrl, const wxString& aMinLabel,
                                             const wxString& aPreferredLabel, const wxString& aMaxLabel,
                                             int* aErrorCount, wxString* aValidationMessage );

    static bool ValidateCheckBoxCtrls( const std::vector<wxCheckBox*>& aCheckboxes, const wxString& aLabel,
                                       int* aErrorCount, wxString* aValidationMessage );
 
    // ==================== Pure Validators (No GUI Dependencies) ====================
    // These can be used in headless tests and by constraint data classes.

    static bool ValidateNumericValue( double aValue, bool aCanBeZero, const wxString& aLabel,
                                      VALIDATION_RESULT* aResult );

    static bool ValidateNumericString( const wxString& aValueStr, bool aCanBeZero, bool aIntegerOnly,
                                       const wxString& aLabel, VALIDATION_RESULT* aResult );

    static bool ValidateMinMax( double aMin, double aMax, const wxString& aMinLabel,
                                const wxString& aMaxLabel, VALIDATION_RESULT* aResult );

    static bool ValidateMinPreferredMax( double aMin, double aPreferred, double aMax,
                                         const wxString& aMinLabel, const wxString& aPrefLabel,
                                         const wxString& aMaxLabel, VALIDATION_RESULT* aResult );

    static bool ValidateAtLeastOneSelected( const std::vector<bool>& aSelected, const wxString& aLabel,
                                            VALIDATION_RESULT* aResult );

    static bool ValidateSelection( int aSelectionIndex, const wxString& aLabel,
                                   VALIDATION_RESULT* aResult );
 
    // ==================== Layer Filtering ====================

    static DRC_LAYER_CATEGORY GetLayerCategoryForConstraint( DRC_RULE_EDITOR_CONSTRAINT_NAME aConstraintType );

    static wxString TranslateTopBottomLayer( DRC_RULE_EDITOR_CONSTRAINT_NAME aConstraintType, bool aIsTop );
};
 
#endif // DRC_RULE_EDITOR_UTILS_H_