compatibility_report.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 3 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/>.
 */
 
#pragma once
 
#include <vector>
#include <wx/string.h>
#include <wx/intl.h>
 
#include <reporter.h>

enum class DOWNGRADE_BUCKET
{
    KEEP,  
    LOWER, 
    DROP,  
    BLOCK  
};
 

struct COMPAT_ENTRY
{
    DOWNGRADE_BUCKET m_bucket;
    wxString         m_feature; 
    wxString         m_detail;  
    int              m_count;
};
 

class COMPATIBILITY_REPORT
{
public:
    void Add( DOWNGRADE_BUCKET aBucket, const wxString& aFeature, const wxString& aDetail = wxEmptyString,
              int aCount = 1 )
    {
        // Merge repeats, so classifying many sheets or files yields one row per feature.
        for( COMPAT_ENTRY& entry : m_entries )
        {
            if( entry.m_bucket == aBucket && entry.m_feature == aFeature )
            {
                entry.m_count += aCount;
 
                if( entry.m_detail.IsEmpty() )
                    entry.m_detail = aDetail;
 
                return;
            }
        }
 
        m_entries.push_back( { aBucket, aFeature, aDetail, aCount } );
    }
 
    void Merge( const COMPATIBILITY_REPORT& aOther )
    {
        for( const COMPAT_ENTRY& entry : aOther.m_entries )
            Add( entry.m_bucket, entry.m_feature, entry.m_detail, entry.m_count );
    }
 
    const std::vector<COMPAT_ENTRY>& Entries() const { return m_entries; }

    bool IsLossy() const { return Has( DOWNGRADE_BUCKET::LOWER ) || Has( DOWNGRADE_BUCKET::DROP ); }

    bool IsBlocked() const { return Has( DOWNGRADE_BUCKET::BLOCK ); }
 
    int Count( DOWNGRADE_BUCKET aBucket ) const
    {
        int total = 0;
 
        for( const COMPAT_ENTRY& entry : m_entries )
        {
            if( entry.m_bucket == aBucket )
                total += entry.m_count;
        }
 
        return total;
    }

    wxString ToText( const wxString& aTargetName ) const
    {
        wxString text = _( "KiCad Compatibility Report" ) + wxS( "\n" );
        text += wxString::Format( _( "Target: %s" ), aTargetName ) + wxS( "\n\n" );
        text += _( "Compatibility preview. This report describes planned changes." ) + wxS( "\n" );
 
        if( IsBlocked() )
            text += _( "Export is blocked by unsupported features." );
        else if( IsLossy() )
            text += _( "Export requires approval for the changes below." );
        else
            text += _( "No compatibility changes were reported." );
 
        text += wxS( "\n\n" ) + _( "Counts cover reported items only." ) + wxS( "\n" );
 
        auto addSection =
                [&]( DOWNGRADE_BUCKET aBucket, const wxString& aLabel )
                {
                    text += wxString::Format( wxS( "\n%s: %d\n" ), aLabel, Count( aBucket ) );
 
                    for( const COMPAT_ENTRY& entry : m_entries )
                    {
                        if( entry.m_bucket != aBucket )
                            continue;
 
                        text += wxString::Format( wxS( "  %s (%d)\n" ), entry.m_feature, entry.m_count );
 
                        if( !entry.m_detail.IsEmpty() )
                            text += wxString::Format( wxS( "    %s\n" ), entry.m_detail );
                    }
                };
 
        addSection( DOWNGRADE_BUCKET::KEEP, _( "Keep" ) );
        addSection( DOWNGRADE_BUCKET::LOWER, _( "Approximate" ) );
        addSection( DOWNGRADE_BUCKET::DROP, _( "Drop" ) );
        addSection( DOWNGRADE_BUCKET::BLOCK, _( "Cannot export" ) );
 
        return text;
    }
 
    void Print( REPORTER* aReporter ) const
    {
        for( const COMPAT_ENTRY& entry : m_entries )
        {
            wxString label;
 
            switch( entry.m_bucket )
            {
            case DOWNGRADE_BUCKET::KEEP: label = _( "keep" ); break;
            case DOWNGRADE_BUCKET::LOWER: label = _( "approximate" ); break;
            case DOWNGRADE_BUCKET::DROP: label = _( "drop" ); break;
            case DOWNGRADE_BUCKET::BLOCK: label = _( "block" ); break;
            }
 
            aReporter->Report( wxString::Format( wxT( "  [%s] %s (%d): %s\n" ),
                                                 label,
                                                 entry.m_feature,
                                                 entry.m_count,
                                                 entry.m_detail ),
                               RPT_SEVERITY_INFO );
        }
    }
 
private:
    bool Has( DOWNGRADE_BUCKET aBucket ) const
    {
        for( const COMPAT_ENTRY& entry : m_entries )
        {
            if( entry.m_bucket == aBucket )
                return true;
        }
 
        return false;
    }
 
    std::vector<COMPAT_ENTRY> m_entries;
};