libs/context/doc/context.qbk

   1 [/
   2           Copyright Oliver Kowalke 2014.
   3  Distributed under the Boost Software License, Version 1.0.
   4     (See accompanying file LICENSE_1_0.txt or copy at
   5           http://www.boost.org/LICENSE_1_0.txt
   6 ]
   7
   8 [library Context
   9     [quickbook 1.5]
  10     [authors [Kowalke, Oliver]]
  11     [copyright 2014 Oliver Kowalke]
  12     [id context]
  13     [purpose C++ Library for swiching different user ctx]
  14     [category text]
  15     [license
  16         Distributed under the Boost Software License, Version 1.0.
  17         (See accompanying file LICENSE_1_0.txt or copy at
  18         [@http://www.boost.org/LICENSE_1_0.txt])
  19     ]
  20 ]
  21
  22
  23 [def __boost_build__ [*Boost.Build]]
  24 [def __boost_context__ [*Boost.Context]]
  25
  26 [template mdash[] '''&mdash;''']
  27 [template superscript[exp] '''<superscript>'''[exp]'''</superscript>''']
  28
  29 [template class_heading[class_name]
  30 [hding class_[class_name]..Class [`[class_name]]]
  31 ]
  32 [template class_link[class_name] [dblink class_[class_name]..[`[class_name]]]]
  33
  34 [template template_heading[class_name]
  35 [hding class_[class_name]..Template [`[class_name]<>]]
  36 ]
  37 [template template_link[class_name] [dblink class_[class_name]..[`[class_name]<>]]]
  38
  39 [template member_heading[class_name method_name]
  40 [operator_heading [class_name]..[method_name]..[method_name]]
  41 ]
  42 [template member_link[class_name method_name] [operator_link [class_name]..[method_name]..[method_name]]]
  43
  44 [template operator_heading[class_name method_name method_text]
  45 [hding [class_name]_[method_name]..Member function [`[method_text]]()]
  46 ]
  47 [template operator_link[class_name method_name method_text] [dblink [class_name]_[method_name]..[`[class_name]::[method_text]()]]]
  48
  49 [template template_member_heading[class_name method_name]
  50 [hding [class_name]_[method_name]..Templated member function [`[method_name]]()]
  51 ]
  52 [template template_member_link[class_name method_name] [member_link [class_name]..[method_name]]]
  53
  54 [template static_member_heading[class_name method_name]
  55 [hding [class_name]_[method_name]..Static member function [`[method_name]]()]
  56 ]
  57 [template static_member_link[class_name method_name] [member_link [class_name]..[method_name]]]
  58
  59 [template data_member_heading[class_name member_name]
  60 [hding [class_name]_[member_name]..Data member [`[member_name]]]
  61 ]
  62 [template data_member_link[class_name member_name] [dblink [class_name]_[member_name]..[`[class_name]::[member_name]]]]
  63
  64 [template function_heading[function_name]
  65 [hding [function_name]..Non-member function [`[function_name]()]]
  66 ]
  67 [template function_link[function_name] [dblink [function_name]..[`[function_name]()]]]
  68
  69 [template ns_function_heading[namespace function_name]
  70 [hding [namespace]_[function_name]..Non-member function [`[namespace]::[function_name]()]]
  71 ]
  72 [template ns_function_link[namespace function_name] [dblink [namespace]_[function_name]..[`[namespace]::[function_name]()]]]
  73
  74 [template constructor_heading[class_name constructor_name]
  75 [hding [class_name]_[constructor_name]..Constructor]
  76 ]
  77
  78 [template destructor_heading[class_name destructor_name]
  79 [hding [class_name]_[destructor_name]..Destructor]
  80 ]
  81
  82 [template copy_constructor_heading[class_name copy_constructor_name]
  83 [hding [class_name]_[copy_constructor_name]..Copy constructor]
  84 ]
  85
  86 [template move_constructor_heading[class_name move_constructor_name]
  87 [hding [class_name]_[move_constructor_name]..Move constructor]
  88 ]
  89
  90 [template copy_assignment_heading[class_name copy_assignment_name]
  91 [hding [class_name]_[copy_assignment_name]..Copy assignment operator]
  92 ]
  93
  94 [template move_assignment_heading[class_name move_assignment_name]
  95 [hding [class_name]_[move_assignment_name]..Move assignment operator]
  96 ]
  97
  98 [template anchor[name] '''<anchor id="'''[name]'''"/>''']
  99 [template hding[name title]
 100 '''<bridgehead renderas="sect4" id="'''[name]_bridgehead'''">
 101   <phrase id="'''[name]'''"/>
 102   <link linkend="'''[name]'''">'''[title]'''</link>
 103 </bridgehead>'''
 104 ]
 105 [template dblink[id text] '''<link linkend="'''[id]'''">'''[text]'''</link>''']
 106 [template `[text] '''<code>'''[text]'''</code>''']
 107
 108
 109 [def __callcc__ ['call/cc]]
 110 [def __context_fn__ ['context-function]]
 111 [def __coroutine__ ['coroutine]]
 112 [def __coroutines__ ['coroutines]]
 113 [def __coop_threads__ ['cooperative threads (userland threads)]]
 114 [def __fls__ ['fiber-local storage]]
 115 [def __guard_page__ ['guard-page]]
 116 [def __not_a_context__ ['not-a-context]]
 117 [def __stack__ ['stack]]
 118 [def __thread__ ['thread]]
 119 [def __threads__ ['threads]]
 120 [def __tls__ ['thread-local storage]]
 121 [def __toe__ ['thread-of-execution]]
 122 [def __stack_allocator__ ['StackAllocator]]
 123 [def __stack_allocator_concept__ ['stack-allocator concept]]
 124 [def __stack_traits__ ['stack-traits]]
 125
 126 [def __cc__ [link cc ['callcc()]]]
 127 [def __con__ [link cc ['continuation]]]
 128 [def __econtext__ ['execution_context]]
 129 [def __ecv1__ [link ecv1 ['execution_context] (v1)]]
 130 [def __ecv2__ [link ecv2 ['execution_context] (v2)]]
 131 [def __fcontext__ ['fcontext_t]]
 132 [def __forced_unwind__ ['detail::forced_unwind]]
 133 [def __ucontext__ ['ucontext_t]]
 134 [def __fixedsize__ ['fixedsize_stack]]
 135 [def __pooled_fixedsize__ ['pooled_fixedsize_stack]]
 136 [def __protected_fixedsize__ ['protected_fixedsize_stack]]
 137 [def __segmented__ ['segmented_stack]]
 138 [def __stack_context__ ['stack_context]]
 139
 140 [def __fls_alloc__ ['::FlsAlloc()]]
 141 [def __fls_free__ ['::FlsFree()]]
 142
 143 [def __bad_alloc__ ['std::bad_alloc]]
 144 [def __ec_current__ ['execution_context::current()]]
 145 [def __ec_op__ ['execution_context::operator()]]
 146 [def __fc_base__ ['fc_base]]
 147 [def __fc_link__ ['fc_link]]
 148 [def __jump_fcontext__ ['jump_fcontext()]]
 149 [def __make_fcontext__ ['make_fcontext()]]
 150 [def __invalid_argument__ ['std::invalid_argument]]
 151 [def __ot_error__ ['ontop_error]]
 152 [def __stack_alloc__ ['allocate()]]
 153 [def __stack_dealloc__ ['deallocate()]]
 154 [def __stack_helper__ ['stack_helper]]
 155 [def __yield__ ['yield]]
 156
 157 [def __context_ns__ ['boost::context]]
 158
 159 [include overview.qbk]
 160 [include requirements.qbk]
 161 [include callcc.qbk]
 162 [include execution_context_v2.qbk]
 163 [include execution_context_v1.qbk]
 164 [include stack.qbk]
 165 [include preallocated.qbk]
 166 [include performance.qbk]
 167 [include architectures.qbk]
 168 [include rationale.qbk]
 169 [include reference.qbk]
 170 [include acknowledgements.qbk]