Updated documentation

This commit is contained in:
Justin J. Meza 2010-12-21 22:16:22 -05:00
parent 78456aabfd
commit 6ebeb26d18
4 changed files with 107 additions and 70 deletions

View File

@ -20,7 +20,14 @@ char *createString(char *data) /**< [in] A pointer to the string data to store.
*
* \return A pointer to a nil type ValueObject structure.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createBooleanValueObject(int)
* \see createIntegerValueObject(int)
* \see createFloatValueObject(float)
* \see createStringValueObject(char *)
* \see createFunctionValueObject(FuncDefStmtNode *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createNilValueObject(void)
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -38,7 +45,14 @@ ValueObject *createNilValueObject(void)
* \return A pointer to a boolean type ValueObject structure with value
* \c 0 if \a data equals 0 and \c 1 otherwise.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createNilValueObject(void)
* \see createIntegerValueObject(int)
* \see createFloatValueObject(float)
* \see createStringValueObject(char *)
* \see createFunctionValueObject(FuncDefStmtNode *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createBooleanValueObject(int data) /**< [in] The boolean data to store. */
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -57,7 +71,14 @@ ValueObject *createBooleanValueObject(int data) /**< [in] The boolean data to st
* \return A pointer to an integer type ValueObject structure with value
* \a data.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createNilValueObject(void)
* \see createBooleanValueObject(int)
* \see createFloatValueObject(float)
* \see createStringValueObject(char *)
* \see createFunctionValueObject(FuncDefStmtNode *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createIntegerValueObject(int data) /**< [in] The integer data to store. */
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -76,7 +97,14 @@ ValueObject *createIntegerValueObject(int data) /**< [in] The integer data to st
* \return A pointer to a floating point decimal type ValueObject structure
* with value \a data.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createNilValueObject(void)
* \see createBooleanValueObject(int)
* \see createIntegerValueObject(int)
* \see createStringValueObject(char *)
* \see createFunctionValueObject(FuncDefStmtNode *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createFloatValueObject(float data) /**< [in] The floating point data to store. */
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -94,7 +122,14 @@ ValueObject *createFloatValueObject(float data) /**< [in] The floating point dat
*
* \return A pointer to a string type ValueObject structure with value \a data.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createNilValueObject(void)
* \see createBooleanValueObject(int)
* \see createIntegerValueObject(int)
* \see createFloatValueObject(float)
* \see createFunctionValueObject(FuncDefStmtNode *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createStringValueObject(char *data) /**< [in] The string data to store. */
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -112,7 +147,14 @@ ValueObject *createStringValueObject(char *data) /**< [in] The string data to st
*
* \return A pointer to a function type ValueObject structure with definition \a data.
*
* \retval NULL malloc was unable to allocate memory. */
* \retval NULL malloc was unable to allocate memory.
*
* \see createNilValueObject(void)
* \see createBooleanValueObject(int)
* \see createIntegerValueObject(int)
* \see createFloatValueObject(float)
* \see createStringValueObject(char *)
* \see deleteValueObject(ValueObject *) */
ValueObject *createFunctionValueObject(FuncDefStmtNode *data) /**< [in] The function definition to store. */
{
ValueObject *p = malloc(sizeof(ValueObject));
@ -350,7 +392,7 @@ void deleteScopeObject(ScopeObject *scope) /**< [in,out] The ScopeObject structu
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \return A pointer to the stored ValueObject structure named by \a target.
*
@ -391,7 +433,7 @@ ValueObject *getScopeValue(ScopeObject *scope, /**< [in] The ScopeObject str
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \return A pointer to the stored ValueObject structure named by \a target.
*
@ -427,7 +469,7 @@ ValueObject *getLocalScopeValue(ScopeObject *scope, /**< [in] The ScopeObjec
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \return A pointer to the newly created ValueObject structure named by
* \a target.
@ -478,7 +520,7 @@ ValueObject *createScopeValue(ScopeObject *scope, /**< [in,out] The ScopeObj
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre The value named by \a target was created by createScopeValue(ScopeObject *, IdentifierNode *).
* \pre \a value was created by either createNilValueObject(void), createBooleanValueObject(int),
* createIntegerValueObject(int), createFloatValueObject(float), createStringValueObject(char *),
@ -533,7 +575,7 @@ ValueObject *updateScopeValue(ScopeObject *scope, /**< [in,out] A pointer to
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \see getScopeValue(ScopeObject *, IdentifierNode *)
* \see getLocalScopeValue(ScopeObject *, IdentifierNode *)
@ -1289,7 +1331,7 @@ ValueObject *interpretCastExprNode(ExprNode *node, /**< [in] A pointer to an
*
* \pre \a node was created by createExprNode(ExprType type, void *expr)
* where \a type is ET_FUNCCALL and \a expr is a FunctionCallExprNode
* structure created by createFuncCallExprNode(FuncDefStmtNode *, ExprNodeList *).
* structure created by createFuncCallExprNode(IdentifierNode *, IdentifierNode *, ExprNodeList *).
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
@ -1386,7 +1428,7 @@ ValueObject *interpretFuncCallExprNode(ExprNode *node, /**< [in] A pointer t
*
* \pre \a node was created by createExprNode(ExprType type, void *expr)
* where \a type is ET_IDENTIFIER and \a expr is an IdentifierNode
* structure created by createIdentifierNode(char *, const char *, unsigned int).
* structure created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
@ -2424,7 +2466,7 @@ ValueObject *opNeqFloatFloat(ValueObject *a, /**< [in] The first value to test.
/** Tests if two boolean values are equal.
*
* \pre \a a and \a b were created by createBooleanValueObject(float).
* \pre \a a and \a b were created by createBooleanValueObject(int).
*
* \return A pointer to a ValueObject structure containing a boolean value
* indicating whether \a a is equal to \a b.
@ -2438,7 +2480,7 @@ ValueObject *opEqBooleanBoolean(ValueObject *a, /**< [in] The first value to tes
/** Tests if two boolean values are not equal.
*
* \pre \a a and \a b were created by createBooleanValueObject(float).
* \pre \a a and \a b were created by createBooleanValueObject(int).
*
* \return A pointer to a ValueObject structure containing a boolean value
* indicating whether \a a is not equal to \a b.
@ -2962,7 +3004,7 @@ ReturnObject *interpretAssignmentStmtNode(StmtNode *node, /**< [in] A pointe
/** Interprets a declaration statement.
*
* \pre \a node was created by createStmtNode(StmtType type, void *stmt) where
* \a type is ST_DECLARATION and \a stmt was created by createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *).
* \a type is ST_DECLARATION and \a stmt was created by createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *, TypeNode *).
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).
@ -3437,7 +3479,7 @@ ReturnObject *interpretDeallocationStmtNode(StmtNode *node, /**< [in] A poin
/** Interprets a function definition statement.
*
* \pre \a node was created by createStmtNode(StmtType type, void *stmt) where
* \a type is ST_SWITCH and \a stmt was created by createSwitchStmtNode(IdentifierNode *, IdentifierNode *, IdentifierNodeList *, BlockNode *).
* \a type is ST_SWITCH and \a stmt was created by createSwitchStmtNode(ExprNodeList *, BlockNodeList *, BlockNode *).
* \pre \a scope was created by createScopeObject(ScopeObject *) and contains
* contents added by createScopeValue(ScopeObject *, IdentifierNode *) and
* contents updated by updateScopeValue(ScopeObject *, IdentifierNode *, ValueObject *).

View File

@ -280,12 +280,12 @@ IdentifierNode *createIdentifierNode(IdentifierType type, /**< [in] The type of
/** Deletes an IdentifierNode structure.
*
* \pre \a node was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a node was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \post The memory at \a node and any of its associated members will be
* freed.
*
* \see createIdentifierNode(char *, const char *, unsigned int) */
* \see createIdentifierNode(IdentifierType, void *, const char *, unsigned int) */
void deleteIdentifierNode(IdentifierNode *node) /**< [in,out] A pointer to the IdentifierNode structure to be deleted. */
{
if (!node) return;
@ -329,7 +329,7 @@ IdentifierNodeList *createIdentifierNodeList(void)
/** Adds an IdentifierNode structure to an IdentifierNodeList structure.
*
* \pre \a list was created by createIdentifierNodeList(void).
* \pre \a node was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a node was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \post \a node will be added on to the end of \a list and the size of
* \a list will be updated accordingly.
@ -412,7 +412,7 @@ void deleteTypeNode(TypeNode *node) /**< [in,out] A pointer to the TypeNode stru
* - ST_PRINT: createPrintStmtNode(ExprNodeList *, int)
* - ST_INPUT: createInputStmtNode(IdentifierNode *)
* - ST_ASSIGNMENT: createAssignmentStmtNode(IdentifierNode *, ExprNode *)
* - ST_DECLARATION: createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *)
* - ST_DECLARATION: createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *, TypeNode *)
* - ST_IFTHENELSE: createIfThenElseStmtNode(BlockNode *, BlockNode *, ExprNodeList *, BlockNodeList *)
* - ST_SWITCH: createSwitchStmtNode(ExprNodeList *, BlockNodeList *, BlockNode *)
* - ST_BREAK: no structure needed, use \c NULL
@ -588,7 +588,7 @@ void deleteStmtNodeList(StmtNodeList *list) /**< [in,out] A pointer to the StmtN
/** Creates a CastStmtNode structure.
*
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a newtype was created by createTypeNode(ConstantType).
*
* \return A pointer to a CastStmtNode structure with the desired properties.
@ -665,7 +665,7 @@ void deletePrintStmtNode(PrintStmtNode *node) /**< [in,out] A pointer to the Pri
/** Creates an InputStmtNode structure.
*
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \return A pointer to an InputStmtNode structure with the desired properties.
*
@ -700,7 +700,7 @@ void deleteInputStmtNode(InputStmtNode *node) /**< [in,out] A pointer to the Inp
/** Creates an AssignmentStmtNode structure.
*
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a expr was created by createExprNode(ExprType, void *).
*
* \return A pointer to an AssignmentStmtNode structure with the desired
@ -740,8 +740,8 @@ void deleteAssignmentStmtNode(AssignmentStmtNode *node) /**< [in,out] A pointer
/** Creates a DeclarationStmtNode structure.
*
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a scope was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a expr was created by createExprNode(ExprType, void *).
*
* \return A pointer to a DeclarationStmtNode structure with the desired
@ -769,12 +769,12 @@ DeclarationStmtNode *createDeclarationStmtNode(IdentifierNode *scope, /**< [in]
/** Deletes a DeclarationStmtNode structure.
*
* \pre \a node was created by createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *).
* \pre \a node was created by createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *, TypeNode *).
*
* \post The memory at \a node and any of its associated members will be
* freed.
*
* \see createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *) */
* \see createDeclarationStmtNode(IdentifierNode *, IdentifierNode *, ExprNode *, TypeNode *) */
void deleteDeclarationStmtNode(DeclarationStmtNode *node) /**< [in,out] A pointer to the DeclarationStmtNode structure to be deleted. */
{
if (!node) return;
@ -917,8 +917,8 @@ void deleteReturnStmtNode(ReturnStmtNode *node) /**< [in,out] A pointer to the R
/** Creates a LoopStmtNode structure.
*
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a var was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a name was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a var was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a guard was created by createExprNode(ExprType, void *).
* \pre \a update was created by createExprNode(ExprType, void *).
* \pre \a body was created by createBlockNode(StmtNodeList *).
@ -968,7 +968,7 @@ void deleteLoopStmtNode(LoopStmtNode *node) /**< [in,out] A pointer to the LoopS
/** Creates a DeallocationStmtNode structure.
*
* \pre \a target was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a target was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
*
* \return A pointer to a DeallocationStmtNode structure with the desired
* properties.
@ -1004,8 +1004,8 @@ void deleteDeallocationStmtNode(DeallocationStmtNode *node) /**< [in,out] A poin
/** Creates a FuncDefStmtNode structure.
*
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a scope was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a name was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a args was created by createIdentifierNodeList(void) and contains
* items added by addIdentifierNode(IdentifierNodeList *, IdentifierNode *).
* \pre \a body was created by createBlockNode(StmtNodeList *).
@ -1057,7 +1057,7 @@ void deleteFuncDefStmtNode(FuncDefStmtNode *node) /**< [in,out] A pointer to the
* - ET_CAST: createCastExprNode(ExprNode *, TypeNode *)
* - ET_CONSTANT: createBooleanConstantNode(int), createIntegerConstantNode(int),
* createFloatConstantNode(float), or createStringConstantNode(char *)
* - ET_IDENTIFIER: createIdentifierNode(char *, const char *, unsigned int)
* - ET_IDENTIFIER: createIdentifierNode(IdentifierType, void *, const char *, unsigned int)
* - ET_FUNCCALL: createFuncCallExprNode(IdentifierNode *, IdentifierNode *, ExprNodeList *)
* - ET_OP: createOpExprNode(OpType, ExprNodeList *)
* - ET_IMPVAR: (for the \ref impvar "implicit variable") no structure needed, use \c NULL
@ -1223,8 +1223,8 @@ void deleteCastExprNode(CastExprNode *node) /**< [in,out] A pointer to the CastE
/** Creates a FuncCallExprNode structure.
*
* \pre \a scope was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a name was created by createIdentifierNode(char *, const char *, unsigned int).
* \pre \a scope was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a name was created by createIdentifierNode(IdentifierType, void *, const char *, unsigned int).
* \pre \a args was created by createIdentifierNodeList(void) and contains
* items added by addIdentifierNode(IdentifierNodeList *, IdentifierNode *).
*
@ -1311,7 +1311,7 @@ void deleteOpExprNode(OpExprNode *node) /**< [in,out] A pointer to the OpExprNod
* function \b does modify \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post If the token pointed to by \a tokenp does not match \a token,
* \a tokenp will point to the same token as when the function was
@ -1340,7 +1340,7 @@ int acceptToken(Token ***tokenp, /**< [in,out] A pointer to the position of the
* modify \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the same token as when the function was
* called.
@ -1365,7 +1365,7 @@ int peekToken(Token ***tokenp, /**< [in] A pointer to the position of the next t
* modify \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the same token as when the function was
* called.
@ -1387,7 +1387,7 @@ int nextToken(Token ***tokenp, /**< [in] A pointer to the position of the next t
* is the line the next token appears on, INFO is \a info and NEXT is the image
* of the next token.
*
* \pre \a tokens was created by tokenizeLexemes(Lexeme **). */
* \pre \a tokens was created by tokenizeLexemes(LexemeList *). */
void error(const char *info, /**< [in] The array of characters to print. */
Token **tokens) /**< [in] A pointer to an array of tokens to parse. */
{
@ -1398,7 +1398,7 @@ void error(const char *info, /**< [in] The array of characters to print. */
* token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1524,7 +1524,7 @@ parseConstantNodeAbort: /* Exception handling */
* token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1614,7 +1614,7 @@ parseTypeNodeAbort: /* Exception handling */
* the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1711,7 +1711,7 @@ parseIdentifierNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1786,7 +1786,7 @@ parseCastExprNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1839,7 +1839,7 @@ parseConstantExprNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -1892,7 +1892,7 @@ parseIdentifierExprNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2004,7 +2004,7 @@ parseFuncCallExprNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2241,7 +2241,7 @@ parseOpExprNodeAbort: /* Exception handling */
* token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2330,7 +2330,7 @@ ExprNode *parseExprNode(Token ***tokenp) /**< [in,out] A pointer to the position
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2416,7 +2416,7 @@ parseCastStmtNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2516,7 +2516,7 @@ parsePrintStmtNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2597,7 +2597,7 @@ parseInputStmtNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2683,7 +2683,7 @@ parseAssignmentStmtNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2786,7 +2786,7 @@ parseDeclarationStmtNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -2951,7 +2951,7 @@ parseIfThenElseStmtNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3137,7 +3137,7 @@ parseSwitchStmtNodeAbort: /* Exception handling */
* statement. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3203,7 +3203,7 @@ parseBreakStmtNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3282,7 +3282,7 @@ parseReturnStmtNodeAbort: /* Exception handling */
* structure. Parsing begins at the token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3645,7 +3645,7 @@ parseLoopStmtNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3726,7 +3726,7 @@ parseDeallocationStmtNodeAbort: /* Exception handling */
* \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -3864,7 +3864,7 @@ parseFuncDefStmtNodeAbort: /* Exception handling */
* token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -4022,7 +4022,7 @@ StmtNode *parseStmtNode(Token ***tokenp) /**< [in,out] A pointer to the position
* token pointed to by \a tokenp.
*
* \pre \a tokenp points to a position in an array of tokens created by
* tokenizeLexemes(Lexeme **).
* tokenizeLexemes(LexemeList *).
*
* \post \a tokenp will point to the next \b unparsed token in the array.
*
@ -4103,7 +4103,7 @@ parseBlockNodeAbort: /* Exception handling */
* passed along to a later stage of processing such as, for example, an
* interpreter.
*
* \pre \a tokens was created by tokenizeLexemes(Lexeme **).
* \pre \a tokens was created by tokenizeLexemes(LexemeList *).
*
* \return A pointer to the generated MainNode structure.
*

View File

@ -150,11 +150,6 @@ int isIdentifier(const char *image) /**< [in] The string of characters to compar
cur++;
while (*cur) {
if (isalnum(*cur) || *cur == '_') cur++;
/* Proposed LOLCODE Version 1.3 identifiers
* Remember to update expression: [a-zA-Z][a-zA-Z0-9]*([!!|!?][a-zA-Z][a-zA-Z0-9]*)*
else if (*cur == '!' && *(cur + 1) && *(cur + 1) == '!') cur += 2;
else if (*cur == '!' && *(cur + 1) && *(cur + 1) == '?') cur += 2;
*/
else return 0;
}
return 1;

View File

@ -1,5 +1,5 @@
/** Data and functions for converting from Unicode normative names to
* codepoints.
* code points.
*
* \file unicode.h
*