cdez/Anti-GUR-Checker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Initialize the Project

Browse source 
++ 249Utilities
++ Main Program
++ Utilities for File IO and Console
++ Makefile template for the project
This commit is contained in:
Charles Descamps 2023-11-16 10:32:18 -07:00
parent ef3115db5f
commit 29bc5d4dee
12 changed files with 2872 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

141
249GURUtility.h Normal file
View file

@ -0,0 +1,141 @@
/*
Name: checkForSingleLetterVariable (GUR 1 - 249)
Process: checks for single letter variables in code, warns if there may be a
variable that is less than three letters long. Will only warn at the
definition of a variable and within function declaration.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForCurlyBraces (GUR 2 - 249)
Process: checks for missing or non aligned curly braces, will warn if there are
unaligned or missing braces.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForRedundantBoolean (GUR 3 - 249)
Process: checks for redundant boolean test, in other words, if there is a bool
expression, and that is being compared to true or false.
e.g. <boolean expression> == true or == false
Warns if an a bool type is going to be compared to true or false.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForDoubleIf (GUR 4 - 249)
Process: checks for back to back if statements. This comes down to the programmer
logic to make sure, but will warn for "double if" if there is two if
statements that could be logically else or else if. Will warn if there
are two if statements found next to each other.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForDataStateChange (GUR 5 - 249)
Process: checks for increment or decrementing changes within an array call or
function call. Warns if there is any function parameter found with a
state change, or if there is an array call parameter with a data change.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForDeclaredLoopVariable (GUR 6 - 249)
Process: checks for any variable that is declared WITHIN a loop, either in the
loop's parameter, or inside the loop itself. Warns if any variable type
if declared within the code block of a loop.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForIncompleteForLoop (GUR 7 - 249)
Process: checks for an incomplete for loop. Looks for all three parameters
present, with their semicolons in the correct place. Warns if any of the
three parameters have only semicolons.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForBooleanRedundancy (GUR 8 - 249)
Process: checks for the return statement of a bool function, if it is a boolean
statement. If it isn't, this may warn the user about compressing logic
to their return statement in place of if/else logic.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForCodeWithCurlyBraces (GUR 9 - 249)
Process: checks for curly braces on the same line as code, in other words, if
there is a curly brace that isn't aligned with a code block properly.
Warns if there is a code block that has curly braces with no newline
between them.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForBooleanReplacement (GUR 10 - 249)
Process: checks for if any integer may be used in place of true or false. Warns
if there is potential for an integer being used this way.
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/
/*
Name: checkForUseOfLiterals (GUR 11 - 249)
Process: checks for
Function input/parameters: ???
Function output/parameters: ???
Function output/returned: ???
Device input/ ---: ???
Device output/ ---: ???
Dependencies: ???
*/