CustomIntrinsicCall.h

//===-- Lower/CustomIntrinsicCall.h -----------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/
//
//===----------------------------------------------------------------------===//
//===----------------------------------------------------------------------===//
 
#ifndef FORTRAN_LOWER_CUSTOMINTRINSICCALL_H
#define FORTRAN_LOWER_CUSTOMINTRINSICCALL_H
 
#include "flang/Lower/AbstractConverter.h"
#include "flang/Optimizer/Builder/IntrinsicCall.h"
#include <functional>
#include <optional>
 
namespace Fortran {
 
namespace evaluate {
class ProcedureRef;
struct SpecificIntrinsic;
} // namespace evaluate
 
namespace lower {

fir::IntrinsicLoweringOptions getIntrinsicLoweringOptions(AbstractConverter &);

bool intrinsicRequiresCustomOptionalHandling(
    const Fortran::evaluate::ProcedureRef &procRef,
    const Fortran::evaluate::SpecificIntrinsic &intrinsic,
    AbstractConverter &converter);

using OperandPrepare = std::function<void(const Fortran::lower::SomeExpr &)>;
using OperandPrepareAs = std::function<void(const Fortran::lower::SomeExpr &,
                                            fir::LowerIntrinsicArgAs)>;

using OperandPresent = std::function<std::optional<mlir::Value>(std::size_t)>;

using OperandGetter = std::function<fir::ExtendedValue(std::size_t, bool)>;

void prepareCustomIntrinsicArgument(
    const Fortran::evaluate::ProcedureRef &procRef,
    const Fortran::evaluate::SpecificIntrinsic &intrinsic,
    std::optional<mlir::Type> retTy,
    const OperandPrepare &prepareOptionalArgument,
    const OperandPrepareAs &prepareOtherArgument, AbstractConverter &converter);

fir::ExtendedValue
lowerCustomIntrinsic(fir::FirOpBuilder &builder, mlir::Location loc,
                     llvm::StringRef name, std::optional<mlir::Type> retTy,
                     const OperandPresent &isPresentCheck,
                     const OperandGetter &getOperand, std::size_t numOperands,
                     Fortran::lower::StatementContext &stmtCtx);

fir::ExtendedValue
genIntrinsicCall(fir::FirOpBuilder &builder, mlir::Location loc,
                 llvm::StringRef name, std::optional<mlir::Type> resultType,
                 llvm::ArrayRef<fir::ExtendedValue> args,
                 StatementContext &stmtCtx,
                 Fortran::lower::AbstractConverter *converter = nullptr);
 
} // namespace lower
} // namespace Fortran
 
#endif // FORTRAN_LOWER_CUSTOMINTRINSICCALL_H