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

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.37 by sf-exg, Wed Aug 24 23:28:47 2011 UTC vs.
Revision 1.49 by root, Thu Jun 28 14:50:01 2012 UTC

…		…
53	C<uint32_t>, then the corresponding function works only with that type. If	53	C<uint32_t>, then the corresponding function works only with that type. If
54	only a generic name is used (C<expr>, C<cond>, C<value> and so on), then	54	only a generic name is used (C<expr>, C<cond>, C<value> and so on), then
55	the corresponding function relies on C to implement the correct types, and	55	the corresponding function relies on C to implement the correct types, and
56	is usually implemented as a macro. Specifically, a "bool" in this manual	56	is usually implemented as a macro. Specifically, a "bool" in this manual
57	refers to any kind of boolean value, not a specific type.	57	refers to any kind of boolean value, not a specific type.
		58
		59	=head2 TYPES / TYPE SUPPORT
		60
		61	ecb.h makes sure that the following types are defined (in the expected way):
		62
		63	int8_t uint8_t int16_t uint16_t
		64	int32_t uint32_t int64_t uint64_t
		65	intptr_t uintptr_t
		66
		67	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
		69	expressions.
		70
		71	For C<ptrdiff_t> and C<size_t> use C<stddef.h>.
		72
		73	=head2 LANGUAGE/COMPILER VERSIONS
		74
		75	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
		77	ensure it's either C<0> or C<1> if you need that).
		78
		79	=over 4
		80
		81	=item ECB_C
		82
		83	True if the implementation defines the C<__STDC__> macro to a true value,
		84	which is typically true for both C and C++ compilers.
		85
		86	=item ECB_C99
		87
		88	True if the implementation claims to be compliant to C99 (ISO/IEC
		89	9899:1999) or any later version.
		90
		91	Note that later versions (ECB_C11) remove core features again (for
		92	example, variable length arrays).
		93
		94	=item ECB_C11
		95
		96	True if the implementation claims to be compliant to C11 (ISO/IEC
		97	9899:2011) or any later version.
		98
		99	=item ECB_CPP
		100
		101	True if the implementation defines the C<__cplusplus__> macro to a true
		102	value, which is typically true for C++ compilers.
		103
		104	=item ECB_CPP11
		105
		106	True if the implementation claims to be compliant to ISO/IEC 14882:2011
		107	(C++11) or any later version.
		108
		109	=item ECB_GCC_VERSION(major,minor)
		110
		111	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
		113	higher.
		114
		115	This macro tries to return false on compilers that claim to be GCC
		116	compatible but aren't.
		117
		118	=back
58		119
59	=head2 GCC ATTRIBUTES	120	=head2 GCC ATTRIBUTES
60		121
61	A major part of libecb deals with GCC attributes. These are additional	122	A major part of libecb deals with GCC attributes. These are additional
62	attributes that you can assign to functions, variables and sometimes even	123	attributes that you can assign to functions, variables and sometimes even
…		…
425	For example:	486	For example:
426		487
427	ecb_ctz32 (3) = 0	488	ecb_ctz32 (3) = 0
428	ecb_ctz32 (6) = 1	489	ecb_ctz32 (6) = 1
429		490
		491	=item bool ecb_is_pot32 (uint32_t x)
		492
		493	=item bool ecb_is_pot64 (uint32_t x)
		494
		495	Return true iff C<x> is a power of two or C<x == 0>.
		496
		497	For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>.
		498
430	=item int ecb_ld32 (uint32_t x)	499	=item int ecb_ld32 (uint32_t x)
431		500
432	=item int ecb_ld64 (uint64_t x)	501	=item int ecb_ld64 (uint64_t x)
433		502
434	Returns the index of the most significant bit set in C<x>, or the number	503	Returns the index of the most significant bit set in C<x>, or the number
…		…
454		523
455	For example:	524	For example:
456		525
457	ecb_popcount32 (7) = 3	526	ecb_popcount32 (7) = 3
458	ecb_popcount32 (255) = 8	527	ecb_popcount32 (255) = 8
		528
		529	=item uint8_t ecb_bitrev8 (uint8_t x)
		530
		531	=item uint16_t ecb_bitrev16 (uint16_t x)
		532
		533	=item uint32_t ecb_bitrev32 (uint32_t x)
		534
		535	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
		536	and so on.
		537
		538	Example:
		539
		540	ecb_bitrev8 (0xa7) = 0xea
		541	ecb_bitrev32 (0xffcc4411) = 0x882233ff
459		542
460	=item uint32_t ecb_bswap16 (uint32_t x)	543	=item uint32_t ecb_bswap16 (uint32_t x)
461		544
462	=item uint32_t ecb_bswap32 (uint32_t x)	545	=item uint32_t ecb_bswap32 (uint32_t x)
463		546
…		…
527		610
528	=item x = ecb_div_ru (val, div)	611	=item x = ecb_div_ru (val, div)
529		612
530	Returns C<val> divided by C<div> rounded down or up, respectively.	613	Returns C<val> divided by C<div> rounded down or up, respectively.
531	C<val> and C<div> must have integer types and C<div> must be strictly	614	C<val> and C<div> must have integer types and C<div> must be strictly
532	positive.	615	positive. Note that these functions are implemented with macros in C
		616	and with function templates in C++.
533		617
534	=back	618	=back
535		619
536	=head2 UTILITY	620	=head2 UTILITY
537		621
…		…
547	for (i = 0; i < ecb_array_length (primes); i++)	631	for (i = 0; i < ecb_array_length (primes); i++)
548	sum += primes [i];	632	sum += primes [i];
549		633
550	=back	634	=back
551		635
		636	=head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF
552		637
		638	These symbols need to be defined before including F<ecb.h> the first time.
		639
		640	=over 4
		641
		642	=item ECB_NO_THRADS
		643
		644	If F<ecb.h> is never used from multiple threads, then this symbol can
		645	be defined, in which case memory fences (and similar constructs) are
		646	completely removed, leading to more efficient code and fewer dependencies.
		647
		648	Setting this symbol to a true value implies C<ECB_NO_SMP>.
		649
		650	=item ECB_NO_SMP
		651
		652	The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from
		653	multiple threads, but never concurrently (e.g. if the system the program
		654	runs on has only a single CPU with a single core, no hyperthreading and so
		655	on), then this symbol can be defined, leading to more efficient code and
		656	fewer dependencies.
		657
		658	=back
		659
		660

Diff Legend

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

Comparing cvsroot/libecb/ecb.pod (file contents): Revision 1.37 by sf-exg, Wed Aug 24 23:28:47 2011 UTC vs. Revision 1.49 by root, Thu Jun 28 14:50:01 2012 UTC

Diff Legend

Comparing cvsroot/libecb/ecb.pod (file contents):
Revision 1.37 by sf-exg, Wed Aug 24 23:28:47 2011 UTC vs.
Revision 1.49 by root, Thu Jun 28 14:50:01 2012 UTC