A class that writes API notes data to a binary representation that can be read by the APINotesReader
.
More...
#include "clang/APINotes/APINotesWriter.h"
|
| APINotesWriter (llvm::StringRef ModuleName, const FileEntry *SF) |
| Create a new API notes writer with the given module name and (optional) source file. More...
|
|
| ~APINotesWriter () |
|
| APINotesWriter (const APINotesWriter &)=delete |
|
APINotesWriter & | operator= (const APINotesWriter &)=delete |
|
void | writeToStream (llvm::raw_ostream &OS) |
|
ContextID | addObjCContext (std::optional< ContextID > ParentCtxID, llvm::StringRef Name, ContextKind Kind, const ObjCContextInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a specific Objective-C class or protocol or a C++ namespace. More...
|
|
void | addObjCProperty (ContextID CtxID, llvm::StringRef Name, bool IsInstanceProperty, const ObjCPropertyInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a specific Objective-C property. More...
|
|
void | addObjCMethod (ContextID CtxID, ObjCSelectorRef Selector, bool IsInstanceMethod, const ObjCMethodInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a specific Objective-C method. More...
|
|
void | addGlobalVariable (std::optional< Context > Ctx, llvm::StringRef Name, const GlobalVariableInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a global variable. More...
|
|
void | addGlobalFunction (std::optional< Context > Ctx, llvm::StringRef Name, const GlobalFunctionInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a global function. More...
|
|
void | addEnumConstant (llvm::StringRef Name, const EnumConstantInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about an enumerator. More...
|
|
void | addTag (std::optional< Context > Ctx, llvm::StringRef Name, const TagInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a tag (struct/union/enum/C++ class). More...
|
|
void | addTypedef (std::optional< Context > Ctx, llvm::StringRef Name, const TypedefInfo &Info, llvm::VersionTuple SwiftVersion) |
| Add information about a typedef. More...
|
|
A class that writes API notes data to a binary representation that can be read by the APINotesReader
.
Definition at line 32 of file APINotesWriter.h.
◆ APINotesWriter() [1/2]
clang::api_notes::APINotesWriter::APINotesWriter |
( |
llvm::StringRef |
ModuleName, |
|
|
const FileEntry * |
SF |
|
) |
| |
Create a new API notes writer with the given module name and (optional) source file.
Definition at line 1257 of file APINotesWriter.cpp.
◆ ~APINotesWriter()
clang::api_notes::APINotesWriter::~APINotesWriter |
( |
| ) |
|
|
default |
◆ APINotesWriter() [2/2]
clang::api_notes::APINotesWriter::APINotesWriter |
( |
const APINotesWriter & |
| ) |
|
|
delete |
◆ addEnumConstant()
void clang::api_notes::APINotesWriter::addEnumConstant |
( |
llvm::StringRef |
Name, |
|
|
const EnumConstantInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about an enumerator.
- Parameters
-
Name | The name of this enumerator. |
Info | Information about this enumerator. |
Definition at line 1368 of file APINotesWriter.cpp.
◆ addGlobalFunction()
void clang::api_notes::APINotesWriter::addGlobalFunction |
( |
std::optional< Context > |
Ctx, |
|
|
llvm::StringRef |
Name, |
|
|
const GlobalFunctionInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about a global function.
- Parameters
-
Name | The name of this global function. |
Info | Information about this global function. |
Definition at line 1359 of file APINotesWriter.cpp.
◆ addGlobalVariable()
void clang::api_notes::APINotesWriter::addGlobalVariable |
( |
std::optional< Context > |
Ctx, |
|
|
llvm::StringRef |
Name, |
|
|
const GlobalVariableInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about a global variable.
- Parameters
-
Name | The name of this global variable. |
Info | Information about this global variable. |
Definition at line 1350 of file APINotesWriter.cpp.
◆ addObjCContext()
Add information about a specific Objective-C class or protocol or a C++ namespace.
- Parameters
-
Name | The name of this class/protocol/namespace. |
Kind | Whether this is a class, a protocol, or a namespace. |
Info | Information about this class/protocol/namespace. |
- Returns
- the ID of the class, protocol, or namespace, which can be used to add properties and methods to the class/protocol/namespace.
Definition at line 1266 of file APINotesWriter.cpp.
◆ addObjCMethod()
◆ addObjCProperty()
void clang::api_notes::APINotesWriter::addObjCProperty |
( |
ContextID |
CtxID, |
|
|
llvm::StringRef |
Name, |
|
|
bool |
IsInstanceProperty, |
|
|
const ObjCPropertyInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about a specific Objective-C property.
- Parameters
-
CtxID | The context in which this property resides. |
Name | The name of this property. |
Info | Information about this property. |
Definition at line 1305 of file APINotesWriter.cpp.
◆ addTag()
void clang::api_notes::APINotesWriter::addTag |
( |
std::optional< Context > |
Ctx, |
|
|
llvm::StringRef |
Name, |
|
|
const TagInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about a tag (struct/union/enum/C++ class).
- Parameters
-
Name | The name of this tag. |
Info | Information about this tag. |
Definition at line 1375 of file APINotesWriter.cpp.
◆ addTypedef()
void clang::api_notes::APINotesWriter::addTypedef |
( |
std::optional< Context > |
Ctx, |
|
|
llvm::StringRef |
Name, |
|
|
const TypedefInfo & |
Info, |
|
|
llvm::VersionTuple |
SwiftVersion |
|
) |
| |
Add information about a typedef.
- Parameters
-
Name | The name of this typedef. |
Info | Information about this typedef. |
Definition at line 1382 of file APINotesWriter.cpp.
◆ operator=()
◆ writeToStream()
void clang::api_notes::APINotesWriter::writeToStream |
( |
llvm::raw_ostream & |
OS | ) |
|
The documentation for this class was generated from the following files: