## Copyright (C) 2011 John W. Eaton
##
## This file is part of Octave.
##
## Octave 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 3 of the License, or (at
## your option) any later version.
##
## Octave 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 Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {@var{h} =} waitbar (@var{frac})
## @deftypefnx {Function File} {@var{h} =} waitbar (@var{frac}, @var{msg})
## @deftypefnx {Function File} {@var{h} =} waitbar (@dots{}, "FigureProperty", "Value", @dots{})
## @deftypefnx {Function File} {} waitbar (@var{frac})
## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{msg})
## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar})
## @deftypefnx {Function File} {} waitbar (@var{frac}, @var{hwbar}, @var{msg})
## Return a handle @var{h} to a new waitbar object.  The waitbar is
## filled to fraction @var{frac} which must be in the range [0, 1].  The
## optional message @var{msg} is centered and displayed above the waitbar.
## The appearance of the waitbar figure window can be configured by passing 
## property/value pairs to the function.
## 
## If no output handle is requested, and there is an existing waitbar, then
## the current waitbar is updated with new @var{frac} and optional @var{msg}
## values.  If there are multiple outstanding waitbars they can be updated
## individually by passing the handle @var{hwbar} of the specific waitbar to
## modify.
## @end deftypefn

## Author: jwe

function retval = waitbar (varargin)

  persistent curr_waitbar;

  if (nargin < 1)
    print_usage ();
  endif

  frac = varargin{1};
  varargin(1) = [];

  if (! (isnumeric (frac) && isscalar (frac) && frac >= 0 && frac <= 1))
    error ("waitbar: FRAC must be between 0 and 1");
  endif

  ## Use existing waitbar if it still points to a valid graphics handle.
  if (nargin == 1 && ishandle (curr_waitbar))
    h = curr_waitbar;
  else
    h = false;
  endif

  if (! isempty (varargin) && isnumeric (varargin{1}))
    if (! ishandle (varargin{1}))
      error ("waitbar: H must be a handle to a waitbar object");
    else
      h = varargin{1};
      varargin(1) = [];
      if (! isfigure (h) || ! strcmp (get (h, "tag"), "waitbar"))
        error ("waitbar: H must be a handle to a waitbar object");
      endif
    endif
  endif

  msg = false;

  if (! isempty (varargin))
    msg = varargin{1};
    varargin(1) = [];
    if (! ischar (msg))
      error ("waitbar: MSG must be a character string");
    endif
  endif

  if (rem (numel (varargin), 2) != 0)
    error ("waitbar: invalid number of property-value pairs");
  endif

  if (h)
    p = findobj (h, "type", "patch");
    set (p, "xdata", [0; frac; frac; 0]);
    ax = findobj (h, "type", "axes");
    if (ischar (msg))
      th = get (ax, "title");
      curr_msg = get (th, "string");
      if (! strcmp (msg, curr_msg))
        set (th, "string", msg);
      endif
    endif
  else
    h = __go_figure__ (NaN, "position", [250, 500, 400, 100],
                       "numbertitle", "off",
                       "toolbar", "none", "menubar", "none",
                       "integerhandle", "off",
                       "handlevisibility", "callback",
                       "tag", "waitbar",
                       varargin{:});

    ax = axes ("parent", h, "xtick", [], "ytick", [],
               "xlim", [0, 1], "ylim", [0, 1],
               "xlimmode", "manual", "ylimmode", "manual",
               "position", [0.1, 0.3, 0.8, 0.2]);

    patch (ax, [0; frac; frac; 0], [0; 0; 1; 1], [0, 0.35, 0.75]);

    if (ischar (msg))
      title (ax, msg);
    endif
  endif

  drawnow ();

  if (nargout > 0)
    retval = h;
  endif

  ## If there were no errors, update current waitbar.
  curr_waitbar = h;

endfunction


%!demo
%! h = waitbar (0, "0.00%");
%! for i = 0:0.01:1
%!   waitbar (i, h, sprintf ("%.2f%%", 100*i));
%! endfor
%! close (h);

%!demo
%! h = waitbar (0, "please wait...");
%! for i = 0:0.01:0.6
%!   waitbar (i);
%! endfor
%! i = 0.3
%! waitbar (i, h, "don't you hate taking a step backward?")
%! pause (0.5)
%! for i = i:0.005:0.7
%!   waitbar (i, h);
%! endfor
%! waitbar (i, h, "or stalling?")
%! pause (1)
%! for i = i:0.003:0.8
%!   waitbar (i, h, "just a little longer now")
%! endfor
%! for i = i:0.001:1
%!   waitbar (i, h, "please don't be impatient")
%! endfor
%! close (h);

%!demo
%! h1 = waitbar (0, "Waitbar #1");
%! h2 = waitbar (0, "Waitbar #2");
%! h2pos = get (h2, "position");
%! h2pos(1) += h2pos(3) + 50;
%! set (h2, "position", h2pos);
%! pause (0.5)
%! for i = 1:4
%!   waitbar (i/4, h1);
%!   pause (0.5);
%!   waitbar (i/4, h2);
%!   pause (0.5);
%! endfor
%! pause (0.5)
%! close (h1);
%! close (h2);

%% Test input validation
%!error <FRAC must be between 0 and 1> waitbar (-0.5)
%!error <FRAC must be between 0 and 1> waitbar (1.5)
%!error <MSG must be a character string> waitbar (0.5, struct ())
%!error <invalid number of property-value pairs> waitbar (0.5, "msg", "Name")

