Fixed ambigious grammar rules, fixed interpreter

Author: wendehals

model/BuildCollection.go

@@ -1,6 +1,10 @@
 package model
 
-import "sort"
+import (
+	"encoding/json"
+	"log"
+	"sort"
+)
 
 type BuildCollection struct {
 	Set     Set
@@ -23,6 +27,7 @@ func (b *BuildCollection) Sort() *BuildCollection {
 	return b
 }
 
+// HasMissingParts returns true if there are parts missing in the BuildCollection.
 func (b *BuildCollection) HasMissingParts() bool {
 	for _, entry := range b.Mapping {
 		if entry.Quantity > 0 {
@@ -33,6 +38,7 @@ func (b *BuildCollection) HasMissingParts() bool {
 	return false
 }
 
+// CountMissingParts counts all parts that are still missing in the BuildCollection.
 func (b *BuildCollection) CountMissingParts() int {
 	var missing int
 	for _, entry := range b.Mapping {
@@ -42,6 +48,7 @@ func (b *BuildCollection) CountMissingParts() int {
 	return missing
 }
 
+// CountProvidedParts counts all parts that are provided in the BuildCollection, including substitutes.
 func (b *BuildCollection) CountProvidedParts() int {
 	var provided int
 	for _, entry := range b.Mapping {
@@ -53,10 +60,28 @@ func (b *BuildCollection) CountProvidedParts() int {
 	return provided
 }
 
+// Save writes the BuildCollection into a JSON encoded file. In case of an error it terminates with a fatal log entry.
 func (b BuildCollection) Save(filePath string) {
 	Save(b, filePath)
 }
 
+// Print outputs a human-readable representation of the BuildCollection to the standard output.
 func (b BuildCollection) Print() {
 	Print(b)
 }
+
+// Clone creates a deep copy of the BuildCollection and returns it as a CollectionType.
+func (b BuildCollection) Clone() CollectionType {
+	origJSON, err := json.Marshal(b)
+	if err != nil {
+		log.Fatalf(CLONING_FAILED_MSG, err.Error())
+	}
+
+	clone := new(BuildCollection)
+	err = json.Unmarshal(origJSON, clone)
+	if err != nil {
+		log.Fatalf(CLONING_FAILED_MSG, err.Error())
+	}
+
+	return *clone
+}

model/Collection.go

@@ -1,6 +1,8 @@
 package model
 
 import (
+	"encoding/json"
+	"log"
 	"sort"
 
 	"github.com/google/go-cmp/cmp"
@@ -179,14 +181,32 @@ func (c *Collection) MapPartsByPartNumber(keyMapping func(string) string) map[st
 	return partsMap
 }
 
+// Save writes the Collection into a JSON encoded file. In case of an error it terminates with a fatal log entry.
 func (c Collection) Save(filePath string) {
 	Save(c, filePath)
 }
 
+// Print outputs a human-readable representation of the Collection to the standard output.
 func (c Collection) Print() {
 	Print(c)
 }
 
+// Clone creates a deep copy of the Collection and returns it as a CollectionType.
+func (b Collection) Clone() CollectionType {
+	origJSON, err := json.Marshal(b)
+	if err != nil {
+		log.Fatalf(CLONING_FAILED_MSG, err.Error())
+	}
+
+	clone := new(Collection)
+	err = json.Unmarshal(origJSON, clone)
+	if err != nil {
+		log.Fatalf(CLONING_FAILED_MSG, err.Error())
+	}
+
+	return *clone
+}
+
 func (c *Collection) setParts(partsMap map[string][]Part) {
 	newParts := []Part{}
 	for key, value := range partsMap {

model/CollectionType.go

@@ -3,4 +3,5 @@ package model
 type CollectionType interface {
 	Save(filePath string)
 	Print()
+	Clone() CollectionType
 }

scripting/bricksInterpreter.go

@@ -85,7 +85,7 @@ func (b *bricksInterpreter) ExitBuild(ctx *parser.BuildContext) {
 	if neededCollection, ok := firstValue.(model.Collection); ok {
 		if providedCollection, ok := secondValue.(model.Collection); ok {
 			result := services.Build(&neededCollection, &providedCollection, mode)
-			b.stack.push(result)
+			b.stack.push(*result)
 		} else {
 			log.Fatal("The second operand of build must be a collection")
 			return
@@ -101,7 +101,7 @@ func (b *bricksInterpreter) ExitIdentifier(ctx *parser.IdentifierContext) {
 	if !ok {
 		log.Fatalf("The variable '%s' is not defined", ctx.ID().GetText())
 	}
-	b.stack.push(model.DeepClone(value))
+	b.stack.push(value.Clone())
 }
 
 func (b *bricksInterpreter) ExitLoad(ctx *parser.LoadContext) {
@@ -115,29 +115,29 @@ func (b *bricksInterpreter) ExitLoad(ctx *parser.LoadContext) {
 func (b *bricksInterpreter) ExitImport_(ctx *parser.Import_Context) {
 	filePath := strings.Trim(ctx.STRING().GetText(), "\"")
 
-	b.stack.push(services.ImportCSVCollection(filePath))
+	b.stack.push(*services.ImportCSVCollection(filePath))
 }
 
 func (b *bricksInterpreter) ExitAllParts(ctx *parser.AllPartsContext) {
 	allParts := b.usersAPI.GetAllParts()
-	b.stack.push(allParts)
+	b.stack.push(*allParts)
 }
 
 func (b *bricksInterpreter) ExitLost(ctx *parser.LostContext) {
 	lostParts := b.usersAPI.GetLostParts()
-	b.stack.push(lostParts)
+	b.stack.push(*lostParts)
 }
 
 func (b *bricksInterpreter) ExitSet(ctx *parser.SetContext) {
 	includeMiniFigs := ctx.BOOL() != nil && ctx.BOOL().GetText() == "true"
 	setParts := api.RetrieveSetParts(b.bricksAPI, ctx.SET_NUM().GetText(), includeMiniFigs)
-	b.stack.push(setParts)
+	b.stack.push(*setParts)
 }
 
 func (b *bricksInterpreter) ExitUserSet(ctx *parser.UserSetContext) {
 	includeMiniFigs := ctx.BOOL() != nil && ctx.BOOL().GetText() == "true"
 	userSetParts := api.RetrieveUserSetParts(b.bricksAPI, b.usersAPI, ctx.SET_NUM().GetText(), includeMiniFigs)
-	b.stack.push(userSetParts)
+	b.stack.push(*userSetParts)
 }
 
 func (b *bricksInterpreter) ExitSetList(ctx *parser.SetListContext) {
@@ -151,7 +151,7 @@ func (b *bricksInterpreter) ExitSetList(ctx *parser.SetListContext) {
 	collection := services.MergeAllCollections(setListParts)
 	collection.SortByColorAndName(false)
 
-	b.stack.push(collection)
+	b.stack.push(*collection)
 }
 
 func (b *bricksInterpreter) ExitPartList(ctx *parser.PartListContext) {
@@ -160,23 +160,23 @@ func (b *bricksInterpreter) ExitPartList(ctx *parser.PartListContext) {
 		log.Fatal(err)
 	}
 	partListParts := b.usersAPI.GetPartListParts(uint(partListId))
-	b.stack.push(partListParts)
+	b.stack.push(*partListParts)
 }
 
 func (b *bricksInterpreter) ExitPartLists(ctx *parser.PartListsContext) {
 	filePath := strings.Trim(ctx.STRING().GetText(), "\"")
 	includeNonBuildable := ctx.BOOL() != nil && ctx.BOOL().GetText() == "true"
 	collections := api.RetrievePartListsParts(b.usersAPI, filePath, includeNonBuildable)
 	collection := services.MergeAllCollections(collections)
-	b.stack.push(collection)
+	b.stack.push(*collection)
 }
 
 func (b *bricksInterpreter) ExitSum(ctx *parser.SumContext) {
 	log.Printf("Calculating sum")
 
 	sum := model.NewCollection()
 
-	for range ctx.AllCollectionExp() {
+	for range ctx.AllCollectionOrId() {
 		value := b.stack.pop()
 		if summand, ok := value.(model.Collection); ok {
 			sum.Add(&summand)
@@ -185,7 +185,7 @@ func (b *bricksInterpreter) ExitSum(ctx *parser.SumContext) {
 		}
 	}
 
-	b.stack.push(sum)
+	b.stack.push(*sum)
 }
 
 func (b *bricksInterpreter) ExitSubtract(ctx *parser.SubtractContext) {
@@ -209,15 +209,15 @@ func (b *bricksInterpreter) ExitMax(ctx *parser.MaxContext) {
 	log.Printf("Calculating maximum")
 
 	max := model.NewCollection()
-	for range ctx.AllCollectionExp() {
+	for range ctx.AllCollectionOrId() {
 		value := b.stack.pop()
 		if collection, ok := value.(model.Collection); ok {
 			max.Max(&collection)
 		} else {
 			log.Fatal("Only collections can be compared")
 		}
 
-		b.stack.push(max)
+		b.stack.push(*max)
 	}
 }
 

scripting/parser/Bricks.g4

@@ -4,18 +4,22 @@ bricks: command+;
 
 command: assignment | save | export | print | pause;
 
-assignment: ID ':=' collectionExp;
+expression: collection | build | identifier;
 
-save: 'save' '(' (collectionExp | buildExp) ',' STRING ')';
+assignment: ID ':=' expression;
 
-export: 'export' '(' (collectionExp | buildExp) ',' STRING ')';
+save: 'save' '(' expression ',' STRING ')';
 
-print: 'print' '(' (collectionExp | buildExp) ')';
+export: 'export' '(' expression ',' STRING ')';
+
+print: 'print' '(' expression ')';
 
 pause: 'pause' '(' seconds=INT ')';
 
 
-collectionExp: identifier | load | import_ | allParts | lost | set | userSet | setList | partList | partLists | sum | subtract | max | sort;
+collectionOrId: collection | identifier;
+
+collection: load | import_ | allParts | lost | set | userSet | setList | partList | partLists | sum | subtract | max | sort;
 
 load: 'load' '(' STRING ')';
 
@@ -35,18 +39,16 @@ partList: 'partList' '(' INT ')';
 
 partLists: 'partLists' '(' STRING (',' BOOL)? ')';
 
-sum: 'sum' '(' collectionExp (',' collectionExp)+ ')';
-
-subtract: 'subtract' '(' collectionExp ',' collectionExp ')';
+sum: 'sum' '(' collectionOrId (',' collectionOrId)+ ')';
 
-max: 'max' '(' collectionExp (',' collectionExp)+ ')';
+subtract: 'subtract' '(' collectionOrId ',' collectionOrId ')';
 
-sort: 'sort' '(' collectionExp (',' quantity='quantity')? (',' descending='descending')? ')';
+max: 'max' '(' collectionOrId (',' collectionOrId)+ ')';
 
+sort: 'sort' '(' collectionOrId (',' quantity='quantity')? (',' descending='descending')? ')';
 
-buildExp : identifier | build;
 
-build: 'build' '(' collectionExp ',' collectionExp (',' build_mode=ID )? ')';
+build: 'build' '(' collectionOrId ',' collectionOrId (',' build_mode=ID )? ')';
 
 
 ID: [a-zA-Z][a-zA-Z0-9_]*;