Home Explore Help
Register Sign In
embedded
/
owner-nrf52sdk
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: fd41ddea6b
Branches Tags
owner-nrf52sdk
/
nRF5_SDK_15.3.0
/
external
/
protothreads
/
pt-1.4
/
doc
/
html
/
a00020.html

a00020.html 13 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
    3. 

  3. <title>The Protothreads Library 1.4: lc.h Source File</title>
    4. 

  4. <link href="doxygen.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="tabs.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.4.6 -->
    8. 

  8. <div class="tabs">
    9. 

  9.   <ul>
    10. 

  10.     <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
    11. 

  11.     <li><a href="modules.html"><span>Modules</span></a></li>
    12. 

  12.     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    13. 

  13.     <li id="current"><a href="files.html"><span>Files</span></a></li>
    14. 

  14.   </ul></div>
    15. 

  15. <div class="tabs">
    16. 

  16.   <ul>
    17. 

  17.     <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    18. 

  18.     <li><a href="globals.html"><span>Globals</span></a></li>
    19. 

  19.   </ul></div>
    20. 

  20. <h1>lc.h</h1><a href="a00011.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
    21. 

  21. <a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2004-2005, Swedish Institute of Computer Science.</span>
    22. 

  22. <a name="l00003"></a>00003 <span class="comment"> * All rights reserved. </span>
    23. 

  23. <a name="l00004"></a>00004 <span class="comment"> *</span>
    24. 

  24. <a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
    25. 

  25. <a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
    26. 

  26. <a name="l00007"></a>00007 <span class="comment"> * are met: </span>
    27. 

  27. <a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
    28. 

  28. <a name="l00009"></a>00009 <span class="comment"> *    notice, this list of conditions and the following disclaimer. </span>
    29. 

  29. <a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
    30. 

  30. <a name="l00011"></a>00011 <span class="comment"> *    notice, this list of conditions and the following disclaimer in the </span>
    31. 

  31. <a name="l00012"></a>00012 <span class="comment"> *    documentation and/or other materials provided with the distribution. </span>
    32. 

  32. <a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
    33. 

  33. <a name="l00014"></a>00014 <span class="comment"> *    may be used to endorse or promote products derived from this software </span>
    34. 

  34. <a name="l00015"></a>00015 <span class="comment"> *    without specific prior written permission. </span>
    35. 

  35. <a name="l00016"></a>00016 <span class="comment"> *</span>
    36. 

  36. <a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
    37. 

  37. <a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
    38. 

  38. <a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
    39. 

  39. <a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
    40. 

  40. <a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
    41. 

  41. <a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
    42. 

  42. <a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
    43. 

  43. <a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
    44. 

  44. <a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
    45. 

  45. <a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
    46. 

  46. <a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE. </span>
    47. 

  47. <a name="l00028"></a>00028 <span class="comment"> *</span>
    48. 

  48. <a name="l00029"></a>00029 <span class="comment"> * This file is part of the protothreads library.</span>
    49. 

  49. <a name="l00030"></a>00030 <span class="comment"> * </span>
    50. 

  50. <a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels &lt;adam@sics.se&gt;</span>
    51. 

  51. <a name="l00032"></a>00032 <span class="comment"> *</span>
    52. 

  52. <a name="l00033"></a>00033 <span class="comment"> * $Id: lc.h,v 1.2 2005/02/24 10:36:59 adam Exp $</span>
    53. 

  53. <a name="l00034"></a>00034 <span class="comment"> */</span>
    54. 

  54. <a name="l00035"></a>00035 <span class="comment"></span>
    55. 

  55. <a name="l00036"></a>00036 <span class="comment">/**</span>
    56. 

  56. <a name="l00037"></a>00037 <span class="comment"> * \addtogroup pt</span>
    57. 

  57. <a name="l00038"></a>00038 <span class="comment"> * @{</span>
    58. 

  58. <a name="l00039"></a>00039 <span class="comment"> */</span>
    59. 

  59. <a name="l00040"></a>00040 <span class="comment"></span>
    60. 

  60. <a name="l00041"></a>00041 <span class="comment">/**</span>
    61. 

  61. <a name="l00042"></a>00042 <span class="comment"> * \defgroup lc Local continuations</span>
    62. 

  62. <a name="l00043"></a>00043 <span class="comment"> * @{</span>
    63. 

  63. <a name="l00044"></a>00044 <span class="comment"> *</span>
    64. 

  64. <a name="l00045"></a>00045 <span class="comment"> * Local continuations form the basis for implementing protothreads. A</span>
    65. 

  65. <a name="l00046"></a>00046 <span class="comment"> * local continuation can be &lt;i&gt;set&lt;/i&gt; in a specific function to</span>
    66. 

  66. <a name="l00047"></a>00047 <span class="comment"> * capture the state of the function. After a local continuation has</span>
    67. 

  67. <a name="l00048"></a>00048 <span class="comment"> * been set can be &lt;i&gt;resumed&lt;/i&gt; in order to restore the state of the</span>
    68. 

  68. <a name="l00049"></a>00049 <span class="comment"> * function at the point where the local continuation was set.</span>
    69. 

  69. <a name="l00050"></a>00050 <span class="comment"> *</span>
    70. 

  70. <a name="l00051"></a>00051 <span class="comment"> *</span>
    71. 

  71. <a name="l00052"></a>00052 <span class="comment"> */</span>
    72. 

  72. <a name="l00053"></a>00053 <span class="comment"></span>
    73. 

  73. <a name="l00054"></a>00054 <span class="comment">/**</span>
    74. 

  74. <a name="l00055"></a>00055 <span class="comment"> * \file lc.h</span>
    75. 

  75. <a name="l00056"></a>00056 <span class="comment"> * Local continuations</span>
    76. 

  76. <a name="l00057"></a>00057 <span class="comment"> * \author</span>
    77. 

  77. <a name="l00058"></a>00058 <span class="comment"> * Adam Dunkels &lt;adam@sics.se&gt;</span>
    78. 

  78. <a name="l00059"></a>00059 <span class="comment"> *</span>
    79. 

  79. <a name="l00060"></a>00060 <span class="comment"> */</span>
    80. 

  80. <a name="l00061"></a>00061 
    81. 

  81. <a name="l00062"></a>00062 <span class="preprocessor">#ifdef DOXYGEN</span>
    82. 

  82. <a name="l00063"></a>00063 <span class="preprocessor"></span><span class="comment">/**</span>
    83. 

  83. <a name="l00064"></a>00064 <span class="comment"> * Initialize a local continuation.</span>
    84. 

  84. <a name="l00065"></a>00065 <span class="comment"> *</span>
    85. 

  85. <a name="l00066"></a>00066 <span class="comment"> * This operation initializes the local continuation, thereby</span>
    86. 

  86. <a name="l00067"></a>00067 <span class="comment"> * unsetting any previously set continuation state.</span>
    87. 

  87. <a name="l00068"></a>00068 <span class="comment"> *</span>
    88. 

  88. <a name="l00069"></a>00069 <span class="comment"> * \hideinitializer</span>
    89. 

  89. <a name="l00070"></a>00070 <span class="comment"> */</span>
    90. 

  90. <a name="l00071"></a><a class="code" href="a00017.html#g9ca9d0fef02b9c5d93bed2834e7aeb76">00071</a> <span class="preprocessor">#define LC_INIT(lc)</span>
    91. 

  91. <a name="l00072"></a>00072 <span class="preprocessor"></span><span class="comment"></span>
    92. 

  92. <a name="l00073"></a>00073 <span class="comment">/**</span>
    93. 

  93. <a name="l00074"></a>00074 <span class="comment"> * Set a local continuation.</span>
    94. 

  94. <a name="l00075"></a>00075 <span class="comment"> *</span>
    95. 

  95. <a name="l00076"></a>00076 <span class="comment"> * The set operation saves the state of the function at the point</span>
    96. 

  96. <a name="l00077"></a>00077 <span class="comment"> * where the operation is executed. As far as the set operation is</span>
    97. 

  97. <a name="l00078"></a>00078 <span class="comment"> * concerned, the state of the function does &lt;b&gt;not&lt;/b&gt; include the</span>
    98. 

  98. <a name="l00079"></a>00079 <span class="comment"> * call-stack or local (automatic) variables, but only the program</span>
    99. 

  99. <a name="l00080"></a>00080 <span class="comment"> * counter and such CPU registers that needs to be saved.</span>
    100. 

  100. <a name="l00081"></a>00081 <span class="comment"> *</span>
    101. 

  101. <a name="l00082"></a>00082 <span class="comment"> * \hideinitializer</span>
    102. 

  102. <a name="l00083"></a>00083 <span class="comment"> */</span>
    103. 

  103. <a name="l00084"></a><a class="code" href="a00017.html#gfb1d5e671e40464a7a7bda589b5d4341">00084</a> <span class="preprocessor">#define LC_SET(lc)</span>
    104. 

  104. <a name="l00085"></a>00085 <span class="preprocessor"></span><span class="comment"></span>
    105. 

  105. <a name="l00086"></a>00086 <span class="comment">/**</span>
    106. 

  106. <a name="l00087"></a>00087 <span class="comment"> * Resume a local continuation.</span>
    107. 

  107. <a name="l00088"></a>00088 <span class="comment"> *</span>
    108. 

  108. <a name="l00089"></a>00089 <span class="comment"> * The resume operation resumes a previously set local continuation, thus</span>
    109. 

  109. <a name="l00090"></a>00090 <span class="comment"> * restoring the state in which the function was when the local</span>
    110. 

  110. <a name="l00091"></a>00091 <span class="comment"> * continuation was set. If the local continuation has not been</span>
    111. 

  111. <a name="l00092"></a>00092 <span class="comment"> * previously set, the resume operation does nothing.</span>
    112. 

  112. <a name="l00093"></a>00093 <span class="comment"> *</span>
    113. 

  113. <a name="l00094"></a>00094 <span class="comment"> * \hideinitializer</span>
    114. 

  114. <a name="l00095"></a>00095 <span class="comment"> */</span>
    115. 

  115. <a name="l00096"></a><a class="code" href="a00017.html#g33dad6011c98dfeb4e64fee1d6892cb3">00096</a> <span class="preprocessor">#define LC_RESUME(lc)</span>
    116. 

  116. <a name="l00097"></a>00097 <span class="preprocessor"></span><span class="comment"></span>
    117. 

  117. <a name="l00098"></a>00098 <span class="comment">/**</span>
    118. 

  118. <a name="l00099"></a>00099 <span class="comment"> * Mark the end of local continuation usage.</span>
    119. 

  119. <a name="l00100"></a>00100 <span class="comment"> *</span>
    120. 

  120. <a name="l00101"></a>00101 <span class="comment"> * The end operation signifies that local continuations should not be</span>
    121. 

  121. <a name="l00102"></a>00102 <span class="comment"> * used any more in the function. This operation is not needed for</span>
    122. 

  122. <a name="l00103"></a>00103 <span class="comment"> * most implementations of local continuation, but is required by a</span>
    123. 

  123. <a name="l00104"></a>00104 <span class="comment"> * few implementations.</span>
    124. 

  124. <a name="l00105"></a>00105 <span class="comment"> *</span>
    125. 

  125. <a name="l00106"></a>00106 <span class="comment"> * \hideinitializer </span>
    126. 

  126. <a name="l00107"></a>00107 <span class="comment"> */</span>
    127. 

  127. <a name="l00108"></a><a class="code" href="a00017.html#g3d76802e55349cc8bf74f286ced203c3">00108</a> <span class="preprocessor">#define LC_END(lc)</span>
    128. 

  128. <a name="l00109"></a>00109 <span class="preprocessor"></span><span class="comment"></span>
    129. 

  129. <a name="l00110"></a>00110 <span class="comment">/**</span>
    130. 

  130. <a name="l00111"></a>00111 <span class="comment"> * \var typedef lc_t;</span>
    131. 

  131. <a name="l00112"></a>00112 <span class="comment"> *</span>
    132. 

  132. <a name="l00113"></a>00113 <span class="comment"> * The local continuation type.</span>
    133. 

  133. <a name="l00114"></a>00114 <span class="comment"> *</span>
    134. 

  134. <a name="l00115"></a>00115 <span class="comment"> * \hideinitializer</span>
    135. 

  135. <a name="l00116"></a>00116 <span class="comment"> */</span>
    136. 

  136. <a name="l00117"></a>00117 <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span>
    137. 

  137. <a name="l00118"></a>00118 
    138. 

  138. <a name="l00119"></a>00119 <span class="preprocessor">#ifndef __LC_H__</span>
    139. 

  139. <a name="l00120"></a>00120 <span class="preprocessor"></span><span class="preprocessor">#define __LC_H__</span>
    140. 

  140. <a name="l00121"></a>00121 <span class="preprocessor"></span>
    141. 

  141. <a name="l00122"></a>00122 
    142. 

  142. <a name="l00123"></a>00123 <span class="preprocessor">#ifdef LC_INCLUDE</span>
    143. 

  143. <a name="l00124"></a>00124 <span class="preprocessor"></span><span class="preprocessor">#include LC_INCLUDE</span>
    144. 

  144. <a name="l00125"></a>00125 <span class="preprocessor"></span><span class="preprocessor">#else</span>
    145. 

  145. <a name="l00126"></a>00126 <span class="preprocessor"></span><span class="preprocessor">#include "<a class="code" href="a00010.html">lc-switch.h</a>"</span>
    146. 

  146. <a name="l00127"></a>00127 <span class="preprocessor">#endif </span><span class="comment">/* LC_INCLUDE */</span>
    147. 

  147. <a name="l00128"></a>00128 
    148. 

  148. <a name="l00129"></a>00129 <span class="preprocessor">#endif </span><span class="comment">/* __LC_H__ */</span>
    149. 

  149. <a name="l00130"></a>00130 <span class="comment"></span>
    150. 

  150. <a name="l00131"></a>00131 <span class="comment">/** @} */</span><span class="comment"></span>
    151. 

  151. <a name="l00132"></a>00132 <span class="comment">/** @} */</span>
    152. 

  152. </pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Oct 2 10:06:29 2006 for The Protothreads Library 1.4 by&nbsp;
    153. 

  153. <a href="http://www.doxygen.org/index.html">
    154. 

  154. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
    155. 

  155. </body>
    156. 

  156. </html>
    157.