Add using statement for complex return types

perbone · perbone · commit a84666b5d07e · 2021-09-29T22:44:07.000-03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## 0.0.68 - 2021-09-29
+
+### Changed
+
+* Add using statement for complex return types
+
 ## 0.0.67 - 2021-09-04
 
 ### Added
diff --git a/lua_script_language.cpp b/lua_script_language.cpp
@@ -2,7 +2,7 @@
  * This file is part of LuaScript
  * https://github.com/perbone/luascrip/
  *
- * Copyright 2017-2021 Paulo Perbone 
+ * Copyright 2017-2021 Paulo Perbone
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not  use this file except in compliance with the License.
@@ -206,7 +206,7 @@ bool LuaScriptLanguage::validate(const String &p_script, int &r_line_error, int
 		List<String> *r_functions, List<Warning> *r_warnings, Set<int> *r_safe_lines) const {
 	print_debug("LuaScriptLanguage::validate( p_path = %s )", p_path.ascii().get_data());
 
-	std::unique_ptr<parser::ast::AbstractSyntaxTree> ast = parser.parse(p_script.ascii().get_data());
+	parser::ast::AST ast = parser.parse(p_script.ascii().get_data());
 
 	if (ast->is_valid()) {
 		r_functions->clear();
diff --git a/parser/ast/abstract_syntax_tree.h b/parser/ast/abstract_syntax_tree.h
@@ -2,7 +2,7 @@
  * This file is part of LuaScript
  * https://github.com/perbone/luascrip/
  *
- * Copyright 2017-2021 Paulo Perbone 
+ * Copyright 2017-2021 Paulo Perbone
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not  use this file except in compliance with the License.
@@ -19,6 +19,7 @@
 
 #pragma once
 
+#include <memory>
 #include <string>
 #include <string_view>
 #include <vector>
@@ -66,4 +67,6 @@ class AbstractSyntaxTree {
 	bool valid;
 };
 
+using AST = std::unique_ptr<ast::AbstractSyntaxTree>;
+
 }; // namespace parser::ast
diff --git a/parser/ast/antlr_tree_walker.cpp b/parser/ast/antlr_tree_walker.cpp
@@ -2,7 +2,7 @@
  * This file is part of LuaScript
  * https://github.com/perbone/luascrip/
  *
- * Copyright 2017-2021 Paulo Perbone 
+ * Copyright 2017-2021 Paulo Perbone
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not  use this file except in compliance with the License.
@@ -25,18 +25,20 @@
 
 namespace parser::ast {
 
-AntlrTreeWalker::AntlrTreeWalker() {
-}
+AntlrTreeWalker::AntlrTreeWalker() {}
 
-AntlrTreeWalker::~AntlrTreeWalker() {
-}
+AntlrTreeWalker::~AntlrTreeWalker() {}
 
-std::unique_ptr<AbstractSyntaxTree> AntlrTreeWalker::walk(const std::string_view chunk) {
+AST AntlrTreeWalker::walk(const std::string_view chunk) {
 	antlr4::ANTLRInputStream input(chunk);
 	generated::LuaLexer lexer(&input);
 	antlr4::CommonTokenStream tokens(&lexer);
 	generated::LuaParser parser(&tokens);
 
+	// We instantiate a new collection of methods each time we walk the tree 
+	// so we can move it to the returned AST at the end of the parser. 
+	// The fact that this collection is a data member is just for easy access 
+	// from within the listener functions.
 	this->methods = Methods{};
 
 	antlr4::tree::ParseTree *chunk_tree = parser.chunk();
diff --git a/parser/ast/antlr_tree_walker.h b/parser/ast/antlr_tree_walker.h
@@ -2,7 +2,7 @@
  * This file is part of LuaScript
  * https://github.com/perbone/luascrip/
  *
- * Copyright 2017-2021 Paulo Perbone 
+ * Copyright 2017-2021 Paulo Perbone
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not  use this file except in compliance with the License.
@@ -23,7 +23,6 @@
 
 #include "../generated/LuaBaseListener.h"
 
-#include <memory>
 #include <string_view>
 
 namespace parser::ast {
@@ -33,7 +32,7 @@ class AntlrTreeWalker : public TreeWalker, generated::LuaBaseListener {
 	AntlrTreeWalker();
 	~AntlrTreeWalker();
 
-	std::unique_ptr<ast::AbstractSyntaxTree> walk(const std::string_view chunk) override;
+	[[nodiscard]] AST walk(const std::string_view chunk) override;
 
 	virtual void exitStatFunction(generated::LuaParser::StatFunctionContext *ctx) override;
 
diff --git a/parser/ast/tree_walker.h b/parser/ast/tree_walker.h
@@ -30,7 +30,7 @@ class TreeWalker {
 public:
 	virtual ~TreeWalker() = default;
 
-	virtual std::unique_ptr<AbstractSyntaxTree> walk(const std::string_view chunk) = 0;
+	virtual AST walk(const std::string_view chunk) = 0;
 };
 
 } // namespace parser::ast
diff --git a/parser/parser.cpp b/parser/parser.cpp
@@ -30,7 +30,7 @@ Parser::Parser() :
 Parser::~Parser() {
 }
 
-std::unique_ptr<ast::AbstractSyntaxTree> Parser::parse(const std::string_view chunk) const {
+ast::AST Parser::parse(const std::string_view chunk) const {
 	return treeWalker->walk(chunk);
 }
 
diff --git a/parser/parser.h b/parser/parser.h
@@ -31,7 +31,7 @@ class Parser {
 	Parser();
 	~Parser();
 
-	std::unique_ptr<ast::AbstractSyntaxTree> parse(const std::string_view chunk) const;
+	ast::AST parse(const std::string_view chunk) const;
 
 private:
 	std::unique_ptr<ast::TreeWalker> treeWalker;

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ Parser::Parser() :`
`30`	`30`	`Parser::~Parser() {`
`31`	`31`	`}`
`32`	`32`
`33`		`-std::unique_ptr<ast::AbstractSyntaxTree> Parser::parse(const std::string_view chunk) const {`
	`33`	`+ast::AST Parser::parse(const std::string_view chunk) const {`
`34`	`34`	`return treeWalker->walk(chunk);`
`35`	`35`	`}`
`36`	`36`