## Copyright (C) 2005 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 2, 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, write to the Free
## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
## 02110-1301, USA.

## -*- texinfo -*-
## @deftypefn {Function File} {} __uiobject_free__ (@var{h})
## Clear the contents of the element of the @code{__uiobject_list__}
## corresponding to the handle @var{h} and return the element to the
## free list.
## @end deftypefn

## Author: jwe

function __uiobject_free__ (h)

  __uiobject_globals__;

  if (nargin == 1)
    idx = __uiobject_handle2idx__ (h);
    if (! isempty (idx))
      if (! isempty (__uiobject_list__) && __uiobject_list__(idx).in_use)
	h = __uiobject_list__(idx).handle;
	__uiobject_handles__ = complement (h, __uiobject_handles__);
	__uiobject_list__(idx).next = __uiobject_head__;
	__uiobject_list__(idx).in_use = false;
	__uiobject_list__(idx).handle = NaN;
	__uiobject_list__(idx).object = NaN;
	__uiobject_head__ = idx;
	if (h < 0)
	  __uiobject_handles_free_list__(end+1) = h;
        elseif (h > 0)
          __uiobject_figure_handles_free_list__(end+1) = h;
        endif
      else
	error ("__uiobject_free__: attempt to free unallocated element");
      endif
    endif
  else
    print_usage ();
  endif
endfunction