OpCAPIParamHelper.h

Go to the documentation of this file.

//===- OpCAPIParamHelper.h ------------------------------------------------===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2025 Veridise Inc.
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
//
// Helpers for generating C API and C API link tests for Operations.
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include <mlir/TableGen/Argument.h>
#include <mlir/TableGen/Operator.h>
 
#include <string>

struct GenStringFromOpPieces {
  virtual ~GenStringFromOpPieces() = default;

  std::string gen(const mlir::tblgen::Operator &op);
 
protected:
  virtual void genHeader(llvm::raw_ostream &os) {}

  virtual void genResult(
      llvm::raw_ostream &os, const mlir::tblgen::NamedTypeConstraint &result,
      const std::string &resultName
  ) = 0;

  virtual void genResultInferred(llvm::raw_ostream &os) {}

  virtual void
  genOperand(llvm::raw_ostream &os, const mlir::tblgen::NamedTypeConstraint &operand) = 0;

  virtual void genAttributesPrefix(llvm::raw_ostream &os, const mlir::tblgen::Operator &op) {}

  virtual void genAttribute(llvm::raw_ostream &os, const mlir::tblgen::NamedAttribute &attr) = 0;

  virtual void genAttributesSuffix(llvm::raw_ostream &os, const mlir::tblgen::Operator &op) {}

  virtual void genRegionsPrefix(llvm::raw_ostream &os, const mlir::tblgen::Operator &op) {}

  virtual void genRegion(llvm::raw_ostream &os, const mlir::tblgen::NamedRegion &region) = 0;

  virtual void genRegionsSuffix(llvm::raw_ostream &os, const mlir::tblgen::Operator &op) {}
};