shared_source/c_datd/charfunc.h

//$Header$
//-------------------------------------------------------------------------------------------------
//This file is part of "David T. Ashley's Shared Source Code", a set of shared components
//integrated into many of David T. Ashley's projects.
//-------------------------------------------------------------------------------------------------
//This source code and any program in which it is compiled/used is provided under the MIT License,
//reproduced below.
//-------------------------------------------------------------------------------------------------
//Permission is hereby granted, free of charge, to any person obtaining a copy of
//this software and associated documentation files(the "Software"), to deal in the
//Software without restriction, including without limitation the rights to use,
//copy, modify, merge, publish, distribute, sublicense, and / or sell copies of the
//Software, and to permit persons to whom the Software is furnished to do so,
//subject to the following conditions :
//
//The above copyright notice and this permission notice shall be included in all
//copies or substantial portions of the Software.
//
//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
//SOFTWARE.
//-------------------------------------------------------------------------------------------------
#ifndef CHARFUNC_H_INCLUDED
   #define CHARFUNC_H_INCLUDED

   #ifdef MODULE_CHARFUNC
      #define DECMOD_CHARFUNC
   #else
      #define DECMOD_CHARFUNC extern
   #endif

   //Returns the value of a digit (0-9), or -1 if the
   //passed character is not a digit.
   DECMOD_CHARFUNC int CHARFUNC_digit_to_val(char digit);

   //Returns a lower-case character corresponding to the 
   //lowest nibble of the argument.
   DECMOD_CHARFUNC char CHARFUNC_nibble_to_lc_hex_digit(int nibble);

   //Converts a passed integer to 8 hex digits, lower case letters,
   //in reverse order (LSB first), with no terminator.  s may not
   //be null, and caller must provide space for s[0] through s[7].
   //s[8] is not necessary (no terminator is appended.
   DECMOD_CHARFUNC void CHARFUNC_int_to_lc_hex_rev(int arg, char *s);

   DECMOD_CHARFUNC const char *CHARFUNC_cvcinfo(void);
   DECMOD_CHARFUNC const char *CHARFUNC_hvcinfo(void);
   #define CHARFUNC_H_VERSION ("$Header$")
#endif

//End of charfunc.h.
1	dashley	56	//$Header$
2	dashley	25	//-------------------------------------------------------------------------------------------------
3	dashley	56	//This file is part of "David T. Ashley's Shared Source Code", a set of shared components
4			//integrated into many of David T. Ashley's projects.
5	dashley	25	//-------------------------------------------------------------------------------------------------
6	dashley	56	//This source code and any program in which it is compiled/used is provided under the MIT License,
7			//reproduced below.
8			//-------------------------------------------------------------------------------------------------
9			//Permission is hereby granted, free of charge, to any person obtaining a copy of
10			//this software and associated documentation files(the "Software"), to deal in the
11			//Software without restriction, including without limitation the rights to use,
12			//copy, modify, merge, publish, distribute, sublicense, and / or sell copies of the
13			//Software, and to permit persons to whom the Software is furnished to do so,
14			//subject to the following conditions :
15	dashley	25	//
16	dashley	56	//The above copyright notice and this permission notice shall be included in all
17			//copies or substantial portions of the Software.
18	dashley	25	//
19	dashley	56	//THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20			//IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21			//FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
22			//AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23			//LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24			//OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25			//SOFTWARE.
26	dashley	25	//-------------------------------------------------------------------------------------------------
27			#ifndef CHARFUNC_H_INCLUDED
28			#define CHARFUNC_H_INCLUDED
29
30			#ifdef MODULE_CHARFUNC
31			#define DECMOD_CHARFUNC
32			#else
33			#define DECMOD_CHARFUNC extern
34			#endif
35
36			//Returns the value of a digit (0-9), or -1 if the
37			//passed character is not a digit.
38			DECMOD_CHARFUNC int CHARFUNC_digit_to_val(char digit);
39
40			//Returns a lower-case character corresponding to the
41			//lowest nibble of the argument.
42			DECMOD_CHARFUNC char CHARFUNC_nibble_to_lc_hex_digit(int nibble);
43
44			//Converts a passed integer to 8 hex digits, lower case letters,
45			//in reverse order (LSB first), with no terminator. s may not
46			//be null, and caller must provide space for s[0] through s[7].
47			//s[8] is not necessary (no terminator is appended.
48			DECMOD_CHARFUNC void CHARFUNC_int_to_lc_hex_rev(int arg, char *s);
49
50			DECMOD_CHARFUNC const char *CHARFUNC_cvcinfo(void);
51			DECMOD_CHARFUNC const char *CHARFUNC_hvcinfo(void);
52	dashley	56	#define CHARFUNC_H_VERSION ("$Header$")
53	dashley	25	#endif
54
55	dashley	56	//End of charfunc.h.