diff --git a/gtk2_ardour/progress_reporter.cc b/gtk2_ardour/progress_reporter.cc new file mode 100644 index 0000000000..30093ddc99 --- /dev/null +++ b/gtk2_ardour/progress_reporter.cc @@ -0,0 +1,44 @@ +/* + Copyright (C) 2010 Paul Davis + + 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. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + +#include +#include +#include "progress_reporter.h" + +ProgressReporter::ProgressReporter () +{ + +} + +ProgressReporter::~ProgressReporter () +{ + +} + +void +ProgressReporter::set_overall_progress (float p) +{ + update_progress_gui (p); + + /* Make sure the progress widget gets updated */ + while (Glib::MainContext::get_default()->iteration (false)) { + /* do nothing */ + } +} + diff --git a/gtk2_ardour/progress_reporter.h b/gtk2_ardour/progress_reporter.h new file mode 100644 index 0000000000..6426f8f1aa --- /dev/null +++ b/gtk2_ardour/progress_reporter.h @@ -0,0 +1,36 @@ +/* + Copyright (C) 2010 Paul Davis + + 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. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + +#include "ardour/progress.h" + +/** A parent class for classes which can report progress on something */ +class ProgressReporter : public ARDOUR::Progress +{ +public: + ProgressReporter (); + virtual ~ProgressReporter (); + +private: + void set_overall_progress (float); + + /** Update our GUI to reflect progress. + * @param p Progress, from 0 to 1. + */ + virtual void update_progress_gui (float p) = 0; +}; diff --git a/libs/ardour/ardour/progress.h b/libs/ardour/ardour/progress.h new file mode 100644 index 0000000000..891af22059 --- /dev/null +++ b/libs/ardour/ardour/progress.h @@ -0,0 +1,51 @@ +/* + Copyright (C) 2010 Paul Davis + + 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. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + +#include + +namespace ARDOUR { + +/** A class to handle reporting of progress of something */ +class Progress +{ +public: + Progress (); + virtual ~Progress () {} + void set_progress (float); + + void ascend (); + void descend (float); + +private: + /** Report overall progress. + * @param p Current progress (from 0 to 1) + */ + virtual void set_overall_progress (float p) = 0; + + struct Level { + Level (float a) : allocation (a), normalised (0) {} + + float allocation; + float normalised; + }; + + std::list _stack; +}; + +} diff --git a/libs/ardour/progress.cc b/libs/ardour/progress.cc new file mode 100644 index 0000000000..0679ce8a13 --- /dev/null +++ b/libs/ardour/progress.cc @@ -0,0 +1,70 @@ +/* + Copyright (C) 2010 Paul Davis + + 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. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +*/ + +#include +#include +#include "ardour/progress.h" + +using namespace std; + +ARDOUR::Progress::Progress () +{ + descend (1); +} + +/** Descend down one level in terms of progress reporting; e.g. if + * there is a task which is split up into N subtasks, each of which + * report their progress from 0 to 100%, call descend() before executing + * each subtask, and ascend() afterwards to ensure that overall progress + * is reported correctly. + * + * @param p Percentage (from 0 to 1) of the current task to allocate to the subtask. + */ +void +ARDOUR::Progress::descend (float a) +{ + _stack.push_back (Level (a)); +} + +void +ARDOUR::Progress::ascend () +{ + assert (!_stack.empty ()); + _stack.pop_back (); +} + +/** Set the progress of the current task. + * @param p Progress (from 0 to 1) + */ +void +ARDOUR::Progress::set_progress (float p) +{ + assert (!_stack.empty ()); + + _stack.back().normalised = p; + + float overall = 0; + float factor = 1; + for (list::iterator i = _stack.begin(); i != _stack.end(); ++i) { + factor *= i->allocation; + overall += i->normalised * factor; + } + + set_overall_progress (overall); +}