octave_packages/m/startup/__finish__.m

   1 ## Copyright (C) 2008-2012 Ben Abbott
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} __finish__ ()
  21 ## Undocumented internal function.
  22 ## @end deftypefn
  23
  24 ## Check for the existence of the function/script, @file{finish}, in the
  25 ## path or current working directory and execute it.  This function is
  26 ## intended to be excecuted upon a clean exit form Octave.  This is
  27 ## accomplished in the system script @file{startup/octaverc} by use of
  28 ## the built-in function @code{onexit}.
  29
  30 function __finish__ ()
  31
  32   if (exist ("finish", "file"))
  33     ## No arg list here since finish might be a script.
  34     finish;
  35   endif
  36
  37 endfunction
  38
  39 ## No test needed for internal helper function.
  40 %!assert (1)