BitWriter.h revision 263508 
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_BITCODEWRITER_H
20#define LLVM_C_BITCODEWRITER_H
21
22#include "llvm-c/Core.h"
23
24#ifdef __cplusplus
25extern "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. */
38int LLVMWriteBitcodeToFile(LLVMModuleRef M, const char *Path);
39
40/** Writes a module to an open file descriptor. Returns 0 on success. */
41int 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. */
46int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
47
48/**
49 * @}
50 */
51
52#ifdef __cplusplus
53}
54#endif
55
56#endif
57