Mercurial > octave

diff scripts/deprecated/usleep.m @ 20923:58263bea2fdf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Unified "sleep" functions to "octave_sleep" in C++ and "pause" in Octave. * doc/interpreter/system.txi: removed sleep and usleep from doc. * libinterp/corefcn/sysdep.cc (pause): updated docstring. * libinterp/corefcn/sysdep.cc (sleep): moved to deprecate sleep.m. * libinterp/corefcn/sysdep.cc (usleep): moved to deprecate usleep.m. * scripts/deprecated/sleep.m: moved here from sysdep.cc. * scripts/deprecated/usleep.m: moved here from sysdep.cc. * scripts/deprecated/module.mk: add sleep.m and usleep.m to build system. * NEWS: deprecation news for sleep and usleep. * libinterp/corefcn/data.cc: examples updated. * libinterp/corefcn/syscalls.cc: examples updated. * scripts/audio/@audioplayer/audioplayer.m: examples updated. * scripts/audio/@audiorecorder/audiorecorder.m: examples updated. * scripts/plot/util/ginput.m: examples updated. * scripts/plot/util/private/__gnuplot_get_var__.m: use pause. * scripts/plot/util/private/__gnuplot_ginput__.m: use pause. * libinterp/corefcn/utils.cc (octave_sleep): Unified "sleep" functions here. * libinterp/corefcn/utils.h: removed header cutils.h. * libinterp/corefcn/graphics.cc (drawnow): use octave_sleep. * libinterp/corefcn/graphics.cc (waitfor): use octave_sleep. * libinterp/corefcn/toplev.cc (clean_up_and_exit): use octave_sleep. * libinterp/corefcn/cutils.c: removed no longer needed code. * libinterp/corefcn/cutils.h: removed no longer needed header. * libinterp/corefcn/matherr.c: removed orphaned code. * libinterp/corefcn/module.mk: removed cutils.h, cutils.c, and matherr.c from build system.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Thu, 17 Dec 2015 16:04:13 +0100
parents
children 1da6c81e6486
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/deprecated/usleep.m	Thu Dec 17 16:04:13 2015 +0100
@@ -0,0 +1,52 @@
+## Copyright (C) 1993-2015 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 {} {} usleep (@var{microseconds})\n\
+##
+## @code{usleep} is deprecated and will be removed in Octave version 4.6.
+## Use @code{pause} instead.
+##
+## Suspend the execution of the program for the given number of
+## microseconds (1e-6 seconds).
+##
+## @seealso{pause}
+## @end deftypefn
+
+function [] = usleep (microseconds)
+
+  persistent warned = false;
+  if (! warned)
+    warned = true;
+    warning ("Octave:deprecated-function",
+             "usleep is obsolete and will be removed from a future version of Octave, please use pause instead");
+  endif
+
+  if (nargin == 1)
+    pause (microseconds / 1e6);
+  else
+    print_usage ();
+  endif
+
+endfunction
+
+%!test
+%! usleep (1000);
+
+%!error (usleep ())
+%!error (usleep (1, 2))