[ViewVC] Diff of: cvs/libecb/ecb.pod

Comparing libecb/ecb.pod (file contents):
Revision 1.72 by root, Sat Nov 21 18:09:37 2015 UTC vs.
Revision 1.81 by root, Mon Jan 20 21:01:29 2020 UTC

…		…
58		58
59	=head2 TYPES / TYPE SUPPORT	59	=head2 TYPES / TYPE SUPPORT
60		60
61	ecb.h makes sure that the following types are defined (in the expected way):	61	ecb.h makes sure that the following types are defined (in the expected way):
62		62
63	int8_t uint8_t int16_t uint16_t	63	int8_t uint8_
64	int32_t uint32_t int64_t uint64_t	64	int16_t uint16_t
		65	int32_t uint32_
		66	int64_t uint64_t
		67	int_fast8_t uint_fast8_t
		68	int_fast16_t uint_fast16_t
		69	int_fast32_t uint_fast32_t
		70	int_fast64_t uint_fast64_t
65	intptr_t uintptr_t	71	intptr_t uintptr_t
66		72
67	The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this	73	The macro C<ECB_PTRSIZE> is defined to the size of a pointer on this
68	platform (currently C<4> or C<8>) and can be used in preprocessor	74	platform (currently C<4> or C<8>) and can be used in preprocessor
69	expressions.	75	expressions.
70		76
71	For C<ptrdiff_t> and C<size_t> use C<stddef.h>.	77	For C<ptrdiff_t> and C<size_t> use C<stddef.h>/C<cstddef>.
72		78
73	=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS	79	=head2 LANGUAGE/ENVIRONMENT/COMPILER VERSIONS
74		80
75	All the following symbols expand to an expression that can be tested in	81	All the following symbols expand to an expression that can be tested in
76	preprocessor instructions as well as treated as a boolean (use C<!!> to	82	preprocessor instructions as well as treated as a boolean (use C<!!> to
…		…
89	9899:1999) or any later version, while not claiming to be C++.	95	9899:1999) or any later version, while not claiming to be C++.
90		96
91	Note that later versions (ECB_C11) remove core features again (for	97	Note that later versions (ECB_C11) remove core features again (for
92	example, variable length arrays).	98	example, variable length arrays).
93		99
94	=item ECB_C11	100	=item ECB_C11, ECB_C17
95		101
96	True if the implementation claims to be compliant to C11 (ISO/IEC	102	True if the implementation claims to be compliant to C11/C17 (ISO/IEC
97	9899:2011) or any later version, while not claiming to be C++.	103	9899:2011, :20187) or any later version, while not claiming to be C++.
98		104
99	=item ECB_CPP	105	=item ECB_CPP
100		106
101	True if the implementation defines the C<__cplusplus__> macro to a true	107	True if the implementation defines the C<__cplusplus__> macro to a true
102	value, which is typically true for C++ compilers.	108	value, which is typically true for C++ compilers.
103		109
104	=item ECB_CPP11	110	=item ECB_CPP11, ECB_CPP14, ECB_CPP17
105		111
106	True if the implementation claims to be compliant to ISO/IEC 14882:2011	112	True if the implementation claims to be compliant to C++11/C++14/C++17
107	(C++11) or any later version.	113	(ISO/IEC 14882:2011, :2014, :2017) or any later version.
		114
		115	=item ECB_OPTIMIZE_SIZE
		116
		117	Is C<1> when the compiler optimizes for size, C<0> otherwise. This symbol
		118	can also be defined before including F<ecb.h>, in which case it will be
		119	unchanged.
108		120
109	=item ECB_GCC_VERSION (major, minor)	121	=item ECB_GCC_VERSION (major, minor)
110		122
111	Expands to a true value (suitable for testing in by the preprocessor)	123	Expands to a true value (suitable for testing in by the preprocessor)
112	if the compiler used is GNU C and the version is the given version, or	124	if the compiler used is GNU C and the version is the given version, or
…		…
248	used instead of a generic depreciation message when the object is being	260	used instead of a generic depreciation message when the object is being
249	used.	261	used.
250		262
251	=item ecb_inline	263	=item ecb_inline
252		264
253	Expands either to C<static inline> or to just C<static>, if inline	265	Expands either to (a compiler-specific equivalent of) C<static inline> or
254	isn't supported. It should be used to declare functions that should be	266	to just C<static>, if inline isn't supported. It should be used to declare
255	inlined, for code size or speed reasons.	267	functions that should be inlined, for code size or speed reasons.
256		268
257	Example: inline this function, it surely will reduce codesize.	269	Example: inline this function, it surely will reduce codesize.
258		270
259	ecb_inline int	271	ecb_inline int
260	negmul (int a, int b)	272	negmul (int a, int b)
…		…
583		595
584	=item int ecb_ctz32 (uint32_t x)	596	=item int ecb_ctz32 (uint32_t x)
585		597
586	=item int ecb_ctz64 (uint64_t x)	598	=item int ecb_ctz64 (uint64_t x)
587		599
		600	=item int ecb_ctz (T x) [C++]
		601
588	Returns the index of the least significant bit set in C<x> (or	602	Returns the index of the least significant bit set in C<x> (or
589	equivalently the number of bits set to 0 before the least significant bit	603	equivalently the number of bits set to 0 before the least significant bit
590	set), starting from 0. If C<x> is 0 the result is undefined.	604	set), starting from 0. If C<x> is 0 the result is undefined.
591		605
592	For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.	606	For smaller types than C<uint32_t> you can safely use C<ecb_ctz32>.
593		607
		608	The overloaded C++ C<ecb_ctz> function supports C<uint8_t>, C<uint16_t>,
		609	C<uint32_t> and C<uint64_t> types.
		610
594	For example:	611	For example:
595		612
596	ecb_ctz32 (3) = 0	613	ecb_ctz32 (3) = 0
597	ecb_ctz32 (6) = 1	614	ecb_ctz32 (6) = 1
598		615
599	=item bool ecb_is_pot32 (uint32_t x)	616	=item bool ecb_is_pot32 (uint32_t x)
600		617
601	=item bool ecb_is_pot64 (uint32_t x)	618	=item bool ecb_is_pot64 (uint32_t x)
602		619
		620	=item bool ecb_is_pot (T x) [C++]
		621
603	Returns true iff C<x> is a power of two or C<x == 0>.	622	Returns true iff C<x> is a power of two or C<x == 0>.
604		623
605	For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>.	624	For smaller types than C<uint32_t> you can safely use C<ecb_is_pot32>.
606		625
		626	The overloaded C++ C<ecb_is_pot> function supports C<uint8_t>, C<uint16_t>,
		627	C<uint32_t> and C<uint64_t> types.
		628
607	=item int ecb_ld32 (uint32_t x)	629	=item int ecb_ld32 (uint32_t x)
608		630
609	=item int ecb_ld64 (uint64_t x)	631	=item int ecb_ld64 (uint64_t x)
		632
		633	=item int ecb_ld64 (T x) [C++]
610		634
611	Returns the index of the most significant bit set in C<x>, or the number	635	Returns the index of the most significant bit set in C<x>, or the number
612	of digits the number requires in binary (so that C<< 2**ld <= x <	636	of digits the number requires in binary (so that C<< 2**ld <= x <
613	2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is	637	2**(ld+1) >>). If C<x> is 0 the result is undefined. A common use case is
614	to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for	638	to compute the integer binary logarithm, i.e. C<floor (log2 (n))>, for
…		…
619	the given data type), while C<ecb_ld> returns how many bits the number	643	the given data type), while C<ecb_ld> returns how many bits the number
620	itself requires.	644	itself requires.
621		645
622	For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.	646	For smaller types than C<uint32_t> you can safely use C<ecb_ld32>.
623		647
		648	The overloaded C++ C<ecb_ld> function supports C<uint8_t>, C<uint16_t>,
		649	C<uint32_t> and C<uint64_t> types.
		650
624	=item int ecb_popcount32 (uint32_t x)	651	=item int ecb_popcount32 (uint32_t x)
625		652
626	=item int ecb_popcount64 (uint64_t x)	653	=item int ecb_popcount64 (uint64_t x)
627		654
		655	=item int ecb_popcount (T x) [C++]
		656
628	Returns the number of bits set to 1 in C<x>.	657	Returns the number of bits set to 1 in C<x>.
629		658
630	For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.	659	For smaller types than C<uint32_t> you can safely use C<ecb_popcount32>.
		660
		661	The overloaded C++ C<ecb_popcount> function supports C<uint8_t>, C<uint16_t>,
		662	C<uint32_t> and C<uint64_t> types.
631		663
632	For example:	664	For example:
633		665
634	ecb_popcount32 (7) = 3	666	ecb_popcount32 (7) = 3
635	ecb_popcount32 (255) = 8	667	ecb_popcount32 (255) = 8
…		…
638		670
639	=item uint16_t ecb_bitrev16 (uint16_t x)	671	=item uint16_t ecb_bitrev16 (uint16_t x)
640		672
641	=item uint32_t ecb_bitrev32 (uint32_t x)	673	=item uint32_t ecb_bitrev32 (uint32_t x)
642		674
		675	=item T ecb_bitrev (T x) [C++]
		676
643	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1	677	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
644	and so on.	678	and so on.
645		679
		680	The overloaded C++ C<ecb_bitrev> function supports C<uint8_t>, C<uint16_t> and C<uint32_t> types.
		681
646	Example:	682	Example:
647		683
648	ecb_bitrev8 (0xa7) = 0xea	684	ecb_bitrev8 (0xa7) = 0xea
649	ecb_bitrev32 (0xffcc4411) = 0x882233ff	685	ecb_bitrev32 (0xffcc4411) = 0x882233ff
650		686
		687	=item T ecb_bitrev (T x) [C++]
		688
		689	Overloaded C++ bitrev function.
		690
		691	C<T> must be one of C<uint8_t>, C<uint16_t> or C<uint32_t>.
		692
651	=item uint32_t ecb_bswap16 (uint32_t x)	693	=item uint32_t ecb_bswap16 (uint32_t x)
652		694
653	=item uint32_t ecb_bswap32 (uint32_t x)	695	=item uint32_t ecb_bswap32 (uint32_t x)
654		696
655	=item uint64_t ecb_bswap64 (uint64_t x)	697	=item uint64_t ecb_bswap64 (uint64_t x)
		698
		699	=item T ecb_bswap (T x)
656		700
657	These functions return the value of the 16-bit (32-bit, 64-bit) value	701	These functions return the value of the 16-bit (32-bit, 64-bit) value
658	C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in	702	C<x> after reversing the order of bytes (0x11223344 becomes 0x44332211 in
659	C<ecb_bswap32>).	703	C<ecb_bswap32>).
660		704
		705	The overloaded C++ C<ecb_bswap> function supports C<uint8_t>, C<uint16_t>,
		706	C<uint32_t> and C<uint64_t> types.
		707
661	=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)	708	=item uint8_t ecb_rotl8 (uint8_t x, unsigned int count)
662		709
663	=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)	710	=item uint16_t ecb_rotl16 (uint16_t x, unsigned int count)
664		711
665	=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)	712	=item uint32_t ecb_rotl32 (uint32_t x, unsigned int count)
…		…
679	(C<ecb_rotl>).	726	(C<ecb_rotl>).
680		727
681	Current GCC versions understand these functions and usually compile them	728	Current GCC versions understand these functions and usually compile them
682	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on	729	to "optimal" code (e.g. a single C<rol> or a combination of C<shld> on
683	x86).	730	x86).
		731
		732	=item T ecb_rotl (T x, unsigned int count) [C++]
		733
		734	=item T ecb_rotr (T x, unsigned int count) [C++]
		735
		736	Overloaded C++ rotl/rotr functions.
		737
		738	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		739
		740	=back
		741
		742	=head2 HOST ENDIANNESS CONVERSION
		743
		744	=over 4
		745
		746	=item uint_fast16_t ecb_be_u16_to_host (uint_fast16_t v)
		747
		748	=item uint_fast32_t ecb_be_u32_to_host (uint_fast32_t v)
		749
		750	=item uint_fast64_t ecb_be_u64_to_host (uint_fast64_t v)
		751
		752	=item uint_fast16_t ecb_le_u16_to_host (uint_fast16_t v)
		753
		754	=item uint_fast32_t ecb_le_u32_to_host (uint_fast32_t v)
		755
		756	=item uint_fast64_t ecb_le_u64_to_host (uint_fast64_t v)
		757
		758	Convert an unsigned 16, 32 or 64 bit value from big or little endian to host byte order.
		759
		760	The naming convention is C<ecb_>(C<be>\|C<le>)C<_u>C<16\|32\|64>C<_to_host>,
		761	where C<be> and C<le> stand for big endian and little endian, respectively.
		762
		763	=item uint_fast16_t ecb_host_to_be_u16 (uint_fast16_t v)
		764
		765	=item uint_fast32_t ecb_host_to_be_u32 (uint_fast32_t v)
		766
		767	=item uint_fast64_t ecb_host_to_be_u64 (uint_fast64_t v)
		768
		769	=item uint_fast16_t ecb_host_to_le_u16 (uint_fast16_t v)
		770
		771	=item uint_fast32_t ecb_host_to_le_u32 (uint_fast32_t v)
		772
		773	=item uint_fast64_t ecb_host_to_le_u64 (uint_fast64_t v)
		774
		775	Like above, but converts I<from> host byte order to the specified
		776	endianness.
		777
		778	=back
		779
		780	In C++ the following additional template functions are supported:
		781
		782	=over 4
		783
		784	=item T ecb_be_to_host (T v)
		785
		786	=item T ecb_le_to_host (T v)
		787
		788	=item T ecb_host_to_be (T v)
		789
		790	=item T ecb_host_to_le (T v)
		791
		792	These functions work like their C counterparts, above, but use templates,
		793	which make them useful in generic code.
		794
		795	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>
		796	(so unlike their C counterparts, there is a version for C<uint8_t>, which
		797	again can be useful in generic code).
		798
		799	=head2 UNALIGNED LOAD/STORE
		800
		801	These function load or store unaligned multi-byte values.
		802
		803	=over 4
		804
		805	=item uint_fast16_t ecb_peek_u16_u (const void *ptr)
		806
		807	=item uint_fast32_t ecb_peek_u32_u (const void *ptr)
		808
		809	=item uint_fast64_t ecb_peek_u64_u (const void *ptr)
		810
		811	These functions load an unaligned, unsigned 16, 32 or 64 bit value from
		812	memory.
		813
		814	=item uint_fast16_t ecb_peek_be_u16_u (const void *ptr)
		815
		816	=item uint_fast32_t ecb_peek_be_u32_u (const void *ptr)
		817
		818	=item uint_fast64_t ecb_peek_be_u64_u (const void *ptr)
		819
		820	=item uint_fast16_t ecb_peek_le_u16_u (const void *ptr)
		821
		822	=item uint_fast32_t ecb_peek_le_u32_u (const void *ptr)
		823
		824	=item uint_fast64_t ecb_peek_le_u64_u (const void *ptr)
		825
		826	Like above, but additionally convert from big endian (C<be>) or little
		827	endian (C<le>) byte order to host byte order while doing so.
		828
		829	=item ecb_poke_u16_u (void *ptr, uint16_t v)
		830
		831	=item ecb_poke_u32_u (void *ptr, uint32_t v)
		832
		833	=item ecb_poke_u64_u (void *ptr, uint64_t v)
		834
		835	These functions store an unaligned, unsigned 16, 32 or 64 bit value to
		836	memory.
		837
		838	=item ecb_poke_be_u16_u (void *ptr, uint_fast16_t v)
		839
		840	=item ecb_poke_be_u32_u (void *ptr, uint_fast32_t v)
		841
		842	=item ecb_poke_be_u64_u (void *ptr, uint_fast64_t v)
		843
		844	=item ecb_poke_le_u16_u (void *ptr, uint_fast16_t v)
		845
		846	=item ecb_poke_le_u32_u (void *ptr, uint_fast32_t v)
		847
		848	=item ecb_poke_le_u64_u (void *ptr, uint_fast64_t v)
		849
		850	Like above, but additionally convert from host byte order to big endian
		851	(C<be>) or little endian (C<le>) byte order while doing so.
		852
		853	=back
		854
		855	In C++ the following additional template functions are supported:
		856
		857	=over 4
		858
		859	=item T ecb_peek<T> (const void *ptr)
		860
		861	=item T ecb_peek_be<T> (const void *ptr)
		862
		863	=item T ecb_peek_le<T> (const void *ptr)
		864
		865	=item T ecb_peek_u<T> (const void *ptr)
		866
		867	=item T ecb_peek_be_u<T> (const void *ptr)
		868
		869	=item T ecb_peek_le_u<T> (const void *ptr)
		870
		871	Similarly to their C counterparts, these functions load an unsigned 8, 16,
		872	32 or 64 bit value from memory, with optional conversion from big/little
		873	endian.
		874
		875	Since the type cannot be deduced, it has to be specified explicitly, e.g.
		876
		877	uint_fast16_t v = ecb_peek<uint16_t> (ptr);
		878
		879	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		880
		881	Unlike their C counterparts, these functions support 8 bit quantities
		882	(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
		883	all of which hopefully makes them more useful in generic code.
		884
		885	=item ecb_poke (void *ptr, T v)
		886
		887	=item ecb_poke_be (void *ptr, T v)
		888
		889	=item ecb_poke_le (void *ptr, T v)
		890
		891	=item ecb_poke_u (void *ptr, T v)
		892
		893	=item ecb_poke_be_u (void *ptr, T v)
		894
		895	=item ecb_poke_le_u (void *ptr, T v)
		896
		897	Again, similarly to their C counterparts, these functions store an
		898	unsigned 8, 16, 32 or z64 bit value to memory, with optional conversion to
		899	big/little endian.
		900
		901	C<T> must be one of C<uint8_t>, C<uint16_t>, C<uint32_t> or C<uint64_t>.
		902
		903	Unlike their C counterparts, these functions support 8 bit quantities
		904	(C<uint8_t>) and also have an aligned version (without the C<_u> prefix),
		905	all of which hopefully makes them more useful in generic code.
684		906
685	=back	907	=back
686		908
687	=head2 FLOATING POINT FIDDLING	909	=head2 FLOATING POINT FIDDLING
688		910

Diff Legend

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

Comparing libecb/ecb.pod (file contents): Revision 1.72 by root, Sat Nov 21 18:09:37 2015 UTC vs. Revision 1.81 by root, Mon Jan 20 21:01:29 2020 UTC

Diff Legend

Comparing libecb/ecb.pod (file contents):
Revision 1.72 by root, Sat Nov 21 18:09:37 2015 UTC vs.
Revision 1.81 by root, Mon Jan 20 21:01:29 2020 UTC