LadderButtonConfig.h

/*
MIT License
 
Copyright (c) 2020 Brian T. Park
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef ACE_BUTTON_LADDER_BUTTON_CONFIG_H
#define ACE_BUTTON_LADDER_BUTTON_CONFIG_H
 
#include "ButtonConfig.h"
 
// Unit test
class LadderButtonConfig_extractIndex;
 
namespace ace_button {
 
class AceButton;
 
class LadderButtonConfig : public ButtonConfig {
  public:
 
    LadderButtonConfig(uint8_t pin, uint8_t numLevels, const uint16_t levels[],
        uint8_t numButtons, AceButton* const buttons[],
        uint8_t defaultReleasedState = HIGH);
 
    int readButton(uint8_t pin) override;
 
    void checkButtons() const;
 
    uint8_t getNoButtonPin() const {
      return mNumLevels - 1;
    }
 
  protected:
    virtual uint8_t getVirtualPin() const;
 
  private:
    // Allow unit test to access extractIndex().
    friend class ::LadderButtonConfig_extractIndex;
 
    // Disable copy-constructor and assignment operator
    LadderButtonConfig(const LadderButtonConfig&) = delete;
    LadderButtonConfig& operator=(const LadderButtonConfig&) = delete;
 
    static uint8_t extractIndex(uint8_t numLevels, uint16_t const levels[],
        uint16_t level);
 
  private:
    // Arranged for efficient packing on 32-bit processors
    uint8_t const mPin;
    uint8_t const mNumLevels;
    uint8_t const mNumButtons;
    uint8_t const mPressedState;
    uint16_t const* const mLevels;
    AceButton* const* const mButtons;
};
 
}
 
#endif