include/llvm-c/Linker.h

   1 /*===-- llvm-c/Linker.h - Module Linker 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 file defines the C interface to the module/file/archive linker.       *|
  11 |*                                                                            *|
  12 \*===----------------------------------------------------------------------===*/
  13
  14 #ifndef LLVM_C_LINKER_H
  15 #define LLVM_C_LINKER_H
  16
  17 #include "llvm-c/Types.h"
  18
  19 #ifdef __cplusplus
  20 extern "C" {
  21 #endif
  22
  23 /* This enum is provided for backwards-compatibility only. It has no effect. */
  24 typedef enum {
  25   LLVMLinkerDestroySource = 0, /* This is the default behavior. */
  26   LLVMLinkerPreserveSource_Removed = 1 /* This option has been deprecated and
  27                                           should not be used. */
  28 } LLVMLinkerMode;
  29
  30 /* Links the source module into the destination module. The source module is
  31  * damaged. The only thing that can be done is destroy it. Optionally returns a
  32  * human-readable description of any errors that occurred in linking. OutMessage
  33  * must be disposed with LLVMDisposeMessage. The return value is true if an
  34  * error occurred, false otherwise.
  35  *
  36  * Note that the linker mode parameter \p Unused is no longer used, and has
  37  * no effect.
  38  *
  39  * This function is deprecated. Use LLVMLinkModules2 instead.
  40  */
  41 LLVMBool LLVMLinkModules(LLVMModuleRef Dest, LLVMModuleRef Src,
  42                          LLVMLinkerMode Unused, char **OutMessage);
  43
  44 /* Links the source module into the destination module. The source module is
  45  * destroyed.
  46  * The return value is true if an error occurred, false otherwise.
  47  * Use the diagnostic handler to get any diagnostic message.
  48 */
  49 LLVMBool LLVMLinkModules2(LLVMModuleRef Dest, LLVMModuleRef Src);
  50
  51 #ifdef __cplusplus
  52 }
  53 #endif
  54
  55 #endif