clang::tooling::HeaderIncludes::HeaderToInsert Struct Reference

Represents a single header directive to be inserted in a batch operation. More...

#include "clang/Tooling/Inclusions/HeaderIncludes.h"

Public Types
enum class	QuoteStyle { AUTO , ANGLED , QUOTED }

Public Member Functions
	HeaderToInsert (llvm::StringRef RawOrSpelledHeader, IncludeDirective Directive=IncludeDirective::Include, QuoteStyle QuoteStyle=QuoteStyle::AUTO)

Public Attributes
std::string	Header
IncludeDirective	Directive
bool	IsAngled

Detailed Description

Represents a single header directive to be inserted in a batch operation.

Usage:

• HeaderToInsert("<vector>") -> inserts #include <vector> (auto-detects angled)
• HeaderToInsert("\"foo.h\"") -> inserts #include "foo.h" (auto-detects quoted)
• HeaderToInsert("<foo>", IncludeDirective::Import) -> inserts #import <foo>
• HeaderToInsert("foo.h", IncludeDirective::Include, /*IsAngled=*‍/false) -> explicit IsAngled

Definition at line 94 of file HeaderIncludes.h.

Member Enumeration Documentation

QuoteStyle

enum class clang::tooling::HeaderIncludes::HeaderToInsert::QuoteStyle

strong

Enumerator
AUTO
ANGLED
QUOTED

Definition at line 95 of file HeaderIncludes.h.

Constructor & Destructor Documentation

HeaderToInsert()

clang::tooling::HeaderIncludes::HeaderToInsert::HeaderToInsert	(	llvm::StringRef	RawOrSpelledHeader,
		IncludeDirective	Directive = IncludeDirective::Include,
		QuoteStyle	QuoteStyle = QuoteStyle::AUTO )

Definition at line 519 of file HeaderIncludes.cpp.

References Directive, and clang::if().

Member Data Documentation

Directive

IncludeDirective clang::tooling::HeaderIncludes::HeaderToInsert::Directive

Definition at line 100 of file HeaderIncludes.h.

Referenced by HeaderToInsert(), and clang::tooling::HeaderIncludes::insert().

Header

std::string clang::tooling::HeaderIncludes::HeaderToInsert::Header

Definition at line 98 of file HeaderIncludes.h.

Referenced by clang::tooling::HeaderIncludes::insert().

IsAngled

bool clang::tooling::HeaderIncludes::HeaderToInsert::IsAngled

Definition at line 104 of file HeaderIncludes.h.

Referenced by clang::tooling::HeaderIncludes::insert().

---

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

• include/clang/Tooling/Inclusions/HeaderIncludes.h
• lib/Tooling/Inclusions/HeaderIncludes.cpp