xref: /freebsd/contrib/llvm-project/llvm/include/llvm-c/IRReader.h (revision 700637cbb5e582861067a11aaca4d053546871d2)
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 
21 LLVM_C_EXTERN_C_BEGIN
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  */
39 LLVM_C_ABI LLVMBool LLVMParseIRInContext(LLVMContextRef ContextRef,
40                                          LLVMMemoryBufferRef MemBuf,
41                                          LLVMModuleRef *OutM,
42                                          char **OutMessage);
43 
44 /**
45  * @}
46  */
47 
48 LLVM_C_EXTERN_C_END
49 
50 #endif
51