Implemented function scanning

src/scanner/Scan.go

@@ -2,23 +2,26 @@ package scanner
 
 import (
 	"git.urbach.dev/cli/q/src/build"
+	"git.urbach.dev/cli/q/src/core"
 	"git.urbach.dev/cli/q/src/fs"
 )
 
 // Scan scans all the files included in the build.
-func Scan(b *build.Build) (<-chan *fs.File, <-chan error) {
+func Scan(b *build.Build) (<-chan *core.Function, <-chan *fs.File, <-chan error) {
 	s := scanner{
-		files:  make(chan *fs.File),
-		errors: make(chan error),
-		build:  b,
+		functions: make(chan *core.Function),
+		files:     make(chan *fs.File),
+		errors:    make(chan error),
+		build:     b,
 	}
 
 	go func() {
 		s.queue(b.Files...)
 		s.group.Wait()
+		close(s.functions)
 		close(s.files)
 		close(s.errors)
 	}()
 
-	return s.files, s.errors
+	return s.functions, s.files, s.errors
 }

src/scanner/Scan_test.go

@@ -4,6 +4,7 @@ import (
 	"testing"
 
 	"git.urbach.dev/cli/q/src/build"
+	"git.urbach.dev/cli/q/src/core"
 	"git.urbach.dev/cli/q/src/fs"
 	"git.urbach.dev/cli/q/src/scanner"
 	"git.urbach.dev/go/assert"
@@ -11,30 +12,45 @@ import (
 
 func TestScanDirectory(t *testing.T) {
 	b := build.New("testdata")
-	files, errors := scanner.Scan(b)
-	err := consume(t, files, errors)
+	functions, files, errors := scanner.Scan(b)
+	err := consume(t, functions, files, errors)
 	assert.Nil(t, err)
 }
 
 func TestScanFile(t *testing.T) {
 	b := build.New("testdata/file.q")
-	files, errors := scanner.Scan(b)
-	err := consume(t, files, errors)
+	functions, files, errors := scanner.Scan(b)
+	err := consume(t, functions, files, errors)
 	assert.Nil(t, err)
 }
 
 func TestScanNotExisting(t *testing.T) {
 	b := build.New("_")
-	files, errors := scanner.Scan(b)
-	err := consume(t, files, errors)
+	functions, files, errors := scanner.Scan(b)
+	err := consume(t, functions, files, errors)
 	assert.NotNil(t, err)
 }
 
-func consume(t *testing.T, files <-chan *fs.File, errors <-chan error) error {
+func TestScanHelloExample(t *testing.T) {
+	b := build.New("../../examples/hello")
+	functions, files, errors := scanner.Scan(b)
+	err := consume(t, functions, files, errors)
+	assert.Nil(t, err)
+}
+
+func consume(t *testing.T, functions <-chan *core.Function, files <-chan *fs.File, errors <-chan error) error {
 	var lastError error
 
-	for files != nil || errors != nil {
+	for functions != nil || files != nil || errors != nil {
 		select {
+		case function, ok := <-functions:
+			if !ok {
+				functions = nil
+				continue
+			}
+
+			t.Log(function)
+
 		case file, ok := <-files:
 			if !ok {
 				files = nil

src/scanner/errors.go

@@ -1,41 +0,0 @@
-package scanner
-
-import (
-	"fmt"
-
-	"git.urbach.dev/cli/q/src/errors"
-)
-
-var (
-	expectedPackageName = &errors.String{Message: "Expected package name"}
-)
-
-// invalidCharacter is created when an invalid character appears.
-type invalidCharacter struct {
-	Character string
-}
-
-// Error implements the error interface.
-func (err *invalidCharacter) Error() string {
-	return fmt.Sprintf("Invalid character '%s'", err.Character)
-}
-
-// invalidTopLevel error is created when a top-level instruction is not valid.
-type invalidTopLevel struct {
-	Instruction string
-}
-
-// Error generates the string representation.
-func (err *invalidTopLevel) Error() string {
-	return fmt.Sprintf("Invalid top level instruction '%s'", err.Instruction)
-}
-
-// isNotDirectory error is created when a path is not a directory.
-type isNotDirectory struct {
-	Path string
-}
-
-// Error generates the string representation.
-func (err *isNotDirectory) Error() string {
-	return fmt.Sprintf("Import path '%s' is not a directory", err.Path)
-}

src/scanner/queue.go

@@ -0,0 +1,21 @@
+package scanner
+
+import "os"
+
+// queue scans the list of files.
+func (s *scanner) queue(files ...string) {
+	for _, file := range files {
+		stat, err := os.Stat(file)
+
+		if err != nil {
+			s.errors <- err
+			return
+		}
+
+		if stat.IsDir() {
+			s.queueDirectory(file, "main")
+		} else {
+			s.queueFile(file, "main")
+		}
+	}
+}

src/scanner/queueDirectory.go

@@ -0,0 +1,80 @@
+package scanner
+
+import (
+	"path/filepath"
+	"strings"
+
+	"git.urbach.dev/cli/q/src/build"
+	"git.urbach.dev/cli/q/src/fs"
+)
+
+// queueDirectory queues an entire directory to be scanned.
+func (s *scanner) queueDirectory(directory string, pkg string) {
+	_, loaded := s.queued.LoadOrStore(directory, nil)
+
+	if loaded {
+		return
+	}
+
+	err := fs.Walk(directory, func(name string) {
+		if !strings.HasSuffix(name, ".q") {
+			return
+		}
+
+		tmp := name[:len(name)-2]
+
+		for {
+			underscore := strings.LastIndexByte(tmp, '_')
+
+			if underscore == -1 {
+				break
+			}
+
+			condition := tmp[underscore+1:]
+
+			switch condition {
+			case "linux":
+				if s.build.OS != build.Linux {
+					return
+				}
+
+			case "mac":
+				if s.build.OS != build.Mac {
+					return
+				}
+
+			case "unix":
+				if s.build.OS != build.Linux && s.build.OS != build.Mac {
+					return
+				}
+
+			case "windows":
+				if s.build.OS != build.Windows {
+					return
+				}
+
+			case "x86":
+				if s.build.Arch != build.X86 {
+					return
+				}
+
+			case "arm":
+				if s.build.Arch != build.ARM {
+					return
+				}
+
+			default:
+				return
+			}
+
+			tmp = tmp[:underscore]
+		}
+
+		fullPath := filepath.Join(directory, name)
+		s.queueFile(fullPath, pkg)
+	})
+
+	if err != nil {
+		s.errors <- err
+	}
+}

src/scanner/queueFile.go

@@ -0,0 +1,15 @@
+package scanner
+
+// queueFile queues a single file to be scanned.
+func (s *scanner) queueFile(file string, pkg string) {
+	s.group.Add(1)
+
+	go func() {
+		defer s.group.Done()
+		err := s.scanFile(file, pkg)
+
+		if err != nil {
+			s.errors <- err
+		}
+	}()
+}

src/scanner/scanFile.go

@@ -0,0 +1,52 @@
+package scanner
+
+import (
+	"os"
+
+	"git.urbach.dev/cli/q/src/errors"
+	"git.urbach.dev/cli/q/src/fs"
+	"git.urbach.dev/cli/q/src/token"
+)
+
+// scanFile scans a single file.
+func (s *scanner) scanFile(path string, pkg string) error {
+	contents, err := os.ReadFile(path)
+
+	if err != nil {
+		return err
+	}
+
+	tokens := token.Tokenize(contents)
+
+	file := &fs.File{
+		Path:    path,
+		Package: pkg,
+		Bytes:   contents,
+		Tokens:  tokens,
+	}
+
+	s.files <- file
+
+	for i := 0; i < len(tokens); i++ {
+		switch tokens[i].Kind {
+		case token.NewLine:
+		case token.Comment:
+		case token.Identifier:
+			i, err = s.scanFunction(file, tokens, i)
+		case token.Import:
+			i, err = s.scanImport(file, tokens, i)
+		case token.EOF:
+			return nil
+		case token.Invalid:
+			return errors.New(&errors.InvalidCharacter{Character: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
+		default:
+			return errors.New(&errors.InvalidTopLevel{Instruction: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
+		}
+
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}

src/scanner/scanFunction.go

@@ -1,15 +1,77 @@
 package scanner
 
 import (
+	"git.urbach.dev/cli/q/src/errors"
 	"git.urbach.dev/cli/q/src/fs"
 	"git.urbach.dev/cli/q/src/token"
 )
 
 // scanFunction scans a function.
 func (s *scanner) scanFunction(file *fs.File, tokens token.List, i int) (int, error) {
-	for i < len(tokens) && tokens[i].Kind != token.BlockEnd {
-		i++
+	function, i, err := scanSignature(file, tokens, i, token.BlockStart)
+
+	if err != nil {
+		return i, err
 	}
 
+	var (
+		blockLevel = 0
+		bodyStart  = -1
+	)
+
+	// Function definition
+	for i < len(tokens) {
+		if tokens[i].Kind == token.BlockStart {
+			blockLevel++
+			i++
+
+			if blockLevel == 1 {
+				bodyStart = i
+			}
+
+			continue
+		}
+
+		if tokens[i].Kind == token.BlockEnd {
+			blockLevel--
+
+			if blockLevel < 0 {
+				return i, errors.New(errors.MissingBlockStart, file, tokens[i].Position)
+			}
+
+			if blockLevel == 0 {
+				break
+			}
+
+			i++
+			continue
+		}
+
+		if tokens[i].Kind == token.Invalid {
+			return i, errors.New(&errors.InvalidCharacter{Character: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
+		}
+
+		if tokens[i].Kind == token.EOF {
+			if blockLevel > 0 {
+				return i, errors.New(errors.MissingBlockEnd, file, tokens[i].Position)
+			}
+
+			if bodyStart == -1 {
+				return i, errors.New(errors.ExpectedFunctionDefinition, file, tokens[i].Position)
+			}
+
+			return i, nil
+		}
+
+		if blockLevel > 0 {
+			i++
+			continue
+		}
+
+		return i, errors.New(errors.ExpectedFunctionDefinition, file, tokens[i].Position)
+	}
+
+	function.Body = tokens[bodyStart:i]
+	s.functions <- function
 	return i, nil
 }

src/scanner/scanImport.go

@@ -15,7 +15,7 @@ func (s *scanner) scanImport(file *fs.File, tokens token.List, i int) (int, erro
 	i++
 
 	if tokens[i].Kind != token.Identifier {
-		return i, errors.New(expectedPackageName, file, tokens[i].Position)
+		return i, errors.New(errors.ExpectedPackageName, file, tokens[i].Position)
 	}
 
 	packageName := tokens[i].String(file.Bytes)
@@ -27,7 +27,7 @@ func (s *scanner) scanImport(file *fs.File, tokens token.List, i int) (int, erro
 	}
 
 	if !stat.IsDir() {
-		return i, errors.New(&isNotDirectory{Path: fullPath}, file, tokens[i].Position)
+		return i, errors.New(&errors.IsNotDirectory{Path: fullPath}, file, tokens[i].Position)
 	}
 
 	s.queueDirectory(fullPath, packageName)

src/scanner/scanSignature.go

@@ -0,0 +1,118 @@
+package scanner
+
+import (
+	"git.urbach.dev/cli/q/src/core"
+	"git.urbach.dev/cli/q/src/errors"
+	"git.urbach.dev/cli/q/src/fs"
+	"git.urbach.dev/cli/q/src/token"
+)
+
+// scanSignature scans only the function signature without the body.
+func scanSignature(file *fs.File, tokens token.List, i int, delimiter token.Kind) (*core.Function, int, error) {
+	var (
+		groupLevel  = 0
+		nameStart   = i
+		paramsStart = -1
+		paramsEnd   = -1
+		typeStart   = -1
+		typeEnd     = -1
+	)
+
+	i++
+
+	// Function parameters
+	for i < len(tokens) {
+		if tokens[i].Kind == token.GroupStart {
+			groupLevel++
+			i++
+
+			if groupLevel == 1 {
+				paramsStart = i
+			}
+
+			continue
+		}
+
+		if tokens[i].Kind == token.GroupEnd {
+			groupLevel--
+
+			if groupLevel < 0 {
+				return nil, i, errors.New(errors.MissingGroupStart, file, tokens[i].Position)
+			}
+
+			if groupLevel == 0 {
+				paramsEnd = i
+				i++
+				break
+			}
+
+			i++
+			continue
+		}
+
+		if tokens[i].Kind == token.Invalid {
+			return nil, i, errors.New(&errors.InvalidCharacter{Character: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
+		}
+
+		if tokens[i].Kind == token.EOF {
+			if groupLevel > 0 {
+				return nil, i, errors.New(errors.MissingGroupEnd, file, tokens[i].Position)
+			}
+
+			if paramsStart == -1 {
+				return nil, i, errors.New(errors.InvalidDefinition, file, tokens[i].Position)
+			}
+
+			return nil, i, nil
+		}
+
+		if groupLevel > 0 {
+			i++
+			continue
+		}
+
+		return nil, i, errors.New(errors.InvalidDefinition, file, tokens[i].Position)
+	}
+
+	// Return type
+	if i < len(tokens) && tokens[i].Kind == token.ReturnType {
+		typeStart = i + 1
+
+		for i < len(tokens) && tokens[i].Kind != delimiter {
+			i++
+		}
+
+		typeEnd = i
+	}
+
+	name := tokens[nameStart].String(file.Bytes)
+	function := core.NewFunction(name, file)
+	parameters := tokens[paramsStart:paramsEnd]
+
+	for param := range parameters.Split {
+		if len(param) == 0 {
+			return nil, i, errors.New(errors.MissingParameter, file, parameters[0].Position)
+		}
+
+		if len(param) == 1 {
+			return nil, i, errors.New(errors.MissingType, file, param[0].End())
+		}
+
+		function.Input = append(function.Input, core.NewParameter(param))
+	}
+
+	if typeStart != -1 {
+		if tokens[typeStart].Kind == token.GroupStart && tokens[typeEnd-1].Kind == token.GroupEnd {
+			typeStart++
+			typeEnd--
+		}
+
+		outputTokens := tokens[typeStart:typeEnd]
+
+		for param := range outputTokens.Split {
+			function.Output = append(function.Output, core.NewParameter(param))
+		}
+	}
+
+	return function, i, nil
+}

src/scanner/scanner.go

@@ -1,168 +1,19 @@
 package scanner
 
 import (
-	"os"
-	"path/filepath"
-	"strings"
 	"sync"
 
 	"git.urbach.dev/cli/q/src/build"
-	"git.urbach.dev/cli/q/src/errors"
+	"git.urbach.dev/cli/q/src/core"
 	"git.urbach.dev/cli/q/src/fs"
-	"git.urbach.dev/cli/q/src/token"
 )
 
 // scanner is used to scan files before the actual compilation step.
 type scanner struct {
-	files  chan *fs.File
-	errors chan error
-	build  *build.Build
-	queued sync.Map
-	group  sync.WaitGroup
-}
-
-// queue scans the list of files.
-func (s *scanner) queue(files ...string) {
-	for _, file := range files {
-		stat, err := os.Stat(file)
-
-		if err != nil {
-			s.errors <- err
-			return
-		}
-
-		if stat.IsDir() {
-			s.queueDirectory(file, "main")
-		} else {
-			s.queueFile(file, "main")
-		}
-	}
-}
-
-// queueDirectory queues an entire directory to be scanned.
-func (s *scanner) queueDirectory(directory string, pkg string) {
-	_, loaded := s.queued.LoadOrStore(directory, nil)
-
-	if loaded {
-		return
-	}
-
-	err := fs.Walk(directory, func(name string) {
-		if !strings.HasSuffix(name, ".q") {
-			return
-		}
-
-		tmp := name[:len(name)-2]
-
-		for {
-			underscore := strings.LastIndexByte(tmp, '_')
-
-			if underscore == -1 {
-				break
-			}
-
-			condition := tmp[underscore+1:]
-
-			switch condition {
-			case "linux":
-				if s.build.OS != build.Linux {
-					return
-				}
-
-			case "mac":
-				if s.build.OS != build.Mac {
-					return
-				}
-
-			case "unix":
-				if s.build.OS != build.Linux && s.build.OS != build.Mac {
-					return
-				}
-
-			case "windows":
-				if s.build.OS != build.Windows {
-					return
-				}
-
-			case "x86":
-				if s.build.Arch != build.X86 {
-					return
-				}
-
-			case "arm":
-				if s.build.Arch != build.ARM {
-					return
-				}
-
-			default:
-				return
-			}
-
-			tmp = tmp[:underscore]
-		}
-
-		fullPath := filepath.Join(directory, name)
-		s.queueFile(fullPath, pkg)
-	})
-
-	if err != nil {
-		s.errors <- err
-	}
-}
-
-// queueFile queues a single file to be scanned.
-func (s *scanner) queueFile(file string, pkg string) {
-	s.group.Add(1)
-
-	go func() {
-		defer s.group.Done()
-		err := s.scanFile(file, pkg)
-
-		if err != nil {
-			s.errors <- err
-		}
-	}()
-}
-
-// scanFile scans a single file.
-func (s *scanner) scanFile(path string, pkg string) error {
-	contents, err := os.ReadFile(path)
-
-	if err != nil {
-		return err
-	}
-
-	tokens := token.Tokenize(contents)
-
-	file := &fs.File{
-		Path:    path,
-		Package: pkg,
-		Bytes:   contents,
-		Tokens:  tokens,
-	}
-
-	s.files <- file
-
-	for i := 0; i < len(tokens); i++ {
-		switch tokens[i].Kind {
-		case token.NewLine:
-		case token.Comment:
-		case token.Identifier:
-			i, err = s.scanFunction(file, tokens, i)
-		case token.Import:
-			i, err = s.scanImport(file, tokens, i)
-		case token.EOF:
-			return nil
-		case token.Invalid:
-			return errors.New(&invalidCharacter{Character: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
-		default:
-			return errors.New(&invalidTopLevel{Instruction: tokens[i].String(file.Bytes)}, file, tokens[i].Position)
-		}
-
-		if err != nil {
-			return err
-		}
-	}
-
-	return nil
+	functions chan *core.Function
+	files     chan *fs.File
+	errors    chan error
+	build     *build.Build
+	queued    sync.Map
+	group     sync.WaitGroup
 }