corpus.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 QA_DRC_BENCHMARK_CORPUS_H
#define QA_DRC_BENCHMARK_CORPUS_H
 
#include <vector>
 
#include <wx/string.h>
 
#include <drc/drc_rule.h>
 

struct CORPUS_ENTRY
{
    wxString board;     
    wxString rules;     
    wxString tier;      
    wxString source;    
    wxString notes;     
    bool     quick = false;   
};
 

class CORPUS
{
public:
    static bool IsConfigured();

    static wxString Root();

    static bool Load( std::vector<CORPUS_ENTRY>& aEntries, wxString& aError );
};
 

const char* ConstraintTypeName( DRC_CONSTRAINT_T aType );
 

const std::vector<DRC_CONSTRAINT_T>& AllConstraintTypes();
 

const std::vector<wxString>& AllPredicateNames();
 

std::vector<wxString> ScanPredicatesInRules( const wxString& aRulesText );
 
 
#endif // QA_DRC_BENCHMARK_CORPUS_H