Struct.h

Go to the documentation of this file.

//===-- Struct.h - C API for Struct dialect -----------------------*- C -*-===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This header declares the C interface for registering and accessing the
// Struct dialect. A dialect should be registered with a context to make it
// available to users of the context. These users must load the dialect
// before using any of its attributes, operations, or types. Parser and pass
// manager can load registered dialects automatically.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLZK_C_DIALECT_STRUCT_H
#define LLZK_C_DIALECT_STRUCT_H
 
#include "llzk-c/Support.h"
 
#include <mlir-c/AffineMap.h>
#include <mlir-c/IR.h>
#include <mlir-c/Support.h>
 
#include <stdint.h>
 
// Include the generated CAPI
#include "llzk/Dialect/Struct/IR/Ops.capi.h.inc"
#include "llzk/Dialect/Struct/IR/Types.capi.h.inc"
#include "llzk/Dialect/Struct/Transforms/TransformationPasses.capi.h.inc"
 
#ifdef __cplusplus
extern "C" {
#endif

MLIR_DECLARE_CAPI_DIALECT_REGISTRATION(Struct, llzk__component);
 
//===----------------------------------------------------------------------===//
// StructType
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirType llzkStruct_StructTypeGet(MlirAttribute name);

MLIR_CAPI_EXPORTED
MlirType llzkStruct_StructTypeGetWithArrayAttr(MlirAttribute name, MlirAttribute params);

MLIR_CAPI_EXPORTED MlirType llzkStruct_StructTypeGetWithAttrs(
    MlirAttribute name, intptr_t numParams, MlirAttribute const *params
);

MLIR_CAPI_EXPORTED MlirLogicalResult llzkStructStructTypeGetDefinition(
    MlirType type, MlirOperation root, LlzkSymbolLookupResult *result
);

MLIR_CAPI_EXPORTED MlirLogicalResult llzkStructStructTypeGetDefinitionFromModule(
    MlirType type, MlirModule root, LlzkSymbolLookupResult *result
);
 
//===----------------------------------------------------------------------===//
// StructDefOp
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirBlock llzkStruct_StructDefOpGetBody(MlirOperation op);

MLIR_CAPI_EXPORTED MlirType llzkStruct_StructDefOpGetType(MlirOperation op);

MLIR_CAPI_EXPORTED MlirType
llzkStruct_StructDefOpGetTypeWithParams(MlirOperation op, MlirAttribute params);

MLIR_CAPI_EXPORTED void llzkStruct_StructDefOpGetMemberDefs(MlirOperation op, MlirOperation *dst);

MLIR_CAPI_EXPORTED intptr_t llzkStruct_StructDefOpGetNumMemberDefs(MlirOperation op);

MLIR_CAPI_EXPORTED const char *llzkStruct_StructDefOpGetHeaderString(
    MlirOperation op, intptr_t *dstSize, char *(*alloc_string)(size_t)
);

MLIR_CAPI_EXPORTED void
llzkStruct_StructDefOpGetTemplateParamOpNames(MlirOperation op, MlirAttribute *dst);

MLIR_CAPI_EXPORTED intptr_t llzkStruct_StructDefOpGetNumTemplateParamOpNames(MlirOperation op);

MLIR_CAPI_EXPORTED void
llzkStruct_StructDefOpGetTemplateExprOpNames(MlirOperation op, MlirAttribute *dst);

MLIR_CAPI_EXPORTED intptr_t llzkStruct_StructDefOpGetNumTemplateExprOpNames(MlirOperation op);
 
//===----------------------------------------------------------------------===//
// MemberDefOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_BUILD_METHOD(
    Struct, MemberDefOp, MlirStringRef name, MlirType type, bool isSignal, bool isColumn
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    Struct, MemberDefOp, WithAttrs, MlirAttribute name, MlirAttribute type, bool isSignal,
    bool isColumn
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    Struct, MemberDefOp, WithNamedAttrs, intptr_t numAttrs, MlirNamedAttribute const *attrs,
    bool isSignal, bool isColumn
);

MLIR_CAPI_EXPORTED bool llzkStruct_MemberDefOpGetColumnValue(MlirOperation op);

MLIR_CAPI_EXPORTED void llzkStruct_MemberDefOpSetColumnValue(MlirOperation op, bool newValue);

MLIR_CAPI_EXPORTED bool llzkStruct_MemberDefOpGetSignalValue(MlirOperation op);

MLIR_CAPI_EXPORTED void llzkStruct_MemberDefOpSetSignalValue(MlirOperation op, bool newValue);
 
//===----------------------------------------------------------------------===//
// MemberReadOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_BUILD_METHOD(
    Struct, MemberReadOp, MlirType type, MlirValue component, MlirIdentifier memberName
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    Struct, MemberReadOp, WithAffineMapDistance, MlirType type, MlirValue component,
    MlirIdentifier memberName, MlirAffineMap affineMap, MlirValueRange mapOperands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    Struct, MemberReadOp, WithTemplateSymbolDistance, MlirType type, MlirValue component,
    MlirIdentifier memberName, MlirStringRef paramName
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    Struct, MemberReadOp, WithLiteralDistance, MlirType type, MlirValue component,
    MlirIdentifier memberName, int64_t distance
);
 
#ifdef __cplusplus
}
#endif
 
#endif // LLZK_C_DIALECT_STRUCT_H