cgic.h File Reference

#include <stdio.h>

Include dependency graph for cgic.h:

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

Go to the source code of this file.

Defines

• #define cgiReferer   cgiReferrer
• #define cgiFormSubmitClicked   cgiFormCheckboxSingle

Typedefs

• typedef struct cgiFileStruct * cgiFilePtr

Enumerations

• enum cgiFormResultType {
    cgiFormSuccess, cgiFormTruncated, cgiFormBadType, cgiFormEmpty,
    cgiFormNotFound, cgiFormConstrained, cgiFormNoSuchChoice, cgiFormMemory,
    cgiFormNoFileName, cgiFormNoContentType, cgiFormNotAFile, cgiFormOpenFailed,
    cgiFormIO, cgiFormEOF
  }
• enum cgiEnvironmentResultType { cgiEnvironmentIO, cgiEnvironmentMemory, cgiEnvironmentSuccess, cgiEnvironmentWrongVersion }

Functions

• cgiFormResultType cgiFormString (const char *name, char *result, int max)
• cgiFormResultType cgiFormStringNoNewlines (const char *name, char *result, int max)
• cgiFormResultType cgiFormStringSpaceNeeded (const char *name, int *length)
• cgiFormResultType cgiFormStringMultiple (const char *name, char ***ptrToStringArray)
• void cgiStringArrayFree (char **stringArray)
• cgiFormResultType cgiFormInteger (const char *name, int *result, int defaultV)
• cgiFormResultType cgiFormIntegerBounded (const char *name, int *result, int min, int max, int defaultV)
• cgiFormResultType cgiFormDouble (const char *name, double *result, double defaultV)
• cgiFormResultType cgiFormDoubleBounded (const char *name, double *result, double min, double max, double defaultV)
• cgiFormResultType cgiFormSelectSingle (const char *name, char **choicesText, int choicesTotal, int *result, int defaultV)
• cgiFormResultType cgiFormSelectMultiple (const char *name, char **choicesText, int choicesTotal, int *result, int *invalid)
• cgiFormResultType cgiFormCheckboxSingle (const char *name)
• cgiFormResultType cgiFormCheckboxMultiple (const char *name, char **valuesText, int valuesTotal, int *result, int *invalid)
• cgiFormResultType cgiFormRadio (const char *name, char **valuesText, int valuesTotal, int *result, int defaultV)
• cgiFormResultType cgiFormFileName (const char *name, char *result, int max)
• cgiFormResultType cgiFormFileContentType (const char *name, char *result, int max)
• cgiFormResultType cgiFormFileSize (const char *name, int *sizeP)
• cgiFormResultType cgiFormFileOpen (const char *name, cgiFilePtr *cfpp)
• cgiFormResultType cgiFormFileRead (cgiFilePtr cfp, char *buffer, int bufferSize, int *gotP)
• cgiFormResultType cgiFormFileClose (cgiFilePtr cfp)
• cgiFormResultType cgiCookieString (const char *name, char *result, int max)
• cgiFormResultType cgiCookieInteger (const char *name, int *result, int defaultV)
• cgiFormResultType cgiCookies (char ***ptrToStringArray)
• void cgiHeaderCookieSetString (const char *name, char *value, int secondsToLive, char *path, char *domain)
• void cgiHeaderCookieSetInteger (const char *name, int value, int secondsToLive, char *path, char *domain)
• void cgiHeaderLocation (const char *redirectUrl)
• void cgiHeaderStatus (int status, const char *statusMessage)
• void cgiHeaderContentType (const char *mimeType)
• cgiEnvironmentResultType cgiWriteEnvironment (char *filename)
• cgiEnvironmentResultType cgiReadEnvironment (char *filename)
• int cgiMain ()
• cgiFormResultType cgiFormEntries (char ***ptrToStringArray)
• cgiFormResultType cgiHtmlEscape (char *s)
• cgiFormResultType cgiHtmlEscapeData (char *data, int len)
• cgiFormResultType cgiValueEscape (char *s)
• cgiFormResultType cgiValueEscapeData (char *data, int len)

Variables

• char * cgiServerSoftware
• char * cgiServerName
• char * cgiGatewayInterface
• char * cgiServerProtocol
• char * cgiServerPort
• char * cgiRequestMethod
• char * cgiPathInfo
• char * cgiPathTranslated
• char * cgiScriptName
• char * cgiQueryString
• char * cgiRemoteHost
• char * cgiRemoteAddr
• char * cgiAuthType
• char * cgiRemoteUser
• char * cgiRemoteIdent
• char * cgiContentType
• char * cgiAccept
• char * cgiUserAgent
• char * cgiReferrer
• char * cgiCookie
• int cgiContentLength
• FILE * cgiOut
• FILE * cgiIn

---

Define Documentation

#define cgiReferer   cgiReferrer

#define cgiFormSubmitClicked   cgiFormCheckboxSingle

Referenced by ReadFromHtml().

---

Typedef Documentation

typedef struct cgiFileStruct* cgiFilePtr

---

Enumeration Type Documentation

enum cgiFormResultType

Enumerator:

cgiFormSuccess
cgiFormTruncated
cgiFormBadType
cgiFormEmpty
cgiFormNotFound
cgiFormConstrained
cgiFormNoSuchChoice
cgiFormMemory
cgiFormNoFileName
cgiFormNoContentType
cgiFormNotAFile
cgiFormOpenFailed
cgiFormIO
cgiFormEOF

enum cgiEnvironmentResultType

Enumerator:

cgiEnvironmentIO
cgiEnvironmentMemory
cgiEnvironmentSuccess
cgiEnvironmentWrongVersion

---

Function Documentation

cgiFormResultType cgiFormString	(	const char *	name,
		char *	result,
		int	max
	)

References cgiFormEntryFindFirst(), and cgiFormEntryString().

Here is the call graph for this function:

cgiFormResultType cgiFormStringNoNewlines	(	const char *	name,
		char *	result,
		int	max
	)

References cgiFormEntryFindFirst(), and cgiFormEntryString().

Here is the call graph for this function:

cgiFormResultType cgiFormStringSpaceNeeded	(	const char *	name,
		int *	length
	)

References cgiFormEntryFindFirst(), and cgiFormEntryStruct::value.

Here is the call graph for this function:

cgiFormResultType cgiFormStringMultiple	(	const char *	name,
		char ***	ptrToStringArray
	)

References CGICDEBUGEND, CGICDEBUGSTART, cgiFormEntryFindFirst(), cgiFormEntryFindNext(), cgiFormEntryString(), cgiStringArrayFree(), and cgiFormEntryStruct::value.

Here is the call graph for this function:

void cgiStringArrayFree

(

char **

stringArray

)

Referenced by cgiCookies(), cgiFormEntries(), and cgiFormStringMultiple().

Here is the caller graph for this function:

cgiFormResultType cgiFormInteger	(	const char *	name,
		int *	result,
		int	defaultV
	)

References cgiFirstNonspaceChar(), cgiFormEntryFindFirst(), and cgiFormEntryStruct::value.

Here is the call graph for this function:

cgiFormResultType cgiFormIntegerBounded	(	const char *	name,
		int *	result,
		int	min,
		int	max,
		int	defaultV
	)

References cgiFormInteger(), and cgiFormSuccess.

Here is the call graph for this function:

cgiFormResultType cgiFormDouble	(	const char *	name,
		double *	result,
		double	defaultV
	)

References cgiFirstNonspaceChar(), cgiFormEntryFindFirst(), and cgiFormEntryStruct::value.

Here is the call graph for this function:

cgiFormResultType cgiFormDoubleBounded	(	const char *	name,
		double *	result,
		double	min,
		double	max,
		double	defaultV
	)

References cgiFormDouble(), and cgiFormSuccess.

Here is the call graph for this function:

cgiFormResultType cgiFormSelectSingle	(	const char *	name,
		char **	choicesText,
		int	choicesTotal,
		int *	result,
		int	defaultV
	)

References CGICDEBUGEND, CGICDEBUGSTART, cgiFormEntryFindFirst(), and cgiStrEq.

Here is the call graph for this function:

cgiFormResultType cgiFormSelectMultiple	(	const char *	name,
		char **	choicesText,
		int	choicesTotal,
		int *	result,
		int *	invalid
	)

References cgiFormEntryFindFirst(), cgiFormEntryFindNext(), cgiStrEq, and cgiFormEntryStruct::value.

Here is the call graph for this function:

cgiFormResultType cgiFormCheckboxSingle

(

const char *

name

)

References cgiFormEntryFindFirst().

Here is the call graph for this function:

cgiFormResultType cgiFormCheckboxMultiple	(	const char *	name,
		char **	valuesText,
		int	valuesTotal,
		int *	result,
		int *	invalid
	)

References cgiFormSelectMultiple().

Here is the call graph for this function:

cgiFormResultType cgiFormRadio	(	const char *	name,
		char **	valuesText,
		int	valuesTotal,
		int *	result,
		int	defaultV
	)

References cgiFormSelectSingle().

Here is the call graph for this function:

cgiFormResultType cgiFormFileName	(	const char *	name,
		char *	result,
		int	max
	)

cgiFormResultType cgiFormFileContentType	(	const char *	name,
		char *	result,
		int	max
	)

cgiFormResultType cgiFormFileSize	(	const char *	name,
		int *	sizeP
	)

cgiFormResultType cgiFormFileOpen	(	const char *	name,
		cgiFilePtr *	cfpp
	)

cgiFormResultType cgiFormFileRead	(	cgiFilePtr	cfp,
		char *	buffer,
		int	bufferSize,
		int *	gotP
	)

References cgiFileStruct::in.

Referenced by cgiWriteEnvironment().

Here is the caller graph for this function:

cgiFormResultType cgiFormFileClose

(

cgiFilePtr

cfp

)

References cgiFileStruct::in.

Referenced by cgiWriteEnvironment().

Here is the caller graph for this function:

cgiFormResultType cgiCookieString	(	const char *	name,
		char *	result,
		int	max
	)

cgiFormResultType cgiCookieInteger	(	const char *	name,
		int *	result,
		int	defaultV
	)

cgiFormResultType cgiCookies

(

char ***

ptrToStringArray

)

References cgiCookie, and cgiStringArrayFree().

Here is the call graph for this function:

void cgiHeaderCookieSetString	(	const char *	name,
		char *	value,
		int	secondsToLive,
		char *	path,
		char *	domain
	)

void cgiHeaderCookieSetInteger	(	const char *	name,
		int	value,
		int	secondsToLive,
		char *	path,
		char *	domain
	)

void cgiHeaderLocation

(

const char *

redirectUrl

)

References cgiOut.

void cgiHeaderStatus	(	int	status,
		const char *	statusMessage
	)

References cgiOut.

void cgiHeaderContentType

(

const char *

mimeType

)

References cgiOut.

cgiEnvironmentResultType cgiWriteEnvironment

(

char *

filename

)

References cgiFormEntryStruct::attr, cgiAccept, cgiAuthType, cgiContentLength, cgiContentType, cgiCookie, cgiFormFileClose(), cgiFormFileOpen(), cgiFormFileRead(), cgiFormSuccess, cgiGatewayInterface, cgiPathInfo, cgiPathTranslated, cgiQueryString, cgiReferrer, cgiRemoteAddr, cgiRemoteHost, cgiRemoteIdent, cgiRemoteUser, cgiRequestMethod, cgiScriptName, cgiServerName, cgiServerPort, cgiServerProtocol, cgiServerSoftware, cgiUserAgent, cgiWriteInt(), cgiWriteString(), cgiFormEntryStruct::contentType, cgiFormEntryStruct::fileName, cgiFormEntryStruct::next, cgiFormEntryStruct::value, and cgiFormEntryStruct::valueLength.

Here is the call graph for this function:

cgiEnvironmentResultType cgiReadEnvironment

(

char *

filename

)

References cgiFormEntryStruct::attr, cgiAccept, cgiAuthType, CGIC_VERSION, cgiContentLength, cgiContentType, cgiCookie, cgiFreeResources(), cgiGatewayInterface, cgiParseSuccess, cgiPathInfo, cgiPathTranslated, cgiQueryString, cgiReadInt(), cgiReadString(), cgiReferrer, cgiRemoteAddr, cgiRemoteHost, cgiRemoteIdent, cgiRemoteUser, cgiRequestMethod, cgiRestored, cgiScriptName, cgiServerName, cgiServerPort, cgiServerProtocol, cgiServerSoftware, cgiUserAgent, cgiFormEntryStruct::contentType, cgiFormEntryStruct::fileName, getTempFileName(), cgiFormEntryStruct::next, cgiFormEntryStruct::tfileName, cgiFormEntryStruct::value, and cgiFormEntryStruct::valueLength.

Here is the call graph for this function:

int cgiMain

(

)

Referenced by main().

Here is the caller graph for this function:

cgiFormResultType cgiFormEntries

(

char ***

ptrToStringArray

)

References cgiFormEntryStruct::attr, cgiStringArrayFree(), and cgiFormEntryStruct::next.

Here is the call graph for this function:

cgiFormResultType cgiHtmlEscape

(

char *

s

)

References cgiHtmlEscapeData().

Here is the call graph for this function:

cgiFormResultType cgiHtmlEscapeData	(	char *	data,
		int	len
	)

References TRYPUTC.

Referenced by cgiHtmlEscape().

Here is the caller graph for this function:

cgiFormResultType cgiValueEscape

(

char *

s

)

References cgiValueEscapeData().

Here is the call graph for this function:

cgiFormResultType cgiValueEscapeData	(	char *	data,
		int	len
	)

References TRYPUTC.

Referenced by cgiValueEscape().

Here is the caller graph for this function:

---

Variable Documentation

char* cgiServerSoftware

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiServerName

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiGatewayInterface

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiServerProtocol

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiServerPort

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiRequestMethod

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiPathInfo

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiPathTranslated

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiScriptName

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiQueryString

Referenced by cgiFreeResources(), cgiParseGetFormInput(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiRemoteHost

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiRemoteAddr

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiAuthType

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiRemoteUser

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiRemoteIdent

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiContentType

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiAccept

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiUserAgent

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiReferrer

Referenced by cgiFreeResources(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

char* cgiCookie

Referenced by cgiCookies(), cgiCookieString(), cgiReadEnvironment(), cgiWriteEnvironment(), and main().

int cgiContentLength

Referenced by cgiParseGetFormInput(), cgiParsePostFormInput(), cgiParsePostMultipartInput(), cgiReadEnvironment(), cgiWriteEnvironment(), main(), and mpRead().

FILE* cgiOut

Referenced by cgiHeaderContentType(), cgiHeaderCookieSetString(), cgiHeaderLocation(), cgiHeaderStatus(), and main().

FILE* cgiIn

Referenced by cgiParsePostFormInput(), main(), and mpRead().