bprintf.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	INT2STRINGPADDED   /* ... for zero-padding, +signs, thousand grouping */
Functions
void	putchar (char c)
	Calls sci_tx() to transmit a char over std SCI port.
void	bputs (char *pSrc)
	POSIX puts() look-alike. Prints a string to "stdout".
void	int2stringpadded (char **ppDst, sshort number, uchar intbase, uchar padsize, bool numgroup, bool plussign)
	Prints a number to a pre-allocated ASCII string, with extra formatting.
__inline__ char	digit2char (char num) __attribute__((pure))
void	bvsnprintf (char *pDst, ushort maxn, const char *pSrc, va_list ap)
	POSIX vsnprintf() look-alike.
void	bsnprintf (char *pDst, ushort maxn, const char *pSrc,...)
	POSIX sprintf() look-alike.
void	bprintf (ushort extra, const char *pString,...)
	POSIX printf look-alike, but is NOT COMPATIBLE.
Variables
bool	lk_bputs
bool	lk_putchar

---

Define Documentation

#define INT2STRINGPADDED   /* ... for zero-padding, +signs, thousand grouping */

Definition at line 39 of file bprintf.h.

---

Function Documentation

void bprintf (  ushort  extra, const char *  pString,   ... )

POSIX printf look-alike, but is NOT COMPATIBLE. Parameters: extra  This argument makes bprintf() incompatible. The caller must "guess" how many bytes MORE than the length of the pString char string the final output will be. extra is used to allocate the intermediate memory that is required. pString  A NULL-terminated, formatted ASCII char string. ...  Variable argument list. There must be a matching argument for each '%' format specifier that appears in pString. Warning: bprintf() is NOT COMPATIBLE with the similar POSIX function printf(). See notes on thread locking. Assumes the final output will be (strlen(pString) + extra) bytes in length. This function is a wrapper to bvsnprintf(). Thread locking It's dodgy. See bputs(). See also: bputs. Note: actually the "extra" is temporarily disabled for now, str fixed @ 40 Definition at line 400 of file bprintf.c. References bputs(), bvsnprintf(), and ushort. Referenced by bfree(), bmalloc(), bmallocinit(), bremalloc(), btnscan_chk(), exec_idle(), and task_dumpinfo(). { char pWorking[80]; va_list ap; va_start(ap, pString); bvsnprintf(pWorking, 80, pString, ap); va_end(ap); bputs(pWorking); return; }

Here is the call graph for this function:

void bputs (  char *  pSrc  )

POSIX puts() look-alike. Prints a string to "stdout". Parameters: pSrc  Source char string. Definition at line 78 of file bprintf.c. References lk_bputs, and putchar(). Referenced by bprintf(), exec_idle(), and task_dumpinfo(). { /*@-nullderef@*/ /*@-retvalint@*/ /*@-internalglobs@*/ /*@-modfilesys@*/ while (lk_bputs); lk_bputs = true; do { putchar(*pSrc); } while ('\0' != *pSrc++); lk_bputs = false; /*@=nullderef@*/ /*@=retvalint@*/ /*@=internalglobs@*/ /*@=modfilesys@*/ return; }

Here is the call graph for this function:

void bsnprintf (  char *  pDst, ushort  maxn, const char *  pSrc,   ... )

POSIX sprintf() look-alike. Parameters: pDst  Pre-allocated destination char string. Must have at least maxn bytes allocated. maxn  Maximum number of characters to write to pDst. pSrc  NULL-terminated, formatted ASCII string to print from. ...  Variable argument list. There must be a matching argument for each '%' format specifier that appears in pString. Prints a formatted string to another string. A wrapper to bvsnprintf(). Definition at line 374 of file bprintf.c. References bvsnprintf(), and ushort. { va_list ap; va_start(ap, pSrc); bvsnprintf(pDst, maxn, pSrc, ap); va_end(ap); return; }

Here is the call graph for this function:

void bvsnprintf (  char *  pDst, ushort  maxn, const char *  pSrc, va_list  ap )

POSIX vsnprintf() look-alike. Parameters: pDst  Pre-allocated destination char string. maxn  Maximum number of characters to print. pSrc  Formatted source char string. ap  <stdarg.h> va_list argument list. There must be a matching argument for each '%' format specifier that appears in pString. Supports only the following format specifiers: %, i, X, o, B, s. If INT2STRINGPADDED is defined, additional format modifiers are supported: ' (apostrophe - thousand grouping), + (plus sign - writes plus sign if number is positive) and 0n (zero padding modifier, followed by n zeroes) eg. bvsnprintf(pDst, 20, "Binary number: %'+08B.\n", ap); Definition at line 268 of file bprintf.c. References bstrncpy(), int2stringpadded(), NULL, sshort, uchar, and ushort. Referenced by bprintf(), and bsnprintf(). { char *pString = NULL; ushort ncopied = 0; sshort intvar = 0; uchar intbase = 0; uchar padzeroes = 0; bool plussign = false, numgroup = false; bool foundvar = false; #ifdef BPRINTF_DEBUG printf("bprintf(): pDst(%p), maxn(%i), pSrc = \"%s\"\n", pDst, maxn, pSrc); #endif do { if (*pSrc == '%') { foundvar = true; } if (foundvar) { /* If a '%' was hit, then interpret following chars. */ switch (*(++pSrc)) { case '%': /* '%%' == '%' */ *pDst++ = *pSrc++; ncopied++; foundvar = false; /*@switchbreak@*/break; case 'i': /* decimal int */ intbase = 10; /*@switchbreak@*/break; case 'X': /* hex int */ case 'x': case 'p': intbase = 0x10; /*@switchbreak@*/break; case 'o': /* octal int */ intbase = 010; /*@switchbreak@*/break; case 'B': /* binary int */ intbase = 2; /*@switchbreak@*/break; case 'c': /* character char */ *pDst++ = (char) va_arg(ap, int); ncopied++; /*after here,finished with vartype*/ /*@switchbreak@*/break; case 's': /* a string var is to be printed */ pString = va_arg(ap, char *); ncopied += bstrncpy(pDst, pString, maxn - ncopied); /*@switchbreak@*/break; case '0': /* Zero padding */ padzeroes = *(pSrc + 1) - '0'; /*@switchbreak@*/break; case '+': plussign = true; /*@switchbreak@*/break; case '\'': numgroup = true; /*@switchbreak@*/break; default: /*@switchbreak@*/break; } if (0 < intbase) { intvar = (sshort) (va_arg(ap, int)); pString = pDst; /*@-nullstate@*/ #ifdef INT2STRINGPADDED int2stringpadded(&pDst, intvar, intbase, padzeroes, numgroup, plussign); #else #ifdef INT2STRING int2string(&pDst, intvar, intbase); #endif #endif /*@=nullstate@*/ pSrc++; /* Inc. past vartype char */ ncopied += pDst - pString; intbase = 0; foundvar = false; } } else { *(pDst++) = *pSrc; if ('\0' != *pSrc) pSrc++; ncopied++; } } while ( ((ushort)ncopied < maxn) && ('\0' != *(pSrc)) ); /*@-nullderef@*/ *pDst = '\0'; /*@=nullderef@*/ return; }

Here is the call graph for this function:

__inline__ char digit2char (  char  num  )

void int2stringpadded (  char **  ppDst, sshort  number, uchar  intbase, uchar  padsize, bool  numgroup, bool  plussign )

Prints a number to a pre-allocated ASCII string, with extra formatting. Parameters: ppDst  Address of pre-allocated destination char pointer. number  The number to printed; 16 bit signed. intbase  The base value, eg. 10 for decimal, 2 for binary, 16 for hex. padsize  Number of zeroes to pad the number with. numgroup  Enable comma-separated "thousand" grouping of digits. plussign  Enable forced plus sign '+' if number is positive. ppDst Increments *ppDst as it goes. *ppDst will _NOT_ be NULL terminated, it is up to the caller to do so if necessary. On return, *ppDst will point to an as-yet unused byte. intbase int2string() can print to any arbitrary (even-integer) base number format as specified by the intbase parameter. Tested values: 2 (binary), 8 (octal), 16 (hex), 10 (decimal). For different values, please check that the switch(intbase) block sets multiplier to an appropriate value. Uses digit2char() for digit-to-character conversion. Note: int2stringpadded() performs the functions of int2string(), but may also (left) pad a number with a specified number of zeroes (padsize), can perform "thousand" grouping (numgroup), as well as enforcing a '+' sign if a number is positive (plussign). Warning: YOU NEED TO SET THE INT2STRINGPADDED #define TO USE THIS FUNCTION . Definition at line 161 of file bprintf.c. References digit2char, sshort, uchar, and ushort. Referenced by bvsnprintf(). { ushort multiplier, i; uchar quotient, groupsize; uchar ndigit = (uchar)0; /* ndigit: counts digit no. for grouping */ /* Calc. groupsize, "thousand" comma grouping. Should handle 16 bit ints. */ switch (intbase) { case 10: groupsize = 3; multiplier = 10000; /* For decimal numbers */ break; case 0x10: groupsize = 4; multiplier = 0x1000; /* For hex numbers */ break; default: groupsize = 4; multiplier = 0x8000; /* To get full 16bit range for oct+bin */ break; } if (!numgroup) { groupsize = 127; /* Cheap way of saying "no grouping" */ } /* Deal with +/- signs. */ if (0 > number) { /*@-nullderef@*/ *(*ppDst)++ = '-'; number *= -1; /* Int printing assumes positive numbers */ } else if (0 == number) { if (0 != padsize) padsize--; *(*ppDst)++ = '0'; } else if (plussign) { *(*ppDst)++ = '+'; /* Mandatory plussign if needed */ } /* Calc. no. digits; necessary for "thousand" grouping commas. */ for (i = number; 0 < i; i /= intbase) { ndigit++; } /* Do zero padding, with "thousand" grouping of those zeroes */ for (i = padsize; i > ndigit; i--) { *(*ppDst)++ = '0'; if ((0 == ((i - 1) % (groupsize))) && (1 != i)) { /* != 1: no end comma */ *(*ppDst)++ = ','; } } /* The main int printing loop. */ do { /* Deal with non-zero, positive int */ if (number >= multiplier) { /* Find a base multiple for number */ quotient = number/multiplier; /* quotient will be printed, */ number -= quotient*multiplier; /* so update number accordingly */ digit2char(**ppDst, quotient); /* print the quotient to string */ (*ppDst)++; ndigit--; if ((0 == (ndigit % groupsize)) && (0 != ndigit)) { *(*ppDst)++ = ','; /* "thousand" comma grouping */ } if (multiplier/intbase > number) { /* Detect zero printing */ for (i = multiplier/intbase; i > number; i /= intbase) { *(*ppDst)++ = '0'; /* otherwise they will be skipped */ ndigit--; if ((0 == (ndigit % groupsize)) && (0 != ndigit)) { *(*ppDst)++ = ','; } /*@=nullderef@*/ } } } multiplier /= intbase; /* Update multiplier for next digit print */ } while (multiplier > 0); return; }

void putchar (  char  c  )

Calls sci_tx() to transmit a char over std SCI port. Parameters: c  The char to be sent Thread locking It's dodgy. Definition at line 61 of file bprintf.c. References lk_putchar, SCI0BDH, sci_tx(), and uchar. Referenced by bputs(). { /* while (lk_putchar);*/ lk_putchar = true; sci_tx(((uchar *) (&SCI0BDH)), c); lk_putchar = false; }

Here is the call graph for this function:

---

Variable Documentation

bool lk_bputs

Definition at line 7 of file bprintf.h. Referenced by _start(), and bputs().

bool lk_putchar

Definition at line 8 of file bprintf.h. Referenced by _start(), and putchar().

---