feat: add support for constant checks

Author: hhirsch

example.scl

@@ -19,6 +19,17 @@ VERSION : 0.1
       test : UInt;
    END_VAR
 
+   VAR_GLOBAL CONSTANT
+      MAX_HEIGHT      : INT := 100;
+      MAX_SAFE_HEIGHT : INT := MAX_HEIGHT - 5;
+      counter : INT := 2
+   END_VAR
+
+   VAR_GLOBAL
+      DEFAULT : INT := 2 
+      errors  : INT := 0
+   END_VAR
+    
    VAR_TEMP 
       messageTextIdx : UInt;
       source : String[10];

internal/models/style/symbol.go

@@ -14,3 +14,8 @@ func IsCamelCase(input string) bool {
 	expression := regexp.MustCompile(`^[a-z]+([A-Z][a-z]*)*$`)
 	return expression.MatchString(input)
 }
+
+func IsMixedCapitalSnakeCase(input string) bool {
+	expression := regexp.MustCompile(`^[A-Z]+([A-Z_][0-9]*)*$`)
+	return expression.MatchString(input)
+}

main.go

@@ -19,7 +19,6 @@ const (
 )
 
 var arguments []string = os.Args
-var parserIsInsideVariableBlock bool = false
 var isErrorDetected bool = false
 var variableBlockStartStrings = []string{"VAR_INPUT", "VAR", "VAR_OUTPUT", "VAR_TEMP", "VAR_GLOBAL"}
 var currentBlock Block = None
@@ -28,14 +27,24 @@ func checkVariableStyle(symbol string) {
 	if style.IsMixedCamelCase(symbol) {
 		fmt.Printf("Success: Variable %s is camel case.\n", symbol)
 	} else {
-		fmt.Fprintf(os.Stderr, "Error: Variable %s is not camel case.\n", symbol)
+		fmt.Fprintf(os.Stderr, "Error: Variable %s is not mixed camel case.\n", symbol)
+		isErrorDetected = true
+	}
+}
+
+func checkConstantStyle(symbol string) {
+	if style.IsMixedCapitalSnakeCase(symbol) {
+		fmt.Printf("Success: Constant %s is mixed capital snake case.\n", symbol)
+	} else {
+		fmt.Fprintf(os.Stderr, "Error: Constant %s is not mixed capital snake case.\n", symbol)
 		isErrorDetected = true
 	}
 }
 
 func handleLine(input string) {
 	if strings.TrimSpace(input) == "VAR_GLOBAL CONSTANT" {
 		currentBlock = Constant
+		return
 	}
 	inputWithoutWhiteSpaces := strings.ReplaceAll(input, " ", "")
 	if currentBlock == Variable {
@@ -51,6 +60,14 @@ func handleLine(input string) {
 		}
 	}
 
+	if currentBlock == Constant {
+		if strings.Contains(inputWithoutWhiteSpaces, ":") {
+			parts := strings.Split(inputWithoutWhiteSpaces, ":")
+			checkConstantStyle(parts[0])
+			return
+		}
+	}
+
 	if slices.Contains(variableBlockStartStrings, inputWithoutWhiteSpaces) {
 		if currentBlock == None {
 			currentBlock = Variable

main_test.go

@@ -5,21 +5,19 @@ import (
 )
 
 func resetState() {
-	parserIsInsideVariableBlock = false
 	currentBlock = None
 }
 
 func TestDetectsWhenInVariableBlock(test *testing.T) {
 	test.Cleanup(resetState)
 	handleLine("errorActive1 : Bool;")
-	if parserIsInsideVariableBlock {
+	if currentBlock == Variable {
 		test.Error("mixed camel case must be valid")
 	}
 }
 
 func TestMixedCamelCaseVariableIsValid(test *testing.T) {
 	test.Cleanup(resetState)
-	parserIsInsideVariableBlock = true
 	currentBlock = Variable
 	handleLine("errorActive1 : Bool;")
 	if isErrorDetected {
@@ -29,7 +27,6 @@ func TestMixedCamelCaseVariableIsValid(test *testing.T) {
 
 func TestMixedCamelCaseFunctionIsValid(test *testing.T) {
 	test.Cleanup(resetState)
-	parserIsInsideVariableBlock = true
 	currentBlock = Variable
 	handleLine("almError {InstructionName := 'Program_Alarm'; LibVersion := '1.0'} : Program_Alarm;")
 	if isErrorDetected {
@@ -39,19 +36,28 @@ func TestMixedCamelCaseFunctionIsValid(test *testing.T) {
 
 func TestVariableBlockInitiallyNotDetected(test *testing.T) {
 	test.Cleanup(resetState)
-	if parserIsInsideVariableBlock || currentBlock == Constant || currentBlock == Variable {
+	if currentBlock == Constant || currentBlock == Variable {
 		test.Error("initial value of inside variable block should be false")
 	}
 }
 
-func TestSnakeCaseConstantsAreValid(test *testing.T) {
+func TestConstantBlockRecognized(test *testing.T) {
 	test.Cleanup(resetState)
 	handleLine("VAR_GLOBAL CONSTANT")
 	if currentBlock != Constant {
 		test.Error("did not detect that VAR_GLOBAL CONSTANT started")
 	}
 }
 
+func TestSnakeCaseConstantsAreValid(test *testing.T) {
+	test.Cleanup(resetState)
+	handleLine("VAR_GLOBAL CONSTANT")
+	handleLine("      MAX_HEIGHT      : INT := 100;")
+	if isErrorDetected == true {
+		test.Error("constants should be in mixed capital snake case")
+	}
+}
+
 func TestDoubleOpeningVariableBlockLeadsToError(test *testing.T) {
 	test.Cleanup(resetState)
 	handleLine("VAR_GLOBAL")