94 lines · c
1/*===-- llvm-c/BitReader.h - BitReader Library C Interface ------*- C++ -*-===*\2|* *|3|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|4|* Exceptions. *|5|* See https://llvm.org/LICENSE.txt for license information. *|6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|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#ifndef LLVM_C_BITREADER_H20#define LLVM_C_BITREADER_H21 22#include "llvm-c/ExternC.h"23#include "llvm-c/Types.h"24#include "llvm-c/Visibility.h"25 26LLVM_C_EXTERN_C_BEGIN27 28/**29 * @defgroup LLVMCBitReader Bit Reader30 * @ingroup LLVMC31 *32 * @{33 */34 35/* Builds a module from the bitcode in the specified memory buffer, returning a36 reference to the module via the OutModule parameter. Returns 0 on success.37 Optionally returns a human-readable error message via OutMessage.38 39 This is deprecated. Use LLVMParseBitcode2. */40LLVM_C_ABI LLVMBool LLVMParseBitcode(LLVMMemoryBufferRef MemBuf,41 LLVMModuleRef *OutModule,42 char **OutMessage);43 44/* Builds a module from the bitcode in the specified memory buffer, returning a45 reference to the module via the OutModule parameter. Returns 0 on success. */46LLVM_C_ABI LLVMBool LLVMParseBitcode2(LLVMMemoryBufferRef MemBuf,47 LLVMModuleRef *OutModule);48 49/* This is deprecated. Use LLVMParseBitcodeInContext2. */50LLVM_C_ABI LLVMBool LLVMParseBitcodeInContext(LLVMContextRef ContextRef,51 LLVMMemoryBufferRef MemBuf,52 LLVMModuleRef *OutModule,53 char **OutMessage);54 55LLVM_C_ABI LLVMBool LLVMParseBitcodeInContext2(LLVMContextRef ContextRef,56 LLVMMemoryBufferRef MemBuf,57 LLVMModuleRef *OutModule);58 59/** Reads a module from the specified path, returning via the OutMP parameter60 a module provider which performs lazy deserialization. Returns 0 on success.61 Optionally returns a human-readable error message via OutMessage.62 This is deprecated. Use LLVMGetBitcodeModuleInContext2. */63LLVM_C_ABI LLVMBool LLVMGetBitcodeModuleInContext(LLVMContextRef ContextRef,64 LLVMMemoryBufferRef MemBuf,65 LLVMModuleRef *OutM,66 char **OutMessage);67 68/** Reads a module from the given memory buffer, returning via the OutMP69 * parameter a module provider which performs lazy deserialization.70 *71 * Returns 0 on success.72 *73 * Takes ownership of \p MemBuf if (and only if) the module was read74 * successfully. */75LLVM_C_ABI LLVMBool LLVMGetBitcodeModuleInContext2(LLVMContextRef ContextRef,76 LLVMMemoryBufferRef MemBuf,77 LLVMModuleRef *OutM);78 79/* This is deprecated. Use LLVMGetBitcodeModule2. */80LLVM_C_ABI LLVMBool LLVMGetBitcodeModule(LLVMMemoryBufferRef MemBuf,81 LLVMModuleRef *OutM,82 char **OutMessage);83 84LLVM_C_ABI LLVMBool LLVMGetBitcodeModule2(LLVMMemoryBufferRef MemBuf,85 LLVMModuleRef *OutM);86 87/**88 * @}89 */90 91LLVM_C_EXTERN_C_END92 93#endif94