blob: 6db66074b31ace65eb0914683abaeace6336f086 [file] [log] [blame]
Gordon Henriksenbbc65972007-12-11 00:20:48 +00001/*===-- llvm-c/BitReader.h - BitReader Library C Interface ------*- C++ -*-===*\
2|* *|
3|* The LLVM Compiler Infrastructure *|
4|* *|
Chris Lattner7ed47a12007-12-29 19:59:42 +00005|* This file is distributed under the University of Illinois Open Source *|
6|* License. See LICENSE.TXT for details. *|
Gordon Henriksenbbc65972007-12-11 00:20:48 +00007|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
10|* This header declares the C interface to libLLVMBitReader.a, which *|
11|* implements input of the LLVM bitcode format. *|
12|* *|
13|* Many exotic languages can interoperate with C code but have a harder time *|
14|* with C++ due to name mangling. So in addition to C, this interface enables *|
15|* tools written in such languages. *|
16|* *|
17\*===----------------------------------------------------------------------===*/
18
19#ifndef LLVM_C_BITCODEREADER_H
20#define LLVM_C_BITCODEREADER_H
21
22#include "llvm-c/Core.h"
23
24#ifdef __cplusplus
25extern "C" {
26#endif
27
28
Gordon Henriksenda1435f2007-12-19 22:30:40 +000029/* Builds a module from the bitcode in the specified memory buffer, returning a
30 reference to the module via the OutModule parameter. Returns 0 on success.
31 Optionally returns a human-readable error message via OutMessage. */
Chris Lattnerd686c8e2010-01-09 22:27:07 +000032LLVMBool LLVMParseBitcode(LLVMMemoryBufferRef MemBuf,
33 LLVMModuleRef *OutModule, char **OutMessage);
Gordon Henriksenbbc65972007-12-11 00:20:48 +000034
Chris Lattnerd686c8e2010-01-09 22:27:07 +000035LLVMBool LLVMParseBitcodeInContext(LLVMContextRef ContextRef,
36 LLVMMemoryBufferRef MemBuf,
37 LLVMModuleRef *OutModule, char **OutMessage);
Owen Andersonc8897d92009-07-02 07:17:57 +000038
Erick Tryzelaardf7df072010-03-02 23:58:54 +000039/** Reads a module from the specified path, returning via the OutMP parameter
40 a module provider which performs lazy deserialization. Returns 0 on success.
41 Optionally returns a human-readable error message via OutMessage. */
42LLVMBool LLVMGetBitcodeModuleInContext(LLVMContextRef ContextRef,
43 LLVMMemoryBufferRef MemBuf,
44 LLVMModuleRef *OutM,
45 char **OutMessage);
Gordon Henriksenbbc65972007-12-11 00:20:48 +000046
Erick Tryzelaardf7df072010-03-02 23:58:54 +000047LLVMBool LLVMGetBitcodeModule(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM,
48 char **OutMessage);
49
50
51/** Deprecated: Use LLVMGetBitcodeModuleInContext instead. */
Chris Lattnerd686c8e2010-01-09 22:27:07 +000052LLVMBool LLVMGetBitcodeModuleProviderInContext(LLVMContextRef ContextRef,
53 LLVMMemoryBufferRef MemBuf,
54 LLVMModuleProviderRef *OutMP,
55 char **OutMessage);
Owen Andersonc8897d92009-07-02 07:17:57 +000056
Erick Tryzelaardf7df072010-03-02 23:58:54 +000057/** Deprecated: Use LLVMGetBitcodeModule instead. */
58LLVMBool LLVMGetBitcodeModuleProvider(LLVMMemoryBufferRef MemBuf,
59 LLVMModuleProviderRef *OutMP,
60 char **OutMessage);
Gordon Henriksenbbc65972007-12-11 00:20:48 +000061
62#ifdef __cplusplus
63}
64#endif
65
66#endif