mirror of
https://github.com/RPCSX/llvm.git
synced 2024-12-23 20:44:51 +00:00
6244b51888
This gives a lot of love to the docs for the C API. Like Clang's documentation, the C API is now organized into a Doxygen "module" (LLVMC). Each C header file is a child of the main module. Some modules (like Core) have a hierarchy of there own. The produced documentation is thus better organized (before everything was in one monolithic list). This patch also includes a lot of new documentation for APIs in Core.h. It doesn't document them all, but is better than none. Function docs are missing @param and @return annotation, but the documentation body now commonly provides help details (like the expected llvm::Value sub-type to expect). git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@153157 91177308-0d34-0410-b5e6-96231b3b80d8
66 lines
2.5 KiB
C++
66 lines
2.5 KiB
C++
/*===-- llvm-c/Analysis.h - Analysis Library C Interface --------*- C++ -*-===*\
|
|
|* *|
|
|
|* The LLVM Compiler Infrastructure *|
|
|
|* *|
|
|
|* This file is distributed under the University of Illinois Open Source *|
|
|
|* License. See LICENSE.TXT for details. *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header declares the C interface to libLLVMAnalysis.a, which *|
|
|
|* implements various analyses of the LLVM IR. *|
|
|
|* *|
|
|
|* Many exotic languages can interoperate with C code but have a harder time *|
|
|
|* with C++ due to name mangling. So in addition to C, this interface enables *|
|
|
|* tools written in such languages. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_ANALYSIS_H
|
|
#define LLVM_C_ANALYSIS_H
|
|
|
|
#include "llvm-c/Core.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup LLVMCAnalysis Analysis
|
|
* @ingroup LLVMC
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
typedef enum {
|
|
LLVMAbortProcessAction, /* verifier will print to stderr and abort() */
|
|
LLVMPrintMessageAction, /* verifier will print to stderr and return 1 */
|
|
LLVMReturnStatusAction /* verifier will just return 1 */
|
|
} LLVMVerifierFailureAction;
|
|
|
|
|
|
/* Verifies that a module is valid, taking the specified action if not.
|
|
Optionally returns a human-readable description of any invalid constructs.
|
|
OutMessage must be disposed with LLVMDisposeMessage. */
|
|
LLVMBool LLVMVerifyModule(LLVMModuleRef M, LLVMVerifierFailureAction Action,
|
|
char **OutMessage);
|
|
|
|
/* Verifies that a single function is valid, taking the specified action. Useful
|
|
for debugging. */
|
|
LLVMBool LLVMVerifyFunction(LLVMValueRef Fn, LLVMVerifierFailureAction Action);
|
|
|
|
/* Open up a ghostview window that displays the CFG of the current function.
|
|
Useful for debugging. */
|
|
void LLVMViewFunctionCFG(LLVMValueRef Fn);
|
|
void LLVMViewFunctionCFGOnly(LLVMValueRef Fn);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|