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 #include "ardour/libardour_visibility.h"
  26
  27 namespace ARDOUR {
  28
  29 /** A class to handle reporting of progress of something */
  30 class LIBARDOUR_API Progress
  31 {
  32 public:
  33         Progress ();
  34         virtual ~Progress () {}
  35         void set_progress (float);
  36
  37         void ascend ();
  38         void descend (float);
  39
  40         bool cancelled () const;
  41
  42 protected:
  43         void cancel ();
  44
  45 private:
  46         /** Report overall progress.
  47          *  @param p Current progress (from 0 to 1)
  48          */
  49         virtual void set_overall_progress (float p) = 0;
  50
  51         struct Level {
  52                 Level (float a) : allocation (a), normalised (0) {}
  53
  54                 float allocation;
  55                 float normalised;
  56         };
  57
  58         std::list<Level> _stack;
  59         bool _cancelled;
  60 };
  61
  62 }
  63
  64 #endif