include/llvm-c/Support.h

0001 /*===-- llvm-c/Support.h - Support C Interface --------------------*- C -*-===*\
0002 |*                                                                            *|
0003 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
0004 |* Exceptions.                                                                *|
0005 |* See https://llvm.org/LICENSE.txt for license information.                  *|
0006 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
0007 |*                                                                            *|
0008 |*===----------------------------------------------------------------------===*|
0009 |*                                                                            *|
0010 |* This file defines the C interface to the LLVM support library.             *|
0011 |*                                                                            *|
0012 \*===----------------------------------------------------------------------===*/
0013
0014 #ifndef LLVM_C_SUPPORT_H
0015 #define LLVM_C_SUPPORT_H
0016
0017 #include "llvm-c/DataTypes.h"
0018 #include "llvm-c/ExternC.h"
0019 #include "llvm-c/Types.h"
0020
0021 LLVM_C_EXTERN_C_BEGIN
0022
0023 /**
0024  * @addtogroup LLVMCCore
0025  *
0026  * @{
0027  */
0028
0029 /**
0030  * This function permanently loads the dynamic library at the given path.
0031  * It is safe to call this function multiple times for the same library.
0032  *
0033  * @see sys::DynamicLibrary::LoadLibraryPermanently()
0034   */
0035 LLVMBool LLVMLoadLibraryPermanently(const char* Filename);
0036
0037 /**
0038  * This function parses the given arguments using the LLVM command line parser.
0039  * Note that the only stable thing about this function is its signature; you
0040  * cannot rely on any particular set of command line arguments being interpreted
0041  * the same way across LLVM versions.
0042  *
0043  * @see llvm::cl::ParseCommandLineOptions()
0044  */
0045 void LLVMParseCommandLineOptions(int argc, const char *const *argv,
0046                                  const char *Overview);
0047
0048 /**
0049  * This function will search through all previously loaded dynamic
0050  * libraries for the symbol \p symbolName. If it is found, the address of
0051  * that symbol is returned. If not, null is returned.
0052  *
0053  * @see sys::DynamicLibrary::SearchForAddressOfSymbol()
0054  */
0055 void *LLVMSearchForAddressOfSymbol(const char *symbolName);
0056
0057 /**
0058  * This functions permanently adds the symbol \p symbolName with the
0059  * value \p symbolValue.  These symbols are searched before any
0060  * libraries.
0061  *
0062  * @see sys::DynamicLibrary::AddSymbol()
0063  */
0064 void LLVMAddSymbol(const char *symbolName, void *symbolValue);
0065
0066 /**
0067  * @}
0068  */
0069
0070 LLVM_C_EXTERN_C_END
0071
0072 #endif