// Licensed to the Apache Software Foundation (ASF) under one

// or more contributor license agreements.  See the NOTICE file

// distributed with this work for additional information

// regarding copyright ownership.  The ASF licenses this file

// to you 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 <fmt/format.h>

#include <memory>

#include <string>

#include "common/object_pool.h"

#include "common/status.h"

#include "exprs/function_context.h"

#include "exprs/vexpr.h"

namespace doris {

class BitmapFilterFuncBase;

class RowDescriptor;

class RuntimeState;

class TExprNode;

class Block;

class VExprContext;

} // namespace doris

namespace doris {

// used for bitmap runtime filter

class VBitmapPredicate final : public VExpr {

    ENABLE_FACTORY_CREATOR(VBitmapPredicate);

public:

    VBitmapPredicate(const TExprNode& node);

    ~VBitmapPredicate() override = default;

    Status execute_column(VExprContext* context, const Block* block, Selector* selector,

                          size_t count, ColumnPtr& result_column) const override;

    Status execute_runtime_filter(VExprContext* context, const Block* block,

                                  const uint8_t* __restrict filter, size_t count,

                                  ColumnPtr& result_column, ColumnPtr* arg_column) const override;

    Status prepare(RuntimeState* state, const RowDescriptor& desc, VExprContext* context) override;

    Status open(RuntimeState* state, VExprContext* context,

                FunctionContext::FunctionStateScope scope) override;

    void close(VExprContext* context, FunctionContext::FunctionStateScope scope) override;

    const std::string& expr_name() const override;

    void set_filter(std::shared_ptr<BitmapFilterFuncBase> filter);

    std::shared_ptr<BitmapFilterFuncBase> get_bitmap_filter_func() const override {

        return _filter;

    }

    std::string debug_string() const override {

        return fmt::format(" VBitmapPredicate:{}", VExpr::debug_string());

    }

    // not need support bitmap filter get_digest

    uint64_t get_digest(uint64_t seed) const override { return 0; }

private:

    Status _do_execute(VExprContext* context, const Block* block, const uint8_t* __restrict filter,

                       Selector* selector, size_t count, ColumnPtr& result_column) const;

    std::shared_ptr<BitmapFilterFuncBase> _filter;

    inline static const std::string EXPR_NAME = "bitmap_predicate";

};

} // namespace doris