mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 12:12:47 +01:00
43c1c2e000
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). llvm-svn: 153157
150 lines
5.6 KiB
C++
150 lines
5.6 KiB
C++
/*===-- llvm-c/Object.h - Object Lib C Iface --------------------*- 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 libLLVMObject.a, which */
|
|
/* implements object file reading and writing. */
|
|
/* */
|
|
/* 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_OBJECT_H
|
|
#define LLVM_C_OBJECT_H
|
|
|
|
#include "llvm-c/Core.h"
|
|
#include "llvm/Config/llvm-config.h"
|
|
|
|
#ifdef __cplusplus
|
|
#include "llvm/Object/ObjectFile.h"
|
|
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup LLVMCObject Object file reading and writing
|
|
* @ingroup LLVMC
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
// Opaque type wrappers
|
|
typedef struct LLVMOpaqueObjectFile *LLVMObjectFileRef;
|
|
typedef struct LLVMOpaqueSectionIterator *LLVMSectionIteratorRef;
|
|
typedef struct LLVMOpaqueSymbolIterator *LLVMSymbolIteratorRef;
|
|
typedef struct LLVMOpaqueRelocationIterator *LLVMRelocationIteratorRef;
|
|
|
|
// ObjectFile creation
|
|
LLVMObjectFileRef LLVMCreateObjectFile(LLVMMemoryBufferRef MemBuf);
|
|
void LLVMDisposeObjectFile(LLVMObjectFileRef ObjectFile);
|
|
|
|
// ObjectFile Section iterators
|
|
LLVMSectionIteratorRef LLVMGetSections(LLVMObjectFileRef ObjectFile);
|
|
void LLVMDisposeSectionIterator(LLVMSectionIteratorRef SI);
|
|
LLVMBool LLVMIsSectionIteratorAtEnd(LLVMObjectFileRef ObjectFile,
|
|
LLVMSectionIteratorRef SI);
|
|
void LLVMMoveToNextSection(LLVMSectionIteratorRef SI);
|
|
void LLVMMoveToContainingSection(LLVMSectionIteratorRef Sect,
|
|
LLVMSymbolIteratorRef Sym);
|
|
|
|
// ObjectFile Symbol iterators
|
|
LLVMSymbolIteratorRef LLVMGetSymbols(LLVMObjectFileRef ObjectFile);
|
|
void LLVMDisposeSymbolIterator(LLVMSymbolIteratorRef SI);
|
|
LLVMBool LLVMIsSymbolIteratorAtEnd(LLVMObjectFileRef ObjectFile,
|
|
LLVMSymbolIteratorRef SI);
|
|
void LLVMMoveToNextSymbol(LLVMSymbolIteratorRef SI);
|
|
|
|
// SectionRef accessors
|
|
const char *LLVMGetSectionName(LLVMSectionIteratorRef SI);
|
|
uint64_t LLVMGetSectionSize(LLVMSectionIteratorRef SI);
|
|
const char *LLVMGetSectionContents(LLVMSectionIteratorRef SI);
|
|
uint64_t LLVMGetSectionAddress(LLVMSectionIteratorRef SI);
|
|
LLVMBool LLVMGetSectionContainsSymbol(LLVMSectionIteratorRef SI,
|
|
LLVMSymbolIteratorRef Sym);
|
|
|
|
// Section Relocation iterators
|
|
LLVMRelocationIteratorRef LLVMGetRelocations(LLVMSectionIteratorRef Section);
|
|
void LLVMDisposeRelocationIterator(LLVMRelocationIteratorRef RI);
|
|
LLVMBool LLVMIsRelocationIteratorAtEnd(LLVMSectionIteratorRef Section,
|
|
LLVMRelocationIteratorRef RI);
|
|
void LLVMMoveToNextRelocation(LLVMRelocationIteratorRef RI);
|
|
|
|
|
|
// SymbolRef accessors
|
|
const char *LLVMGetSymbolName(LLVMSymbolIteratorRef SI);
|
|
uint64_t LLVMGetSymbolAddress(LLVMSymbolIteratorRef SI);
|
|
uint64_t LLVMGetSymbolFileOffset(LLVMSymbolIteratorRef SI);
|
|
uint64_t LLVMGetSymbolSize(LLVMSymbolIteratorRef SI);
|
|
|
|
// RelocationRef accessors
|
|
uint64_t LLVMGetRelocationAddress(LLVMRelocationIteratorRef RI);
|
|
uint64_t LLVMGetRelocationOffset(LLVMRelocationIteratorRef RI);
|
|
LLVMSymbolIteratorRef LLVMGetRelocationSymbol(LLVMRelocationIteratorRef RI);
|
|
uint64_t LLVMGetRelocationType(LLVMRelocationIteratorRef RI);
|
|
// NOTE: Caller takes ownership of returned string of the two
|
|
// following functions.
|
|
const char *LLVMGetRelocationTypeName(LLVMRelocationIteratorRef RI);
|
|
const char *LLVMGetRelocationValueString(LLVMRelocationIteratorRef RI);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
|
|
namespace llvm {
|
|
namespace object {
|
|
inline ObjectFile *unwrap(LLVMObjectFileRef OF) {
|
|
return reinterpret_cast<ObjectFile*>(OF);
|
|
}
|
|
|
|
inline LLVMObjectFileRef wrap(const ObjectFile *OF) {
|
|
return reinterpret_cast<LLVMObjectFileRef>(const_cast<ObjectFile*>(OF));
|
|
}
|
|
|
|
inline section_iterator *unwrap(LLVMSectionIteratorRef SI) {
|
|
return reinterpret_cast<section_iterator*>(SI);
|
|
}
|
|
|
|
inline LLVMSectionIteratorRef
|
|
wrap(const section_iterator *SI) {
|
|
return reinterpret_cast<LLVMSectionIteratorRef>
|
|
(const_cast<section_iterator*>(SI));
|
|
}
|
|
|
|
inline symbol_iterator *unwrap(LLVMSymbolIteratorRef SI) {
|
|
return reinterpret_cast<symbol_iterator*>(SI);
|
|
}
|
|
|
|
inline LLVMSymbolIteratorRef
|
|
wrap(const symbol_iterator *SI) {
|
|
return reinterpret_cast<LLVMSymbolIteratorRef>
|
|
(const_cast<symbol_iterator*>(SI));
|
|
}
|
|
|
|
inline relocation_iterator *unwrap(LLVMRelocationIteratorRef SI) {
|
|
return reinterpret_cast<relocation_iterator*>(SI);
|
|
}
|
|
|
|
inline LLVMRelocationIteratorRef
|
|
wrap(const relocation_iterator *SI) {
|
|
return reinterpret_cast<LLVMRelocationIteratorRef>
|
|
(const_cast<relocation_iterator*>(SI));
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* defined(__cplusplus) */
|
|
|
|
#endif
|
|
|