deimos.llvm.c.bitreader source code

1 /*===-- llvm-c/BitReader.h - BitReader Library C Interface ------*- C++ -*-===*\
2 |*                                                                            *|
3 |*                     The LLVM Compiler Infrastructure                       *|
4 |*                                                                            *|
5 |* This file is distributed under the University of Illinois Open Source      *|
6 |* License. See LICENSE.TXT for details.                                      *|
7 |*                                                                            *|
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 module deimos.llvm.c.bitreader;
20 
21 import deimos.llvm.c.core;
22 
23 extern(C) nothrow:
24 
25 /**
26  * @defgroup LLVMCBitReader Bit Reader
27  * @ingroup LLVMC
28  *
29  * @{
30  */
31 
32 /* Builds a module from the bitcode in the specified memory buffer, returning a
33    reference to the module via the OutModule parameter. Returns 0 on success.
34    Optionally returns a human-readable error message via OutMessage. */ 
35 LLVMBool LLVMParseBitcode(LLVMMemoryBufferRef MemBuf,
36                           LLVMModuleRef *OutModule, char **OutMessage);
37 
38 LLVMBool LLVMParseBitcodeInContext(LLVMContextRef ContextRef,
39                                    LLVMMemoryBufferRef MemBuf,
40                                    LLVMModuleRef *OutModule, char **OutMessage);
41 
42 /** Reads a module from the specified path, returning via the OutMP parameter
43     a module provider which performs lazy deserialization. Returns 0 on success.
44     Optionally returns a human-readable error message via OutMessage. */ 
45 LLVMBool LLVMGetBitcodeModuleInContext(LLVMContextRef ContextRef,
46                                        LLVMMemoryBufferRef MemBuf,
47                                        LLVMModuleRef *OutM,
48                                        char **OutMessage);
49 
50 LLVMBool LLVMGetBitcodeModule(LLVMMemoryBufferRef MemBuf, LLVMModuleRef *OutM,
51                               char **OutMessage);
52 
53 
54 /** Deprecated: Use LLVMGetBitcodeModuleInContext instead. */
55 LLVMBool LLVMGetBitcodeModuleProviderInContext(LLVMContextRef ContextRef,
56                                                LLVMMemoryBufferRef MemBuf,
57                                                LLVMModuleProviderRef *OutMP,
58                                                char **OutMessage);
59 
60 /** Deprecated: Use LLVMGetBitcodeModule instead. */
61 LLVMBool LLVMGetBitcodeModuleProvider(LLVMMemoryBufferRef MemBuf,
62                                       LLVMModuleProviderRef *OutMP,
63                                       char **OutMessage);
64 
65 /**
66  * @}
67  */