PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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  * This file is part of the protothreads library.
30  *
31  * Author: Adam Dunkels <adam@sics.se>
32  *
33  * $Id: lc.h,v 1.2 2005/02/24 10:36:59 adam Exp $
34  */
35 
36 /*
37  * \file lc.h
38  * Local continuations
39  * \author
40  * Adam Dunkels <adam@sics.se>
41  *
42  */
43 
44 #ifdef DOXYGEN
45 /**
46  * Initialize a local continuation.
47  *
48  * This operation initializes the local continuation, thereby
49  * unsetting any previously set continuation state.
50  *
51  * \hideinitializer
52  */
53 #define LC_INIT(lc)
54 
55 /**
56  * Set a local continuation.
57  *
58  * The set operation saves the state of the function at the point
59  * where the operation is executed. As far as the set operation is
60  * concerned, the state of the function does <b>not</b> include the
61  * call-stack or local (automatic) variables, but only the program
62  * counter and such CPU registers that needs to be saved.
63  *
64  * \hideinitializer
65  */
66 #define LC_SET(lc)
67 
68 /**
69  * Resume a local continuation.
70  *
71  * The resume operation resumes a previously set local continuation, thus
72  * restoring the state in which the function was when the local
73  * continuation was set. If the local continuation has not been
74  * previously set, the resume operation does nothing.
75  *
76  * \hideinitializer
77  */
78 #define LC_RESUME(lc)
79 
80 /**
81  * Mark the end of local continuation usage.
82  *
83  * The end operation signifies that local continuations should not be
84  * used any more in the function. This operation is not needed for
85  * most implementations of local continuation, but is required by a
86  * few implementations.
87  *
88  * \hideinitializer
89  */
90 #define LC_END(lc)
91 
92 /**
93  * \var typedef lc_t;
94  *
95  * The local continuation type.
96  *
97  * \hideinitializer
98  */
99 #endif /* DOXYGEN */
100 
101 #ifndef __LC_H__
102 #define __LC_H__
103 
104 
105 #ifdef LC_INCLUDE
106 #include LC_INCLUDE
107 #else
108 #include "lc-switch.h"
109 #endif /* LC_INCLUDE */
110 
111 #endif /* __LC_H__ */
112 
113 /** @} */
114 /** @} */