#include <qcoloringmessagehandler_p.h>

Inheritance diagram for QPatternist::ColoringMessageHandler:

Public Functions
	ColoringMessageHandler (QObject *parent=0)

Public Functions inherited from QAbstractMessageHandler
void	message (QtMsgType type, const QString &description, const QUrl &identifier=QUrl(), const QSourceLocation &sourceLocation=QSourceLocation())
	Sends a message to this message handler. More...

	QAbstractMessageHandler (QObject *parent=0)
	Constructs a QAbstractMessageHandler. More...

virtual	~QAbstractMessageHandler ()
	Destructs this QAbstractMessageHandler. More...

Public Functions inherited from QObject
bool	blockSignals (bool b)
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...

const QObjectList &	children () const
	Returns a list of child objects. More...

bool	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=0, const QObject receiver=0, const char *member=0)

bool	disconnect (const QObject receiver, const char member=0)

void	dumpObjectInfo ()
	Dumps information about signal connections, etc. More...

void	dumpObjectTree ()
	Dumps a tree of children to the debug output. More...

QList< QByteArray >	dynamicPropertyNames () const
	Returns the names of all properties that were dynamically added to the object using setProperty(). More...

virtual bool	event (QEvent *)
	This virtual function receives events to an object and should return true if the event e was recognized and processed. More...

virtual bool	eventFilter (QObject , QEvent )
	Filters events if this object has been installed as an event filter for the watched object. More...

template<typename T >
T	findChild (const QString &aName=QString()) const
	Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...

template<typename T >
QList< T >	findChildren (const QString &aName=QString()) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...

template<typename T >
QList< T >	findChildren (const QRegExp &re) const

bool	inherits (const char *classname) const
	Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...

void	installEventFilter (QObject *)
	Installs an event filter filterObj on this object. More...

bool	isWidgetType () const
	Returns true if the object is a widget; otherwise returns false. More...

void	killTimer (int id)
	Kills the timer with timer identifier, id. More...

virtual const QMetaObject *	metaObject () const
	Returns a pointer to the meta-object of this object. More...

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children. More...

QString	objectName () const

QObject *	parent () const
	Returns a pointer to the parent object. More...

QVariant	property (const char *name) const
	Returns the value of the object's name property. More...

Q_INVOKABLE	QObject (QObject *parent=0)
	Constructs an object with parent object parent. More...

void	removeEventFilter (QObject *)
	Removes an event filter object obj from this object. More...

void	setObjectName (const QString &name)

void	setParent (QObject *)
	Makes the object a child of parent. More...

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value. More...

void	setUserData (uint id, QObjectUserData *data)

bool	signalsBlocked () const
	Returns true if signals are blocked; otherwise returns false. More...

int	startTimer (int interval)
	Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...

QThread *	thread () const
	Returns the thread in which the object lives. More...

QObjectUserData *	userData (uint id) const

virtual	~QObject ()
	Destroys the object, deleting all its child objects. More...

Protected Functions
virtual void	handleMessage (QtMsgType type, const QString &description, const QUrl &identifier, const QSourceLocation &sourceLocation)
	This function must be implemented by the sub-class. More...

Protected Functions inherited from QObject
virtual void	childEvent (QChildEvent *)
	This event handler can be reimplemented in a subclass to receive child events. More...

virtual void	connectNotify (const char *signal)
	This virtual function is called when something has been connected to signal in this object. More...

virtual void	customEvent (QEvent *)
	This event handler can be reimplemented in a subclass to receive custom events. More...

virtual void	disconnectNotify (const char *signal)
	This virtual function is called when something has been disconnected from signal in this object. More...

	QObject (QObjectPrivate &dd, QObject *parent=0)

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal. More...

QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *)
	This event handler can be reimplemented in a subclass to receive timer events for the object. More...

Private Types
enum	ColorType { RunningText, Location, ErrorCode, Keyword, Data }

Private Types inherited from QPatternist::ColorOutput
typedef QFlags< ColorCodeComponent >	ColorCode

enum	ColorCodeComponent { BlackForeground = 1 << ForegroundShift, BlueForeground = 2 << ForegroundShift, GreenForeground = 3 << ForegroundShift, CyanForeground = 4 << ForegroundShift, RedForeground = 5 << ForegroundShift, PurpleForeground = 6 << ForegroundShift, BrownForeground = 7 << ForegroundShift, LightGrayForeground = 8 << ForegroundShift, DarkGrayForeground = 9 << ForegroundShift, LightBlueForeground = 10 << ForegroundShift, LightGreenForeground = 11 << ForegroundShift, LightCyanForeground = 12 << ForegroundShift, LightRedForeground = 13 << ForegroundShift, LightPurpleForeground = 14 << ForegroundShift, YellowForeground = 15 << ForegroundShift, WhiteForeground = 16 << ForegroundShift, BlackBackground = 1 << BackgroundShift, BlueBackground = 2 << BackgroundShift, GreenBackground = 3 << BackgroundShift, CyanBackground = 4 << BackgroundShift, RedBackground = 5 << BackgroundShift, PurpleBackground = 6 << BackgroundShift, BrownBackground = 7 << BackgroundShift, DefaultColor = 1 << SpecialShift }

typedef QHash< int, ColorCode >	ColorMapping

Private Functions
QString	colorifyDescription (const QString &in) const

Private Functions inherited from QPatternist::ColorOutput
QString	colorify (const QString &message, int color=-1) const
	Treats message and colorID identically to write(), but instead of writing message to `stderr`, it is prepared for being written to `stderr`, but is then returned. More...

ColorMapping	colorMapping () const
	Returns the color mappings in use. More...

	ColorOutput ()
	Constructs a ColorOutput instance, ready for use. More...

void	insertMapping (int colorID, const ColorCode colorCode)
	Adds a color mapping from colorID to colorCode, for this ColorOutput instance. More...

void	setColorMapping (const ColorMapping &cMapping)
	Sets the color mapping to be cMapping. More...

void	write (const QString &message, int color=-1)
	Sends message to `stderr`, using the color looked up in colorMapping() using colorID. More...

void	writeUncolored (const QString &message)
	Writes message to `stderr` as if for instance QTextStream would have been used, and adds a line ending at the end. More...

	~ColorOutput ()
	Destructs this ColorOutput instance. More...

Properties
QHash< QString, ColorType >	m_classToColor

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	Schedules this object for deletion. More...

Signals inherited from QObject
void	destroyed (QObject *=0)
	This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...

Static Public Functions inherited from QObject
static bool	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...

static bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	Disconnects signal in object sender from method in object receiver. More...

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static uint	registerUserData ()

static QString	tr (const char sourceText, const char comment=0, int n=-1)

static QString	trUtf8 (const char sourceText, const char comment=0, int n=-1)

Static Public Variables inherited from QObject
static const QMetaObject	staticMetaObject
	This variable stores the meta-object for the class. More...

Protected Variables inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Static Protected Variables inherited from QObject
static const QMetaObject	staticQtMetaObject

Related Functions inherited from QObject
T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QRegExp &regExp)()

T *	qobject_cast (QObject *object)

	QObjectList

void *	qt_find_obj_child (QObject parent, const char type, const QString &name)
	Returns a pointer to the object named name that inherits type and with a given parent. More...

Detailed Description

Definition at line 66 of file qcoloringmessagehandler_p.h.

Enumerations

◆ ColorType

enum QPatternist::ColoringMessageHandler::ColorType

private

Enumerator
RunningText
Location
ErrorCode
Keyword
Data

Definition at line 81 of file qcoloringmessagehandler_p.h.

         {
             RunningText,
             Location,
             ErrorCode,
             Keyword,
             Data
         };

Constructors and Destructors

◆ ColoringMessageHandler()

ColoringMessageHandler::ColoringMessageHandler ( QObject * parent = 0 )

Definition at line 51 of file qcoloringmessagehandler.cpp.

                                                               : QAbstractMessageHandler(parent)
 {
     m_classToColor.insert(QLatin1String("XQuery-data"), Data);
     m_classToColor.insert(QLatin1String("XQuery-expression"), Keyword);
     m_classToColor.insert(QLatin1String("XQuery-function"), Keyword);
     m_classToColor.insert(QLatin1String("XQuery-keyword"), Keyword);
     m_classToColor.insert(QLatin1String("XQuery-type"), Keyword);
     m_classToColor.insert(QLatin1String("XQuery-uri"), Data);
     m_classToColor.insert(QLatin1String("XQuery-filepath"), Data);
 
     /* If you're tuning the colors, take it easy laddie. Take into account:
      *
      * - Get over your own taste, there's others too on this planet
      * - Make sure it works well on black & white
      * - Make sure it works well on white & black
      */
     insertMapping(Location, CyanForeground);
     insertMapping(ErrorCode, RedForeground);
     insertMapping(Keyword, BlueForeground);
     insertMapping(Data, BlueForeground);
     insertMapping(RunningText, DefaultColor);
 }

Functions

◆ colorifyDescription()

QString ColoringMessageHandler::colorifyDescription ( const QString & in ) const

private

Definition at line 149 of file qcoloringmessagehandler.cpp.

Referenced by handleMessage().

 {
     QXmlStreamReader reader(in);
     QString result;
     result.reserve(in.size());
     ColorType currentColor = RunningText;
 
     while(!reader.atEnd())
     {
         reader.readNext();
 
         switch(reader.tokenType())
         {
             case QXmlStreamReader::StartElement:
             {
                 if(reader.name() == QLatin1String("span"))
                 {
                     Q_ASSERT(m_classToColor.contains(reader.attributes().value(QLatin1String("class")).toString()));
                     currentColor = m_classToColor.value(reader.attributes().value(QLatin1String("class")).toString());
                 }
 
                 continue;
             }
             case QXmlStreamReader::Characters:
             {
                 result.append(colorify(reader.text().toString(), currentColor));
                 continue;
             }
             case QXmlStreamReader::EndElement:
             {
                 currentColor = RunningText;
                 continue;
             }
             /* Fallthrough, */
             case QXmlStreamReader::StartDocument:
             /* Fallthrough, */
             case QXmlStreamReader::EndDocument:
                 continue;
             default:
                 Q_ASSERT_X(false, Q_FUNC_INFO,
                            "Unexpected node.");
         }
     }
 
     Q_ASSERT_X(!reader.hasError(), Q_FUNC_INFO,
                "The output from Patternist must be well-formed.");
     return result;
 }

◆ handleMessage()

void ColoringMessageHandler::handleMessage	(	QtMsgType	type,
		const QString &	description,
		const QUrl &	identifier,
		const QSourceLocation &	sourceLocation
	)

protectedvirtual

This function must be implemented by the sub-class.

message() will call this function, passing in its parameters, type, description, identifier and sourceLocation unmodified.

Implements QAbstractMessageHandler.

Definition at line 74 of file qcoloringmessagehandler.cpp.

 {
     const bool hasLine = sourceLocation.line() != -1;
 
     switch(type)
     {
         case QtWarningMsg:
         {
             if(hasLine)
             {
                 writeUncolored(QXmlPatternistCLI::tr("Warning in %1, at line %2, column %3: %4").arg(QString::fromLatin1(sourceLocation.uri().toEncoded()),
                                                                                                  QString::number(sourceLocation.line()),
                                                                                                  QString::number(sourceLocation.column()),
                                                                                                  colorifyDescription(description)));
             }
             else
             {
                 writeUncolored(QXmlPatternistCLI::tr("Warning in %1: %2").arg(QString::fromLatin1(sourceLocation.uri().toEncoded()),
                                                                           colorifyDescription(description)));
             }
 
             break;
         }
         case QtFatalMsg:
         {
             const QString errorCode(identifier.fragment());
             Q_ASSERT(!errorCode.isEmpty());
             QUrl uri(identifier);
             uri.setFragment(QString());
 
             QString location;
 
             if(sourceLocation.isNull())
                 location = QXmlPatternistCLI::tr("Unknown location");
             else
                 location = QString::fromLatin1(sourceLocation.uri().toEncoded());
 
             QString errorId;
             /* If it's a standard error code, we don't want to output the
              * whole URI. */
             if(uri.toString() == QLatin1String("http://www.w3.org/2005/xqt-errors"))
                 errorId = errorCode;
             else
                 errorId = QString::fromLatin1(identifier.toEncoded());
 
             if(hasLine)
             {
                 writeUncolored(QXmlPatternistCLI::tr("Error %1 in %2, at line %3, column %4: %5").arg(colorify(errorId, ErrorCode),
                                                                                                   colorify(location, Location),
                                                                                                   colorify(QString::number(sourceLocation.line()), Location),
                                                                                                   colorify(QString::number(sourceLocation.column()), Location),
                                                                                                   colorifyDescription(description)));
             }
             else
             {
                 writeUncolored(QXmlPatternistCLI::tr("Error %1 in %2: %3").arg(colorify(errorId, ErrorCode),
                                                                            colorify(location, Location),
                                                                            colorifyDescription(description)));
             }
             break;
         }
         case QtCriticalMsg:
         /* Fallthrough. */
         case QtDebugMsg:
         {
             Q_ASSERT_X(false, Q_FUNC_INFO,
                        "message() is not supposed to receive QtCriticalMsg or QtDebugMsg.");
             return;
         }
     }
 }

Properties

◆ m_classToColor

QHash<QString, ColorType> QPatternist::ColoringMessageHandler::m_classToColor

private

Definition at line 90 of file qcoloringmessagehandler_p.h.

Referenced by colorifyDescription(), and ColoringMessageHandler().

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

/src/xmlpatterns/api/qcoloringmessagehandler_p.h
/src/xmlpatterns/api/qcoloringmessagehandler.cpp

Public Functions

Protected Functions

Private Types

Private Functions

Properties

Additional Inherited Members

Detailed Description

Enumerations

◆ ColorType

Constructors and Destructors

◆ ColoringMessageHandler()

Functions

◆ colorifyDescription()

◆ handleMessage()

Properties

◆ m_classToColor