libs/ardour/ardour/progress.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_progress_h__
  21 #define __ardour_progress_h__
  22
  23 #include <list>
  24
  25 namespace ARDOUR {
  26
  27 /** A class to handle reporting of progress of something */
  28 class Progress
  29 {
  30 public:
  31         Progress ();
  32         virtual ~Progress () {}
  33         void set_progress (float);
  34
  35         void ascend ();
  36         void descend (float);
  37
  38         bool cancelled () const;
  39
  40 protected:
  41         void cancel ();
  42
  43 private:
  44         /** Report overall progress.
  45          *  @param p Current progress (from 0 to 1)
  46          */
  47         virtual void set_overall_progress (float p) = 0;
  48
  49         struct Level {
  50                 Level (float a) : allocation (a), normalised (0) {}
  51
  52                 float allocation;
  53                 float normalised;
  54         };
  55
  56         std::list<Level> _stack;
  57         bool _cancelled;
  58 };
  59
  60 }
  61
  62 #endif