// 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 <gen_cpp/Types_types.h>

#include <string>

#include <vector>

#include "common/status.h"

#include "core/block/column_numbers.h"

#include "exprs/function/function.h"

#include "exprs/function_context.h"

#include "exprs/vexpr.h"

#include "exprs/vexpr_context.h"

#include "exprs/vliteral.h"

#include "exprs/vslot_ref.h"

#include "runtime/runtime_state.h"

#include "storage/index/ann/ann_range_search_runtime.h"

namespace doris {

class RowDescriptor;

class RuntimeState;

class TExprNode;

} // namespace doris

namespace doris {

#include "common/compile_check_begin.h"

class Block;

class VExprContext;

class VectorizedFnCall : public VExpr {

    ENABLE_FACTORY_CREATOR(VectorizedFnCall);

public:

#ifdef BE_TEST

    VectorizedFnCall() = default;

#endif

    VectorizedFnCall(const TExprNode& node);

    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 evaluate_inverted_index(VExprContext* context, uint32_t segment_num_rows) 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;

    std::string function_name() const;

    std::string debug_string() const override;

    double execute_cost() const override;

    bool is_blockable() const override {

        return _function->is_blockable() ||

               std::any_of(_children.begin(), _children.end(),

                           [](VExprSPtr child) { return child->is_blockable(); });

    }

    bool is_constant() const override {

        if (!_function->is_use_default_implementation_for_constants() ||

            // udf function with no argument, can't sure it's must return const column

            (_fn.binary_type == TFunctionBinaryType::JAVA_UDF && _children.empty())) {

            return false;

        }

        return VExpr::is_constant();

    }

    static std::string debug_string(const std::vector<VectorizedFnCall*>& exprs);

    bool can_push_down_to_index() const override;

    bool equals(const VExpr& other) override;

    size_t estimate_memory(const size_t rows) override;

    Status evaluate_ann_range_search(

            const segment_v2::AnnRangeSearchRuntime& runtime,

            const std::vector<std::unique_ptr<segment_v2::IndexIterator>>& cid_to_index_iterators,

            const std::vector<ColumnId>& idx_to_cid,

            const std::vector<std::unique_ptr<segment_v2::ColumnIterator>>& column_iterators,

            roaring::Roaring& row_bitmap, segment_v2::AnnIndexStats& ann_index_stats) override;

    void prepare_ann_range_search(const doris::VectorSearchUserParams& params,

                                  segment_v2::AnnRangeSearchRuntime& runtime,

                                  bool& suitable_for_ann_index) override;

protected:

    FunctionBasePtr _function;

    std::string _expr_name;

    std::string _function_name;

private:

    Status _do_execute(VExprContext* context, const Block* block, Selector* selector, size_t count,

                       ColumnPtr& result_column, ColumnPtr* arg_column) const;

};

#include "common/compile_check_end.h"

} // namespace doris