added Top-Level Comment to Modules

Author: bafto

src/ast/module.go

@@ -16,6 +16,8 @@ type Module struct {
 	FileNameToken *token.Token
 	// all the imported modules
 	Imports []*ImportStmt
+	// First token in the file if present, or nil otherwise
+	Comment *token.Token
 	// a set which contains all files needed
 	// to link the final executable
 	// contains .c, .lib, .a and .o files

src/parser/declarations.go

@@ -60,6 +60,10 @@ func (p *parser) varDeclaration(startDepth int, isField bool) ast.Declaration {
 	if comment != nil && comment.Range.End.Line < begin.Range.Start.Line-1 {
 		comment = nil
 	}
+	// prefer to attach the comment to a declaration, rather than to the module
+	if comment == p.module.Comment {
+		p.module.Comment = nil
+	}
 
 	isPublic := p.peekN(startDepth+1).Type == token.OEFFENTLICHE || p.peekN(startDepth+1).Type == token.OEFFENTLICHEN
 
@@ -383,6 +387,10 @@ func (p *parser) funcDeclaration(startDepth int) ast.Declaration {
 	if comment != nil && comment.Range.End.Line < begin.Range.Start.Line-1 {
 		comment = nil
 	}
+	// prefer to attach the comment to a declaration, rather than to the module
+	if comment == p.module.Comment {
+		p.module.Comment = nil
+	}
 
 	isPublic := p.peekN(startDepth+1).Type == token.OEFFENTLICHE
 
@@ -695,6 +703,10 @@ func (p *parser) structDeclaration() ast.Declaration {
 	if comment != nil && comment.Range.End.Line < begin.Range.Start.Line-1 {
 		comment = nil
 	}
+	// prefer to attach the comment to a declaration, rather than to the module
+	if comment == p.module.Comment {
+		p.module.Comment = nil
+	}
 
 	p.consume(token.NENNEN, token.DIE)
 	isPublic := p.match(token.OEFFENTLICHE)

src/parser/parser.go

@@ -54,6 +54,8 @@ func newParser(name string, tokens []token.Token, modules map[string]*ast.Module
 		tokens = append(tokens, token.Token{Type: token.EOF})
 	}
 
+	is_first_tok_comment := tokens[0].Type == token.COMMENT
+
 	comments := make([]token.Token, 0)
 	// filter the comments out
 	i := 0
@@ -67,6 +69,11 @@ func newParser(name string, tokens []token.Token, modules map[string]*ast.Module
 	}
 	tokens = tokens[:i]
 
+	var module_comment *token.Token
+	if is_first_tok_comment {
+		module_comment = &comments[0]
+	}
+
 	parser := &parser{
 		tokens:       tokens,
 		comments:     comments,
@@ -75,6 +82,7 @@ func newParser(name string, tokens []token.Token, modules map[string]*ast.Module
 		module: &ast.Module{
 			FileName:             name,
 			Imports:              make([]*ast.ImportStmt, 0),
+			Comment:              module_comment,
 			ExternalDependencies: make(map[string]struct{}, 5),
 			Ast: &ast.Ast{
 				Statements: make([]ast.Statement, 0),