LLVM 22.0.0git
IRReader.h
Go to the documentation of this file.
1/*===-- llvm-c/IRReader.h - IR Reader C Interface -----------------*- C -*-===*\
2|* *|
3|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4|* Exceptions. *|
5|* See https://llvm.org/LICENSE.txt for license information. *|
6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
7|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This file defines the C interface to the IR Reader. *|
11|* *|
12\*===----------------------------------------------------------------------===*/
13
14#ifndef LLVM_C_IRREADER_H
15#define LLVM_C_IRREADER_H
16
17#include "llvm-c/ExternC.h"
18#include "llvm-c/Types.h"
19#include "llvm-c/Visibility.h"
20
22
23/**
24 * @defgroup LLVMCCoreIRReader IR Reader
25 * @ingroup LLVMCCore
26 *
27 * @{
28 */
29
30/**
31 * Read LLVM IR from a memory buffer and convert it into an in-memory Module
32 * object. Returns 0 on success.
33 * Optionally returns a human-readable description of any errors that
34 * occurred during parsing IR. OutMessage must be disposed with
35 * LLVMDisposeMessage.
36 *
37 * @see llvm::ParseIR()
38 */
41 LLVMModuleRef *OutM,
42 char **OutMessage);
43
44/**
45 * @}
46 */
47
49
50#endif
#define LLVM_C_EXTERN_C_BEGIN
Definition: ExternC.h:35
#define LLVM_C_EXTERN_C_END
Definition: ExternC.h:36
#define LLVM_C_ABI
LLVM_C_ABI is the export/visibility macro used to mark symbols declared in llvm-c as exported when bu...
Definition: Visibility.h:40
LLVM_C_ABI LLVMBool LLVMParseIRInContext(LLVMContextRef ContextRef, LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM, char **OutMessage)
Read LLVM IR from a memory buffer and convert it into an in-memory Module object.
Definition: IRReader.cpp:112
int LLVMBool
Definition: Types.h:28
struct LLVMOpaqueMemoryBuffer * LLVMMemoryBufferRef
LLVM uses a polymorphic type hierarchy which C cannot represent, therefore parameters must be passed ...
Definition: Types.h:48
struct LLVMOpaqueContext * LLVMContextRef
The top-level container for all LLVM global data.
Definition: Types.h:53
struct LLVMOpaqueModule * LLVMModuleRef
The top-level container for all other LLVM Intermediate Representation (IR) objects.
Definition: Types.h:61