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

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.77 by root, Mon Jan 20 13:41:18 2020 UTC vs.
Revision 1.84 by root, Mon Jan 20 21:10:16 2020 UTC

… …
85=over 4 85=over 4
86 86
87=item ECB_C 87=item ECB_C
88 88
89True if the implementation defines the C<__STDC__> macro to a true value, 89True if the implementation defines the C<__STDC__> macro to a true value,
90while not claiming to be C++. 90while not claiming to be C++, i..e C, but not C++.
91 91
92=item ECB_C99 92=item ECB_C99
93 93
94True if the implementation claims to be compliant to C99 (ISO/IEC 94True if the implementation claims to be compliant to C99 (ISO/IEC
959899:1999) or any later version, while not claiming to be C++. 959899:1999) or any later version, while not claiming to be C++.
… …
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
115Note that many C++20 features will likely have their own feature test
116macros (see e.g. L<http://eel.is/c++draft/cpp.predefined#1.8>).
117
118=item ECB_OPTIMIZE_SIZE
119
120Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
121can also be defined before including F<ecb.h>, in which case it will be
122unchanged.
123
115=item ECB_GCC_VERSION (major, minor) 124=item ECB_GCC_VERSION (major, minor)
116 125
117Expands to a true value (suitable for testing in by the preprocessor) 126Expands to a true value (suitable for testing by the preprocessor) if the
118if the compiler used is GNU C and the version is the given version, or 127compiler used is GNU C and the version is the given version, or higher.
119higher.
120 128
121This macro tries to return false on compilers that claim to be GCC 129This macro tries to return false on compilers that claim to be GCC
122compatible but aren't. 130compatible but aren't.
123 131
124=item ECB_EXTERN_C 132=item ECB_EXTERN_C
… …
143 151
144 ECB_EXTERN_C_END 152 ECB_EXTERN_C_END
145 153
146=item ECB_STDFP 154=item ECB_STDFP
147 155
148If this evaluates to a true value (suitable for testing in by the 156If this evaluates to a true value (suitable for testing by the
149preprocessor), then C<float> and C<double> use IEEE 754 single/binary32 157preprocessor), then C<float> and C<double> use IEEE 754 single/binary32
150and double/binary64 representations internally I<and> the endianness of 158and double/binary64 representations internally I<and> the endianness of
151both types match the endianness of C<uint32_t> and C<uint64_t>. 159both types match the endianness of C<uint32_t> and C<uint64_t>.
152 160
153This means you can just copy the bits of a C<float> (or C<double>) to an 161This means you can just copy the bits of a C<float> (or C<double>) to an
… …
408 416
409=head2 OPTIMISATION HINTS 417=head2 OPTIMISATION HINTS
410 418
411=over 4 419=over 4
412 420
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) 421=item bool ecb_is_constant (expr)
420 422
421Returns true iff the expression can be deduced to be a compile-time 423Returns true iff the expression can be deduced to be a compile-time
422constant, and false otherwise. 424constant, and false otherwise.
423 425
… …
694 696
695=item uint32_t ecb_bswap32 (uint32_t x) 697=item uint32_t ecb_bswap32 (uint32_t x)
696 698
697=item uint64_t ecb_bswap64 (uint64_t x) 699=item uint64_t ecb_bswap64 (uint64_t x)
698 700
701=item T ecb_bswap (T x)
702
699These functions return the value of the 16-bit (32-bit, 64-bit) value 703These 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 704C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
701C<ecb_bswap32>). 705C<ecb_bswap32>).
702 706
703The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>, 707The 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) 758=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v)
755 759
756Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order. 760Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order.
757 761
758The naming convention is C<ecb_>(C<be>|C<le>)C<_u>C<16|32|64>C<_to_host>, 762The 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. 763where C<be> and C<le> stand for big endian and little endian, respectively.
760 764
761=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v) 765=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v)
762 766
763=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v) 767=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v)
764 768
… …
852 856
853In C++ the following additional template functions are supported: 857In C++ the following additional template functions are supported:
854 858
855=over 4 859=over 4
856 860
857=item T ecb_peek (const void *ptr) 861=item T ecb_peek<T> (const void *ptr)
858 862
859=item T ecb_peek_be (const void *ptr) 863=item T ecb_peek_be<T> (const void *ptr)
860 864
861=item T ecb_peek_le (const void *ptr) 865=item T ecb_peek_le<T> (const void *ptr)
862 866
863=item T ecb_peek_u (const void *ptr) 867=item T ecb_peek_u<T> (const void *ptr)
864 868
865=item T ecb_peek_be_u (const void *ptr) 869=item T ecb_peek_be_u<T> (const void *ptr)
866 870
867=item T ecb_peek_le_u (const void *ptr) 871=item T ecb_peek_le_u<T> (const void *ptr)
868 872
869Similarly to their C counterparts, these functions load an unsigned 8, 16, 873Similarly to their C counterparts, these functions load an unsigned 8, 16,
87032 or 64 bit value from memory, with optional conversion from big/little 87432 or 64 bit value from memory, with optional conversion from big/little
871endian. 875endian.
872 876
873Since the type cannot be deduced, it has top be specified explicitly, e.g. 877Since the type cannot be deduced, it has to be specified explicitly, e.g.
874 878
875 uint_fast16_t v = ecb_peek<uint16_t> (ptr); 879 uint_fast16_t v = ecb_peek<uint16_t> (ptr);
876 880
877C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>. 881C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
878 882

Diff Legend

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