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"

#define SIP_NO_FILE

#include <QMutex>
#include <QElapsedTimer>
#include <QString>
#include <QVector>


//
//  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() );

    class ScopedEvent
    {
      public:
        ScopedEvent( const QString &category, const QString &name ): mCat( category ), mName( name ) { addEvent( Begin, mCat, mName ); }
        ~ScopedEvent() { addEvent( End, mCat, mName ); }
      private:
        QString mCat, mName;
    };

};


#endif // QGSEVENTTRACING_H