compiler/posixc/siglongjmp.c

   1 /*
   2     Copyright © 2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: POSIX.1-2008 function siglongjmp()
   6     Lang: english
   7 */
   8
   9 /******************************************************************************
  10
  11     NAME
  12 #include <setjmp.h>
  13
  14         void siglongjmp (jmp_buf env, int val);
  15
  16     FUNCTION
  17         Save the current context so that you can return to it later.
  18
  19     INPUTS
  20         env - The context/environment to restore
  21         val - This value is returned by setjmp() when you return to the
  22                 saved context. You cannot return 0. If val is 0, then
  23                 setjmp() returns with 1.
  24
  25     RESULT
  26         This function doesn't return.
  27
  28     NOTES
  29
  30     EXAMPLE
  31         jmp_buf env;
  32
  33         ... some code ...
  34
  35         if (!setjmp (env))
  36         {
  37             ... this code is executed after setjmp() returns ...
  38
  39             // This is no good example on how to use this function
  40             // You should not do that
  41             if (error)
  42                 siglongjmp (env, 5);
  43
  44             ... some code ...
  45         }
  46         else
  47         {
  48             ... this code is executed if you call siglongjmp(env) ...
  49         }
  50
  51     BUGS
  52
  53     SEE ALSO
  54         setjmp()
  55
  56     INTERNALS
  57
  58 ******************************************************************************/
  59
  60 #error siglongjmp has to be implemented for each cpu