LLVM 22.0.0git
Support.h
Go to the documentation of this file.
1/*===-- llvm-c/Support.h - Support 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 file defines the C interface to the LLVM support library. *|
11|* *|
12\*===----------------------------------------------------------------------===*/
13
14#ifndef LLVM_C_SUPPORT_H
15#define LLVM_C_SUPPORT_H
16
17#include "llvm-c/DataTypes.h"
18#include "llvm-c/ExternC.h"
19#include "llvm-c/Types.h"
20#include "llvm-c/Visibility.h"
21
23
24/**
25 * @addtogroup LLVMCCore
26 *
27 * @{
28 */
29
30/**
31 * This function permanently loads the dynamic library at the given path.
32 * It is safe to call this function multiple times for the same library.
33 *
34 * @see sys::DynamicLibrary::LoadLibraryPermanently()
35 */
37
38/**
39 * This function parses the given arguments using the LLVM command line parser.
40 * Note that the only stable thing about this function is its signature; you
41 * cannot rely on any particular set of command line arguments being interpreted
42 * the same way across LLVM versions.
43 *
44 * @see llvm::cl::ParseCommandLineOptions()
45 */
46LLVM_C_ABI void LLVMParseCommandLineOptions(int argc, const char *const *argv,
47 const char *Overview);
48
49/**
50 * This function will search through all previously loaded dynamic
51 * libraries for the symbol \p symbolName. If it is found, the address of
52 * that symbol is returned. If not, null is returned.
53 *
54 * @see sys::DynamicLibrary::SearchForAddressOfSymbol()
55 */
56LLVM_C_ABI void *LLVMSearchForAddressOfSymbol(const char *symbolName);
57
58/**
59 * This functions permanently adds the symbol \p symbolName with the
60 * value \p symbolValue. These symbols are searched before any
61 * libraries.
62 *
63 * @see sys::DynamicLibrary::AddSymbol()
64 */
65LLVM_C_ABI void LLVMAddSymbol(const char *symbolName, void *symbolValue);
66
67/**
68 * @}
69 */
70
72
73#endif
#define LLVM_C_EXTERN_C_BEGIN
Definition: ExternC.h:35
#define LLVM_C_EXTERN_C_END
Definition: ExternC.h:36
#define LLVM_C_ABI
LLVM_C_ABI is the export/visibility macro used to mark symbols declared in llvm-c as exported when bu...
Definition: Visibility.h:40
LLVM_C_ABI LLVMBool LLVMLoadLibraryPermanently(const char *Filename)
This function permanently loads the dynamic library at the given path.
LLVM_C_ABI void * LLVMSearchForAddressOfSymbol(const char *symbolName)
This function will search through all previously loaded dynamic libraries for the symbol symbolName.
LLVM_C_ABI void LLVMAddSymbol(const char *symbolName, void *symbolValue)
This functions permanently adds the symbol symbolName with the value symbolValue.
LLVM_C_ABI void LLVMParseCommandLineOptions(int argc, const char *const *argv, const char *Overview)
This function parses the given arguments using the LLVM command line parser.
int LLVMBool
Definition: Types.h:28