mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2025-01-27 11:55:49 +00:00
ad523cc398
The LLVM-C API is relatively small so we've previously added doxygen tags so it's easier to navigate the LLVM-C web docs. Over the years, more headers were added without proper doxygen tags, effectively hiding them from the main LLVM-C doxygen page. This patch adds comments to headers which did not have them. Reviewed By: lhames Differential Revision: https://reviews.llvm.org/D112474
73 lines
2.5 KiB
C
73 lines
2.5 KiB
C
/*===-- llvm-c/Support.h - Support C Interface --------------------*- C -*-===*\
|
|
|* *|
|
|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|
|
|* Exceptions. *|
|
|
|* See https://llvm.org/LICENSE.txt for license information. *|
|
|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This file defines the C interface to the LLVM support library. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_SUPPORT_H
|
|
#define LLVM_C_SUPPORT_H
|
|
|
|
#include "llvm-c/DataTypes.h"
|
|
#include "llvm-c/ExternC.h"
|
|
#include "llvm-c/Types.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* @addtogroup LLVMCCore
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* This function permanently loads the dynamic library at the given path.
|
|
* It is safe to call this function multiple times for the same library.
|
|
*
|
|
* @see sys::DynamicLibrary::LoadLibraryPermanently()
|
|
*/
|
|
LLVMBool LLVMLoadLibraryPermanently(const char* Filename);
|
|
|
|
/**
|
|
* This function parses the given arguments using the LLVM command line parser.
|
|
* Note that the only stable thing about this function is its signature; you
|
|
* cannot rely on any particular set of command line arguments being interpreted
|
|
* the same way across LLVM versions.
|
|
*
|
|
* @see llvm::cl::ParseCommandLineOptions()
|
|
*/
|
|
void LLVMParseCommandLineOptions(int argc, const char *const *argv,
|
|
const char *Overview);
|
|
|
|
/**
|
|
* This function will search through all previously loaded dynamic
|
|
* libraries for the symbol \p symbolName. If it is found, the address of
|
|
* that symbol is returned. If not, null is returned.
|
|
*
|
|
* @see sys::DynamicLibrary::SearchForAddressOfSymbol()
|
|
*/
|
|
void *LLVMSearchForAddressOfSymbol(const char *symbolName);
|
|
|
|
/**
|
|
* This functions permanently adds the symbol \p symbolName with the
|
|
* value \p symbolValue. These symbols are searched before any
|
|
* libraries.
|
|
*
|
|
* @see sys::DynamicLibrary::AddSymbol()
|
|
*/
|
|
void LLVMAddSymbol(const char *symbolName, void *symbolValue);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif
|