Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlJS::Dom::OutWriter Class Reference

#include <qqmldomoutwriter_p.h>

Collaboration diagram for QQmlJS::Dom::OutWriter:

Public Types

using RegionToCommentMap = QMap<FileLocationRegion, CommentedElement>
using OffsetToDisabledRegionMap = QMap<quint32, SourceLocation>

Public Member Functions

 OutWriter (LineWriter &lw)
 OutWriter (std::shared_ptr< ExternalOwningItem > ownerFile, LineWriter &lw)
int increaseIndent (int level=1)
int decreaseIndent (int level=1, int expectedIndent=-1)
void itemStart (const DomItem &it)
void itemEnd ()
void writePreComment (FileLocationRegion region)
void writePostComment (FileLocationRegion regino)
quint32 counter () const
OutWriter & writeRegion (const FileLocations::Tree &fLoc, FileLocationRegion region, QStringView toWrite)
OutWriter & writeRegion (const FileLocations::Tree &fLoc, FileLocationRegion region)
OutWriter & ensureNewline (int nNewlines=1)
OutWriter & ensureSpace ()
OutWriter & ensureSpace (QStringView space)
OutWriter & newline ()
OutWriter & write (QStringView v, LineWriter::TextAddType t=LineWriter::TextAddType::Normal)
void flush ()
void eof (bool ensureNewline=true)
int addNewlinesAutospacerCallback (int nLines)
int addTextAddCallback (std::function< bool(LineWriter &, LineWriter::TextAddType)> callback)
bool removeTextAddCallback (int i)
void maybeWriteComment (const Comment &comment)
bool formatterEnabled () const
bool shouldFormat (const FileLocations::Tree &fLoc, FileLocationRegion region)
void maybeWriteDisabledRegion (const SourceLocation &loc)
void scanFormatDirectives (QStringView code, const QList< SourceLocation > &comments)
void writeDisabledRegion (const SourceLocation &loc)
QStringView attachedDisableCode (quint32 offset) const

Public Attributes

int indent = 0
bool indentNextlines = false
bool skipComments = false
LineWriter & lineWriter
QString writtenStr
QStack< RegionToCommentMap > pendingComments
QStringView code
bool isFormatterEnabled = true
OffsetToDisabledRegionMap formatDisabledRegions

Detailed Description

Definition at line 31 of file qqmldomoutwriter_p.h.

Member Typedef Documentation

◆ OffsetToDisabledRegionMap

using QQmlJS::Dom::OutWriter::OffsetToDisabledRegionMap = QMap<quint32, SourceLocation>

Definition at line 45 of file qqmldomoutwriter_p.h.

◆ RegionToCommentMap

using QQmlJS::Dom::OutWriter::RegionToCommentMap = QMap<FileLocationRegion, CommentedElement>

Definition at line 40 of file qqmldomoutwriter_p.h.

Constructor & Destructor Documentation

◆ OutWriter() [1/2]

QQmlJS::Dom::OutWriter::OutWriter ( LineWriter & lw)
inlineexplicit

Definition at line 48 of file qqmldomoutwriter_p.h.

◆ OutWriter() [2/2]

QQmlJS::Dom::OutWriter::OutWriter ( std::shared_ptr< ExternalOwningItem > ownerFile,
LineWriter & lw )
inline

Definition at line 59 of file qqmldomoutwriter_p.h.

Member Function Documentation

◆ addNewlinesAutospacerCallback()

int QQmlJS::Dom::OutWriter::addNewlinesAutospacerCallback ( int nLines)
inline

Definition at line 146 of file qqmldomoutwriter_p.h.

◆ addTextAddCallback()

int QQmlJS::Dom::OutWriter::addTextAddCallback ( std::function< bool(LineWriter &, LineWriter::TextAddType)> callback)
inline

Definition at line 150 of file qqmldomoutwriter_p.h.

◆ attachedDisableCode()

QStringView QQmlJS::Dom::OutWriter::attachedDisableCode ( quint32 offset) const

Definition at line 77 of file qqmldomoutwriter.cpp.

◆ counter()

quint32 QQmlJS::Dom::OutWriter::counter ( ) const
inline

Definition at line 97 of file qqmldomoutwriter_p.h.

◆ decreaseIndent()

int QQmlJS::Dom::OutWriter::decreaseIndent ( int level = 1,
int expectedIndent = -1 )
inline

Definition at line 85 of file qqmldomoutwriter_p.h.

◆ ensureNewline()

OutWriter & QQmlJS::Dom::OutWriter::ensureNewline ( int nNewlines = 1)
inline

Definition at line 100 of file qqmldomoutwriter_p.h.

◆ ensureSpace() [1/2]

OutWriter & QQmlJS::Dom::OutWriter::ensureSpace ( )
inline

Definition at line 107 of file qqmldomoutwriter_p.h.

◆ ensureSpace() [2/2]

OutWriter & QQmlJS::Dom::OutWriter::ensureSpace ( QStringView space)
inline

Definition at line 114 of file qqmldomoutwriter_p.h.

◆ eof()

void QQmlJS::Dom::OutWriter::eof ( bool ensureNewline = true)
inline

Definition at line 140 of file qqmldomoutwriter_p.h.

◆ flush()

void QQmlJS::Dom::OutWriter::flush ( )
inline

Definition at line 134 of file qqmldomoutwriter_p.h.

Referenced by testing.tools.encode_pdf_filter._SinkPdfStream::close().

Here is the caller graph for this function:

◆ formatterEnabled()

bool QQmlJS::Dom::OutWriter::formatterEnabled ( ) const

Definition at line 134 of file qqmldomoutwriter.cpp.

◆ increaseIndent()

int QQmlJS::Dom::OutWriter::increaseIndent ( int level = 1)
inline

Definition at line 79 of file qqmldomoutwriter_p.h.

◆ itemEnd()

void QQmlJS::Dom::OutWriter::itemEnd ( )

Definition at line 176 of file qqmldomoutwriter.cpp.

◆ itemStart()

void QQmlJS::Dom::OutWriter::itemStart ( const DomItem & it)

Definition at line 167 of file qqmldomoutwriter.cpp.

◆ maybeWriteComment()

void QQmlJS::Dom::OutWriter::maybeWriteComment ( const Comment & comment)

Definition at line 151 of file qqmldomoutwriter.cpp.

◆ maybeWriteDisabledRegion()

void QQmlJS::Dom::OutWriter::maybeWriteDisabledRegion ( const SourceLocation & loc)

Definition at line 90 of file qqmldomoutwriter.cpp.

◆ newline()

OutWriter & QQmlJS::Dom::OutWriter::newline ( )
inline

Definition at line 121 of file qqmldomoutwriter_p.h.

◆ removeTextAddCallback()

bool QQmlJS::Dom::OutWriter::removeTextAddCallback ( int i)
inline

Definition at line 154 of file qqmldomoutwriter_p.h.

◆ scanFormatDirectives()

void QQmlJS::Dom::OutWriter::scanFormatDirectives ( QStringView code,
const QList< SourceLocation > & comments )

Definition at line 121 of file qqmldomoutwriter.cpp.

◆ shouldFormat()

bool QQmlJS::Dom::OutWriter::shouldFormat ( const FileLocations::Tree & fLoc,
FileLocationRegion region )

Definition at line 109 of file qqmldomoutwriter.cpp.

◆ write()

OutWriter & QQmlJS::Dom::OutWriter::write ( QStringView v,
LineWriter::TextAddType t = LineWriter::TextAddType::Normal )
inline

Definition at line 128 of file qqmldomoutwriter_p.h.

◆ writeDisabledRegion()

void QQmlJS::Dom::OutWriter::writeDisabledRegion ( const SourceLocation & loc)

Definition at line 139 of file qqmldomoutwriter.cpp.

◆ writePostComment()

void QQmlJS::Dom::OutWriter::writePostComment ( FileLocationRegion regino)

Definition at line 199 of file qqmldomoutwriter.cpp.

◆ writePreComment()

void QQmlJS::Dom::OutWriter::writePreComment ( FileLocationRegion region)

Definition at line 186 of file qqmldomoutwriter.cpp.

◆ writeRegion() [1/2]

OutWriter & QQmlJS::Dom::OutWriter::writeRegion ( const FileLocations::Tree & fLoc,
FileLocationRegion region )

Helper method for writeRegion(FileLocationRegion region) that allows to use {writeRegion(ColonTokenRegion);} instead of having to write out the more error-prone {writeRegion(ColonTokenRegion, ":");} for tokens and keywords.

Definition at line 245 of file qqmldomoutwriter.cpp.

◆ writeRegion() [2/2]

OutWriter & QQmlJS::Dom::OutWriter::writeRegion ( const FileLocations::Tree & fLoc,
FileLocationRegion region,
QStringView toWrite )

Definition at line 415 of file qqmldomoutwriter.cpp.

Member Data Documentation

◆ code

QStringView QQmlJS::Dom::OutWriter::code

Definition at line 42 of file qqmldomoutwriter_p.h.

◆ formatDisabledRegions

OffsetToDisabledRegionMap QQmlJS::Dom::OutWriter::formatDisabledRegions

Definition at line 46 of file qqmldomoutwriter_p.h.

◆ indent

int QQmlJS::Dom::OutWriter::indent = 0

Definition at line 34 of file qqmldomoutwriter_p.h.

◆ indentNextlines

bool QQmlJS::Dom::OutWriter::indentNextlines = false

Definition at line 35 of file qqmldomoutwriter_p.h.

◆ isFormatterEnabled

bool QQmlJS::Dom::OutWriter::isFormatterEnabled = true

Definition at line 43 of file qqmldomoutwriter_p.h.

◆ lineWriter

LineWriter& QQmlJS::Dom::OutWriter::lineWriter

Definition at line 38 of file qqmldomoutwriter_p.h.

◆ pendingComments

QStack<RegionToCommentMap> QQmlJS::Dom::OutWriter::pendingComments

Definition at line 41 of file qqmldomoutwriter_p.h.

◆ skipComments

bool QQmlJS::Dom::OutWriter::skipComments = false

Definition at line 37 of file qqmldomoutwriter_p.h.

◆ writtenStr

QString QQmlJS::Dom::OutWriter::writtenStr

Definition at line 39 of file qqmldomoutwriter_p.h.

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