[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.47 by root, Tue May 29 16:51:24 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 ptrdiff_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	=head2 LANGUAGE/COMPILER VERSIONS
		72
		73	All the following symbols expand to an expression that can be tested in
		74	preprocessor instructions as well as treated as a boolean (use C<!!> to
		75	ensure it's either C<0> or C<1> if you need that).
		76
		77	=over 4
		78
		79	=item ECB_C
		80
		81	True if the implementation defines the C<__STDC__> macro to a true value,
		82	which is typically true for both C and C++ compilers.
		83
		84	=item ECB_C99
		85
		86	True if the implementation claims to be compliant to C99 (ISO/IEC
		87	9899:1999) or any later version.
		88
		89	Note that later versions (ECB_C11) remove core features again (for
		90	example, variable length arrays).
		91
		92	=item ECB_C11
		93
		94	True if the implementation claims to be compliant to C11 (ISO/IEC
		95	9899:2011) or any later version.
		96
		97	=item ECB_CPP
		98
		99	True if the implementation defines the C<__cplusplus__> macro to a true
		100	value, which is typically true for C++ compilers.
		101
		102	=item ECB_CPP98
		103
		104	True if the implementation claims to be compliant to ISO/IEC 14882:1998
		105	(the first C++ ISO standard) or any later version. Typically true for all
		106	C++ compilers.
		107
		108	=item ECB_CPP11
		109
		110	True if the implementation claims to be compliant to ISO/IEC 14882:2011
		111	(C++11) or any later version.
		112
		113	=item ECB_GCC_VERSION(major,minor)
		114
		115	Expands to a true value (suitable for testing in by the preprocessor)
		116	if the compiler used is GNU C and the version is the given version, or
		117	higher.
		118
		119	This macro tries to return false on compilers that claim to be GCC
		120	compatible but aren't.
		121
		122	=back
58		123
59	=head2 GCC ATTRIBUTES	124	=head2 GCC ATTRIBUTES
60		125
61	A major part of libecb deals with GCC attributes. These are additional	126	A major part of libecb deals with GCC attributes. These are additional
62	attributes that you can assign to functions, variables and sometimes even	127	attributes that you can assign to functions, variables and sometimes even
…		…
425	For example:	490	For example:
426		491
427	ecb_ctz32 (3) = 0	492	ecb_ctz32 (3) = 0
428	ecb_ctz32 (6) = 1	493	ecb_ctz32 (6) = 1
429		494
		495	=item bool ecb_is_pot32 (uint32_t x)
		496
		497	=item bool ecb_is_pot64 (uint32_t x)
		498
		499	Return true iff C<x> is a power of two or C<x == 0>.
		500
		501	For smaller types then C<uint32_t> you can safely use C<ecb_is_pot32>.
		502
430	=item int ecb_ld32 (uint32_t x)	503	=item int ecb_ld32 (uint32_t x)
431		504
432	=item int ecb_ld64 (uint64_t x)	505	=item int ecb_ld64 (uint64_t x)
433		506
434	Returns the index of the most significant bit set in C<x>, or the number	507	Returns the index of the most significant bit set in C<x>, or the number
…		…
454		527
455	For example:	528	For example:
456		529
457	ecb_popcount32 (7) = 3	530	ecb_popcount32 (7) = 3
458	ecb_popcount32 (255) = 8	531	ecb_popcount32 (255) = 8
		532
		533	=item uint8_t ecb_bitrev8 (uint8_t x)
		534
		535	=item uint16_t ecb_bitrev16 (uint16_t x)
		536
		537	=item uint32_t ecb_bitrev32 (uint32_t x)
		538
		539	Reverses the bits in x, i.e. the MSB becomes the LSB, MSB-1 becomes LSB+1
		540	and so on.
		541
		542	Example:
		543
		544	ecb_bitrev8 (0xa7) = 0xea
		545	ecb_bitrev32 (0xffcc4411) = 0x882233ff
459		546
460	=item uint32_t ecb_bswap16 (uint32_t x)	547	=item uint32_t ecb_bswap16 (uint32_t x)
461		548
462	=item uint32_t ecb_bswap32 (uint32_t x)	549	=item uint32_t ecb_bswap32 (uint32_t x)
463		550
…		…
527		614
528	=item x = ecb_div_ru (val, div)	615	=item x = ecb_div_ru (val, div)
529		616
530	Returns C<val> divided by C<div> rounded down or up, respectively.	617	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	618	C<val> and C<div> must have integer types and C<div> must be strictly
532	positive.	619	positive. Note that these functions are implemented with macros in C
		620	and with function templates in C++.
533		621
534	=back	622	=back
535		623
536	=head2 UTILITY	624	=head2 UTILITY
537		625
…		…
547	for (i = 0; i < ecb_array_length (primes); i++)	635	for (i = 0; i < ecb_array_length (primes); i++)
548	sum += primes [i];	636	sum += primes [i];
549		637
550	=back	638	=back
551		639
		640	=head2 SYMBOLS GOVERNING COMPILATION OF ECB.H ITSELF
552		641
		642	These symbols need to be defined before including F<ecb.h> the first time.
		643
		644	=over 4
		645
		646	=item ECB_NO_THRADS
		647
		648	If F<ecb.h> is never used from multiple threads, then this symbol can
		649	be defined, in which case memory fences (and similar constructs) are
		650	completely removed, leading to more efficient code and fewer dependencies.
		651
		652	Setting this symbol to a true value implies C<ECB_NO_SMP>.
		653
		654	=item ECB_NO_SMP
		655
		656	The weaker version of C<ECB_NO_THREADS> - if F<ecb.h> is used from
		657	multiple threads, but never concurrently (e.g. if the system the program
		658	runs on has only a single CPU with a single core, no hyperthreading and so
		659	on), then this symbol can be defined, leading to more efficient code and
		660	fewer dependencies.
		661
		662	=back
		663
		664

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.47 by root, Tue May 29 16:51:24 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.47 by root, Tue May 29 16:51:24 2012 UTC