Home | History | Annotate | Download | only in llvm-c
      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
     25 extern "C" {
     26 #endif
     27 
     28 
     29 /*===-- Operations on modules ---------------------------------------------===*/
     30 
     31 /** Writes a module to the specified path. Returns 0 on success. */
     32 int LLVMWriteBitcodeToFile(LLVMModuleRef M, const char *Path);
     33 
     34 /** Writes a module to an open file descriptor. Returns 0 on success. */
     35 int LLVMWriteBitcodeToFD(LLVMModuleRef M, int FD, int ShouldClose,
     36                          int Unbuffered);
     37 
     38 /** Deprecated for LLVMWriteBitcodeToFD. Writes a module to an open file
     39     descriptor. Returns 0 on success. Closes the Handle. */
     40 int LLVMWriteBitcodeToFileHandle(LLVMModuleRef M, int Handle);
     41 
     42 #ifdef __cplusplus
     43 }
     44 #endif
     45 
     46 #endif
     47