1<?xml version="1.0" standalone="yes"?> 2<library-reference id="expressions"><title>Expressions</title><header name="boost/log/expressions/attr.hpp"> 3<para><para>Andrey Semashev </para> 4 5<para>21.07.2012</para> 6 7The header contains implementation of a generic attribute placeholder in template expressions. </para><namespace name="boost"> 8<namespace name="log"> 9<namespace name="expressions"> 10<function name="attr"><type><classname>attribute_actor</classname>< AttributeValueT ></type><template> 11 <template-type-parameter name="AttributeValueT"/> 12 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will extract the value of the attribute with the specified name and type. </para></description></function> 13<function name="attr"><type><classname>attribute_actor</classname>< AttributeValueT, fallback_to_none, TagT ></type><template> 14 <template-type-parameter name="AttributeValueT"/> 15 <template-type-parameter name="TagT"/> 16 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will extract the value of the attribute with the specified name and type. </para></description></function> 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84</namespace> 85 86 87</namespace> 88</namespace> 89</header> 90<header name="boost/log/expressions/attr_fwd.hpp"> 91<para><para>Andrey Semashev </para> 92 93<para>21.07.2012</para> 94 95The header contains forward declaration of a generic attribute placeholder in template expressions. </para><namespace name="boost"> 96<namespace name="log"> 97<namespace name="expressions"> 98<class name="attribute_actor"><template> 99 <template-type-parameter name="T"/> 100 <template-type-parameter name="FallbackPolicyT"/> 101 <template-type-parameter name="TagT"/> 102 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 103 </template><inherit access="public">ActorT< attribute_terminal< T, FallbackPolicyT, TagT > ></inherit><description><para>An attribute value extraction terminal actor </para></description><method-group name="public member functions"> 104<method name="get_name" cv="const"><type>attribute_name</type><description><para> 105</para></description><returns><para>The attribute name </para> 106</returns></method> 107<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><description><para> 108</para></description><returns><para>Fallback policy </para> 109</returns></method> 110<method name="or_none" cv="const"><type>or_none_result_type</type><purpose>Generates an expression that extracts the attribute value or a default value. </purpose></method> 111<method name="or_throw" cv="const"><type>or_throw_result_type</type><purpose>Generates an expression that extracts the attribute value or throws an exception. </purpose></method> 112<method name="or_default" cv="const"><type><classname>attribute_actor</classname>< value_type, fallback_to_default< DefaultT >, tag_type, ActorT ></type><template> 113 <template-type-parameter name="DefaultT"/> 114 </template><parameter name="def_val"><paramtype>DefaultT const &</paramtype></parameter><purpose>Generates an expression that extracts the attribute value or a default value. </purpose></method> 115</method-group> 116<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 117</class><class name="attribute_terminal"><template> 118 <template-type-parameter name="T"/> 119 <template-type-parameter name="FallbackPolicyT"/> 120 <template-type-parameter name="TagT"/> 121 </template><description><para>An attribute value extraction terminal </para></description><method-group name="public member functions"> 122<method name="get_name" cv="const"><type>attribute_name</type><description><para> 123</para></description><returns><para>Attribute value name </para> 124</returns></method> 125<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><description><para> 126</para></description><returns><para>Fallback policy </para> 127</returns></method> 128<method name="operator()"><type><classname>result</classname>< <classname>this_type</classname>(ContextT const &) >::type</type><template> 129 <template-type-parameter name="ContextT"/> 130 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>The operator extracts attribute value </para></description></method> 131<method name="operator()" cv="const"><type><classname>result</classname>< const <classname>this_type</classname>(ContextT const &) >::type</type><template> 132 <template-type-parameter name="ContextT"/> 133 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>The operator extracts attribute value </para></description></method> 134</method-group> 135<constructor specifiers="explicit"><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>Initializing constructor </para></description></constructor> 136<constructor><template> 137 <template-type-parameter name="U"/> 138 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="arg"><paramtype>U const &</paramtype></parameter><description><para>Initializing constructor </para></description></constructor> 139<constructor cv="= delete"/> 140</class> 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209</namespace> 210 211 212</namespace> 213</namespace> 214</header> 215<header name="boost/log/expressions/filter.hpp"> 216<para><para>Andrey Semashev </para> 217 218<para>13.07.2012</para> 219 220The header contains a filter function object definition. </para><namespace name="boost"> 221<namespace name="log"> 222<class name="filter"><description><para>Log record filter function wrapper. </para></description><struct name="default_filter"><purpose>Default filter, always returns <computeroutput>true</computeroutput>. </purpose><typedef name="result_type"><type>bool</type></typedef> 223<method-group name="public member functions"> 224<method name="operator()" cv="const"><type>result_type</type><parameter name=""><paramtype>attribute_value_set const &</paramtype></parameter></method> 225</method-group> 226</struct><typedef name="result_type"><purpose>Result type. </purpose><type>bool</type></typedef> 227<method-group name="public member functions"> 228<method name="operator()" cv="const"><type>result_type</type><parameter name="values"><paramtype>attribute_value_set const &</paramtype><description><para>Attribute values of the log record. </para></description></parameter><description><para>Filtering operator.</para><para> 229 230</para></description><returns><para><computeroutput>true</computeroutput> if the log record passes the filter, <computeroutput>false</computeroutput> otherwise. </para> 231</returns></method> 232<method name="reset"><type>void</type><description><para>Resets the filter to the default. The default filter always returns <computeroutput>true</computeroutput>. </para></description></method> 233<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>filter</classname> &</paramtype></parameter><description><para>Swaps two filters </para></description></method> 234</method-group> 235<constructor><description><para>Default constructor. Creates a filter that always returns <computeroutput>true</computeroutput>. </para></description></constructor> 236<constructor><parameter name="that"><paramtype><classname>filter</classname> const &</paramtype></parameter><description><para>Copy constructor </para></description></constructor> 237<constructor cv="noexcept"><parameter name="that"><paramtype><classname>filter</classname> &&</paramtype></parameter><description><para>Move constructor. The moved-from filter is left in an unspecified state. </para></description></constructor> 238<constructor><template> 239 <template-type-parameter name="FunT"/> 240 </template><parameter name="fun"><paramtype>FunT &&</paramtype></parameter><description><para>Initializing constructor. Creates a filter which will invoke the specified function object. </para></description></constructor> 241<copy-assignment cv="noexcept"><type><classname>filter</classname> &</type><parameter name="that"><paramtype><classname>filter</classname> &&</paramtype></parameter><description><para>Move assignment. The moved-from filter is left in an unspecified state. </para></description></copy-assignment> 242<copy-assignment><type><classname>filter</classname> &</type><parameter name="that"><paramtype><classname>filter</classname> const &</paramtype></parameter><description><para>Copy assignment. </para></description></copy-assignment> 243<copy-assignment><type><classname>filter</classname> &</type><template> 244 <template-type-parameter name="FunT"/> 245 </template><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>Initializing assignment. Sets the specified function object to the filter. </para></description></copy-assignment> 246</class> 247<function name="swap"><type>void</type><parameter name="left"><paramtype><classname>filter</classname> &</paramtype></parameter><parameter name="right"><paramtype><classname>filter</classname> &</paramtype></parameter></function> 248</namespace> 249</namespace> 250</header> 251<header name="boost/log/expressions/formatter.hpp"> 252<para><para>Andrey Semashev </para> 253 254<para>13.07.2012</para> 255 256The header contains a formatter function object definition. </para><namespace name="boost"> 257<namespace name="log"> 258<class name="basic_formatter"><template> 259 <template-type-parameter name="CharT"/> 260 </template><description><para>Log record formatter function wrapper. </para></description><typedef name="result_type"><purpose>Result type. </purpose><type>void</type></typedef> 261<typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 262<typedef name="stream_type"><purpose>Output stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 263<method-group name="public member functions"> 264<method name="operator()" cv="const"><type>result_type</type><parameter name="rec"><paramtype>record_view const &</paramtype><description><para>A log record to format. </para></description></parameter><parameter name="strm"><paramtype>stream_type &</paramtype><description><para>A stream to put the formatted characters to. </para></description></parameter><description><para>Formatting operator.</para><para> 265</para></description></method> 266<method name="reset"><type>void</type><description><para>Resets the formatter to the default. The default formatter only outputs message text. </para></description></method> 267<method name="swap" cv="noexcept"><type>void</type><parameter name="that"><paramtype><classname>basic_formatter</classname> &</paramtype></parameter><description><para>Swaps two formatters </para></description></method> 268</method-group> 269<constructor><description><para>Default constructor. Creates a formatter that only outputs log message. </para></description></constructor> 270<constructor><parameter name="that"><paramtype><classname>basic_formatter</classname> const &</paramtype></parameter><description><para>Copy constructor </para></description></constructor> 271<constructor cv="noexcept"><parameter name="that"><paramtype><classname>this_type</classname> &&</paramtype></parameter><description><para>Move constructor. The moved-from formatter is left in an unspecified state. </para></description></constructor> 272<constructor><template> 273 <template-type-parameter name="FunT"/> 274 </template><parameter name="fun"><paramtype>FunT &&</paramtype></parameter><description><para>Initializing constructor. Creates a formatter which will invoke the specified function object. </para></description></constructor> 275<copy-assignment cv="noexcept"><type><classname>basic_formatter</classname> &</type><parameter name="that"><paramtype><classname>this_type</classname> &&</paramtype></parameter><description><para>Move assignment. The moved-from formatter is left in an unspecified state. </para></description></copy-assignment> 276<copy-assignment><type><classname>basic_formatter</classname> &</type><parameter name="that"><paramtype><classname>this_type</classname> const &</paramtype></parameter><description><para>Copy assignment. </para></description></copy-assignment> 277<copy-assignment><type><classname>basic_formatter</classname> &</type><template> 278 <template-type-parameter name="FunT"/> 279 </template><parameter name="fun"><paramtype>FunT &&</paramtype></parameter><description><para>Initializing assignment. Sets the specified function object to the formatter. </para></description></copy-assignment> 280</class><namespace name="expressions"> 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350</namespace> 351<typedef name="formatter"><type><classname>basic_formatter</classname>< char ></type></typedef> 352<typedef name="wformatter"><type><classname>basic_formatter</classname>< wchar_t ></type></typedef> 353<function name="swap"><type>void</type><template> 354 <template-type-parameter name="CharT"/> 355 </template><parameter name="left"><paramtype><classname>basic_formatter</classname>< CharT > &</paramtype></parameter><parameter name="right"><paramtype><classname>basic_formatter</classname>< CharT > &</paramtype></parameter></function> 356 357</namespace> 358</namespace> 359</header> 360<header name="boost/log/expressions/formatters.hpp"> 361<para><para>Andrey Semashev </para> 362 363<para>10.11.2012</para> 364 365The header includes all template expression formatters. </para></header> 366<header name="boost/log/expressions/formatters/auto_newline.hpp"> 367<para><para>Andrey Semashev </para> 368 369<para>23.06.2019</para> 370 371The header contains implementation of formatter for inserting a newline, unless there is already one inserted. </para><namespace name="boost"> 372<namespace name="log"> 373<namespace name="expressions"> 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443</namespace> 444 445 446</namespace> 447</namespace> 448</header> 449<header name="boost/log/expressions/formatters/c_decorator.hpp"> 450<para><para>Andrey Semashev </para> 451 452<para>18.11.2012</para> 453 454The header contains implementation of C-style character decorators. </para><namespace name="boost"> 455<namespace name="log"> 456<namespace name="expressions"> 457<class name="c_ascii_pattern_replacer"><template> 458 <template-type-parameter name="CharT"/> 459 </template><inherit access="public">boost::log::expressions::pattern_replacer< CharT ></inherit><description><para>A character decorator implementation that escapes all non-prontable and non-ASCII characters in the output with C-style escape sequences. </para></description><typedef name="result_type"><purpose>Result type. </purpose><type>base_type::result_type</type></typedef> 460<typedef name="char_type"><purpose>Character type. </purpose><type>base_type::char_type</type></typedef> 461<typedef name="string_type"><purpose>String type. </purpose><type>base_type::string_type</type></typedef> 462<method-group name="public member functions"> 463<method name="operator()" cv="const"><type>result_type</type><parameter name="str"><paramtype>string_type &</paramtype></parameter><parameter name="start_pos"><paramtype>typename string_type::size_type</paramtype><default>0</default></parameter><purpose>Applies string replacements starting from the specified position. </purpose></method> 464</method-group> 465<constructor><purpose>Default constructor. </purpose></constructor> 466</class><data-member name="c_decor"><type><emphasis>unspecified</emphasis></type><description><para>C-style decorator generator object. The decorator replaces characters with specific meaning in C language with the corresponding escape sequences. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator. For example:</para><para><computeroutput> c_decor[ stream << attr< std::string >("MyAttr") ] </computeroutput></para><para>For wide-character formatting there is the similar <computeroutput>wc_decor</computeroutput> decorator generator object. </para></description></data-member> 467<data-member name="wc_decor"><type><emphasis>unspecified</emphasis></type></data-member> 468<data-member name="c_ascii_decor"><type><emphasis>unspecified</emphasis></type><description><para>C-style decorator generator object. Acts similarly to <computeroutput>c_decor</computeroutput>, except that <computeroutput>c_ascii_decor</computeroutput> also converts all non-ASCII and non-printable ASCII characters, except for space character, into C-style hexadecimal escape sequences. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator. For example:</para><para><computeroutput> c_ascii_decor[ stream << attr< std::string >("MyAttr") ] </computeroutput></para><para>For wide-character formatting there is the similar <computeroutput>wc_ascii_decor</computeroutput> decorator generator object. </para></description></data-member> 469<data-member name="wc_ascii_decor"><type><emphasis>unspecified</emphasis></type></data-member> 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537<function name="make_c_decor"><type><emphasis>unspecified</emphasis></type><template> 538 <template-type-parameter name="CharT"/> 539 </template><description><para>The function creates a C-style decorator generator for arbitrary character type. </para></description></function> 540<function name="make_c_ascii_decor"><type><emphasis>unspecified</emphasis></type><template> 541 <template-type-parameter name="CharT"/> 542 </template><description><para>The function creates a C-style decorator generator for arbitrary character type. </para></description></function> 543</namespace> 544 545 546</namespace> 547</namespace> 548</header> 549<header name="boost/log/expressions/formatters/char_decorator.hpp"> 550<para><para>Andrey Semashev </para> 551 552<para>17.11.2012</para> 553 554The header contains implementation of a character decorator. </para><namespace name="boost"> 555<namespace name="log"> 556<namespace name="expressions"> 557<class name="char_decorator_actor"><template> 558 <template-type-parameter name="SubactorT"/> 559 <template-type-parameter name="ImplT"/> 560 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 561 </template><inherit access="public">ActorT< char_decorator_terminal< SubactorT, ImplT > ></inherit><description><para>Character decorator actor </para></description><typedef name="terminal_type"><purpose>Base terminal type. </purpose><type><classname>char_decorator_terminal</classname>< SubactorT, ImplT ></type></typedef> 562<typedef name="char_type"><purpose>Character type. </purpose><type>terminal_type::char_type</type></typedef> 563<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 564<method-group name="public member functions"> 565<method name="get_terminal" cv="const"><type>terminal_type const &</type><purpose>Returns reference to the terminal. </purpose></method> 566</method-group> 567<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 568</class><class name="char_decorator_terminal"><template> 569 <template-type-parameter name="SubactorT"/> 570 <template-type-parameter name="ImplT"/> 571 </template><description><para>Character decorator terminal class. This formatter allows to modify strings generated by other formatters on character level. The most obvious application of decorators is replacing a certain set of characters with decorated equivalents to satisfy requirements of text-based sinks.</para><para>The <computeroutput><classname alt="boost::log::expressions::char_decorator_terminal">char_decorator_terminal</classname></computeroutput> class aggregates the formatter being decorated, and a set of string pairs that are used as decorations. All decorations are applied sequentially. The <computeroutput><classname alt="boost::log::expressions::char_decorator_terminal">char_decorator_terminal</classname></computeroutput> class is a formatter itself, so it can be used to construct more complex formatters, including nesting decorators. </para></description><typedef name="impl_type"><purpose>Implementation type. </purpose><type>ImplT</type></typedef> 572<typedef name="char_type"><purpose>Character type. </purpose><type>impl_type::char_type</type></typedef> 573<typedef name="string_type"><purpose>String type. </purpose><type>impl_type::string_type</type></typedef> 574<typedef name="stream_type"><purpose>Stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 575<typedef name="subactor_type"><purpose>Adopted actor type. </purpose><type>SubactorT</type></typedef> 576<typedef name="result_type"><purpose>Result type definition. </purpose><type>string_type</type></typedef> 577<method-group name="public member functions"> 578<method name="get_subactor" cv="const"><type>subactor_type const &</type><description><para> 579</para></description><returns><para>Adopted subactor </para> 580</returns></method> 581<method name="get_impl" cv="const"><type>impl_type const &</type><description><para> 582</para></description><returns><para>Implementation </para> 583</returns></method> 584<method name="operator()"><type>result_type</type><template> 585 <template-type-parameter name="ContextT"/> 586 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>Invokation operator </para></description></method> 587<method name="operator()" cv="const"><type>result_type</type><template> 588 <template-type-parameter name="ContextT"/> 589 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>Invokation operator </para></description></method> 590</method-group> 591<constructor><parameter name="sub"><paramtype>subactor_type const &</paramtype></parameter><parameter name="impl"><paramtype>impl_type const &</paramtype></parameter><description><para>Initializing constructor. </para></description></constructor> 592<constructor><parameter name="that"><paramtype><classname>char_decorator_terminal</classname> const &</paramtype></parameter><description><para>Copy constructor </para></description></constructor> 593<constructor cv="= delete"/> 594</class><class name="pattern_replacer"><template> 595 <template-type-parameter name="CharT"/> 596 </template><description><para>A simple character decorator implementation. This implementation replaces string patterns in the source string with the fixed replacements. Source patterns and replacements can be specified at the object construction. </para></description><struct name="string_lengths"><purpose>Lengths of source pattern and replacement. </purpose><data-member name="from_len"><type>unsigned int</type></data-member> 597<data-member name="to_len"><type>unsigned int</type></data-member> 598</struct><typedef name="result_type"><purpose>Result type. </purpose><type>void</type></typedef> 599<typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 600<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 601<method-group name="public member functions"> 602<method name="operator()" cv="const"><type>result_type</type><parameter name="str"><paramtype>string_type &</paramtype></parameter><parameter name="start_pos"><paramtype>typename string_type::size_type</paramtype><default>0</default></parameter><purpose>Applies string replacements starting from the specified position. </purpose></method> 603</method-group> 604<constructor specifiers="explicit"><template> 605 <template-type-parameter name="RangeT"/> 606 </template><parameter name="decorations"><paramtype>RangeT const &</paramtype></parameter><description><para>Initializing constructor. Creates a pattern replacer with the specified <emphasis>decorations</emphasis>. The provided decorations must be a sequence of <computeroutput>std::pair</computeroutput> of strings. The first element of each pair is the source pattern, and the second one is the corresponding replacement. </para></description></constructor> 607<constructor><template> 608 <template-type-parameter name="FromRangeT"/> 609 <template-type-parameter name="ToRangeT"/> 610 </template><parameter name="from"><paramtype>FromRangeT const &</paramtype></parameter><parameter name="to"><paramtype>ToRangeT const &</paramtype></parameter><description><para>Initializing constructor. Creates a pattern replacer with decorations specified in form of two same-sized string sequences. Each <computeroutput>i</computeroutput>'th decoration will be <computeroutput>from[i]</computeroutput> -> <computeroutput>to[i]</computeroutput>. </para></description></constructor> 611<constructor><parameter name="that"><paramtype><classname>pattern_replacer</classname> const &</paramtype></parameter><purpose>Copy constructor. </purpose></constructor> 612<method-group name="private static functions"> 613<method name="string_begin" specifiers="static"><type>char_type *</type><parameter name="p"><paramtype>char_type *</paramtype></parameter></method> 614<method name="string_begin" specifiers="static"><type>const char_type *</type><parameter name="p"><paramtype>const char_type *</paramtype></parameter></method> 615<method name="string_begin" specifiers="static"><type>range_const_iterator< RangeT >::type</type><template> 616 <template-type-parameter name="RangeT"/> 617 </template><parameter name="r"><paramtype>RangeT const &</paramtype></parameter></method> 618<method name="string_end" specifiers="static"><type>char_type *</type><parameter name="p"><paramtype>char_type *</paramtype></parameter></method> 619<method name="string_end" specifiers="static"><type>const char_type *</type><parameter name="p"><paramtype>const char_type *</paramtype></parameter></method> 620<method name="string_end" specifiers="static"><type>range_const_iterator< RangeT >::type</type><template> 621 <template-type-parameter name="RangeT"/> 622 </template><parameter name="r"><paramtype>RangeT const &</paramtype></parameter></method> 623</method-group> 624</class> 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689<function name="char_decor"><type><emphasis>unspecified</emphasis></type><template> 690 <template-type-parameter name="RangeT"/> 691 </template><parameter name="decorations"><paramtype>RangeT const &</paramtype><description><para>A sequence of string pairs that will be used as decorations. Every <computeroutput>decorations[i].first</computeroutput> substring occurrence in the output will be replaced with <computeroutput>decorations[i].second</computeroutput>. </para></description></parameter><description><para>The function returns a decorator generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator.</para><para> 692</para></description></function> 693<function name="char_decor"><type><emphasis>unspecified</emphasis></type><template> 694 <template-type-parameter name="FromRangeT"/> 695 <template-type-parameter name="ToRangeT"/> 696 </template><parameter name="from"><paramtype>FromRangeT const &</paramtype><description><para>A sequence of strings that will be sought in the output. </para></description></parameter><parameter name="to"><paramtype>ToRangeT const &</paramtype><description><para>A sequence of strings that will be used as replacements.</para></description></parameter><description><para>The function returns a decorator generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator.</para><para> 697<note><para>The <emphasis>from</emphasis> and <emphasis>to</emphasis> sequences mush be of the same size. Every <computeroutput>from[i]</computeroutput> substring occurrence in the output will be replaced with <computeroutput>to[i]</computeroutput>. </para> 698</note> 699</para></description></function> 700 701 702</namespace> 703 704 705</namespace> 706</namespace> 707</header> 708<header name="boost/log/expressions/formatters/csv_decorator.hpp"> 709<para><para>Andrey Semashev </para> 710 711<para>18.11.2012</para> 712 713The header contains implementation of a CSV-style character decorator. See: <ulink url="http://en.wikipedia.org/wiki/Comma-separated_values">http://en.wikipedia.org/wiki/Comma-separated_values</ulink> </para><namespace name="boost"> 714<namespace name="log"> 715<namespace name="expressions"> 716<data-member name="csv_decor"><type><emphasis>unspecified</emphasis></type><description><para>CSV-style decorator generator object. The decorator doubles double quotes that may be found in the output. See <ulink url="http://en.wikipedia.org/wiki/Comma-separated_values">http://en.wikipedia.org/wiki/Comma-separated_values</ulink> for more information on the CSV format. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator. For example:</para><para><computeroutput> csv_decor[ stream << attr< std::string >("MyAttr") ] </computeroutput></para><para>For wide-character formatting there is the similar <computeroutput>wcsv_decor</computeroutput> decorator generator object. </para></description></data-member> 717<data-member name="wcsv_decor"><type><emphasis>unspecified</emphasis></type></data-member> 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782<function name="make_csv_decor"><type><emphasis>unspecified</emphasis></type><template> 783 <template-type-parameter name="CharT"/> 784 </template><description><para>The function creates an CSV-style decorator generator for arbitrary character type. </para></description></function> 785 786 787 788 789</namespace> 790 791 792</namespace> 793</namespace> 794</header> 795<header name="boost/log/expressions/formatters/date_time.hpp"> 796<para><para>Andrey Semashev </para> 797 798<para>16.09.2012</para> 799 800The header contains a formatter function for date and time attribute values. </para><namespace name="boost"> 801<namespace name="log"> 802<namespace name="expressions"> 803<class name="format_date_time_actor"><template> 804 <template-type-parameter name="T"/> 805 <template-type-parameter name="FallbackPolicyT"/> 806 <template-type-parameter name="CharT"/> 807 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 808 </template><inherit access="public">ActorT< format_date_time_terminal< T, FallbackPolicyT, CharT > ></inherit><description><para>Date and time formatter actor. </para></description><typedef name="value_type"><purpose>Attribute value type. </purpose><type>T</type></typedef> 809<typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 810<typedef name="fallback_policy"><purpose>Fallback policy. </purpose><type>FallbackPolicyT</type></typedef> 811<typedef name="terminal_type"><purpose>Base terminal type. </purpose><type><classname>format_date_time_terminal</classname>< value_type, fallback_policy, char_type ></type></typedef> 812<typedef name="formatter_function_type"><purpose>Formatter function. </purpose><type>terminal_type::formatter_function_type</type></typedef> 813<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 814<method-group name="public member functions"> 815<method name="get_name" cv="const"><type>attribute_name</type><description><para> 816</para></description><returns><para>The attribute name </para> 817</returns></method> 818<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><description><para> 819</para></description><returns><para>Fallback policy </para> 820</returns></method> 821<method name="get_formatter_function" cv="const"><type>formatter_function_type const &</type><description><para> 822</para></description><returns><para>Formatter function </para> 823</returns></method> 824</method-group> 825<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 826</class><class name="format_date_time_terminal"><template> 827 <template-type-parameter name="T"/> 828 <template-type-parameter name="FallbackPolicyT"/> 829 <template-type-parameter name="CharT"/> 830 </template><description><para>Date and time formatter terminal. </para></description><typedef name="value_type"><purpose>Attribute value type. </purpose><type>T</type></typedef> 831<typedef name="fallback_policy"><purpose>Fallback policy. </purpose><type>FallbackPolicyT</type></typedef> 832<typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 833<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 834<typedef name="stream_type"><purpose>Formatting stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 835<typedef name="formatter_function_type"><purpose>Formatter function. </purpose><type><emphasis>unspecified</emphasis></type></typedef> 836<typedef name="result_type"><purpose>Function result type. </purpose><type>string_type</type></typedef> 837<method-group name="public member functions"> 838<method name="get_name" cv="const"><type>attribute_name</type><purpose>Returns attribute name. </purpose></method> 839<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><purpose>Returns fallback policy. </purpose></method> 840<method name="get_formatter_function" cv="const"><type>formatter_function_type const &</type><purpose>Retruns formatter function. </purpose></method> 841<method name="operator()"><type>result_type</type><template> 842 <template-type-parameter name="ContextT"/> 843 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 844<method name="operator()" cv="const"><type>result_type</type><template> 845 <template-type-parameter name="ContextT"/> 846 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 847</method-group> 848<constructor><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="fallback"><paramtype>fallback_policy const &</paramtype></parameter><parameter name="format"><paramtype>string_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 849<constructor><parameter name="that"><paramtype><classname>format_date_time_terminal</classname> const &</paramtype></parameter><purpose>Copy constructor. </purpose></constructor> 850<constructor cv="= delete"/> 851</class> 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909<function name="format_date_time"><type><classname>format_date_time_actor</classname>< AttributeValueT, fallback_to_none, CharT ></type><template> 910 <template-type-parameter name="AttributeValueT"/> 911 <template-type-parameter name="CharT"/> 912 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="format"><paramtype>const CharT *</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 913</para></description></function> 914<function name="format_date_time"><type><classname>format_date_time_actor</classname>< AttributeValueT, fallback_to_none, CharT ></type><template> 915 <template-type-parameter name="AttributeValueT"/> 916 <template-type-parameter name="CharT"/> 917 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 918</para></description></function> 919<function name="format_date_time"><type><classname>format_date_time_actor</classname>< typename DescriptorT::value_type, fallback_to_none, CharT, ActorT ></type><template> 920 <template-type-parameter name="DescriptorT"/> 921 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 922 <template-type-parameter name="CharT"/> 923 </template><parameter name="keyword"><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype><description><para>Attribute keyword </para></description></parameter><parameter name="format"><paramtype>const CharT *</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 924</para></description></function> 925<function name="format_date_time"><type><classname>format_date_time_actor</classname>< typename DescriptorT::value_type, fallback_to_none, CharT, ActorT ></type><template> 926 <template-type-parameter name="DescriptorT"/> 927 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 928 <template-type-parameter name="CharT"/> 929 </template><parameter name="keyword"><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype><description><para>Attribute keyword </para></description></parameter><parameter name="format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 930</para></description></function> 931<function name="format_date_time"><type><classname>format_date_time_actor</classname>< T, FallbackPolicyT, CharT, ActorT ></type><template> 932 <template-type-parameter name="T"/> 933 <template-type-parameter name="FallbackPolicyT"/> 934 <template-type-parameter name="TagT"/> 935 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 936 <template-type-parameter name="CharT"/> 937 </template><parameter name="placeholder"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype><description><para>Attribute placeholder </para></description></parameter><parameter name="format"><paramtype>const CharT *</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 938</para></description></function> 939<function name="format_date_time"><type><classname>format_date_time_actor</classname>< T, FallbackPolicyT, CharT, ActorT ></type><template> 940 <template-type-parameter name="T"/> 941 <template-type-parameter name="FallbackPolicyT"/> 942 <template-type-parameter name="TagT"/> 943 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 944 <template-type-parameter name="CharT"/> 945 </template><parameter name="placeholder"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype><description><para>Attribute placeholder </para></description></parameter><parameter name="format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 946</para></description></function> 947 948 949 950 951 952</namespace> 953 954 955</namespace> 956</namespace> 957</header> 958<header name="boost/log/expressions/formatters/format.hpp"> 959<para><para>Andrey Semashev </para> 960 961<para>15.11.2012</para> 962 963The header contains a generic log record formatter function. </para><namespace name="boost"> 964<namespace name="log"> 965<namespace name="expressions"> 966<class name="format_terminal"><template> 967 <template-type-parameter name="CharT"/> 968 </template><purpose>Template expressions terminal node with Boost.Format-like formatter. </purpose><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 969<typedef name="format_type"><purpose>Boost.Format formatter type. </purpose><type><emphasis>unspecified</emphasis></type></typedef> 970<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 971<typedef name="result_type"><purpose>Terminal result type. </purpose><type>format_type::pump</type></typedef> 972<method-group name="public member functions"> 973<method name="operator()" cv="const"><type>result_type</type><template> 974 <template-type-parameter name="ContextT"/> 975 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 976</method-group> 977<constructor specifiers="explicit"><parameter name="format"><paramtype>const char_type *</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 978<constructor cv="= delete"/> 979</class> 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035<function name="format"><type>phoenix::actor< <classname>format_terminal</classname>< CharT > ></type><template> 1036 <template-type-parameter name="CharT"/> 1037 </template><parameter name="fmt"><paramtype>const CharT *</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will perform log record formatting according to the provided format string. </para></description></function> 1038<function name="format"><type>phoenix::actor< <classname>format_terminal</classname>< CharT > ></type><template> 1039 <template-type-parameter name="CharT"/> 1040 <template-type-parameter name="TraitsT"/> 1041 <template-type-parameter name="AllocatorT"/> 1042 </template><parameter name="fmt"><paramtype>std::basic_string< CharT, TraitsT, AllocatorT > const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will perform log record formatting according to the provided format string. </para></description></function> 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054</namespace> 1055 1056 1057</namespace> 1058</namespace> 1059</header> 1060<header name="boost/log/expressions/formatters/if.hpp"> 1061<para><para>Andrey Semashev </para> 1062 1063<para>17.11.2012</para> 1064 1065The header contains implementation of a conditional formatter. </para><namespace name="boost"> 1066<namespace name="log"> 1067<namespace name="expressions"> 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123<function name="if_"><type><emphasis>unspecified</emphasis></type><template> 1124 <template-type-parameter name="CondT"/> 1125 </template><parameter name="cond"><paramtype>CondT const &</paramtype><description><para>A filter expression that will be used as the condition </para></description></parameter><description><para>The function returns a conditional formatter generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual formatter. The formatter must participate in a streaming expression.</para><para> 1126</para></description></function> 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140</namespace> 1141 1142 1143</namespace> 1144</namespace> 1145</header> 1146<header name="boost/log/expressions/formatters/max_size_decorator.hpp"> 1147<para><para>Andrey Semashev </para> 1148 1149<para>06.07.2016</para> 1150 1151The header contains implementation of a string length limiting decorator. </para><namespace name="boost"> 1152<namespace name="log"> 1153<namespace name="expressions"> 1154<class name="max_size_decorator_actor"><template> 1155 <template-type-parameter name="SubactorT"/> 1156 <template-type-parameter name="CharT"/> 1157 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 1158 </template><inherit access="public">ActorT< max_size_decorator_terminal< SubactorT, CharT > ></inherit><description><para>Character decorator actor </para></description><typedef name="terminal_type"><purpose>Base terminal type. </purpose><type><classname>max_size_decorator_terminal</classname>< SubactorT, CharT ></type></typedef> 1159<typedef name="char_type"><purpose>Character type. </purpose><type>terminal_type::char_type</type></typedef> 1160<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 1161<method-group name="public member functions"> 1162<method name="get_terminal" cv="const"><type>terminal_type const &</type><purpose>Returns reference to the terminal. </purpose></method> 1163</method-group> 1164<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 1165</class><class name="max_size_decorator_terminal"><template> 1166 <template-type-parameter name="SubactorT"/> 1167 <template-type-parameter name="CharT"/> 1168 </template><description><para>String size limiting decorator terminal class. This formatter allows to limit the maximum total length of the strings generated by other formatters.</para><para>The <computeroutput><classname alt="boost::log::expressions::max_size_decorator_terminal">max_size_decorator_terminal</classname></computeroutput> class aggregates the formatter being decorated, the maximum string length it can produce and an optional truncation marker string, which will be put at the end of the output if the limit is exceeded. Note that the marker length is included in the limit and as such must not exceed it. The <computeroutput><classname alt="boost::log::expressions::max_size_decorator_terminal">max_size_decorator_terminal</classname></computeroutput> class is a formatter itself, so it can be used to construct more complex formatters, including nesting decorators. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 1169<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 1170<typedef name="size_type"><purpose>String size type. </purpose><type>std::size_t</type></typedef> 1171<typedef name="stream_type"><purpose>Stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 1172<typedef name="subactor_type"><purpose>Adopted actor type. </purpose><type>SubactorT</type></typedef> 1173<typedef name="result_type"><purpose>Result type definition. </purpose><type>string_type</type></typedef> 1174<method-group name="public member functions"> 1175<method name="get_subactor" cv="const"><type>subactor_type const &</type><description><para> 1176</para></description><returns><para>Adopted subactor </para> 1177</returns></method> 1178<method name="get_max_size" cv="const"><type>size_type</type><description><para> 1179</para></description><returns><para>Max string size limit </para> 1180</returns></method> 1181<method name="get_overflow_marker" cv="const"><type>string_type const &</type><description><para> 1182</para></description><returns><para>Max string size limit </para> 1183</returns></method> 1184<method name="operator()"><type>result_type</type><template> 1185 <template-type-parameter name="ContextT"/> 1186 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>Invokation operator </para></description></method> 1187<method name="operator()" cv="const"><type>result_type</type><template> 1188 <template-type-parameter name="ContextT"/> 1189 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><description><para>Invokation operator </para></description></method> 1190</method-group> 1191<constructor><parameter name="sub"><paramtype>subactor_type const &</paramtype></parameter><parameter name="max_size"><paramtype>size_type</paramtype></parameter><parameter name="overflow_marker"><paramtype>string_type const &</paramtype><default>string_type()</default></parameter><description><para>Initializing constructor. </para></description></constructor> 1192<constructor><parameter name="that"><paramtype><classname>max_size_decorator_terminal</classname> const &</paramtype></parameter><description><para>Copy constructor </para></description></constructor> 1193<constructor cv="= delete"/> 1194</class> 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246<function name="max_size_decor"><type><emphasis>unspecified</emphasis></type><template> 1247 <template-type-parameter name="CharT"/> 1248 </template><parameter name="max_size"><paramtype>std::size_t</paramtype><description><para>The maximum number of characters (i.e. string element objects) that the decorated formatter can produce. </para></description></parameter><description><para>The function returns a decorator generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator.</para><para> 1249</para></description></function> 1250<function name="max_size_decor"><type><emphasis>unspecified</emphasis></type><template> 1251 <template-type-parameter name="CharT"/> 1252 </template><parameter name="max_size"><paramtype>std::size_t</paramtype><description><para>The maximum number of characters (i.e. string element objects) that the decorated formatter can produce. </para></description></parameter><parameter name="overflow_marker"><paramtype>const CharT *</paramtype><description><para>The marker string which is appended to the output if the <emphasis>max_size</emphasis> limit is exceeded. Must be a non-null pointer to a zero-terminated string.</para></description></parameter><description><para>The function returns a decorator generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator.</para><para> 1253 1254</para></description><requires><para>The <emphasis>overflow_marker</emphasis> length must not exceed the <emphasis>max_size</emphasis> limit. </para> 1255</requires></function> 1256<function name="max_size_decor"><type><emphasis>unspecified</emphasis></type><template> 1257 <template-type-parameter name="CharT"/> 1258 </template><parameter name="max_size"><paramtype>std::size_t</paramtype><description><para>The maximum number of characters (i.e. string element objects) that the decorated formatter can produce. </para></description></parameter><parameter name="overflow_marker"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>The marker string which is appended to the output if the <emphasis>max_size</emphasis> limit is exceeded.</para></description></parameter><description><para>The function returns a decorator generator object. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator.</para><para> 1259 1260</para></description><requires><para>The <emphasis>overflow_marker</emphasis> length must not exceed the <emphasis>max_size</emphasis> limit. </para> 1261</requires></function> 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276</namespace> 1277 1278 1279</namespace> 1280</namespace> 1281</header> 1282<header name="boost/log/expressions/formatters/named_scope.hpp"> 1283<para><para>Andrey Semashev </para> 1284 1285<para>11.11.2012</para> 1286 1287The header contains a formatter function for named scope attribute values. </para><namespace name="boost"> 1288<namespace name="log"> 1289<namespace name="expressions"> 1290<class name="format_named_scope_actor"><template> 1291 <template-type-parameter name="FallbackPolicyT"/> 1292 <template-type-parameter name="CharT"/> 1293 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 1294 </template><inherit access="public">ActorT< format_named_scope_terminal< FallbackPolicyT, CharT > ></inherit><description><para>Named scope formatter actor. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 1295<typedef name="fallback_policy"><purpose>Fallback policy. </purpose><type>FallbackPolicyT</type></typedef> 1296<typedef name="terminal_type"><purpose>Base terminal type. </purpose><type><classname>format_named_scope_terminal</classname>< fallback_policy, char_type ></type></typedef> 1297<typedef name="value_type"><purpose>Attribute value type. </purpose><type>terminal_type::value_type</type></typedef> 1298<typedef name="formatter_function_type"><purpose>Formatter function. </purpose><type>terminal_type::formatter_function_type</type></typedef> 1299<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 1300<method-group name="public member functions"> 1301<method name="get_name" cv="const"><type>attribute_name</type><description><para> 1302</para></description><returns><para>The attribute name </para> 1303</returns></method> 1304<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><description><para> 1305</para></description><returns><para>Fallback policy </para> 1306</returns></method> 1307<method name="get_formatter_function" cv="const"><type>formatter_function_type const &</type><description><para> 1308</para></description><returns><para>Formatter function </para> 1309</returns></method> 1310</method-group> 1311<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 1312</class><class name="format_named_scope_terminal"><template> 1313 <template-type-parameter name="FallbackPolicyT"/> 1314 <template-type-parameter name="CharT"/> 1315 </template><description><para>Named scope formatter terminal. </para></description><typedef name="value_type"><purpose>Attribute value type. </purpose><type>attributes::named_scope::value_type</type></typedef> 1316<typedef name="fallback_policy"><purpose>Fallback policy. </purpose><type>FallbackPolicyT</type></typedef> 1317<typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 1318<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 1319<typedef name="stream_type"><purpose>Formatting stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 1320<typedef name="formatter_function_type"><purpose>Formatter function. </purpose><type><emphasis>unspecified</emphasis></type></typedef> 1321<typedef name="result_type"><purpose>Function result type. </purpose><type>string_type</type></typedef> 1322<method-group name="public member functions"> 1323<method name="get_name" cv="const"><type>attribute_name</type><purpose>Returns attribute name. </purpose></method> 1324<method name="get_fallback_policy" cv="const"><type>fallback_policy const &</type><purpose>Returns fallback policy. </purpose></method> 1325<method name="get_formatter_function" cv="const"><type>formatter_function_type const &</type><purpose>Retruns formatter function. </purpose></method> 1326<method name="operator()"><type>result_type</type><template> 1327 <template-type-parameter name="ContextT"/> 1328 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 1329<method name="operator()" cv="const"><type>result_type</type><template> 1330 <template-type-parameter name="ContextT"/> 1331 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 1332</method-group> 1333<constructor><template> 1334 <template-type-parameter name="FormatT"/> 1335 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="fallback"><paramtype>fallback_policy const &</paramtype></parameter><parameter name="element_format"><paramtype>FormatT const &</paramtype></parameter><parameter name="delimiter"><paramtype>string_type const &</paramtype></parameter><parameter name="incomplete_marker"><paramtype>string_type const &</paramtype></parameter><parameter name="empty_marker"><paramtype>string_type const &</paramtype></parameter><parameter name="depth"><paramtype>value_type::size_type</paramtype></parameter><parameter name="direction"><paramtype>scope_iteration_direction</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 1336<constructor><parameter name="that"><paramtype><classname>format_named_scope_terminal</classname> const &</paramtype></parameter><purpose>Copy constructor. </purpose></constructor> 1337<constructor cv="= delete"/> 1338</class><enum name="scope_iteration_direction"><enumvalue name="forward"><purpose>Iterate through scopes from outermost to innermost. </purpose></enumvalue><enumvalue name="reverse"><purpose>Iterate through scopes from innermost to outermost. </purpose></enumvalue><purpose>Scope iteration directions. </purpose></enum> 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< fallback_to_none, CharT ></type><template> 1383 <template-type-parameter name="CharT"/> 1384 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="element_format"><paramtype>const CharT *</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1385</para></description></function> 1386<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< fallback_to_none, CharT ></type><template> 1387 <template-type-parameter name="CharT"/> 1388 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="element_format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1389</para></description></function> 1390<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< fallback_to_none, CharT, ActorT ></type><template> 1391 <template-type-parameter name="DescriptorT"/> 1392 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1393 <template-type-parameter name="CharT"/> 1394 </template><parameter name="keyword"><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype><description><para>Attribute keyword </para></description></parameter><parameter name="element_format"><paramtype>const CharT *</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1395</para></description></function> 1396<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< fallback_to_none, CharT, ActorT ></type><template> 1397 <template-type-parameter name="DescriptorT"/> 1398 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1399 <template-type-parameter name="CharT"/> 1400 </template><parameter name="keyword"><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype><description><para>Attribute keyword </para></description></parameter><parameter name="element_format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1401</para></description></function> 1402<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< FallbackPolicyT, CharT, ActorT ></type><template> 1403 <template-type-parameter name="T"/> 1404 <template-type-parameter name="FallbackPolicyT"/> 1405 <template-type-parameter name="TagT"/> 1406 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1407 <template-type-parameter name="CharT"/> 1408 </template><parameter name="placeholder"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype><description><para>Attribute placeholder </para></description></parameter><parameter name="element_format"><paramtype>const CharT *</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1409</para></description></function> 1410<function name="format_named_scope"><type><classname>format_named_scope_actor</classname>< FallbackPolicyT, CharT, ActorT ></type><template> 1411 <template-type-parameter name="T"/> 1412 <template-type-parameter name="FallbackPolicyT"/> 1413 <template-type-parameter name="TagT"/> 1414 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1415 <template-type-parameter name="CharT"/> 1416 </template><parameter name="placeholder"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype><description><para>Attribute placeholder </para></description></parameter><parameter name="element_format"><paramtype>std::basic_string< CharT > const &</paramtype><description><para>Format string for a single named scope </para></description></parameter><description><para>The function generates a manipulator node in a template expression. The manipulator must participate in a formatting expression (stream output or <computeroutput>format</computeroutput> placeholder filler).</para><para> 1417</para></description></function> 1418<overloaded-function name="format_named_scope"><signature><type>unspecified</type><template> 1419 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 1420 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="args"><paramtype>ArgsT... const &</paramtype><description><para>An set of named parameters. Supported parameters: <itemizedlist> 1421<listitem><para><computeroutput>format</computeroutput> - A format string for named scopes. The string can contain "%n", "%f" and "%l" placeholders for the scope name, file and line number, respectively. This parameter is mandatory. </para> 1422</listitem> 1423<listitem><para><computeroutput>delimiter</computeroutput> - A string that is used to delimit the formatted scope names. Default: "->" or "<-", depending on the iteration direction. </para> 1424</listitem> 1425<listitem><para><computeroutput>incomplete_marker</computeroutput> - A string that is used to indicate that the list was printed incomplete because of depth limitation. Default: "...". </para> 1426</listitem> 1427<listitem><para><computeroutput>empty_marker</computeroutput> - A string that is output in case if the scope list is empty. Default: "", i.e. nothing is output. </para> 1428</listitem> 1429<listitem><para><computeroutput>iteration</computeroutput> - Iteration direction, see <computeroutput>scope_iteration_direction</computeroutput> enumeration. Default: forward. </para> 1430</listitem> 1431<listitem><para><computeroutput>depth</computeroutput> - Iteration depth. Default: unlimited. </para> 1432</listitem> 1433</itemizedlist> 1434</para></description></parameter></signature><signature><type>unspecified</type><template> 1435 <template-type-parameter name="DescriptorT"/> 1436 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1437 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 1438 </template><parameter name="keyword"><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="args"><paramtype>ArgsT... const &</paramtype></parameter></signature><signature><type>unspecified</type><template> 1439 <template-type-parameter name="T"/> 1440 <template-type-parameter name="FallbackPolicyT"/> 1441 <template-type-parameter name="TagT"/> 1442 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1443 <template-nontype-parameter name="ArgsT"><type>typename...</type></template-nontype-parameter> 1444 </template><parameter name="placeholder"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="args"><paramtype>ArgsT... const &</paramtype></parameter></signature><description><para>Formatter generator. Construct the named scope formatter with the specified formatting parameters.</para><para> 1445</para></description></overloaded-function> 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465</namespace> 1466 1467 1468</namespace> 1469</namespace> 1470</header> 1471<header name="boost/log/expressions/formatters/stream.hpp"> 1472<para><para>Andrey Semashev </para> 1473 1474<para>24.07.2012</para> 1475 1476The header contains implementation of a stream placeholder in template expressions. </para><namespace name="boost"> 1477<namespace name="log"> 1478<namespace name="expressions"> 1479<typedef name="stream_type"><description><para>Stream placeholder type in formatter template expressions. </para></description><type>phoenix::expression::argument< 2 >::type</type></typedef> 1480<data-member name="stream"><type>const stream_type</type><description><para>Stream placeholder in formatter template expressions. </para></description></data-member> 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550</namespace> 1551 1552 1553</namespace> 1554</namespace> 1555</header> 1556<header name="boost/log/expressions/formatters/wrap_formatter.hpp"> 1557<para><para>Andrey Semashev </para> 1558 1559<para>24.11.2012</para> 1560 1561The header contains a formatter function wrapper that enables third-party functions to participate in formatting expressions. </para><namespace name="boost"> 1562<namespace name="log"> 1563<namespace name="expressions"> 1564<class name="wrapped_formatter_actor"><template> 1565 <template-type-parameter name="FunT"/> 1566 <template-type-parameter name="CharT"/> 1567 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 1568 </template><inherit access="public">ActorT< wrapped_formatter_terminal< FunT, CharT > ></inherit><description><para>Wrapped formatter function actor. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 1569<typedef name="function_type"><purpose>Wrapped function type. </purpose><type>FunT</type></typedef> 1570<typedef name="terminal_type"><purpose>Base terminal type. </purpose><type><classname>wrapped_formatter_terminal</classname>< function_type, char_type ></type></typedef> 1571<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 1572<method-group name="public member functions"> 1573<method name="get_function" cv="const"><type>function_type const &</type><description><para> 1574</para></description><returns><para>The wrapped function </para> 1575</returns></method> 1576</method-group> 1577<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 1578</class><class name="wrapped_formatter_terminal"><template> 1579 <template-type-parameter name="FunT"/> 1580 <template-type-parameter name="CharT"/> 1581 </template><description><para>Formatter function wrapper terminal. </para></description><typedef name="char_type"><purpose>Character type. </purpose><type>CharT</type></typedef> 1582<typedef name="string_type"><purpose>String type. </purpose><type>std::basic_string< char_type ></type></typedef> 1583<typedef name="stream_type"><purpose>Formatting stream type. </purpose><type>basic_formatting_ostream< char_type ></type></typedef> 1584<typedef name="function_type"><purpose>Wrapped function type. </purpose><type>FunT</type></typedef> 1585<typedef name="result_type"><purpose>Formatter result type. </purpose><type>string_type</type></typedef> 1586<method-group name="public member functions"> 1587<method name="get_function" cv="const"><type>function_type const &</type><purpose>Returns the wrapped function. </purpose></method> 1588<method name="operator()"><type>result_type</type><template> 1589 <template-type-parameter name="ContextT"/> 1590 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 1591<method name="operator()" cv="const"><type>result_type</type><template> 1592 <template-type-parameter name="ContextT"/> 1593 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 1594</method-group> 1595<constructor specifiers="explicit"><parameter name="fun"><paramtype>function_type const &</paramtype></parameter><purpose>Initializing construction. </purpose></constructor> 1596<constructor><parameter name="that"><paramtype><classname>wrapped_formatter_terminal</classname> const &</paramtype></parameter><purpose>Copy constructor. </purpose></constructor> 1597</class> 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638<function name="wrap_formatter"><type><emphasis>unspecified</emphasis></type><template> 1639 <template-type-parameter name="FunT"/> 1640 </template><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>The function wraps a function object in order it to be able to participate in formatting expressions. The wrapped function object must be compatible with the following signature:</para><programlisting> 1641void (record_view const&, basic_formatting_ostream< CharT >&) 1642</programlisting><para>where <computeroutput>CharT</computeroutput> is the character type of the formatting expression. </para></description></function> 1643<function name="wrap_formatter"><type><classname>wrapped_formatter_actor</classname>< FunT, CharT ></type><template> 1644 <template-type-parameter name="CharT"/> 1645 <template-type-parameter name="FunT"/> 1646 </template><parameter name="fun"><paramtype>FunT const &</paramtype></parameter><description><para>The function wraps a function object in order it to be able to participate in formatting expressions. The wrapped function object must be compatible with the following signature:</para><programlisting> 1647void (record_view const&, basic_formatting_ostream< CharT >&) 1648</programlisting><para>where <computeroutput>CharT</computeroutput> is the character type of the formatting expression. </para></description></function> 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675</namespace> 1676 1677 1678</namespace> 1679</namespace> 1680</header> 1681<header name="boost/log/expressions/formatters/xml_decorator.hpp"> 1682<para><para>Andrey Semashev </para> 1683 1684<para>18.11.2012</para> 1685 1686The header contains implementation of a XML-style character decorator. </para><namespace name="boost"> 1687<namespace name="log"> 1688<namespace name="expressions"> 1689<data-member name="xml_decor"><type><emphasis>unspecified</emphasis></type><description><para>XML-style decorator generator object. The decorator replaces characters that have special meaning in XML documents with the corresponding decorated counterparts. The generator provides <computeroutput>operator[]</computeroutput> that can be used to construct the actual decorator. For example:</para><para><computeroutput> xml_decor[ stream << attr< std::string >("MyAttr") ] </computeroutput></para><para>For wide-character formatting there is the similar <computeroutput>wxml_decor</computeroutput> decorator generator object. </para></description></data-member> 1690<data-member name="wxml_decor"><type><emphasis>unspecified</emphasis></type></data-member> 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731<function name="make_xml_decor"><type><emphasis>unspecified</emphasis></type><template> 1732 <template-type-parameter name="CharT"/> 1733 </template><description><para>The function creates an XML-style decorator generator for arbitrary character type. </para></description></function> 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762</namespace> 1763 1764 1765</namespace> 1766</namespace> 1767</header> 1768<header name="boost/log/expressions/is_keyword_descriptor.hpp"> 1769<para><para>Andrey Semashev </para> 1770 1771<para>14.07.2012</para> 1772 1773The header contains attribute keyword descriptor detection trait. </para><namespace name="boost"> 1774<namespace name="log"> 1775<namespace name="expressions"> 1776<struct name="is_keyword_descriptor"><template> 1777 <template-type-parameter name="T"/> 1778 <template-type-parameter name="VoidT"><default>void</default></template-type-parameter> 1779 </template><inherit access="public">false_</inherit><description><para>The metafunction detects if the type <computeroutput>T</computeroutput> is a keyword descriptor </para></description></struct><struct name="keyword_descriptor"><description><para>Base class for keyword descriptors. All keyword descriptors must derive from this class to support the <computeroutput><classname alt="boost::log::expressions::is_keyword_descriptor">is_keyword_descriptor</classname></computeroutput> trait. </para></description></struct> 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848</namespace> 1849 1850 1851</namespace> 1852</namespace> 1853</header> 1854<header name="boost/log/expressions/keyword.hpp"> 1855<para><para>Andrey Semashev </para> 1856 1857<para>29.01.2012</para> 1858 1859The header contains attribute keyword declaration. </para><namespace name="boost"> 1860<namespace name="log"> 1861<namespace name="expressions"> 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931</namespace> 1932 1933 1934</namespace> 1935</namespace> 1936<macro name="BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE" kind="functionlike"><macro-parameter name="keyword_"><description><para>Keyword name </para></description></macro-parameter><macro-parameter name="name_"><description><para>Attribute name string </para></description></macro-parameter><macro-parameter name="value_type_"><description><para>Attribute value type </para></description></macro-parameter><purpose>The macro declares an attribute keyword type. </purpose><description><para>The macro should be used at a namespace scope. It expands into an attribute keyword type definition, including the <computeroutput>tag</computeroutput> namespace and the keyword tag type within which has the following layout:</para><para><programlisting language="c++">namespace tag 1937{ 1938 struct keyword_ : 1939 public boost::log::expressions::keyword_descriptor 1940 { 1941 typedef value_type_ value_type; 1942 static boost::log::attribute_name get_name(); 1943 }; 1944} 1945 1946typedef boost::log::expressions::attribute_keyword< tag::keyword_ > keyword_type; 1947</programlisting></para><para>The <computeroutput>get_name</computeroutput> method returns the attribute name.</para><para><note><para>This macro only defines the type of the keyword. To also define the keyword object, use the <computeroutput>BOOST_LOG_ATTRIBUTE_KEYWORD</computeroutput> macro instead.</para> 1948</note> 1949 1950</para></description></macro> 1951<macro name="BOOST_LOG_ATTRIBUTE_KEYWORD" kind="functionlike"><macro-parameter name="keyword_"><description><para>Keyword name </para></description></macro-parameter><macro-parameter name="name_"><description><para>Attribute name string </para></description></macro-parameter><macro-parameter name="value_type_"><description><para>Attribute value type </para></description></macro-parameter><purpose>The macro declares an attribute keyword. </purpose><description><para>The macro provides definitions similar to <computeroutput>BOOST_LOG_ATTRIBUTE_KEYWORD_TYPE</computeroutput> and additionally defines the keyword object.</para><para> 1952</para></description></macro> 1953</header> 1954<header name="boost/log/expressions/keyword_fwd.hpp"> 1955<para><para>Andrey Semashev </para> 1956 1957<para>29.01.2012</para> 1958 1959The header contains attribute keyword forward declaration. </para><namespace name="boost"> 1960<namespace name="log"> 1961<namespace name="expressions"> 1962<struct name="attribute_keyword"><template> 1963 <template-type-parameter name="DescriptorT"/> 1964 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 1965 </template><purpose>This class implements an expression template keyword. </purpose><description><para>This class implements an expression template keyword. It is used to start template expressions involving attribute values. </para></description><method-group name="public static functions"> 1966<method name="get_name" specifiers="static"><type>attribute_name</type><purpose>Returns attribute name. </purpose></method> 1967<method name="or_none" specifiers="static"><type>or_none_result_type</type><purpose>Generates an expression that extracts the attribute value or a default value. </purpose></method> 1968<method name="or_throw" specifiers="static"><type>or_throw_result_type</type><purpose>Generates an expression that extracts the attribute value or throws an exception. </purpose></method> 1969<method name="or_default" specifiers="static"><type><classname>attribute_actor</classname>< value_type, fallback_to_default< DefaultT >, descriptor_type, ActorT ></type><template> 1970 <template-type-parameter name="DefaultT"/> 1971 </template><parameter name="def_val"><paramtype>DefaultT const &</paramtype></parameter><purpose>Generates an expression that extracts the attribute value or a default value. </purpose></method> 1972</method-group> 1973</struct> 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042</namespace> 2043 2044 2045</namespace> 2046</namespace> 2047</header> 2048<header name="boost/log/expressions/message.hpp"> 2049<para><para>Andrey Semashev </para> 2050 2051<para>13.07.2012</para> 2052 2053The header contains log message keyword declaration. </para><namespace name="boost"> 2054<namespace name="log"> 2055<namespace name="expressions"> 2056<namespace name="tag"> 2057<struct name="message"><inherit access="public">keyword_descriptor</inherit><description><para>Generic log message attribute descriptor. </para></description><typedef name="attribute_type"><type>void</type></typedef> 2058<typedef name="value_type"><type>mpl::vector2< std::string, std::wstring ></type></typedef> 2059<method-group name="public static functions"> 2060<method name="get_name" specifiers="static"><type>attribute_name</type></method> 2061</method-group> 2062</struct><struct name="smessage"><inherit access="public">keyword_descriptor</inherit><description><para>Narrow character log message attribute descriptor. </para></description><typedef name="attribute_type"><type>void</type></typedef> 2063<typedef name="value_type"><type>std::string</type></typedef> 2064<method-group name="public static functions"> 2065<method name="get_name" specifiers="static"><type>attribute_name</type></method> 2066</method-group> 2067</struct><struct name="wmessage"><inherit access="public">keyword_descriptor</inherit><description><para>Wide character log message attribute descriptor. </para></description><typedef name="attribute_type"><type>void</type></typedef> 2068<typedef name="value_type"><type>std::wstring</type></typedef> 2069<method-group name="public static functions"> 2070<method name="get_name" specifiers="static"><type>attribute_name</type></method> 2071</method-group> 2072</struct></namespace> 2073<typedef name="message_type"><description><para>Generic message keyword type. </para></description><type><classname>attribute_keyword</classname>< <classname>tag::message</classname> ></type></typedef> 2074<typedef name="smessage_type"><description><para>Narrow message keyword type. </para></description><type><classname>attribute_keyword</classname>< <classname>tag::smessage</classname> ></type></typedef> 2075<typedef name="wmessage_type"><description><para>Wide message keyword type. </para></description><type><classname>attribute_keyword</classname>< <classname>tag::wmessage</classname> ></type></typedef> 2076<data-member name="message"><type>const message_type</type><description><para>Generic message keyword. </para></description></data-member> 2077<data-member name="smessage"><type>const smessage_type</type><description><para>Narrow message keyword. </para></description></data-member> 2078<data-member name="wmessage"><type>const wmessage_type</type><description><para>Wide message keyword. </para></description></data-member> 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148</namespace> 2149 2150 2151</namespace> 2152</namespace> 2153</header> 2154<header name="boost/log/expressions/predicates.hpp"> 2155<para><para>Andrey Semashev </para> 2156 2157<para>29.01.2012</para> 2158 2159The header includes all template expression predicates. </para></header> 2160<header name="boost/log/expressions/predicates/begins_with.hpp"> 2161<para><para>Andrey Semashev </para> 2162 2163<para>02.09.2012</para> 2164 2165The header contains implementation of a <computeroutput>begins_with</computeroutput> predicate in template expressions. </para><namespace name="boost"> 2166<namespace name="log"> 2167<namespace name="expressions"> 2168<typedef name="attribute_begins_with"><description><para>The predicate checks if the attribute value begins with a substring. The attribute value is assumed to be of a string type. </para></description><type><emphasis>unspecified</emphasis></type></typedef> 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206<function name="begins_with"><type><emphasis>unspecified</emphasis></type><template> 2207 <template-type-parameter name="T"/> 2208 <template-type-parameter name="FallbackPolicyT"/> 2209 <template-type-parameter name="TagT"/> 2210 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2211 <template-type-parameter name="SubstringT"/> 2212 </template><parameter name="attr"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, begins with the specified substring. </para></description></function> 2213<function name="begins_with"><type><emphasis>unspecified</emphasis></type><template> 2214 <template-type-parameter name="DescriptorT"/> 2215 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2216 <template-type-parameter name="SubstringT"/> 2217 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, begins with the specified substring. </para></description></function> 2218<function name="begins_with"><type><emphasis>unspecified</emphasis></type><template> 2219 <template-type-parameter name="T"/> 2220 <template-type-parameter name="SubstringT"/> 2221 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, begins with the specified substring. </para></description></function> 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251</namespace> 2252 2253 2254</namespace> 2255</namespace> 2256</header> 2257<header name="boost/log/expressions/predicates/channel_severity_filter.hpp"> 2258<para><para>Andrey Semashev </para> 2259 2260<para>25.11.2012</para> 2261 2262The header contains implementation of a minimal severity per channel filter. </para><namespace name="boost"> 2263<namespace name="log"> 2264<namespace name="expressions"> 2265<class name="channel_severity_filter_actor"><template> 2266 <template-type-parameter name="ChannelT"/> 2267 <template-type-parameter name="SeverityT"/> 2268 <template-type-parameter name="ChannelFallbackT"><default>fallback_to_none</default></template-type-parameter> 2269 <template-type-parameter name="SeverityFallbackT"><default>fallback_to_none</default></template-type-parameter> 2270 <template-type-parameter name="ChannelOrderT"><default>less</default></template-type-parameter> 2271 <template-type-parameter name="SeverityCompareT"><default>greater_equal</default></template-type-parameter> 2272 <template-type-parameter name="AllocatorT"><default>std::allocator< void ></default></template-type-parameter> 2273 <template-nontype-parameter name="ActorT"><type>template< typename > class</type><default>phoenix::actor</default></template-nontype-parameter> 2274 </template><inherit access="public">ActorT< channel_severity_filter_terminal< ChannelT, SeverityT, ChannelFallbackT, SeverityFallbackT, ChannelOrderT, SeverityCompareT, AllocatorT > ></inherit><class name="subscript_result"><purpose>An auxiliary pseudo-reference to implement insertion through subscript operator. </purpose><method-group name="public member functions"> 2275</method-group> 2276<constructor><parameter name="owner"><paramtype>channel_severity_filter_actor &</paramtype></parameter><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter></constructor> 2277<copy-assignment><type>void</type><parameter name="severity"><paramtype>severity_value_type const &</paramtype></parameter></copy-assignment> 2278</class><typedef name="terminal_type"><purpose>Terminal type. </purpose><type>channel_severity_filter_terminal< ChannelT, SeverityT, ChannelFallbackT, SeverityFallbackT, ChannelOrderT, SeverityCompareT, AllocatorT ></type></typedef> 2279<typedef name="base_type"><purpose>Base actor type. </purpose><type>ActorT< terminal_type ></type></typedef> 2280<typedef name="channel_value_type"><purpose>Channel attribute value type. </purpose><type>terminal_type::channel_value_type</type></typedef> 2281<typedef name="channel_fallback_policy"><purpose>Channel fallback policy. </purpose><type>terminal_type::channel_fallback_policy</type></typedef> 2282<typedef name="severity_value_type"><purpose>Severity level attribute value type. </purpose><type>terminal_type::severity_value_type</type></typedef> 2283<typedef name="severity_fallback_policy"><purpose>Severity level fallback policy. </purpose><type>terminal_type::severity_fallback_policy</type></typedef> 2284<method-group name="public member functions"> 2285<method name="set_default"><type>this_type &</type><parameter name="def"><paramtype>bool</paramtype></parameter><purpose>Sets the default function result. </purpose></method> 2286<method name="add"><type>this_type &</type><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter><parameter name="severity"><paramtype>severity_value_type const &</paramtype></parameter><purpose>Adds a new element to the mapping. </purpose></method> 2287<method name="operator[]"><type>subscript_result</type><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter><purpose>Alternative interface for adding a new element to the mapping. </purpose></method> 2288</method-group> 2289<constructor specifiers="explicit"><parameter name="act"><paramtype>base_type const &</paramtype></parameter><purpose>Initializing constructor. </purpose></constructor> 2290<constructor><parameter name="that"><paramtype>channel_severity_filter_actor const &</paramtype></parameter><purpose>Copy constructor. </purpose></constructor> 2291</class><class name="channel_severity_filter_terminal"><template> 2292 <template-type-parameter name="ChannelT"/> 2293 <template-type-parameter name="SeverityT"/> 2294 <template-type-parameter name="ChannelFallbackT"><default>fallback_to_none</default></template-type-parameter> 2295 <template-type-parameter name="SeverityFallbackT"><default>fallback_to_none</default></template-type-parameter> 2296 <template-type-parameter name="ChannelOrderT"><default>less</default></template-type-parameter> 2297 <template-type-parameter name="SeverityCompareT"><default>greater_equal</default></template-type-parameter> 2298 <template-type-parameter name="AllocatorT"><default>std::allocator< void ></default></template-type-parameter> 2299 </template><struct name="channel_visitor"><template> 2300 <template-type-parameter name="ArgT"/> 2301 </template><purpose>Channel visitor. </purpose><typedef name="result_type"><type>void</type></typedef> 2302<method-group name="public member functions"> 2303<method name="operator()" cv="const"><type>result_type</type><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter></method> 2304</method-group> 2305<constructor><parameter name="self"><paramtype>channel_severity_filter_terminal const &</paramtype></parameter><parameter name="arg"><paramtype>ArgT</paramtype></parameter><parameter name="res"><paramtype>bool &</paramtype></parameter></constructor> 2306</struct><struct name="severity_visitor"><purpose>Severity level visitor. </purpose><typedef name="result_type"><type>void</type></typedef> 2307<method-group name="public member functions"> 2308<method name="operator()" cv="const"><type>result_type</type><parameter name="severity"><paramtype>severity_value_type const &</paramtype></parameter></method> 2309</method-group> 2310<constructor><parameter name="self"><paramtype>channel_severity_filter_terminal const &</paramtype></parameter><parameter name="severity"><paramtype>severity_value_type const &</paramtype></parameter><parameter name="res"><paramtype>bool &</paramtype></parameter></constructor> 2311</struct><typedef name="result_type"><purpose>Function result type. </purpose><type>bool</type></typedef> 2312<typedef name="channel_value_type"><purpose>Channel attribute value type. </purpose><type>ChannelT</type></typedef> 2313<typedef name="channel_fallback_policy"><purpose>Channel fallback policy. </purpose><type>ChannelFallbackT</type></typedef> 2314<typedef name="severity_value_type"><purpose>Severity level attribute value type. </purpose><type>SeverityT</type></typedef> 2315<typedef name="severity_fallback_policy"><purpose>Severity level fallback policy. </purpose><type>SeverityFallbackT</type></typedef> 2316<method-group name="public member functions"> 2317<method name="add"><type>void</type><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter><parameter name="severity"><paramtype>severity_value_type const &</paramtype></parameter><purpose>Adds a new element to the mapping. </purpose></method> 2318<method name="set_default"><type>void</type><parameter name="def"><paramtype>bool</paramtype></parameter><purpose>Sets the default result of the predicate. </purpose></method> 2319<method name="operator()" cv="const"><type>result_type</type><template> 2320 <template-type-parameter name="ContextT"/> 2321 </template><parameter name="ctx"><paramtype>ContextT const &</paramtype></parameter><purpose>Invokation operator. </purpose></method> 2322</method-group> 2323<constructor><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="channel_fallback"><paramtype>channel_fallback_policy const &</paramtype><default>channel_fallback_policy()</default></parameter><parameter name="severity_fallback"><paramtype>severity_fallback_policy const &</paramtype><default>severity_fallback_policy()</default></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype><default>ChannelOrderT()</default></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype><default>SeverityCompareT()</default></parameter><purpose>Initializing constructor. </purpose></constructor> 2324<method-group name="private member functions"> 2325<method name="visit_channel" cv="const"><type>void</type><template> 2326 <template-type-parameter name="ArgT"/> 2327 </template><parameter name="channel"><paramtype>channel_value_type const &</paramtype></parameter><parameter name="arg"><paramtype>ArgT const &</paramtype></parameter><parameter name="res"><paramtype>bool &</paramtype></parameter><purpose>Visits channel name. </purpose></method> 2328<method name="visit_severity" cv="const"><type>void</type><parameter name="left"><paramtype>severity_value_type const &</paramtype></parameter><parameter name="right"><paramtype>severity_value_type const &</paramtype></parameter><parameter name="res"><paramtype>bool &</paramtype></parameter><purpose>Visits severity level. </purpose></method> 2329</method-group> 2330</class> 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346<overloaded-function name="channel_severity_filter"><signature><type>channel_severity_filter_actor< ChannelT, SeverityT ></type><template> 2347 <template-type-parameter name="ChannelT"/> 2348 <template-type-parameter name="SeverityT"/> 2349 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, SeverityT, fallback_to_none, fallback_to_none, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2350 <template-type-parameter name="SeverityT"/> 2351 <template-type-parameter name="ChannelDescriptorT"/> 2352 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2353 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2354 <template-type-parameter name="ChannelT"/> 2355 <template-type-parameter name="SeverityDescriptorT"/> 2356 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2357 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2358 <template-type-parameter name="ChannelDescriptorT"/> 2359 <template-type-parameter name="SeverityDescriptorT"/> 2360 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2361 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, fallback_to_none, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2362 <template-type-parameter name="SeverityT"/> 2363 <template-type-parameter name="ChannelT"/> 2364 <template-type-parameter name="ChannelFallbackT"/> 2365 <template-type-parameter name="ChannelTagT"/> 2366 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2367 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, fallback_to_none, SeverityFallbackT, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2368 <template-type-parameter name="ChannelT"/> 2369 <template-type-parameter name="SeverityT"/> 2370 <template-type-parameter name="SeverityFallbackT"/> 2371 <template-type-parameter name="SeverityTagT"/> 2372 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2373 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, SeverityFallbackT, less, greater_equal, std::allocator< void >, ActorT ></type><template> 2374 <template-type-parameter name="ChannelT"/> 2375 <template-type-parameter name="ChannelFallbackT"/> 2376 <template-type-parameter name="ChannelTagT"/> 2377 <template-type-parameter name="SeverityT"/> 2378 <template-type-parameter name="SeverityFallbackT"/> 2379 <template-type-parameter name="SeverityTagT"/> 2380 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2381 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, fallback_to_none, fallback_to_none, less, SeverityCompareT ></type><template> 2382 <template-type-parameter name="ChannelT"/> 2383 <template-type-parameter name="SeverityT"/> 2384 <template-type-parameter name="SeverityCompareT"/> 2385 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, SeverityT, fallback_to_none, fallback_to_none, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2386 <template-type-parameter name="SeverityT"/> 2387 <template-type-parameter name="ChannelDescriptorT"/> 2388 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2389 <template-type-parameter name="SeverityCompareT"/> 2390 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2391 <template-type-parameter name="ChannelT"/> 2392 <template-type-parameter name="SeverityDescriptorT"/> 2393 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2394 <template-type-parameter name="SeverityCompareT"/> 2395 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2396 <template-type-parameter name="ChannelDescriptorT"/> 2397 <template-type-parameter name="SeverityDescriptorT"/> 2398 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2399 <template-type-parameter name="SeverityCompareT"/> 2400 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, fallback_to_none, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2401 <template-type-parameter name="SeverityT"/> 2402 <template-type-parameter name="ChannelT"/> 2403 <template-type-parameter name="ChannelFallbackT"/> 2404 <template-type-parameter name="ChannelTagT"/> 2405 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2406 <template-type-parameter name="SeverityCompareT"/> 2407 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, fallback_to_none, SeverityFallbackT, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2408 <template-type-parameter name="ChannelT"/> 2409 <template-type-parameter name="SeverityT"/> 2410 <template-type-parameter name="SeverityFallbackT"/> 2411 <template-type-parameter name="SeverityTagT"/> 2412 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2413 <template-type-parameter name="SeverityCompareT"/> 2414 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, SeverityFallbackT, less, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2415 <template-type-parameter name="ChannelT"/> 2416 <template-type-parameter name="ChannelFallbackT"/> 2417 <template-type-parameter name="ChannelTagT"/> 2418 <template-type-parameter name="SeverityT"/> 2419 <template-type-parameter name="SeverityFallbackT"/> 2420 <template-type-parameter name="SeverityTagT"/> 2421 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2422 <template-type-parameter name="SeverityCompareT"/> 2423 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, fallback_to_none, fallback_to_none, ChannelOrderT, SeverityCompareT ></type><template> 2424 <template-type-parameter name="ChannelT"/> 2425 <template-type-parameter name="SeverityT"/> 2426 <template-type-parameter name="SeverityCompareT"/> 2427 <template-type-parameter name="ChannelOrderT"/> 2428 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, SeverityT, fallback_to_none, fallback_to_none, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2429 <template-type-parameter name="SeverityT"/> 2430 <template-type-parameter name="ChannelDescriptorT"/> 2431 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2432 <template-type-parameter name="SeverityCompareT"/> 2433 <template-type-parameter name="ChannelOrderT"/> 2434 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2435 <template-type-parameter name="ChannelT"/> 2436 <template-type-parameter name="SeverityDescriptorT"/> 2437 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2438 <template-type-parameter name="SeverityCompareT"/> 2439 <template-type-parameter name="ChannelOrderT"/> 2440 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< typename ChannelDescriptorT::value_type, typename SeverityDescriptorT::value_type, fallback_to_none, fallback_to_none, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2441 <template-type-parameter name="ChannelDescriptorT"/> 2442 <template-type-parameter name="SeverityDescriptorT"/> 2443 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2444 <template-type-parameter name="SeverityCompareT"/> 2445 <template-type-parameter name="ChannelOrderT"/> 2446 </template><parameter name="channel_keyword"><paramtype><classname>attribute_keyword</classname>< ChannelDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_keyword"><paramtype><classname>attribute_keyword</classname>< SeverityDescriptorT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, fallback_to_none, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2447 <template-type-parameter name="SeverityT"/> 2448 <template-type-parameter name="ChannelT"/> 2449 <template-type-parameter name="ChannelFallbackT"/> 2450 <template-type-parameter name="ChannelTagT"/> 2451 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2452 <template-type-parameter name="SeverityCompareT"/> 2453 <template-type-parameter name="ChannelOrderT"/> 2454 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, fallback_to_none, SeverityFallbackT, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2455 <template-type-parameter name="ChannelT"/> 2456 <template-type-parameter name="SeverityT"/> 2457 <template-type-parameter name="SeverityFallbackT"/> 2458 <template-type-parameter name="SeverityTagT"/> 2459 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2460 <template-type-parameter name="SeverityCompareT"/> 2461 <template-type-parameter name="ChannelOrderT"/> 2462 </template><parameter name="channel_name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><signature><type>channel_severity_filter_actor< ChannelT, SeverityT, ChannelFallbackT, SeverityFallbackT, ChannelOrderT, SeverityCompareT, std::allocator< void >, ActorT ></type><template> 2463 <template-type-parameter name="ChannelT"/> 2464 <template-type-parameter name="ChannelFallbackT"/> 2465 <template-type-parameter name="ChannelTagT"/> 2466 <template-type-parameter name="SeverityT"/> 2467 <template-type-parameter name="SeverityFallbackT"/> 2468 <template-type-parameter name="SeverityTagT"/> 2469 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2470 <template-type-parameter name="SeverityCompareT"/> 2471 <template-type-parameter name="ChannelOrderT"/> 2472 </template><parameter name="channel_placeholder"><paramtype><classname>attribute_actor</classname>< ChannelT, ChannelFallbackT, ChannelTagT, ActorT > const &</paramtype></parameter><parameter name="severity_placeholder"><paramtype><classname>attribute_actor</classname>< SeverityT, SeverityFallbackT, SeverityTagT, ActorT > const &</paramtype></parameter><parameter name="severity_compare"><paramtype>SeverityCompareT const &</paramtype></parameter><parameter name="channel_order"><paramtype>ChannelOrderT const &</paramtype></parameter></signature><description><para>The function generates a filtering predicate that checks the severity levels of log records in different channels. The predicate will return <computeroutput>true</computeroutput> if the record severity level is not less than the threshold for the channel the record belongs to. </para></description></overloaded-function> 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525</namespace> 2526 2527 2528</namespace> 2529</namespace> 2530</header> 2531<header name="boost/log/expressions/predicates/contains.hpp"> 2532<para><para>Andrey Semashev </para> 2533 2534<para>02.09.2012</para> 2535 2536The header contains implementation of a <computeroutput>contains</computeroutput> predicate in template expressions. </para><namespace name="boost"> 2537<namespace name="log"> 2538<namespace name="expressions"> 2539<typedef name="attribute_contains"><description><para>The predicate checks if the attribute value contains a substring. The attribute value is assumed to be of a string type. </para></description><type><emphasis>unspecified</emphasis></type></typedef> 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553<function name="contains"><type><emphasis>unspecified</emphasis></type><template> 2554 <template-type-parameter name="T"/> 2555 <template-type-parameter name="FallbackPolicyT"/> 2556 <template-type-parameter name="TagT"/> 2557 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2558 <template-type-parameter name="SubstringT"/> 2559 </template><parameter name="attr"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, contains the specified substring. </para></description></function> 2560<function name="contains"><type><emphasis>unspecified</emphasis></type><template> 2561 <template-type-parameter name="DescriptorT"/> 2562 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2563 <template-type-parameter name="SubstringT"/> 2564 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, contains the specified substring. </para></description></function> 2565<function name="contains"><type><emphasis>unspecified</emphasis></type><template> 2566 <template-type-parameter name="T"/> 2567 <template-type-parameter name="SubstringT"/> 2568 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, contains the specified substring. </para></description></function> 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622</namespace> 2623 2624 2625</namespace> 2626</namespace> 2627</header> 2628<header name="boost/log/expressions/predicates/ends_with.hpp"> 2629<para><para>Andrey Semashev </para> 2630 2631<para>02.09.2012</para> 2632 2633The header contains implementation of a <computeroutput>ends_with</computeroutput> predicate in template expressions. </para><namespace name="boost"> 2634<namespace name="log"> 2635<namespace name="expressions"> 2636<typedef name="attribute_ends_with"><description><para>The predicate checks if the attribute value ends with a substring. The attribute value is assumed to be of a string type. </para></description><type><emphasis>unspecified</emphasis></type></typedef> 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647<function name="ends_with"><type><emphasis>unspecified</emphasis></type><template> 2648 <template-type-parameter name="T"/> 2649 <template-type-parameter name="FallbackPolicyT"/> 2650 <template-type-parameter name="TagT"/> 2651 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2652 <template-type-parameter name="SubstringT"/> 2653 </template><parameter name="attr"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, ends with the specified substring. </para></description></function> 2654<function name="ends_with"><type><emphasis>unspecified</emphasis></type><template> 2655 <template-type-parameter name="DescriptorT"/> 2656 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2657 <template-type-parameter name="SubstringT"/> 2658 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, ends with the specified substring. </para></description></function> 2659<function name="ends_with"><type><emphasis>unspecified</emphasis></type><template> 2660 <template-type-parameter name="T"/> 2661 <template-type-parameter name="SubstringT"/> 2662 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="substring"><paramtype>SubstringT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, ends with the specified substring. </para></description></function> 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719</namespace> 2720 2721 2722</namespace> 2723</namespace> 2724</header> 2725<header name="boost/log/expressions/predicates/has_attr.hpp"> 2726<para><para>Andrey Semashev </para> 2727 2728<para>23.07.2012</para> 2729 2730The header contains implementation of a generic attribute presence checker in template expressions. </para><namespace name="boost"> 2731<namespace name="log"> 2732<namespace name="expressions"> 2733<class name="has_attribute"><template> 2734 <template-type-parameter name="T"/> 2735 </template><description><para>An attribute value presence checker. </para></description><typedef name="result_type"><purpose>Function result_type. </purpose><type>bool</type></typedef> 2736<typedef name="value_type"><purpose>Expected attribute value type. </purpose><type>T</type></typedef> 2737<method-group name="public member functions"> 2738<method name="operator()" cv="const"><type>result_type</type><template> 2739 <template-type-parameter name="ArgT"/> 2740 </template><parameter name="arg"><paramtype>ArgT const &</paramtype><description><para>A set of attribute values or a log record </para></description></parameter><description><para>Checking operator</para><para> 2741 2742</para></description><returns><para><computeroutput>true</computeroutput> if the log record contains the sought attribute value, <computeroutput>false</computeroutput> otherwise </para> 2743</returns></method> 2744</method-group> 2745<constructor specifiers="explicit"><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><description><para>Initializing constructor</para><para> 2746</para></description></constructor> 2747</class><class-specialization name="has_attribute"><template> 2748 </template><specialization><template-arg>void</template-arg></specialization><description><para>An attribute value presence checker. This specialization does not check the type of the attribute value. </para></description><typedef name="result_type"><purpose>Function result_type. </purpose><type>bool</type></typedef> 2749<typedef name="value_type"><purpose>Expected attribute value type. </purpose><type>void</type></typedef> 2750<method-group name="public member functions"> 2751<method name="operator()" cv="const"><type>result_type</type><parameter name="attrs"><paramtype>attribute_value_set const &</paramtype><description><para>A set of attribute values </para></description></parameter><description><para>Checking operator</para><para> 2752 2753</para></description><returns><para><computeroutput>true</computeroutput> if the log record contains the sought attribute value, <computeroutput>false</computeroutput> otherwise </para> 2754</returns></method> 2755<method name="operator()" cv="const"><type>result_type</type><parameter name="rec"><paramtype>boost::log::record_view const &</paramtype><description><para>A log record </para></description></parameter><description><para>Checking operator</para><para> 2756 2757</para></description><returns><para><computeroutput>true</computeroutput> if the log record contains the sought attribute value, <computeroutput>false</computeroutput> otherwise </para> 2758</returns></method> 2759</method-group> 2760<constructor specifiers="explicit"><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><description><para>Initializing constructor</para><para> 2761</para></description></constructor> 2762</class-specialization> 2763 2764 2765 2766 2767 2768 2769 2770<function name="has_attr"><type><emphasis>unspecified</emphasis></type><template> 2771 <template-type-parameter name="AttributeValueT"/> 2772 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check for the attribute value presence in a log record. The node will also check that the attribute value has the specified type, if present.</para><para>The function generates a terminal node in a template expression. The node will check for the attribute value presence in a log record. </para></description></function> 2773<function name="has_attr"><type><emphasis>unspecified</emphasis></type><template> 2774 <template-type-parameter name="DescriptorT"/> 2775 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2776 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check for the attribute value presence in a log record. The node will also check that the attribute value has the specified type, if present. </para></description></function> 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836</namespace> 2837 2838 2839</namespace> 2840</namespace> 2841</header> 2842<header name="boost/log/expressions/predicates/is_debugger_present.hpp"> 2843<para><para>Andrey Semashev </para> 2844 2845<para>05.12.2012</para> 2846 2847The header contains implementation of the <computeroutput>is_debugger_present</computeroutput> predicate in template expressions. </para></header> 2848<header name="boost/log/expressions/predicates/is_in_range.hpp"> 2849<para><para>Andrey Semashev </para> 2850 2851<para>02.09.2012</para> 2852 2853The header contains implementation of an <computeroutput>is_in_range</computeroutput> predicate in template expressions. </para><namespace name="boost"> 2854<namespace name="log"> 2855<namespace name="expressions"> 2856<typedef name="attribute_is_in_range"><description><para>The predicate checks if the attribute value contains a substring. The attribute value is assumed to be of a string type. </para></description><type><emphasis>unspecified</emphasis></type></typedef> 2857 2858 2859 2860 2861 2862<function name="is_in_range"><type><emphasis>unspecified</emphasis></type><template> 2863 <template-type-parameter name="T"/> 2864 <template-type-parameter name="FallbackPolicyT"/> 2865 <template-type-parameter name="TagT"/> 2866 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2867 <template-type-parameter name="BoundaryT"/> 2868 </template><parameter name="attr"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="least"><paramtype>BoundaryT const &</paramtype></parameter><parameter name="most"><paramtype>BoundaryT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value is in the specified range. The range must be half-open, that is the predicate will be equivalent to <computeroutput>least <= attr < most</computeroutput>. </para></description></function> 2869<function name="is_in_range"><type><emphasis>unspecified</emphasis></type><template> 2870 <template-type-parameter name="DescriptorT"/> 2871 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2872 <template-type-parameter name="BoundaryT"/> 2873 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="least"><paramtype>BoundaryT const &</paramtype></parameter><parameter name="most"><paramtype>BoundaryT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value is in the specified range. The range must be half-open, that is the predicate will be equivalent to <computeroutput>least <= attr < most</computeroutput>. </para></description></function> 2874<function name="is_in_range"><type><emphasis>unspecified</emphasis></type><template> 2875 <template-type-parameter name="T"/> 2876 <template-type-parameter name="BoundaryT"/> 2877 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="least"><paramtype>BoundaryT const &</paramtype></parameter><parameter name="most"><paramtype>BoundaryT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value is in the specified range. The range must be half-open, that is the predicate will be equivalent to <computeroutput>least <= attr < most</computeroutput>. </para></description></function> 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939</namespace> 2940 2941 2942</namespace> 2943</namespace> 2944</header> 2945<header name="boost/log/expressions/predicates/matches.hpp"> 2946<para><para>Andrey Semashev </para> 2947 2948<para>02.09.2012</para> 2949 2950The header contains implementation of a <computeroutput>matches</computeroutput> predicate in template expressions. </para><namespace name="boost"> 2951<namespace name="log"> 2952<namespace name="expressions"> 2953<class name="attribute_matches"><template> 2954 <template-type-parameter name="T"/> 2955 <template-type-parameter name="RegexT"/> 2956 <template-type-parameter name="FallbackPolicyT"><default>fallback_to_none</default></template-type-parameter> 2957 </template><description><para>The predicate checks if the attribute value matches a regular expression. The attribute value is assumed to be of a string type. </para></description><method-group name="public member functions"> 2958</method-group> 2959<constructor><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="rex"><paramtype>RegexT const &</paramtype><description><para>The regular expression to match the attribute value against </para></description></parameter><description><para>Initializing constructor</para><para> 2960</para></description></constructor> 2961<constructor><template> 2962 <template-type-parameter name="U"/> 2963 </template><parameter name="name"><paramtype>attribute_name const &</paramtype><description><para>Attribute name </para></description></parameter><parameter name="rex"><paramtype>RegexT const &</paramtype><description><para>The regular expression to match the attribute value against </para></description></parameter><parameter name="arg"><paramtype>U const &</paramtype><description><para>Additional parameter for the fallback policy </para></description></parameter><description><para>Initializing constructor</para><para> 2964</para></description></constructor> 2965</class> 2966 2967<function name="matches"><type><emphasis>unspecified</emphasis></type><template> 2968 <template-type-parameter name="T"/> 2969 <template-type-parameter name="FallbackPolicyT"/> 2970 <template-type-parameter name="TagT"/> 2971 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2972 <template-type-parameter name="RegexT"/> 2973 </template><parameter name="attr"><paramtype><classname>attribute_actor</classname>< T, FallbackPolicyT, TagT, ActorT > const &</paramtype></parameter><parameter name="rex"><paramtype>RegexT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, matches the specified regular expression. </para></description></function> 2974<function name="matches"><type><emphasis>unspecified</emphasis></type><template> 2975 <template-type-parameter name="DescriptorT"/> 2976 <template-nontype-parameter name="ActorT"><type>template< typename > class</type></template-nontype-parameter> 2977 <template-type-parameter name="RegexT"/> 2978 </template><parameter name=""><paramtype><classname>attribute_keyword</classname>< DescriptorT, ActorT > const &</paramtype></parameter><parameter name="rex"><paramtype>RegexT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, matches the specified regular expression. </para></description></function> 2979<function name="matches"><type><emphasis>unspecified</emphasis></type><template> 2980 <template-type-parameter name="T"/> 2981 <template-type-parameter name="RegexT"/> 2982 </template><parameter name="name"><paramtype>attribute_name const &</paramtype></parameter><parameter name="rex"><paramtype>RegexT const &</paramtype></parameter><description><para>The function generates a terminal node in a template expression. The node will check if the attribute value, which is assumed to be a string, matches the specified regular expression. </para></description></function> 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047</namespace> 3048 3049 3050</namespace> 3051</namespace> 3052<macro name="BOOST_LOG_AUX_FORCEINLINE_MSVC_BUG982738"/> 3053</header> 3054<header name="boost/log/expressions/record.hpp"> 3055<para><para>Andrey Semashev </para> 3056 3057<para>25.07.2012</para> 3058 3059The header contains implementation of a log record placeholder in template expressions. </para><namespace name="boost"> 3060<namespace name="log"> 3061<namespace name="expressions"> 3062<typedef name="record_type"><description><para>Log record placeholder type in formatter template expressions. </para></description><type>phoenix::expression::argument< 1 >::type</type></typedef> 3063<data-member name="record"><type>const record_type</type><description><para>Log record placeholder in formatter template expressions. </para></description></data-member> 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133</namespace> 3134 3135 3136</namespace> 3137</namespace> 3138</header> 3139</library-reference>