unpatched_param.h

/*
 * Copyright © 2017-2023 Synthstrom Audible Limited
 *
 * This file is part of The Synthstrom Audible Deluge Firmware.
 *
 * The Synthstrom Audible Deluge Firmware 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 "gui/menu_item/integer.h"
#include "menu_item_with_cc_learning.h"
#include "param.h"
 
class ModelStackWithAutoParam;
 
namespace deluge::gui::menu_item {
 
class UnpatchedParam : public Param, public IntegerContinuous, public MenuItemWithCCLearning {
public:
    UnpatchedParam(l10n::String newName, l10n::String title, int32_t newP)
        : Param(newP), IntegerContinuous(newName, title) {}
    UnpatchedParam(l10n::String newName, l10n::String title, int32_t newP, NumberStyle style)
        : Param(newP), IntegerContinuous(newName, title), number_style_{style} {}
    UnpatchedParam(l10n::String newName, int32_t newP) : Param(newP), IntegerContinuous(newName) {}
    UnpatchedParam(l10n::String newName, int32_t newP, NumberStyle style)
        : Param(newP), IntegerContinuous(newName), number_style_{style} {}
 
    bool usesAffectEntire() override { return true; }
    void readCurrentValue() override;
    void writeCurrentValue() override;
    ParamDescriptor getLearningThing() final;
    [[nodiscard]] int32_t getMaxValue() const override { return Param::getMaxValue(); }
    [[nodiscard]] int32_t getMinValue() const override { return Param::getMinValue(); }
    MenuItem* selectButtonPress() final { return Param::selectButtonPress(); }
    // this button action function definition should not be required as it should be inherited
    // from the param class, however it does not work if the definition is removed, so there
    // is likely a multi-inheritance issue that needs to be resolved
    ActionResult buttonAction(deluge::hid::Button b, bool on, bool inCardRoutine) final {
        return Param::buttonAction(b, on, inCardRoutine);
    }
    void horizontalEncoderAction(int32_t offset) final { return Param::horizontalEncoderAction(offset); }
 
    void unlearnAction() final { MenuItemWithCCLearning::unlearnAction(); }
    bool allowsLearnMode() final { return MenuItemWithCCLearning::allowsLearnMode(); }
    void learnKnob(MIDICable* cable, int32_t whichKnob, int32_t modKnobMode, int32_t midiChannel) final {
        MenuItemWithCCLearning::learnKnob(cable, whichKnob, modKnobMode, midiChannel);
    };
 
    deluge::modulation::params::Kind getParamKind();
    uint32_t getParamIndex();
    ParamSet* getParamSet() final;
    ModelStackWithAutoParam* getModelStack(void* memory) final;
 
    int32_t getParamValue() {
        readCurrentValue();
        return getValue();
    }
 
    [[nodiscard]] NumberStyle getNumberStyle() const override {
        if (number_style_.has_value()) {
            return number_style_.value();
        }
        return IntegerContinuous::getNumberStyle();
    }
 
protected:
    virtual int32_t getFinalValue();
 
private:
    std::optional<NumberStyle> number_style_{std::nullopt};
};
 
} // namespace deluge::gui::menu_item