/*
 * Copyright (c) 2023 Huawei Device Co., Ltd.
 * 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.
 */

#ifndef OHOS_ABILITY_RUNTIME_DRIVER_EXTENSION_H
#define OHOS_ABILITY_RUNTIME_DRIVER_EXTENSION_H

#include "extension_base.h"

namespace OHOS {
namespace AbilityRuntime {
class DriverExtensionContext;
class Runtime;
class DriverExtension;
using CreatorDriverFunc = std::function<DriverExtension* (const std::unique_ptr<Runtime>& runtime)>;
/**
 * @brief Basic driver components.
 */
class DriverExtension : public ExtensionBase<DriverExtensionContext>,
                         public std::enable_shared_from_this<DriverExtension> {
public:
    DriverExtension() = default;
    virtual ~DriverExtension() = default;

    /**
     * @brief Create and init context.
     *
     * @param record the extension record.
     * @param application the application info.
     * @param handler the extension handler.
     * @param token the remote token.
     * @return The created context.
     */
    virtual std::shared_ptr<DriverExtensionContext> CreateAndInitContext(
        const std::shared_ptr<AbilityLocalRecord> &record,
        const std::shared_ptr<OHOSApplication> &application,
        std::shared_ptr<AbilityHandler> &handler,
        const sptr<IRemoteObject> &token) override;

    /**DRIVER
     * @brief Init the extension.
     *
     * @param record the extension record.
     * @param application the application info.
     * @param handler the extension handler.
     * @param token the remote token.
     */
    virtual void Init(const std::shared_ptr<AbilityLocalRecord> &record,
        const std::shared_ptr<OHOSApplication> &application,
        std::shared_ptr<AbilityHandler> &handler,
        const sptr<IRemoteObject> &token) override;

    /**
     * @brief Create Extension.
     *
     * @param runtime The runtime.
     * @return The DriverExtension instance.
     */
    static DriverExtension* Create(const std::unique_ptr<Runtime>& runtime);

    /**
     * @brief Set a creator function.
     *
     * @param creator The function for create a driver-extension ability.
     */
    static void SetCreator(const CreatorDriverFunc& creator);

private:
    static CreatorDriverFunc creator_;
};
}  // namespace AbilityRuntime
}  // namespace OHOS
#endif  // OHOS_ABILITY_RUNTIME_DRIVER_EXTENSION_H