/*

 *

 *    Copyright (c) 2026 Project CHIP Authors

 *    All rights reserved.

 *

 *    Licensed under the Apache License, Version 2.0 (the "License");

 *    you may not use this file except in compliance with the License.

 *    You may obtain a copy of the License at

 *

 *        http://www.apache.org/licenses/LICENSE-2.0

 *

 *    Unless required by applicable law or agreed to in writing, software

 *    distributed under the License is distributed on an "AS IS" BASIS,

 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 *    See the License for the specific language governing permissions and

 *    limitations under the License.

 */

#pragma once

#include <app/clusters/alarm-base-server/Delegate.h>

#include <app/clusters/alarm-base-server/alarm-base-cluster-objects.h>

#include <app/server-cluster/DefaultServerCluster.h>

namespace chip::app::Clusters {

/**

 * AlarmBaseCluster is the code-driven implementation of the Alarm Base cluster.

 *

 * It provides a base implementation for any derivation (e.g. DishwasherAlarm, RefrigeratorAlarm).

 */

class AlarmBaseCluster : public DefaultServerCluster

{

public:

    struct Config

    {

        AlarmBase::Delegate & delegate;

        BitMask<AlarmBase::Feature> feature{};

        AlarmBase::AlarmMap supported{};

        AlarmBase::AlarmMap latch{};

        bool supportsModifyEnabledAlarms = false;

    };

    AlarmBaseCluster(EndpointId endpointId, AlarmBase::ClusterEntry cluster, const Config & config);

    DataModel::ActionReturnStatus ReadAttribute(const DataModel::ReadAttributeRequest & request,

                                                AttributeValueEncoder & encoder) override;

    CHIP_ERROR Attributes(const ConcreteClusterPath & path, ReadOnlyBufferBuilder<DataModel::AttributeEntry> & builder) override;

    std::optional<DataModel::ActionReturnStatus> InvokeCommand(const DataModel::InvokeRequest & request,

                                                               TLV::TLVReader & input_arguments, CommandHandler * handler) override;

    CHIP_ERROR AcceptedCommands(const ConcreteClusterPath & path,

                                ReadOnlyBufferBuilder<DataModel::AcceptedCommandEntry> & builder) override;

    // Application-facing API

    AlarmBase::AlarmMap GetMask() const { return mMask; }

    AlarmBase::AlarmMap GetState() const { return mState; }

    AlarmBase::AlarmMap GetSupported() const { return mSupported; }

    AlarmBase::AlarmMap GetLatch() const { return mLatch; }

    BitMask<AlarmBase::Feature> GetFeatures() const { return mFeature; }

    Protocols::InteractionModel::Status SetMask(const AlarmBase::AlarmMap & mask);

    Protocols::InteractionModel::Status SetState(const AlarmBase::AlarmMap & newState);

    Protocols::InteractionModel::Status ResetLatchedAlarms(const AlarmBase::AlarmMap & alarms);

protected:

    virtual void SendNotifyEvent(AlarmBase::AlarmMap becameActive, AlarmBase::AlarmMap becameInactive, AlarmBase::AlarmMap newState,

                                 AlarmBase::AlarmMap mask) = 0;

    /// Used when the Latch attribute must not prevent state updates (mask adjustment, reset, integration init).

    /// Applications should use SetState() or ResetLatchedAlarms() instead.

    Protocols::InteractionModel::Status SetStateIgnoringLatch(const AlarmBase::AlarmMap & newState);

private:

    const BitMask<AlarmBase::Feature> mFeature;

    const uint32_t mClusterRevision;

    const bool mSupportsModifyEnabledAlarms;

    AlarmBase::Delegate & mDelegate;

    AlarmBase::AlarmMap mMask{};

    const AlarmBase::AlarmMap mLatch;

    AlarmBase::AlarmMap mState{};

    const AlarmBase::AlarmMap mSupported;

    Protocols::InteractionModel::Status SetStateInternal(const AlarmBase::AlarmMap & newState, bool ignoreLatchState);

    DataModel::ActionReturnStatus HandleReset(const AlarmBase::AlarmMap & alarms);

    DataModel::ActionReturnStatus HandleModifyEnabledAlarms(const AlarmBase::AlarmMap & mask);

};

} // namespace chip::app::Clusters