raw_ostream subclass that simplifies indention a sequence of code. More...

#include "mlir/Support/IndentedOstream.h"

Inheritance diagram for mlir::raw_indented_ostream:

Collaboration diagram for mlir::raw_indented_ostream:

Classes
struct	DelimitedScope
	Simple RAII struct to use to indentation around entering/exiting region. More...

Public Member Functions
	raw_indented_ostream (llvm::raw_ostream &os)

raw_ostream &	getOStream () const
	Returns the underlying (unindented) raw_ostream. More...

DelimitedScope	scope (StringRef open="", StringRef close="", bool indent=true)
	Returns DelimitedScope. More...

raw_indented_ostream &	printReindented (StringRef str, StringRef extraPrefix="")
	Prints a string re-indented to the current indent. More...

raw_indented_ostream &	indent ()
	Increases the indent and returning this raw_indented_ostream. More...

raw_indented_ostream &	unindent ()
	Decreases the indent and returning this raw_indented_ostream. More...

raw_indented_ostream &	indent (int with)
	Emits whitespace and sets the indentation for the stream. More...

Detailed Description

raw_ostream subclass that simplifies indention a sequence of code.

Definition at line 23 of file IndentedOstream.h.

Constructor & Destructor Documentation

◆ raw_indented_ostream()

mlir::raw_indented_ostream::raw_indented_ostream ( llvm::raw_ostream & os )

inlineexplicit

Definition at line 25 of file IndentedOstream.h.

Member Function Documentation

◆ getOStream()

raw_ostream& mlir::raw_indented_ostream::getOStream ( ) const

inline

Returns the underlying (unindented) raw_ostream.

Definition at line 52 of file IndentedOstream.h.

◆ indent() [1/2]

raw_indented_ostream& mlir::raw_indented_ostream::indent ( )

inline

Increases the indent and returning this raw_indented_ostream.

Definition at line 68 of file IndentedOstream.h.

Referenced by mlir::raw_indented_ostream::DelimitedScope::DelimitedScope(), mlir::tblgen::MethodBody::indent(), printOperation(), scope(), and mlir::tblgen::VisibilityDeclaration::writeDeclTo().

◆ indent() [2/2]

raw_indented_ostream& mlir::raw_indented_ostream::indent ( int with )

inline

Emits whitespace and sets the indentation for the stream.

Definition at line 80 of file IndentedOstream.h.

◆ printReindented()

raw_indented_ostream & mlir::raw_indented_ostream::printReindented	(	StringRef	str,
		StringRef	extraPrefix = `""`
	)

Prints a string re-indented to the current indent.

Re-indents by removing the leading whitespace from the first non-empty line from every line of the string, skipping over empty lines at the start. Prefixes each line with extraPrefix after the indentation.

Definition at line 19 of file IndentedOstream.cpp.

References min().

Referenced by mlir::tblgen::ExtraClassDeclaration::writeDeclTo(), and mlir::tblgen::ExtraClassDeclaration::writeDefTo().