kicad/include/tool/selection_conditions.h

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright (C) 2020-2022 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>

class SELECTION;

///< Functor type that checks a specific condition for selected items.
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 );


/// Signature for a reference to a function that takes a SELECTION and returns
/// a boolean. This type is meant to be used to define logical operations between
/// SELECTION_CONDITION functors and non-functor SELECTION_CONDITION-like functions.
/// It should not be used in user code.
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 that groups generic conditions for selected items.
 */
class SELECTION_CONDITIONS
{
public:
    /**
     * The default condition function (always returns true).
     */
    static bool ShowAlways( const SELECTION& aSelection ) { return true; }

    /**
     * Always returns false.
     */
    static bool ShowNever( const SELECTION& aSelection ) { return false; }

    /**
     * Test if there are any items selected.
     */
    static bool NotEmpty( const SELECTION& aSelection );

    /**
     * Test if there are no items selected.
     */
    static bool Empty( const SELECTION& aSelection );

    /**
     * Test if there no items selected or being edited.
     */
    static bool Idle( const SELECTION& aSelection );

    /**
     * Test if all selected items are not being edited.
     */
    static bool IdleSelection( const SELECTION& aSelection );

    /**
     * Create a functor that tests if among the selected items there is at least one of a
     * given type.
     *
     * @param aType is the type that is searched.
     * @return Functor testing for presence of items of a given type.
     */
    static SELECTION_CONDITION HasType( KICAD_T aType );

    /**
     * Create a functor that tests if among the selected items there is at least one of a
     * given types.
     *
     * @param aTypes is an array containing types that are searched.
     * @return Functor testing for presence of items of a given types.
     */
    static SELECTION_CONDITION HasTypes( std::vector<KICAD_T> aTypes );

    /**
     * Create a functor that tests if the selected items are *only* of given types.
     *
     * @param aTypes is an array containing types that are searched.
     * @return Functor testing if selected items are exclusively of the requested types.
     */
    static SELECTION_CONDITION OnlyTypes( std::vector<KICAD_T> aTypes );

    /**
     * Create a functor that tests if the number of selected items is equal to the value given as
     * parameter.
     *
     * @param aNumber is the number of expected items.
     * @return Functor testing if the number of selected items is equal aNumber.
     */
    static SELECTION_CONDITION Count( int aNumber );

    /**
     * Create a functor that tests if the number of selected items is greater than the value given
     * as parameter.
     *
     * @param aNumber is the number used for comparison.
     * @return Functor testing if the number of selected items is greater than aNumber.
     */
    static SELECTION_CONDITION MoreThan( int aNumber );

    /**
     * Create a functor that tests if the number of selected items is smaller than the value given
     * as parameter.
     *
     * @param aNumber is the number used for comparison.
     * @return Functor testing if the number of selected items is smaller than aNumber.
     */
    static SELECTION_CONDITION LessThan( int aNumber );

private:
    ///< Helper function used by HasType()
    static bool hasTypeFunc( const SELECTION& aSelection, KICAD_T aType );

    ///< Helper function used by HasTypes()
    static bool hasTypesFunc( const SELECTION& aSelection, std::vector<KICAD_T> aTypes );

    ///< Helper function used by OnlyTypes()
    static bool onlyTypesFunc( const SELECTION& aSelection, std::vector<KICAD_T> aTypes );

    ///< Helper function used by Count()
    static bool countFunc( const SELECTION& aSelection, int aNumber );

    ///< Helper function used by MoreThan()
    static bool moreThanFunc( const SELECTION& aSelection, int aNumber );

    ///< Helper function used by LessThan()
    static bool lessThanFunc( const SELECTION& aSelection, int aNumber );

    ///< Helper function used by operator||
    static bool orFunc( const SELECTION_CONDITION& aConditionA,
                        const SELECTION_CONDITION& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) || aConditionB( aSelection );
    }

    ///< Helper function used by operator&&
    static bool andFunc( const SELECTION_CONDITION& aConditionA,
                         const SELECTION_CONDITION& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) && aConditionB( aSelection );
    }

    ///< Helper function used by operator!
    static bool notFunc( const SELECTION_CONDITION& aCondition, const SELECTION& aSelection )
    {
        return !aCondition( aSelection );
    }

    ///< Helper function used by operator||
    static bool orBoolFunc( const SELECTION_CONDITION& aConditionA,
                            SELECTION_BOOL& aConditionB, const SELECTION& aSelection )
    {
        return aConditionA( aSelection ) || aConditionB( aSelection );
    }

    ///< Helper function used by operator&&
    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_ */