git.zerfleddert.de Git - fnordlicht-mini/blob - firmware/common/pt/lc.h

   1 /*
   2  * Copyright (c) 2004-2005, Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. Neither the name of the Institute nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * Author: Adam Dunkels <adam@sics.se>
  30  *
  31  * $Id: lc.h,v 1.2 2005/02/24 10:36:59 adam Exp $
  32  */
  33
  34 /**
  35  * \addtogroup pt
  36  * @{
  37  */
  38
  39 /**
  40  * \defgroup lc Local continuations
  41  * @{
  42  *
  43  * Local continuations form the basis for implementing protothreads. A
  44  * local continuation can be <i>set</i> in a specific function to
  45  * capture the state of the function. After a local continuation has
  46  * been set can be <i>resumed</i> in order to restore the state of the
  47  * function at the point where the local continuation was set.
  48  *
  49  *
  50  */
  51
  52 /**
  53  * \file lc.h
  54  * Local continuations
  55  * \author
  56  * Adam Dunkels <adam@sics.se>
  57  *
  58  */
  59
  60 #ifdef DOXYGEN
  61 /**
  62  * Initialize a local continuation.
  63  *
  64  * This operation initializes the local continuation, thereby
  65  * unsetting any previously set continuation state.
  66  *
  67  * \hideinitializer
  68  */
  69 #define LC_INIT(lc)
  70
  71 /**
  72  * Set a local continuation.
  73  *
  74  * The set operation saves the state of the function at the point
  75  * where the operation is executed. As far as the set operation is
  76  * concerned, the state of the function does <b>not</b> include the
  77  * call-stack or local (automatic) variables, but only the program
  78  * counter and such CPU registers that needs to be saved.
  79  *
  80  * \hideinitializer
  81  */
  82 #define LC_SET(lc)
  83
  84 /**
  85  * Resume a local continuation.
  86  *
  87  * The resume operation resumes a previously set local continuation, thus
  88  * restoring the state in which the function was when the local
  89  * continuation was set. If the local continuation has not been
  90  * previously set, the resume operation does nothing.
  91  *
  92  * \hideinitializer
  93  */
  94 #define LC_RESUME(lc)
  95
  96 /**
  97  * Mark the end of local continuation usage.
  98  *
  99  * The end operation signifies that local continuations should not be
 100  * used any more in the function. This operation is not needed for
 101  * most implementations of local continuation, but is required by a
 102  * few implementations.
 103  *
 104  * \hideinitializer
 105  */
 106 #define LC_END(lc)
 107
 108 /**
 109  * \var typedef lc_t;
 110  *
 111  * The local continuation type.
 112  *
 113  * \hideinitializer
 114  */
 115 #endif /* DOXYGEN */
 116
 117 #ifndef __LC_H__
 118 #define __LC_H__
 119
 120
 121 #ifdef LC_INCLUDE
 122 #include LC_INCLUDE
 123 #else
 124 #include "lc-switch.h"
 125 #endif /* LC_INCLUDE */
 126
 127 #endif /* __LC_H__ */
 128
 129 /** @} */
 130 /** @} */