qgsruntimeprofiler.h

Go to the documentation of this file.

/***************************************************************************
    qgsruntimeprofiler.h
    ---------------------
    begin                : June 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                : woodrow dot nathan at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRUNTIMEPROFILER_H
#define QGSRUNTIMEPROFILER_H
 
#include <deque>
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QAbstractItemModel>
#include <QElapsedTimer>
#include <QList>
#include <QPair>
#include <QSet>
#include <QStack>
#include <QTime>
 
#ifndef SIP_RUN

class CORE_EXPORT QgsRuntimeProfilerNode
{
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsRuntimeProfilerNode, Roles ) : int
    {
      Name = Qt::UserRole + 1, 
      Group,                   
      Elapsed,                 
      ParentElapsed,           
      Id,                      
    };
    // *INDENT-ON*

    QgsRuntimeProfilerNode( const QString &group, const QString &name, const QString &id = QString() );
 
    QgsRuntimeProfilerNode( const QgsRuntimeProfilerNode &other ) = delete;
    QgsRuntimeProfilerNode &operator=( const QgsRuntimeProfilerNode &other ) = delete;
 
    ~QgsRuntimeProfilerNode();

    QgsRuntimeProfilerNode *parent() { return mParent; }

    QStringList fullParentPath() const;

    QVariant data( int role = Qt::DisplayRole ) const;

    int childCount() const { return mChildren.size(); }

    void addChild( std::unique_ptr< QgsRuntimeProfilerNode > child );

    int indexOf( QgsRuntimeProfilerNode *child ) const;

    QgsRuntimeProfilerNode *child( const QString &group, const QString &name, const QString &id = QString() );

    QgsRuntimeProfilerNode *childAt( int index );

    void clear();

    void removeChildAt( int index );

    void start();

    void stop();

    void setElapsed( double time );

    double elapsed() const;

    double totalElapsedTimeForChildren( const QString &group ) const;
 
  private:
    std::deque< std::unique_ptr< QgsRuntimeProfilerNode > > mChildren;
    QgsRuntimeProfilerNode *mParent = nullptr;
    QElapsedTimer mProfileTime;
    double mElapsed = 0;
 
    QString mId;
    QString mName;
    QString mGroup;
};
#endif

class CORE_EXPORT QgsRuntimeProfiler : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    QgsRuntimeProfiler();
    ~QgsRuntimeProfiler() override;

    Q_DECL_DEPRECATED void beginGroup( const QString &name ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void endGroup() SIP_DEPRECATED;

    QStringList childGroups( const QString &parent = QString(), const QString &group = "startup" ) const;

    void start( const QString &name, const QString &group = "startup", const QString &id = QString() );

    void end( const QString &group = "startup" );

    void record( const QString &name, double time, const QString &group = "startup", const QString &id = QString() );

    double profileTime( const QString &name, const QString &group = "startup" ) const;

    void clear( const QString &group = "startup" );

    double totalTime( const QString &group = "startup" );

    QSet< QString > groups() const { return mGroups; }

    bool groupIsActive( const QString &group ) const;

    static QString translateGroupName( const QString &group );
 
    // Implementation of virtual functions from QAbstractItemModel
 
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role = Qt::DisplayRole ) const override;

    QString asText( const QString &group = QString() );
 
#ifndef SIP_RUN
  signals:
 
    void started( const QString &group, const QStringList &path, const QString &name, const QString &id );
    void ended( const QString &group, const QStringList &path, const QString &name, const QString &id, double elapsed );
#endif

    void groupAdded( const QString &group );
 
  private slots:
 
    void otherProfilerStarted( const QString &group, const QStringList &path, const QString &name, const QString &id );
    void otherProfilerEnded( const QString &group, const QStringList &path, const QString &name, const QString &id, double elapsed );
 
  private:
    static QgsRuntimeProfiler *threadLocalInstance();
    static QgsRuntimeProfiler *sMainProfiler;
    bool mInitialized = false;
    void setupConnections();
 
    QgsRuntimeProfilerNode *pathToNode( const QString &group, const QString &path ) const;
    QgsRuntimeProfilerNode *pathToNode( const QString &group, const QStringList &path ) const;
    QModelIndex node2index( QgsRuntimeProfilerNode *node ) const;
    QModelIndex indexOfParentNode( QgsRuntimeProfilerNode *parentNode ) const;
    void extractModelAsText( QStringList &lines, const QString &group, const QModelIndex &parent = QModelIndex(), int level = 0 );

    QgsRuntimeProfilerNode *index2node( const QModelIndex &index ) const;
 
    QMap< QString, QStack< QgsRuntimeProfilerNode * > > mCurrentStack;
    std::unique_ptr< QgsRuntimeProfilerNode > mRootNode;
 
    QSet< QString > mGroups;
 
    friend class QgsApplication;
};
 

class CORE_EXPORT QgsScopedRuntimeProfile
{
  public:
    QgsScopedRuntimeProfile( const QString &name, const QString &group = "startup", const QString &id = QString() );

    ~QgsScopedRuntimeProfile();

    void switchTask( const QString &name ); // cppcheck-suppress functionConst
 
  private:
    QString mGroup;
};
 
 
#endif // QGSRUNTIMEPROFILER_H