selection_conditions.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

#ifndef SELECTION_CONDITIONS_H_
#define SELECTION_CONDITIONS_H_

#include <functional>
#include <core/typeinfo.h>
#include <vector>
#include <tool/selection.h>

typedef std::function<bool (const SELECTION&)> SELECTION_CONDITION;

SELECTION_CONDITION operator||( const SELECTION_CONDITION& aConditionA,
                                const SELECTION_CONDITION& aConditionB );

SELECTION_CONDITION operator&&( const SELECTION_CONDITION& aConditionA,
                                const SELECTION_CONDITION& aConditionB );

SELECTION_CONDITION operator!( const SELECTION_CONDITION& aCondition );


typedef bool ( &SELECTION_BOOL )( const SELECTION& );

SELECTION_CONDITION operator||( const SELECTION_CONDITION& aConditionA,
                                SELECTION_BOOL aConditionB );

SELECTION_CONDITION operator||( SELECTION_BOOL aConditionA,
                                const SELECTION_CONDITION& aConditionB );

SELECTION_CONDITION operator&&( const SELECTION_CONDITION& aConditionA,
                                SELECTION_BOOL aConditionB );

SELECTION_CONDITION operator&&( SELECTION_BOOL aConditionA,
                                const SELECTION_CONDITION& aConditionB );

class SELECTION_CONDITIONS
{
public:
    static bool ShowAlways( const SELECTION& aSelection )
    {
        return true;
    }

    static bool ShowNever( const SELECTION& aSelection )
    {
        return false;
    }

    static bool NotEmpty( const SELECTION& aSelection );

    static bool Empty( const SELECTION& aSelection );

    static bool Idle( const SELECTION& aSelection );

    static bool IdleSelection( const SELECTION& aSelection );

    static SELECTION_CONDITION HasType( KICAD_T aType );

    static SELECTION_CONDITION OnlyType( KICAD_T aType );

    static SELECTION_CONDITION OnlyTypes( const KICAD_T aTypes[] );

    static SELECTION_CONDITION Count( int aNumber );

    static SELECTION_CONDITION MoreThan( int aNumber );

    static SELECTION_CONDITION LessThan( int aNumber );

private:
    static bool hasTypeFunc( const SELECTION& aSelection, KICAD_T aType );

    static bool onlyTypeFunc( const SELECTION& aSelection, KICAD_T aType );

    static bool onlyTypesFunc( const SELECTION& aSelection, const KICAD_T aTypes[] );

    static bool countFunc( const SELECTION& aSelection, int aNumber );

    static bool moreThanFunc( const SELECTION& aSelection, int aNumber );

    static bool lessThanFunc( const SELECTION& aSelection, int aNumber );

    static bool orFunc( const SELECTION_CONDITION& aConditionA,
                        const SELECTION_CONDITION& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) || aConditionB( aSelection );
    }

    static bool andFunc( const SELECTION_CONDITION& aConditionA,
                         const SELECTION_CONDITION& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) && aConditionB( aSelection );
    }

    static bool notFunc( const SELECTION_CONDITION& aCondition, const SELECTION& aSelection )
    {
        return !aCondition( aSelection );
    }

    static bool orBoolFunc( const SELECTION_CONDITION& aConditionA,
                             SELECTION_BOOL& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) || aConditionB( aSelection );
    }

    static bool andBoolFunc( const SELECTION_CONDITION& aConditionA,
                             SELECTION_BOOL& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) && aConditionB( aSelection );
    }

    friend SELECTION_CONDITION operator||( const SELECTION_CONDITION& aConditionA,
                                           const SELECTION_CONDITION& aConditionB );

    friend SELECTION_CONDITION operator&&( const SELECTION_CONDITION& aConditionA,
                                           const SELECTION_CONDITION& aConditionB );

    friend SELECTION_CONDITION operator!( const SELECTION_CONDITION& aCondition );

    friend SELECTION_CONDITION operator||( const SELECTION_CONDITION& aConditionA,
                                           SELECTION_BOOL aConditionB );

    friend SELECTION_CONDITION operator&&( const SELECTION_CONDITION& aConditionA,
                                           SELECTION_BOOL aConditionB );
};

#endif /* SELECTION_CONDITIONS_H_ */