Merge pull request #34 from vknabel/feature/packages

Packages and improved LSP

Author: vknabel

.devcontainer/Dockerfile

@@ -16,4 +16,7 @@ RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/
 # RUN go get -x <your-dependency-or-tool>
 
 # [Optional] Uncomment this line to install global node packages.
-# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
+
+COPY ./lithia /usr/local/bin/lithia
+ENV LITHIA_STDLIB /workspaces/lithia/stdlib

.devcontainer/lithia

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+go run ./app/lithia

.vscode/launch.json

@@ -4,13 +4,6 @@
   // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-    {
-      "name": "Attach to Process",
-      "type": "go",
-      "request": "attach",
-      "mode": "local",
-      "processId": 0
-    },
     {
       "name": "Write docs",
       "type": "go",
@@ -37,7 +30,19 @@
       }
     },
     {
-      "name": "Launch lithia",
+      "name": "Launch example greeter",
+      "type": "go",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${workspaceFolder}/app/lithia/main.go",
+      "args": ["${workspaceFolder}/examples/greeter/cmd/main.lithia"],
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "LITHIA_STDLIB": "${workspaceFolder}/stdlib"
+      }
+    },
+    {
+      "name": "Launch fib-type",
       "type": "go",
       "request": "launch",
       "mode": "auto",

CHANGELOG.md

@@ -3,6 +3,12 @@
 ## v0.0.16-next
 
 - fix: undeclared enum case error due to file order within a module
+- compiler: new concept of packages containing modules, optionally marked by a `Potfile`
+- compiler: implicit `src` module for package imports if folder exists
+- compiler: `import root` imports the current package (imports `src` if folder exists)
+- lsp: improved autocompletion and hover information
+- lsp: autocompletion and hover information across module and file boundaries
+- lsp: local autocompletion #30
 
 ## v0.0.15
 

README.md

@@ -26,7 +26,7 @@ Currently Lithia is an early proof of concept. Basic language features exist, bu
 - [x] Creating a custom language server
 - [x] ... with diagnostics
 - [x] ... with syntax highlighting
-- [ ] ... with auto completion _proof of concept_
+- [x] ... with auto completion _basic_
 - [ ] ... with highlights
 - [ ] ... with refactorings
 - [ ] ... with formatter
@@ -264,9 +264,26 @@ As shown, a common use case is to pass the module itself instead of multiple wit
 
 ### Module resolution
 
-Lithia will search for a folder containing source files at the following locations:
+To create your own package of modules, you can create a `Potfile`. Every module defined by the package is a directory next to the Potfile, with `.lithia` files in it.
+
+Though there are a few special cases:
+
+- the `cmd`-folder is typically used for individual files rather than a module. You execute them with `$ lithia cmd/<file>`.
+- the `src`-folder represents the `root` of the package.
+- if the `src`-folder is missing, the package `root` is next to the Potfile.
+
+```
+.
+├── Potfile
+├── cmd
+│   ├── main.lithia
+│   └── test.lithia
+└── src
+    └── greet.lithia
+```
+
+If there aren't any matching local modules, Lithia will search for a package containing source files at the following locations:
 
-- when executing a file, relative to it
 - when in REPL, inside the current working directory
 - at `$LITHIA_LOCALS` if set
 - at `$LITHIA_PACKAGES` if set

ast/context-file.go

@@ -38,3 +38,22 @@ func (sf *SourceFile) AddExpr(expr Expr) {
 	}
 	sf.Statements = append(sf.Statements, expr)
 }
+
+func (sf *SourceFile) ExportedDeclarations() []Decl {
+	decls := make([]Decl, 0)
+	for _, decl := range sf.Declarations {
+		if decl.IsExportedDecl() {
+			decls = append(decls, decl)
+		}
+	}
+	return decls
+}
+
+func (sf SourceFile) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	for _, decl := range sf.Declarations {
+		decl.EnumerateNestedDecls(enumerate)
+	}
+	for _, stmt := range sf.Statements {
+		stmt.EnumerateNestedDecls(enumerate)
+	}
+}

ast/decl-constant.go

@@ -1,6 +1,9 @@
 package ast
 
+import "fmt"
+
 var _ Decl = DeclConstant{}
+var _ Overviewable = DeclConstant{}
 
 type DeclConstant struct {
 	Name  Identifier
@@ -14,6 +17,10 @@ func (e DeclConstant) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclConstant) DeclOverview() string {
+	return fmt.Sprintf("let %s", e.Name)
+}
+
 func (e DeclConstant) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -33,3 +40,7 @@ func MakeDeclConstant(name Identifier, value Expr, source *Source) *DeclConstant
 func (e DeclConstant) ProvidedDocs() *Docs {
 	return e.Docs
 }
+
+func (e DeclConstant) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	e.Value.EnumerateNestedDecls(enumerate)
+}

ast/decl-data.go

@@ -1,6 +1,12 @@
 package ast
 
+import (
+	"fmt"
+	"strings"
+)
+
 var _ Decl = DeclData{}
+var _ Overviewable = DeclData{}
 
 type DeclData struct {
 	Name   Identifier
@@ -14,6 +20,17 @@ func (e DeclData) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclData) DeclOverview() string {
+	if len(e.Fields) == 0 {
+		return fmt.Sprintf("data %s", e.Name)
+	}
+	fieldLines := make([]string, 0)
+	for _, field := range e.Fields {
+		fieldLines = append(fieldLines, "    "+field.DeclOverview())
+	}
+	return fmt.Sprintf("data %s {\n%s\n}", e.Name, strings.Join(fieldLines, "\n"))
+}
+
 func (e DeclData) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -40,3 +57,7 @@ func (e *DeclData) AddField(field DeclField) {
 func (decl DeclData) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (DeclData) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls
+}

ast/decl-enum-case.go

@@ -31,3 +31,7 @@ func MakeDeclEnumCase(name Identifier) *DeclEnumCase {
 func (decl DeclEnumCase) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (DeclEnumCase) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls
+}

ast/decl-enum.go

@@ -1,8 +1,12 @@
 package ast
 
-import "fmt"
+import (
+	"fmt"
+	"strings"
+)
 
 var _ Decl = DeclEnum{}
+var _ Overviewable = DeclEnum{}
 
 type DeclEnum struct {
 	Name  Identifier
@@ -16,6 +20,17 @@ func (e DeclEnum) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclEnum) DeclOverview() string {
+	if len(e.Cases) == 0 {
+		return fmt.Sprintf("enum %s", e.Name)
+	}
+	caseLines := make([]string, 0)
+	for _, cs := range e.Cases {
+		caseLines = append(caseLines, "    "+string(cs.Name))
+	}
+	return fmt.Sprintf("enum %s {\n%s\n}", e.Name, strings.Join(caseLines, "\n"))
+}
+
 func (e DeclEnum) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -54,3 +69,7 @@ func (e DeclEnum) String() string {
 func (decl DeclEnum) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (decl DeclEnum) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls - will be handled by the parser
+}

ast/decl-extern-func.go

@@ -1,6 +1,12 @@
 package ast
 
+import (
+	"fmt"
+	"strings"
+)
+
 var _ Decl = DeclExternFunc{}
+var _ Overviewable = DeclExternFunc{}
 
 type DeclExternFunc struct {
 	Name       Identifier
@@ -22,6 +28,17 @@ func (e DeclExternFunc) IsExportedDecl() bool {
 	return true
 }
 
+func (e DeclExternFunc) DeclOverview() string {
+	if len(e.Parameters) == 0 {
+		return fmt.Sprintf("extern %s { => }", e.Name)
+	}
+	paramNames := make([]string, len(e.Parameters))
+	for i, param := range e.Parameters {
+		paramNames[i] = string(param.Name)
+	}
+	return fmt.Sprintf("extern %s { %s => }", e.Name, strings.Join(paramNames, ", "))
+}
+
 func MakeDeclExternFunc(name Identifier, params []DeclParameter, source *Source) *DeclExternFunc {
 	return &DeclExternFunc{
 		Name:       name,
@@ -33,3 +50,7 @@ func MakeDeclExternFunc(name Identifier, params []DeclParameter, source *Source)
 func (decl DeclExternFunc) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (DeclExternFunc) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls
+}

ast/decl-extern-type.go

@@ -1,6 +1,12 @@
 package ast
 
+import (
+	"fmt"
+	"strings"
+)
+
 var _ Decl = DeclExternType{}
+var _ Overviewable = DeclExternType{}
 
 type DeclExternType struct {
 	Name   Identifier
@@ -14,6 +20,17 @@ func (e DeclExternType) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclExternType) DeclOverview() string {
+	if len(e.Fields) == 0 {
+		return fmt.Sprintf("extern %s", e.Name)
+	}
+	fieldLines := make([]string, 0)
+	for _, field := range e.Fields {
+		fieldLines = append(fieldLines, "    "+field.DeclOverview())
+	}
+	return fmt.Sprintf("extern %s {\n%s\n}", e.Name, strings.Join(fieldLines, "\n"))
+}
+
 func (e DeclExternType) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -38,3 +55,7 @@ func (e *DeclExternType) AddField(decl DeclField) {
 func (decl DeclExternType) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (DeclExternType) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls
+}

ast/decl-field.go

@@ -1,6 +1,12 @@
 package ast
 
+import (
+	"fmt"
+	"strings"
+)
+
 var _ Decl = DeclField{}
+var _ Overviewable = DeclField{}
 
 type DeclField struct {
 	Name       Identifier
@@ -14,6 +20,17 @@ func (e DeclField) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclField) DeclOverview() string {
+	if len(e.Parameters) == 0 {
+		return string(e.Name)
+	}
+	paramNames := make([]string, len(e.Parameters))
+	for i, param := range e.Parameters {
+		paramNames[i] = string(param.Name)
+	}
+	return fmt.Sprintf("%s %s", e.Name, strings.Join(paramNames, ", "))
+}
+
 func (e DeclField) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -36,3 +53,7 @@ func MakeDeclField(name Identifier, params []DeclParameter, source *Source) *Dec
 func (decl DeclField) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (DeclField) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	// no nested decls
+}

ast/decl-func.go

@@ -1,6 +1,12 @@
 package ast
 
+import (
+	"fmt"
+	"strings"
+)
+
 var _ Decl = DeclFunc{}
+var _ Overviewable = DeclFunc{}
 
 type DeclFunc struct {
 	Name Identifier
@@ -14,6 +20,17 @@ func (e DeclFunc) DeclName() Identifier {
 	return e.Name
 }
 
+func (e DeclFunc) DeclOverview() string {
+	if len(e.Impl.Parameters) == 0 {
+		return fmt.Sprintf("func %s { => }", e.Name)
+	}
+	paramNames := make([]string, len(e.Impl.Parameters))
+	for i, param := range e.Impl.Parameters {
+		paramNames[i] = string(param.Name)
+	}
+	return fmt.Sprintf("func %s { %s => }", e.Name, strings.Join(paramNames, ", "))
+}
+
 func (e DeclFunc) Meta() *MetaDecl {
 	return e.MetaInfo
 }
@@ -35,3 +52,7 @@ func MakeDeclFunc(name Identifier, impl *ExprFunc, source *Source) *DeclFunc {
 func (decl DeclFunc) ProvidedDocs() *Docs {
 	return decl.Docs
 }
+
+func (decl DeclFunc) EnumerateNestedDecls(enumerate func(interface{}, []Decl)) {
+	decl.Impl.EnumerateNestedDecls(enumerate)
+}