inc/htmshell.h File Reference

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

Go to the source code of this file.

Functions
void	htmlSetCookie (char *name, char *value, char *expires, char *path, char *domain, boolean isSecure)
void	htmlParagraph (char *line,...)
void	htmlVaParagraph (char *line, va_list args)
void	htmlCenterParagraph (char *line,...)
void	htmlHorizontalLine ()
void	htmlNbSpaces (int count)
void	htmHorizontalLine (FILE *f)
void	htmTextOut (FILE *f, char *s)
void	htmlTextOut (char *s)
char *	htmlEncode (char *s)
void	htmlMemDeath ()
void	htmlStart (char *title)
void	htmStart (FILE *f, char *title)
void	htmlEnd ()
void	htmEnd (FILE *f)
void	htmlSetStyle (char *style)
void	htmlSetBackground (char *imageFile)
void	htmlSetBgColor (int color)
void	htmlEchoInput ()
void	htmlBadVar (char *varName)
void	htmlImage (char *fileName, int width, int height)
void	htmlVaWarn (char *format, va_list args)
char *	htmlWarnStartPattern ()
char *	htmlWarnEndPattern ()
void	htmlAbort ()
void	htmlPushEarlyHandlers ()
void	htmErrOnlyShell (void(*doMiddle)())
void	htmEmptyShell (void(*doMiddle)(), char *method)
void	htmShell (char *title, void(*doMiddle)(), char *method)
void	htmShellWithHead (char *title, char *head, void(*doMiddle)(), char *method)
void	htmlNoEscape ()
void	htmlDoEscape ()
void	htmlIncludeWebFile (char *file)
void	htmlIncludeFile (char *path)
Variables
char *	htmlStyleUndecoratedLink
jmp_buf	htmlRecover

---

Function Documentation

void htmEmptyShell	(	void(*)()	doMiddle,
		char *	method
	)

Definition at line 408 of file htmshell.c.

References htmlAbort(), htmlRecover, htmlVaWarn(), popAbortHandler(), popWarnHandler(), pushAbortHandler(), and pushWarnHandler().

Referenced by htmShell(), and htmShellWithHead().

{
int status;

/* Set up error recovery (for out of memory and the like)
 * so that we finish web page regardless of problems. */
pushAbortHandler(htmlAbort);
pushWarnHandler(htmlVaWarn);
status = setjmp(htmlRecover);

/* Do your main thing. */
if (status == 0)
    {
    doMiddle();
    }

popWarnHandler();
popAbortHandler();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmEnd

(

FILE *

f

)

Definition at line 367 of file htmshell.c.

Referenced by doDetailLine(), and htmlEnd().

{
fputs("\n</BODY>\n</HTML>\n", f);
}

Here is the caller graph for this function:

void htmErrOnlyShell

(

void(*)()

doMiddle

)

Definition at line 393 of file htmshell.c.

References htmlRecover.

{
int status;

/* Set up error recovery. */
status = setjmp(htmlRecover);

/* Do your main thing. */
if (status == 0)
    {
    doMiddle();
    }
}

void htmHorizontalLine

(

FILE *

f

)

Definition at line 74 of file htmshell.c.

Referenced by pslShowAlignmentStranded().

{
fprintf(f, "<P><HR ALIGN=\"CENTER\"></P>");
}

Here is the caller graph for this function:

void htmlAbort

(

)

Definition at line 218 of file htmshell.c.

References htmlRecover.

Referenced by htmEmptyShell().

{
longjmp(htmlRecover, -1);
}

Here is the caller graph for this function:

void htmlBadVar

(

char *

varName

)

Definition at line 382 of file htmshell.c.

References cgiBadVar().

{
cgiBadVar(varName);
}

Here is the call graph for this function:

void htmlCenterParagraph	(	char *	line,
			...
	)

Definition at line 60 of file htmshell.c.

References htmlVaCenterParagraph().

{
va_list args;
va_start(args, line);
htmlVaCenterParagraph(line, args);
va_end(args);
}

Here is the call graph for this function:

void htmlDoEscape

(

)

Definition at line 31 of file htmshell.c.

References FALSE, and NoEscape.

{
NoEscape = FALSE;
}

void htmlEchoInput

(

)

Definition at line 378 of file htmshell.c.

{
}

char* htmlEncode

(

char *

s

)

Definition at line 127 of file htmshell.c.

References needMem().

{
size_t len = 0;
char c;
char *encStr;
char *p = s;
/* First pass through s to determine encoded length to allocate: */
/* [as a shortcut, we could simply allocate 6*length of s] */
while ((c = *p++) != 0)
    {
    switch (c)
        {
        case '>':
        case '<':
            len += 4;
            break;
        case '&':
            len += 5;
            break;
        case '"':
            len += 6;
            break;
        default:
            len++;
            break;
        }
    }
encStr = needMem(len+1);
/* Second pass through s to encode: */
len = 0;
p = s;
while ((c = *p++) != 0)
    {
    switch (c)
        {
        case '>':
            strcat(encStr+len, "&gt;");
            len += 4;
            break;
        case '<':
            strcat(encStr+len, "&lt;");
            len += 4;
            break;
        case '&':
            strcat(encStr+len, "&amp;");
            len += 5;
            break;
        case '"':
            strcat(encStr+len, "&quot;");
            len += 6;
            break;
        default:
            encStr[len++] = c;
            break;
        }
    }
return encStr;
}

Here is the call graph for this function:

void htmlEnd

(

)

Definition at line 373 of file htmshell.c.

References htmEnd().

Referenced by htmShell(), and htmShellWithHead().

{
htmEnd(stdout);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlHorizontalLine

(

)

Definition at line 68 of file htmshell.c.

References htmlParagraph().

Referenced by htmlVaWarn().

{
htmlParagraph("<HR ALIGN=\"CENTER\">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlImage	(	char *	fileName,
		int	width,
		int	height
	)

Definition at line 388 of file htmshell.c.

{
printf("<P ALIGN=\"CENTER\"><IMG SRC=\"%s\" WIDTH=\"%d\" HEIGHT=\"%d\" ALIGN=\"BOTTOM\" BORDER=\"0\"></P>", fileName, width, height);
}

void htmlIncludeFile

(

char *

path

)

Definition at line 479 of file htmshell.c.

References errAbort(), fileExists(), freeMem(), and readInGulp().

Referenced by htmlIncludeWebFile().

{
char *str = NULL;
size_t len = 0;

if (path == NULL)
    errAbort("Program error: including null file");
if (!fileExists(path))
   errAbort("Missing file %s", path); 
readInGulp(path, &str, &len);

if (len <= 0)
    errAbort("Error reading included file: %s", path);

puts(str);
freeMem(str);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlIncludeWebFile

(

char *

file

)

Definition at line 499 of file htmshell.c.

References htmlIncludeFile(), and safef().

{
char path[256];
char *docRoot = "/usr/local/apache/htdocs";

safef(path, sizeof path, "%s/%s", docRoot, file);
htmlIncludeFile(path);
}

Here is the call graph for this function:

void htmlMemDeath

(

)

Definition at line 224 of file htmshell.c.

References errAbort().

{
errAbort("Out of memory.");
}

Here is the call graph for this function:

void htmlNbSpaces

(

int

count

)

Definition at line 80 of file htmshell.c.

{
int i;
for (i=0; i<count; ++i)
    printf("&nbsp;");
}

void htmlNoEscape

(

)

Definition at line 26 of file htmshell.c.

References NoEscape, and TRUE.

{
NoEscape = TRUE;
}

void htmlParagraph	(	char *	line,
			...
	)

Definition at line 44 of file htmshell.c.

References htmlVaParagraph().

Referenced by htmlHorizontalLine().

{
va_list args;
va_start(args, line);
htmlVaParagraph(line, args);
va_end(args);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlPushEarlyHandlers

(

)

Definition at line 250 of file htmshell.c.

References earlyAbortHandler(), earlyWarningHandler(), pushAbortHandler(), and pushWarnHandler().

Referenced by main().

{
pushWarnHandler(earlyWarningHandler);
pushAbortHandler(earlyAbortHandler);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlSetBackground

(

char *

imageFile

)

Definition at line 284 of file htmshell.c.

References htmlBackground.

Referenced by main().

{
htmlBackground = imageFile;
}

Here is the caller graph for this function:

void htmlSetBgColor

(

int

color

)

Definition at line 294 of file htmshell.c.

References gotBgColor, htmlBgColor, and TRUE.

{
htmlBgColor = color;
gotBgColor = TRUE;
}

void htmlSetCookie	(	char *	name,
		char *	value,
		char *	expires,
		char *	path,
		char *	domain,
		boolean	isSecure
	)

Definition at line 302 of file htmshell.c.

References cgiEncode(), and TRUE.

{
char* encoded_name;
char* encoded_value;
char* encoded_path = NULL;

encoded_name = cgiEncode(name);
encoded_value = cgiEncode(value);
if(path != NULL)
        encoded_path = cgiEncode(path);

printf("Set-Cookie: %s=%s; ", encoded_name, encoded_value);

if(expires != NULL)
    printf("expires=%s; ", expires);

if(path != NULL)
    printf("path=%s; ", encoded_path);

if(domain != NULL)
    printf("domain=%s; ", domain);

if(isSecure == TRUE)
    printf("secure");

printf("\n");
}

Here is the call graph for this function:

void htmlSetStyle

(

char *

style

)

Definition at line 273 of file htmshell.c.

References htmlStyle.

{
htmlStyle = style;
}

void htmlStart

(

char *

title

)

Definition at line 349 of file htmshell.c.

References _htmStart().

Referenced by earlyWarningHandler(), and htmShell().

{
puts("Content-Type:text/html");
puts("\n");

puts("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2//EN\">");
_htmStart(stdout, title);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmlTextOut

(

char *

s

)

Definition at line 121 of file htmshell.c.

References htmTextOut().

{
htmTextOut(stdout, s);
}

Here is the call graph for this function:

void htmlVaParagraph	(	char *	line,
		va_list	args
	)

Definition at line 36 of file htmshell.c.

Referenced by earlyWarningHandler(), htmlParagraph(), and htmlVaWarn().

{
fputs("<P>", stdout);
vfprintf(stdout, line, args);
fputs("</P>\n", stdout);
}

Here is the caller graph for this function:

void htmlVaWarn	(	char *	format,
		va_list	args
	)

Definition at line 200 of file htmshell.c.

References htmlHorizontalLine(), htmlVaParagraph(), htmlWarnEndPattern(), htmlWarnStartPattern(), and va_copy.

Referenced by htmEmptyShell().

{
va_list argscp;
va_copy(argscp, args);

htmlHorizontalLine();
printf("%s", htmlWarnStartPattern());
htmlVaParagraph(format,args);
printf("%s", htmlWarnEndPattern());
htmlHorizontalLine();

/* write warning/error message to stderr so they get logged. */
vfprintf(stderr, format, argscp);
va_end(argscp);
fputc('\n', stderr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

char* htmlWarnEndPattern

(

)

Definition at line 194 of file htmshell.c.

Referenced by earlyWarningHandler(), htmlVaWarn(), and qaScanForErrorMessage().

{
return "<!-- HGERROR-END -->\n";
}

Here is the caller graph for this function:

char* htmlWarnStartPattern

(

)

Definition at line 188 of file htmshell.c.

Referenced by earlyWarningHandler(), htmlVaWarn(), and qaScanForErrorMessage().

{
return "<!-- HGERROR-START -->\n";
}

Here is the caller graph for this function:

void htmShell	(	char *	title,
		void(*)()	doMiddle,
		char *	method
	)

Definition at line 434 of file htmshell.c.

References dnaUtilOpen(), htmEmptyShell(), htmlEnd(), and htmlStart().

Referenced by webBlat().

{
/* Preamble. */
dnaUtilOpen();
htmlStart(title);

/* Call wrapper for error handling. */
htmEmptyShell(doMiddle, method);

/* Post-script. */
htmlEnd();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmShellWithHead	(	char *	title,
		char *	head,
		void(*)()	doMiddle,
		char *	method
	)

Definition at line 456 of file htmshell.c.

References dnaUtilOpen(), htmEmptyShell(), htmlBackground, and htmlEnd().

{
/* Preamble. */
dnaUtilOpen();

puts("Content-Type:text/html");
puts("\n");

puts("<HTML>");
printf("<HEAD>%s<TITLE>%s</TITLE>\n</HEAD>\n\n", head, title);
if (htmlBackground == NULL)
    puts("<BODY>\n");
else
    printf("<BODY BACKGROUND=\"%s\">\n", htmlBackground);

/* Call wrapper for error handling. */
htmEmptyShell(doMiddle, method);

/* Post-script. */
htmlEnd();
}

Here is the call graph for this function:

void htmStart	(	FILE *	f,
		char *	title
	)

Definition at line 359 of file htmshell.c.

References _htmStart().

Referenced by doDetailLine().

{
fputs("<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 3.2//EN\">\n", f);
_htmStart(f, title);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void htmTextOut	(	FILE *	f,
		char *	s
	)

Definition at line 88 of file htmshell.c.

References NoEscape.

Referenced by htmlTextOut().

{
char c;
if (NoEscape)
    {
    fputs(s, f);
    return;
    }

while ((c = *s++) != 0)
    {
    switch (c)
        {
        case '>':
            fputs(">", f);
            break;
        case '<':
            fputs("&lt;", f);
            break;
        case '&':
            fputs("&amp;", f);
            break;
        case '"':
            fputs("&quot;", f);
            break;
        default:
            fputc(c, f);
            break;
        }
    }
}

Here is the caller graph for this function:

---

Variable Documentation

jmp_buf htmlRecover

Definition at line 88 of file htmshell.h.

Referenced by htmEmptyShell(), htmErrOnlyShell(), and htmlAbort().

char* htmlStyleUndecoratedLink

Definition at line 265 of file htmshell.c.

---