KiCad PCB EDA Suite
Loading...
Searching...
No Matches
drc_re_custom_rule_constraint_data.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#ifndef DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA_H_
21#define DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA_H_
22
24
30{
31public:
33
34 DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA( int aId, const wxString& aRuleName ) :
35 DRC_RE_BASE_CONSTRAINT_DATA( aId, aRuleName )
36 {
37 }
38
41 {
42 }
43
44 wxString GetRuleText() const { return m_ruleText; }
45
46 void SetRuleText( const wxString& aText ) { m_ruleText = aText; }
47
48 wxString GenerateRule( const RULE_GENERATION_CONTEXT& aContext ) override
49 {
50 if( m_ruleText.IsEmpty() )
51 return wxEmptyString;
52
53 return FormatRule( aContext, m_ruleText );
54 }
55
59 static wxString FormatRule( const RULE_GENERATION_CONTEXT& aContext, const wxString& aBody )
60 {
61 wxString ruleName = aContext.ruleName;
62 ruleName.Replace( wxS( "\"" ), wxS( "\\\"" ) );
63
64 wxString rule;
65 rule << wxS( "(rule \"" ) << ruleName << wxS( "\"" );
66
67 for( const wxString& line : wxSplit( aContext.comment, '\n', '\0' ) )
68 {
69 if( !line.IsEmpty() )
70 rule << wxS( "\n\t# " ) << line;
71 }
72
73 for( const wxString& line : wxSplit( aBody, '\n', '\0' ) )
74 {
75 rule << wxS( "\n" );
76
77 if( !line.IsEmpty() )
78 rule << wxS( "\t" ) << line;
79 }
80
81 return rule + wxS( ")" );
82 }
83
84 VALIDATION_RESULT Validate() const override
85 {
87
88 if( m_ruleText.IsEmpty() )
89 result.AddError( _( "Rule text cannot be empty" ) );
90
91 return result;
92 }
93
94 void CopyFrom( const ICopyable& aSource ) override
95 {
96 const auto& src = dynamic_cast<const DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA&>( aSource );
98 m_ruleText = src.m_ruleText;
99 }
100
101private:
102 wxString m_ruleText;
103};
104
105#endif // DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA_H_
void CopyFrom(const ICopyable &aSource) override
DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA(const DRC_RE_BASE_CONSTRAINT_DATA &aBaseData)
DRC_RE_CUSTOM_RULE_CONSTRAINT_DATA(int aId, const wxString &aRuleName)
VALIDATION_RESULT Validate() const override
Validates the constraint data.
wxString GenerateRule(const RULE_GENERATION_CONTEXT &aContext) override
static wxString FormatRule(const RULE_GENERATION_CONTEXT &aContext, const wxString &aBody)
Wraps a rule body as it is edited, without the indent the file gives it, in a rule.
void CopyFrom(const ICopyable &aSource) override
Abstract interface class to enable polymorphic copying between objects.
#define _(s)
Result of a validation operation.
wxString result
Test unit parsing edge cases and error handling.