drc_re_rule_saver.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_RE_RULE_SAVER_H_
#define DRC_RE_RULE_SAVER_H_
 
#include <map>
#include <vector>
 
#include <wx/string.h>
 
#include "drc_re_loaded_rule.h"
 
class BOARD;
 

class DRC_RULE_SAVER
{
public:
    DRC_RULE_SAVER();

    bool SaveFile( const wxString&                               aPath,
                   const std::vector<DRC_RE_LOADED_PANEL_ENTRY>& aEntries,
                   const BOARD*                                  aBoard = nullptr,
                   const DRC_RE_FILE_TRIVIA&                     aTrivia = {} );

    wxString GenerateRulesText( const std::vector<DRC_RE_LOADED_PANEL_ENTRY>& aEntries,
                                const BOARD*                                  aBoard = nullptr,
                                const DRC_RE_FILE_TRIVIA&                     aTrivia = {} );
 
private:
    wxString generateRuleText( const DRC_RE_LOADED_PANEL_ENTRY& aEntry,
                               const BOARD*                     aBoard );

    wxString generateLayerClause( const LSET& aLayers );

    wxString generateSeverityClause( SEVERITY aSeverity );

    wxString generateMergedRuleText( const std::vector<const DRC_RE_LOADED_PANEL_ENTRY*>& aEntries,
                                      const BOARD*                                         aBoard );
};
 
 
#endif // DRC_RE_RULE_SAVER_H_