ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libecb/ecb.pod
(Generate patch)

Comparing libecb/ecb.pod (file contents):
Revision 1.77 by root, Mon Jan 20 13:41:18 2020 UTC vs.
Revision 1.81 by root, Mon Jan 20 21:01:29 2020 UTC

… …
110=item ECB_CPP11, ECB_CPP14, ECB_CPP17 110=item ECB_CPP11, ECB_CPP14, ECB_CPP17
111 111
112True if the implementation claims to be compliant to C++11/C++14/C++17 112True if the implementation claims to be compliant to C++11/C++14/C++17
113(ISO/IEC 14882:2011, :2014, :2017) or any later version. 113(ISO/IEC 14882:2011, :2014, :2017) or any later version.
114 114
115=item ECB_OPTIMIZE_SIZE
116
117Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
118can also be defined before including F<ecb.h>, in which case it will be
119unchanged.
120
115=item ECB_GCC_VERSION (major, minor) 121=item ECB_GCC_VERSION (major, minor)
116 122
117Expands to a true value (suitable for testing in by the preprocessor) 123Expands to a true value (suitable for testing in by the preprocessor)
118if the compiler used is GNU C and the version is the given version, or 124if the compiler used is GNU C and the version is the given version, or
119higher. 125higher.
… …
408 414
409=head2 OPTIMISATION HINTS 415=head2 OPTIMISATION HINTS
410 416
411=over 4 417=over 4
412 418
413=item ECB_OPTIMIZE_SIZE
414
415Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
416can also be defined before including F<ecb.h>, in which case it will be
417unchanged.
418
419=item bool ecb_is_constant (expr) 419=item bool ecb_is_constant (expr)
420 420
421Returns true iff the expression can be deduced to be a compile-time 421Returns true iff the expression can be deduced to be a compile-time
422constant, and false otherwise. 422constant, and false otherwise.
423 423
… …
694 694
695=item uint32_t ecb_bswap32 (uint32_t x) 695=item uint32_t ecb_bswap32 (uint32_t x)
696 696
697=item uint64_t ecb_bswap64 (uint64_t x) 697=item uint64_t ecb_bswap64 (uint64_t x)
698 698
699=item T ecb_bswap (T x)
700
699These functions return the value of the 16-bit (32-bit, 64-bit) value 701These functions return the value of the 16-bit (32-bit, 64-bit) value
700C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in 702C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
701C<ecb_bswap32>). 703C<ecb_bswap32>).
702 704
703The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>, 705The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>,
… …
754=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v) 756=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v)
755 757
756Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order. 758Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order.
757 759
758The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>, 760The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>,
759where be and le stand for big endian and little endian, respectively. 761where C<be> and C<le> stand for big endian and little endian, respectively.
760 762
761=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v) 763=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v)
762 764
763=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v) 765=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v)
764 766
… …
852 854
853In C++ the following additional template functions are supported: 855In C++ the following additional template functions are supported:
854 856
855=over 4 857=over 4
856 858
857=item T ecb_peek (const void *ptr) 859=item T ecb_peek<T> (const void *ptr)
858 860
859=item T ecb_peek_be (const void *ptr) 861=item T ecb_peek_be<T> (const void *ptr)
860 862
861=item T ecb_peek_le (const void *ptr) 863=item T ecb_peek_le<T> (const void *ptr)
862 864
863=item T ecb_peek_u (const void *ptr) 865=item T ecb_peek_u<T> (const void *ptr)
864 866
865=item T ecb_peek_be_u (const void *ptr) 867=item T ecb_peek_be_u<T> (const void *ptr)
866 868
867=item T ecb_peek_le_u (const void *ptr) 869=item T ecb_peek_le_u<T> (const void *ptr)
868 870
869Similarly to their C counterparts, these functions load an unsigned 8, 16, 871Similarly to their C counterparts, these functions load an unsigned 8, 16,
87032 or 64 bit value from memory, with optional conversion from big/little 87232 or 64 bit value from memory, with optional conversion from big/little
871endian. 873endian.
872 874
873Since the type cannot be deduced, it has top be specified explicitly, e.g. 875Since the type cannot be deduced, it has to be specified explicitly, e.g.
874 876
875 uint_fast16_t v = ecb_peek<uint16_t> (ptr); 877 uint_fast16_t v = ecb_peek<uint16_t> (ptr);
876 878
877C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>. 879C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
878 880

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines