stepper: add the comment to link the specification (#1680)

* add the comment to link the specification * delete the deprecated code, modify the comments --------- Co-authored-by: Martin Henz <[email protected]>
source-academy · Sep 10, 2024 · d3c1191 · d3c1191
1 parent f443ccc
commit d3c1191
Showing 1 changed file with 19 additions and 6 deletions.
diff --git a/src/stepper/stepper.ts b/src/stepper/stepper.ts
@@ -1751,7 +1751,9 @@ function reduceMain(
         ]
       }
     },
-
+    /**
+     * Please refer to reduction of Program in stepper specification
+     */
     Program(
       node: es.Program,
       context: Context,
@@ -1974,7 +1976,9 @@ function reduceMain(
         ]
       }
     },
-
+    /**
+     * Please refer to reduction of BlockStatement in stepper specification
+     */
     BlockStatement(
       node: es.BlockStatement,
       context: Context,
@@ -2195,7 +2199,10 @@ function reduceMain(
         ]
       }
     },
-
+    /**
+     * Please refer to reduction of BlockExpression in stepper specification
+     * This is related to function application
+     */
     BlockExpression(
       node: BlockExpression,
       context: Context,
@@ -3346,6 +3353,7 @@ export function getEvaluationSteps(
   const steps: [es.Program, string[][], string][] = []
   try {
     checkProgramForUndefinedVariables(program, context)
+    //reading the step limit
     const limit = stepLimit === undefined ? 1000 : stepLimit % 2 === 0 ? stepLimit : stepLimit + 1
     evaluateImports(program, context)
     // starts with substituting predefined constants
@@ -3362,6 +3370,9 @@ export function getEvaluationSteps(
       [],
       'Start of evaluation'
     ]
+    /**
+     * push the content into frontend for showing contents in the webpage
+     */
     steps.push([
       reducedWithPath[0] as es.Program,
       reducedWithPath[2].length > 1 ? reducedWithPath[2].slice(1) : reducedWithPath[2],
@@ -3373,13 +3384,18 @@ export function getEvaluationSteps(
     // odd steps: program after reduction
     let i = 1
     let limitExceeded = false
+    /**
+     * This is the start of actual reduction, calling reduceMain function in each iteration
+     * cause the program get reduced by one step at one iteration
+     */
     while (isStatementsReducible(reducedWithPath[0] as es.Program, context)) {
       //Should work on isReducibleStatement instead of checking body.length
       if (steps.length === limit) {
         steps[steps.length - 1] = [ast.program([]), [], 'Maximum number of steps exceeded']
         limitExceeded = true
         break
       }
+      //the program reduce by one step here
       reducedWithPath = reduceMain(reducedWithPath[0], context)
       steps.push([
         reducedWithPath[0] as es.Program,
@@ -3406,9 +3422,6 @@ export function getEvaluationSteps(
         ])
       }
     }
-    if (steps.length === 0) {
-      steps.push([reducedWithPath[0] as es.Program, [], 'Nothing to evaluate'])
-    }
     return steps
   } catch (error) {
     if (error instanceof RuntimeSourceError) {