Structs (#42)

* Implement field assignment for anomyous structs

* Implement struct initialisation and fix concurrency

* implement reassignment of struct field values

* Deepcopy for arrays when passed as arguments for functions

* Implement nested struct for anonymous structs

* Implement some support for nested structs

* Implement arrays of structs

* Implement array and struct interactions

* Implement array and struct interactions

* Implement pointers

* Implement support of pointers for structs

* Implement alignof, offsetof, sizeof

* Implement Add, StringData, String

* Add test coverage utility

* Cleanup codebase

* Update readme.md and fix deepcopy not being applied on goroutines

* Change yarn run local to yarn local

* Attempt to fix compilation/installation errors

* Delete eslint-import related dependencies

* Refactoring, incomplete

* Refactoring

* Fix logic for multi-dimensional arrays containing structs

* Minor cleanup

* Fix literal values not being allowed for struct fields with declared type

* Fix cases where arrays/structs being instantiated and immediately used as arguments do not work

* Further fix to recognise different structs when multiple directly created structs are passed as arguments

* Fix test case

* Fix nested struct not using key index

* Fix test file

* Code cleanup

* Change struct to array, it should be array

* Improve automatic semicolon insertion

Author: chengda300

.eslintignore

@@ -4,4 +4,7 @@ build
 node_modules
 
 # Ignore the parser generated by PeggyJS.
-src/virtual-machine/parser/*.js
+./src/go-virtual-machine-main/virtual-machine/compiler/golang_parser.js
+
+# Ignore test files
+./src/go-virtual-machine-main/tests/*.test.ts

.eslintrc

@@ -25,7 +25,12 @@
       }
     }
   ],
-  "ignorePatterns": ["build/**/*", "!.storybook", "tsconfig.json"],
+  "ignorePatterns": [
+    "build/**/*",
+    "!.storybook",
+    "tsconfig.json",
+    "**/golang_parser.js"
+  ],
   "env": { "es6": true },
   "parserOptions": {
     "ecmaVersion": 2018,

.vscode/launch.json

@@ -1,20 +1,16 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Launch Program",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "program": "${workspaceFolder}\\src\\index.tsx",
-            "outFiles": [
-                "${workspaceFolder}/**/*.js"
-            ]
-        }
-    ]
-}
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}\\src\\index.tsx",
+      "outFiles": ["${workspaceFolder}/**/*.js"]
+    }
+  ]
+}

README.md

@@ -1,5 +1,77 @@
 # go-slang
-Implementation of Go
 
-# Virtual Machine
-The virtual machine is used to run programs written in Go. It is written by Teow Hua Jun and Lim An Jun and the source code can be found [here](https://github.com/huajun07/go-virtual-machine).
+This is an implementation of the language Go, which uses a Virtual Machine architecture and is written in TypeScript.
+
+The virtual machine is used to run programs written in Go. The basic implementation was written by Teow Hua Jun and Lim An Jun and the source code can be found [here](https://github.com/huajun07/go-virtual-machine).
+
+After which, this project is further enhanced by bringing in more features.
+
+## Usage
+
+To begin, we need to install the package manager `yarn`, which can be installed using another package manager `npm`.
+
+```sh
+npm install yarn
+```
+
+After which, we use `yarn install` to install the dependencies used by this repository.
+
+```sh
+yarn install
+```
+
+For testing, we can use `yarn test` to run all the test cases.
+
+```sh
+yarn test
+```
+
+To run a specific test file, we use `yarn test <fileName>`, where the test file must be named as: `<fileName>.test.ts`. For example, to run `unsafe.test.ts`, we use `yarn test unsafe`. This will also work for new test files, so long as the test file is named correctly.
+
+```sh
+yarn test unsafe
+```
+
+To run tests with coverage, we use `yarn coverage`. This will display the test coverage (statement coverage, line coverage, branch coverage and function coverage) after running all tests.
+
+For visualisation, we can use `yarn local` to run the program locally. This lets us visualise the program that is to be written in Go to let us see how the program is executed. However, this only works when the program does not run into any errors.
+
+```sh
+yarn local
+```
+
+Lastly, to build the project, we use `yarn build`.
+
+```sh
+yarn build
+```
+
+## Major architectures
+
+This virtual machine is based on the [Go Language Specification](https://go.dev/ref/spec). It ensures that the implementation can support the notations stated in the specification, which is used by the actual language.
+
+To parse the user program written in Go into the virtual machine, [PeggyJS](https://peggyjs.org/) is used. The user program is first parsed into an Abstract Syntax Tree (AST) using PeggyJS, then it is compiled into virtual machine instructions, which are then executed by the runtime system of the virtual machine.
+
+The runtime system primarily operates on Nodes (not to be confused with NodeJS), which are the objects recognised by the runtime system to load data stored on the heap. The base class is called BaseNode instead of Node as a result (Node class actually refers to NodeJS, which is not what it is supposed to be). These objects are basically pointers by themselves.
+
+## Newly added features
+
+Compared to the previous version, new features of the language are added. This includes:
+
+- Functions being able to return multiple values at once without needing to wrap them into a data structure
+- Structs
+- Pointers (including the `unsafe` package)
+
+There are also fundamental changes implemented, such as:
+
+- Ensuring contiguous memory for arrays and structs
+- Deepcopy for arrays and structs being passed by value into other functions
+- Deepcopy for variables being passed into goroutines
+
+More features will be implemented as time passes.
+
+## Additional Resources on Go
+
+We recommend the [Tour of Go](https://go.dev/tour/welcome/1), which is written by the developers of the language themselves. It introduces the various elements of the programming language as well as their syntaxes, as the syntaxes may differ quite greatly from other programming languages.
+
+For further exploration, we can download the language Go itself [here](https://go.dev/doc/install).

package.json

@@ -8,6 +8,7 @@
     "dev": "NODE_ENV=dev && concurrently \"npm run generate-parser-watch\" \"react-scripts start\"",
     "build": "npm run generate-parser && react-scripts build",
     "test": "npm run generate-parser && vitest",
+    "coverage": "npm run generate-parser && vitest --ui --config ./vitest.config.js",
     "eject": "react-scripts eject",
     "lint-no-fix": "eslint ./ --ignore-path .gitignore && prettier . -c",
     "lint": "eslint ./ --ignore-path .gitignore --fix && prettier . -c --write",
@@ -17,18 +18,36 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@babel/core": "^7.0.0",
+    "@babel/plugin-syntax-flow": "^7.14.5",
+    "@babel/plugin-transform-react-jsx": "^7.14.5",
+    "@babel/runtime": "^7.11.0",
     "@chakra-ui/icons": "^2.0.19",
     "@chakra-ui/react": "^2.6.1",
+    "@chakra-ui/react-utils": "^2.0.5",
+    "@chakra-ui/styled-system": "^2.8.0",
+    "@chakra-ui/system": "^2.0.0",
     "@chakra-ui/theme": "^3.1.1",
     "@chakra-ui/theme-tools": "^2.0.17",
+    "@chakra-ui/utils": "^2.0.8",
     "@choc-ui/chakra-autocomplete": "^5.1.7",
+    "@codemirror/autocomplete": "^6.0.0",
     "@codemirror/lang-go": "^6.0.0",
+    "@codemirror/language": "^6.0.0",
+    "@codemirror/lint": "^6.0.0",
+    "@codemirror/search": "^6.0.0",
+    "@codemirror/state": "^6.0.0",
+    "@codemirror/theme-one-dark": "^6.0.0",
+    "@codemirror/view": "^6.0.0",
     "@emotion/react": "^11.11.0",
     "@emotion/styled": "^11.11.0",
+    "@lezer/common": "^1.0.0",
     "@uiw/codemirror-extensions-zebra-stripes": "^4.20.2",
     "@uiw/codemirror-theme-github": "^4.20.2",
     "@uiw/react-codemirror": "^4.21.25",
     "axios": "^1.7.4",
+    "codemirror": "^6.0.0",
+    "cytoscape": "^3.2.19",
     "cytoscape-cola": "^2.5.1",
     "d3-selection": "^3.0.0",
     "d3-zoom": "^3.0.0",
@@ -58,12 +77,12 @@
     "@types/react-dom": "^18.2.4",
     "@types/seedrandom": "^3.0.8",
     "@types/uuid": "^9.0.2",
+    "@vitest/coverage-v8": "^3.1.1",
     "babel-plugin-named-exports-order": "^0.0.2",
     "chromatic": "^6.19.9",
     "concurrently": "^8.2.2",
     "eslint": "^8.41.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-import-resolver-alias": "^1.1.2",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "eslint-plugin-storybook": "^0.6.12",
@@ -73,7 +92,7 @@
     "start-server-and-test": "^2.0.0",
     "tsconfig-paths-webpack-plugin": "^4.1.0",
     "typescript": "^5.0.4",
-    "vitest": "^1.6.1",
+    "vitest": "^3.1.1",
     "webpack": "^5.94.0"
   },
   "overrides": {

src/frontend/pages/Main.tsx

@@ -44,7 +44,7 @@ export const Main = () => {
   const [speed, setSpeed] = useState<number>(1)
   const [loading, setLoading] = useState(false)
   const [code, setCode] = useState('')
-  const [heapsize, setHeapsize] = useState(2048)
+  const [heapsize, setHeapsize] = useState(4096)
   const [visualMode, setVisualMode] = useState(false)
 
   useEffect(() => {

src/frontend/stores/executionStore.ts

@@ -1,8 +1,11 @@
 import { shallow } from 'zustand/shallow'
 import { createWithEqualityFn } from 'zustand/traditional'
 
-import { ContextInfo, StateInfo } from '../../go-virtual-machine-main/virtual-machine/runtime/debugger'
 import { TokenLocation } from '../../go-virtual-machine-main/virtual-machine/compiler/tokens'
+import {
+  ContextInfo,
+  StateInfo,
+} from '../../go-virtual-machine-main/virtual-machine/runtime/debugger'
 
 export interface ExecutionState {
   currentStep: number