File indexing completed on 2024-04-28 05:41:26

 /*
     This file is part of KCachegrind.
 
     SPDX-FileCopyrightText: 2002-2016 Josef Weidendorfer <Josef.Weidendorfer@gmx.de>
 
     SPDX-License-Identifier: GPL-2.0-only
 */
 
 /*
  * Base class for loaders of profiling data.
  */
 
 #ifndef LOADER_H
 #define LOADER_H
 
 #include <QList>
 #include <QString>
 
 class QIODevice;
 class TraceData;
 class Loader;
 class Logger;
 
 /**
  * To implement a new loader, inherit from the Loader class and
  * and reimplement canLoad() and load().
  *
  * For registration, put into the static initLoaders() function
  * of this base class a _loaderList.append(new MyLoader()).
  *
  * matchingLoader() returns the first loader able to load a file.
  *
  * To show progress and warnings while loading,
  *   loadStatus(), loadError() and loadWarning() should be called.
  * These are just shown as status, warnings or errors to the
  * user, but do not show real failure, as even errors can be
  * recoverable. For inability to load a file, return 0 in
  * load().
  */
 
 class Loader
 {
 public:
     Loader(const QString& name, const QString& desc);
     virtual ~Loader();
 
     // reimplement for a specific Loader
     virtual bool canLoad(QIODevice* file);
     /* load a profile data file.
      * for every section (time span covered by profile), create a TracePart
      * return the number of sections loaded (0 on error)
      */
     virtual int load(TraceData*, QIODevice* file, const QString& filename);
 
     static Loader* matchingLoader(QIODevice* file);
     static Loader* loader(const QString& name);
     static void initLoaders();
     static void deleteLoaders();
 
     QString name() const { return _name; }
     QString description() const { return _description; }
 
     // consumer for notifications
     void setLogger(Logger*);
 
 protected:
     // notifications for the user
     void loadStart(const QString& filename);
     void loadProgress(int progress); // 0 - 100
     void loadError(int line, const QString& msg);
     void loadWarning(int line, const QString& msg);
     void loadFinished(const QString &msg = QString());
 
 protected:
     Logger* _logger;
 
 private:
     QString _name, _description;
 
     static QList<Loader*> _loaderList;
 };
 
 
 #endif