1 /*===-- llvm-c/BitWriter.h - BitWriter 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 libLLVMBitWriter.a, which          *|
11 |* implements output 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_BITWRITER_H
20 #define LLVM_C_BITWRITER_H
21 
22 #include "llvm-c/Types.h"
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /**
29  * @defgroup LLVMCBitWriter Bit Writer
30  * @ingroup LLVMC
31  *
32  * @{
33  */
34 
35 /*===-- Operations on modules ---------------------------------------------===*/
36 
37 /** Writes a module to the specified path. Returns 0 on success. */
38 int LLVMWriteBitcodeToFile(LLVMModuleRef M, const char *Path);
39 
40 /** Writes a module to an open file descriptor. Returns 0 on success. */
41 int LLVMWriteBitcodeToFD(LLVMModuleRef M, int FD, int ShouldClose,
42                          int Unbuffered);
43 
44 /** Deprecated for LLVMWriteBitcodeToFD. Writes a module to an open file
45     descriptor. Returns 0 on success. Closes the Handle. */
46 int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
47 
48 /** Writes a module to a new memory buffer and returns it. */
49 LLVMMemoryBufferRef LLVMWriteBitcodeToMemoryBuffer(LLVMModuleRef M);
50 
51 /**
52  * @}
53  */
54 
55 #ifdef __cplusplus
56 }
57 #endif
58 
59 #endif
60