#include "llvm/Remarks/RemarkLinker.h"

Public Types
using	iterator = pointee_iterator< decltype(Remarks)::const_iterator >
	Return a collection of the linked unique remarks to iterate on.

Public Member Functions
void	setExternalFilePrependPath (StringRef PrependPath)
	Set a path to prepend to the external file path.

Error	link (StringRef Buffer, std::optional< Format > RemarkFormat=std::nullopt)
	Link the remarks found in `Buffer`.

Error	link (const object::ObjectFile &Obj, std::optional< Format > RemarkFormat=std::nullopt)
	Link the remarks found in `Obj` by looking for the right section and calling the method above.

Error	serialize (raw_ostream &OS, Format RemarksFormat) const
	Serialize the linked remarks to the stream `OS`, using the format `RemarkFormat`.

bool	empty () const
	Check whether there are any remarks linked.

iterator_range< iterator >	remarks () const

Detailed Description

Definition at line 32 of file RemarkLinker.h.

Member Typedef Documentation

◆ iterator

using llvm::remarks::RemarkLinker::iterator = pointee_iterator<decltype(Remarks)::const_iterator>

Return a collection of the linked unique remarks to iterate on.

Ex: for (const Remark &R : RL.remarks() { [...] }

Definition at line 89 of file RemarkLinker.h.

Member Function Documentation

◆ empty()

bool llvm::remarks::RemarkLinker::empty ( ) const

inline

Check whether there are any remarks linked.

Definition at line 84 of file RemarkLinker.h.

◆ link() [1/2]

Error RemarkLinker::link	(	const object::ObjectFile &	Obj,
		std::optional< Format >	RemarkFormat = `std::nullopt`
	)

Link the remarks found in Obj by looking for the right section and calling the method above.

Definition at line 108 of file RemarkLinker.cpp.

References llvm::remarks::getRemarksSectionContents(), link(), llvm::Error::success(), and llvm::Expected< T >::takeError().

◆ link() [2/2]

Error RemarkLinker::link	(	StringRef	Buffer,
		std::optional< Format >	RemarkFormat = `std::nullopt`
	)

Link the remarks found in Buffer.

If RemarkFormat is not provided, try to deduce it from the metadata in Buffer. Buffer can be either a standalone remark container or just metadata. This takes care of uniquing and merging the remarks.

Definition at line 72 of file RemarkLinker.cpp.

References assert(), llvm::consumeError(), llvm::remarks::createRemarkParserFromMeta(), E, llvm::remarks::magicToFormat(), llvm::remarks::RemarkParser::next(), shouldKeepRemark(), llvm::Error::success(), and llvm::Expected< T >::takeError().

Referenced by link().

◆ remarks()

iterator_range< iterator > llvm::remarks::RemarkLinker::remarks ( ) const

inline

Definition at line 91 of file RemarkLinker.h.

Referenced by serialize().

◆ serialize()

Error RemarkLinker::serialize	(	raw_ostream &	OS,
		Format	RemarksFormat
	)		const

Serialize the linked remarks to the stream OS, using the format RemarkFormat.

This clears internal state such as the string table. Note: this implies that the serialization mode is standalone.

Definition at line 120 of file RemarkLinker.cpp.

References llvm::remarks::createRemarkSerializer(), OS, remarks(), llvm::RemarksFormat, llvm::remarks::Standalone, llvm::Error::success(), and llvm::Expected< T >::takeError().

◆ setExternalFilePrependPath()

void RemarkLinker::setExternalFilePrependPath ( StringRef PrependPath )

Set a path to prepend to the external file path.

Definition at line 65 of file RemarkLinker.cpp.

The documentation for this struct was generated from the following files:

include/llvm/Remarks/RemarkLinker.h
lib/Remarks/RemarkLinker.cpp

Public Types

Public Member Functions