qgseventtracing.h

Go to the documentation of this file.

/***************************************************************************
  qgseventtracing.h
  --------------------------------------
  Date                 : October 2019
  Copyright            : (C) 2019 by Martin Dobias
  Email                : wonder dot sk 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 QGSEVENTTRACING_H
#define QGSEVENTTRACING_H
 
#include "qgis_core.h"
 
#include <QElapsedTimer>
#include <QMutex>
#include <QString>
#include <QVector>
 
#define SIP_NO_FILE

 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//

class CORE_EXPORT QgsEventTracing
{
  public:
    enum EventType
    {
      Begin,      
      End,        
      Instant,    
      AsyncBegin, 
      AsyncEnd,   
    };

    static bool startTracing();

    static bool stopTracing();

    static bool isTracingEnabled();

    static bool writeTrace( const QString &fileName );

    static void addEvent( EventType type, const QString &category, const QString &name, const QString &id = QString() );

    static void addEventToQgisTrace( EventType type, const QString &category, const QString &name, const QString &id = QString() );

    static void setFloatVariable( const char *name, double value, bool continuous = false );

    static void setIntVariable( const char *name, int64_t value, bool continuous = false );
};

class CORE_EXPORT QgsScopedEvent
{
  public:
    QgsScopedEvent( const QString &category, const QString &name )
      : mCat( category )
      , mName( name )
      , mId( QString::number( sNextId++ ) )
    {
      QgsEventTracing::addEvent( QgsEventTracing::Begin, mCat, mName, mId );
    }
    ~QgsScopedEvent() { QgsEventTracing::addEvent( QgsEventTracing::End, mCat, mName, mId ); }
 
  private:
    QString mCat, mName, mId;
    static size_t sNextId;
};
 

 
#endif // QGSEVENTTRACING_H