MenuIterator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#include <PlatformDetermination.h>
 
#ifndef _MENUITERATOR_H
#define _MENUITERATOR_H
 
#ifndef MAX_MENU_DEPTH
# define MAX_MENU_DEPTH 4
#endif // MAX_MENU_DEPTH
 
// forward reference of menu item
class MenuItem;
 
typedef void (*MenuVisitorFn)(MenuItem* item);
 
MenuItem* getParentRootAndVisit(MenuItem* current, MenuVisitorFn visitor);
 
inline MenuItem* getParentRoot(MenuItem* current) { return getParentRootAndVisit(current, nullptr); }
 
MenuItem* getSubMenuFor(MenuItem* current);
 
MenuItem* getMenuItemById(menuid_t id);
 
int offsetOfCurrentActive(MenuItem* root);
 
int offsetOfItem(MenuItem* itemToFind);
 
uint8_t itemCount(MenuItem* item,  bool includeNonVisble = false);
 
 
class MenuItemPredicate {
public:
    virtual bool matches(MenuItem* item)=0;
};
 
class RemoteNoMenuItemPredicate : public MenuItemPredicate {
private:
    uint8_t remoteNo;
public:
    explicit RemoteNoMenuItemPredicate(int remoteNo) { this->remoteNo = remoteNo; }
 
    bool matches(MenuItem* item) override;
 
    void setRemoteNo(uint8_t newRemoteNum) { remoteNo = newRemoteNum; }
};
 
// the modes that can be passed to the type predicate
#define TM_REGULAR  0
#define TM_INVERTED  1
#define TM_REGULAR_LOCAL_ONLY  8
#define TM_INVERTED_LOCAL_ONLY  9
#define TM_EXTRA_INCLUDE_SUBMENUS 16
#define TM_BIT_INVERT 0U
#define TM_BIT_LOCAL_ONLY 3U
#define TM_BIT_INCLUDE_SUBMENU 4U
 
class MenuItemTypePredicate : public MenuItemPredicate {
private:
    MenuType filterType;
    uint8_t mode;
public:
    MenuItemTypePredicate(MenuType filterType, uint8_t mode = 0) { 
        this->filterType = filterType; 
        this->mode = mode;
    }
 
    bool matches(MenuItem* item) override;
};
 
class MenuItemIterator {
private:
    MenuItem* currentItem;
    MenuItemPredicate* predicate;
    MenuItem* parentItems[MAX_MENU_DEPTH];
    uint8_t level;
    bool processingSubMenu;
public:
    MenuItemIterator() { 
        reset(); 
        predicate = nullptr;
    }
 
    void setPredicate(MenuItemPredicate* predicate) { this->predicate = predicate; }
 
    void reset();
 
    MenuItem* nextItem();
 
    MenuItem* currentParent();
};
 
#endif