/******************************************************************************
Copyright (c) 2000-2001 Richard Woolcock
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.
******************************************************************************/
/******************************************************************************
File Name : justify.c
******************************************************************************
Description : Text justification code, previously one of my snippets.
******************************************************************************/
/******************************************************************************
Required library files.
******************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include "justify.h"
/******************************************************************************
Local operation prototypes.
******************************************************************************/
static void AddSpaces ( char **ppszText, int iNumber );
/******************************************************************************
Global operations.
******************************************************************************/
/* Function: Justify
*
* This function is used to format a piece of text so that it doesn't wrap
* over the line. It also allows you to specify the line width and left,
* right or centre justification.
*
* The function takes three parameters, as follows:
*
* pszText: A pointer to the string to be justified.
* iAlignment: The width in characters of the formatted text.
* eJustify: The style of justification: left, right or centre.
*
* The return value is a pointer to a non-stack based string which contains
* the newly formatted text.
*/
char *Justify( char *pszText, int iAlignment, justify_t eJustify )
{
static char s_szResult[4096];
char * pszResult = &s_szResult[0];
char szStore[4096];
int iMax;
int iLength = iAlignment-1;
int iLoop = 0;
if ( strlen( pszText ) < 10 )
{
/* Store the error */
strcpy( s_szResult, "BUG: Justified string cannot be less than 10 characters long." );
return( &s_szResult[0] );
}
/* Discard all leading spaces and blank lines */
while ( *pszText == ' ' || *pszText == '\n' || *pszText == '\r' ) pszText++;
/* Store the character */
szStore[iLoop++] = *pszText++;
if ( szStore[iLoop-1] >= 'a' && szStore[iLoop-1] <= 'z' )
{
/* Capitalize the first character if it's a letter */
szStore[iLoop-1] &= ~32;
}
/* The first loop goes through the string, copying it into szStore. The
* string is formatted to remove all newlines, capitalise new sentences,
* remove excess white spaces and ensure that full stops, commas and
* exclaimation marks are all followed by two white spaces.
*/
while ( *pszText )
{
switch ( *pszText )
{
default:
/* Store the character */
szStore[iLoop++] = *pszText++;
break;
case ' ': case '\n': case '\r':
/* There shall only be one space between non-space characters */
if ( *(pszText+1) != ' ' && *(pszText+1) != '\n' && *(pszText+1) != '\r' )
{
/* Store the character */
szStore[iLoop++] = ' ';
}
pszText++;
break;
case '.': case '?': case '!':
/* Store the character */
szStore[iLoop++] = *pszText++;
switch ( *pszText )
{
default:
/* Sentence terminators shall be followed by two spaces */
szStore[iLoop++] = ' ';
szStore[iLoop++] = ' ';
/* Discard all leading spaces */
while ( *pszText == ' ' || *pszText == '\n' || *pszText == '\r' ) pszText++;
if ( isalpha( *(pszText+1) ) )
{
/* Store the character */
szStore[iLoop++] = toupper(*pszText);
pszText++;
}
break;
case '.': case '?': case '!':
/* Multiple terminators shall not be separated by spaces */
break;
}
break;
case ',':
/* Store the character */
szStore[iLoop++] = *pszText++;
/* Discard all leading spaces */
while ( *pszText == ' ' || *pszText == '\n' || *pszText == '\r' ) pszText++;
/* Commas shall be followed by one space */
szStore[iLoop++] = ' ';
break;
case '$': case '+':
/* Store the character */
szStore[iLoop++] = *pszText++;
/* Discard all leading spaces */
while ( *pszText == ' ' || *pszText == '\n' || *pszText == '\r' ) pszText++;
break;
}
}
/* Strip off any trailing spaces */
while ( szStore[iLoop-1] == ' ' || szStore[iLoop-1] == '\n' || szStore[iLoop-1] == '\r' )
{
iLoop--;
}
/* Terminate the string */
szStore[iLoop] = '\0';
/* Initialise iMax to the size of szStore */
iMax = strlen( szStore );
/* The second loop goes through the string, inserting newlines at every
* appropriate point.
*/
while ( iLength < iMax )
{
/* Go backwards through the current line searching for a space */
while ( szStore[iLength] != ' ' && iLength > 1 )
{
iLength--;
}
if ( szStore[iLength] == ' ' )
{
/* If a space is found, replace it with a newline */
szStore[iLength] = '\n';
iLength += iAlignment;
}
else
{
/* If no space is found, drop out of the loop */
break;
}
}
/* Add spaces to the front of the line as appropriate */
switch ( eJustify )
{
case JUSTIFY_LEFT:
/* Do nothing */
break;
case JUSTIFY_RIGHT:
AddSpaces( &pszResult, 80-iAlignment );
break;
case JUSTIFY_CENTRE:
AddSpaces( &pszResult, (80-iAlignment)/2 );
break;
}
/* Reset the counter */
iLoop = 0;
/* The third and final loop goes through the string, making sure that there
* is a \r (return to beginning of line) following every newline, with no
* white spaces at the beginning of a particular line of text.
*/
while ( iLoop < iMax )
{
/* Store the character */
*pszResult++ = szStore[iLoop];
switch ( szStore[iLoop] )
{
default:
break;
case '\n':
/* Insert a return after the newline and remove any leading spaces */
*pszResult++ = '\r';
while ( szStore[iLoop+1] == ' ' ) iLoop++;
/* Add spaces to the front of the line as appropriate */
switch ( eJustify )
{
case JUSTIFY_LEFT:
/* Do nothing */
break;
case JUSTIFY_RIGHT:
AddSpaces( &pszResult, 80-iAlignment );
break;
case JUSTIFY_CENTRE:
AddSpaces( &pszResult, (80-iAlignment)/2 );
break;
}
break;
}
iLoop++;
}
/* Terminate the string */
*pszResult++ = '\0';
return( &s_szResult[0] );
}
/******************************************************************************
Local operations.
******************************************************************************/
/* Function: AddSpaces
*
* This function is used to add spaces to the front of a line of text. It
* is used for right and centre justification.
*
* The function takes two parameters, as follows:
*
* ppszText: Pointer to the pointer to the string to have the spaces added to.
* iNumber: The number of spaces to be added to the front of the line.
*
* There is no return value.
*/
static void AddSpaces( char **ppszText, int iNumber )
{
int iLoop;
for ( iLoop = 0; iLoop < iNumber; iLoop++ )
{
*(*ppszText)++ = ' ';
}
}