Merge pull request muqiuhan#26 from X-FRI/main

[compiler]: fix the crash bug when pattern-matching is not exhaustive
X-FRI · Apr 24, 2024 · 6c5492f · 6c5492f
2 parents 665a875 + 59de5a5
commit 6c5492f
Show file tree

Hide file tree

Showing 12 changed files with 238 additions and 271 deletions.
diff --git a/README b/README
@@ -20,7 +20,7 @@ To build and run with xmake:
 Features
 ----------
 o- Typechecking
-o- Pattern Match
+o- Pattern Matching
 o- Garbage Collection
 o- Polymorphism
 

diff --git a/README.md b/README.md
@@ -17,114 +17,69 @@
 - Issues: https://github.com/muqiuhan/Swallow/issues
 - Contribution: https://github.com/muqiuhan/Swallow/pulls
 
----
-
-## Build & Install
-
-To build and run with [xmake](xmake.io):
-> Setup: Install the [xmake](xmake.io), [flex]() and [bison]()
+- Features
+  - Typechecking
+  - Pattern Matching
+  - Garbage Collection
+  - Polymorphism
+
+- Build & Install
+  - > This project provides makefile, CMakeLists.txt, which can be built in an environment without xmake.
+  - > Setup: Install the [xmake](xmake.io)
+  - To build:   xmake build
+  - To run:     xmake run
+  - To install: xmake install
+
+
+- Tools
+  - [XMake: A cross-platform build utility based on Lua](https://xmake.io/#/)
+  - [GNU Bison: A general-purpose parser generator](https://github.com/akimd/bison)
+  - [Flex:  The Fast Lexical Analyzer - scanner generator for lexing in C and C++](https://github.com/westes/flex)
+
+- Library/Frameworks
+  - [optional: C++11/14/17 std::optional with functional-style extensions and reference support](https://github.com/TartanLlama/optional)
+  - [result: Result<T, E> for Modern C++](https://github.com/p-ranav/result)
 
-- To build:   xmake build
-- To run:     xmake run
-- To install: xmake install
-
-## Introduction
-
-### Typechecking
-```rescript
-data Bool = [ True, False ]
-data List = [ Nil, Cons Int List ]
-
-let main(argv) = {
-    match argv with {
-    | True => { 0 }
-    | Nil => { 1 }
-    }
-}
-```
-
-```
-[E013] Error: Type checking failed for pattern
-    /-[example/PatternType.sw]
-    o
-  6 |      | True => { 0 }
-  7 |      | Nil => { 1 }
-    o        ^^^^        
-    o        := This pattern has type 'List', but here may need a 'Bool'
-  8 |      }
-    o
-    o-- Note: 'Bool' conflicts with 'List'
-----/
-```
-
-### Pattern Matching
-```rescript
-data List = [ Nil, Cons Int List ]
-
-let main(argv) = {
-  match argv with {
-  | Nil => { 0 }
-  | Cons x xs => { 0 }
-  }
-}
-```
-
-### Garbage Collection
-...
-
-### Polymorphism
-...
-
-## Acknowledge
-
-### Tools
-- [XMake: A cross-platform build utility based on Lua](https://xmake.io/#/)
-- [GNU Bison: A general-purpose parser generator](https://github.com/akimd/bison)
-- [Flex:  The Fast Lexical Analyzer - scanner generator for lexing in C and C++](https://github.com/westes/flex)
 
-
-### Library/Frameworks
-- [optional: C++11/14/17 std::optional with functional-style extensions and reference support](https://github.com/TartanLlama/optional)
-- [result: Result<T, E> for Modern C++](https://github.com/p-ranav/result)
-
-## REFERENCE
-- [Theory of computation](https://en.wikipedia.org/wiki/Theory_of_computation)
-- [Functional programming](https://en.wikipedia.org/wiki/Functional_programming)
-- [Finite-state machine](https://en.wikipedia.org/wiki/Finite-state_machine)
-- [Implementing Fun tional Languages: a tutorial](https://www.microsoft.com/en-us/research/wp-content/uploads/1992/01/student.pdf)
-- [The G-machine: A fast, graph-reduction evaluator](https://link.springer.com/chapter/10.1007/3-540-15975-4_50)
-- [Panic better using modern C++](https://buildingblock.ai/Panic)
-- [Hindley–Milner type system](https://en.wikipedia.org/wiki/Hindley%E2%80%93Milner_type_system)
-- [Unification](https://en.wikipedia.org/wiki/Unification_(computer_science))
-- [Compiling a Functional Language Using C++](https://danilafe.com/blog/00_compiler_intro/)
-
-## [LICENSE](./LICENSE)
-```
-Copyright (c) 2023 Muqiu Han
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-    * Neither the name of Swallow nor the names of its contributors
-      may be used to endorse or promote products derived from this software
-      without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-```
+- REFERENCE
+  - [Theory of computation](https://en.wikipedia.org/wiki/Theory_of_computation)
+  - [Functional programming](https://en.wikipedia.org/wiki/Functional_programming)
+  - [Finite-state machine](https://en.wikipedia.org/wiki/Finite-state_machine)
+  - [Implementing Fun tional Languages: a tutorial](https://www.microsoft.com/en-us/research/wp-content/uploads/1992/01/student.pdf)
+  - [The G-machine: A fast, graph-reduction evaluator](https://link.springer.com/chapter/10.1007/3-540-15975-4_50)
+  - [Panic better using modern C++](https://buildingblock.ai/Panic)
+  - [Hindley–Milner type system](https://en.wikipedia.org/wiki/Hindley%E2%80%93Milner_type_system)
+  - [Unification](https://en.wikipedia.org/wiki/Unification_(computer_science))
+  - [Compiling a Functional Language Using C++](https://danilafe.com/blog/00_compiler_intro/)
+
+- [LICENSE](./LICENSE)
+  ```
+  Copyright (c) 2023 Muqiu Han
+  
+  All rights reserved.
+  
+  Redistribution and use in source and binary forms, with or without modification,
+  are permitted provided that the following conditions are met:
+  
+      * Redistributions of source code must retain the above copyright notice,
+        this list of conditions and the following disclaimer.
+      * Redistributions in binary form must reproduce the above copyright notice,
+        this list of conditions and the following disclaimer in the documentation
+        and/or other materials provided with the distribution.
+      * Neither the name of Swallow nor the names of its contributors
+        may be used to endorse or promote products derived from this software
+        without specific prior written permission.
+  
+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  ```
+
diff --git a/compiler/ast/ast.hpp b/compiler/ast/ast.hpp
@@ -57,16 +57,16 @@ namespace swallow::compiler::ast
     virtual ~AST() = default;
 
     auto CommonTypeCheck(
-      type::Manager           &typeManager,
-      const type::Environment &typeEnvironment) noexcept -> type::Type::Ptr;
+      type::Manager &typeManager, const type::Environment &typeEnvironment) noexcept
+      -> type::Type::Ptr;
 
     void         CommonResolve(const type::Manager &typeManager) noexcept;
 
     virtual void Resolve(const type::Manager &typeManager) noexcept = 0;
 
-    virtual auto
-      TypeCheck(type::Manager &typeManager, const type::Environment &typeEnvironment)
-        const noexcept -> utils::Result<type::Type::Ptr, utils::Void> = 0;
+    virtual auto TypeCheck(
+      type::Manager &typeManager, const type::Environment &typeEnvironment) const noexcept
+      -> utils::Result<type::Type::Ptr, utils::Void> = 0;
 
     virtual void Dump(uint8_t indent, std::ostream &to) const noexcept = 0;
 

diff --git a/compiler/ast/g-machine.cpp b/compiler/ast/g-machine.cpp
@@ -57,7 +57,7 @@ namespace swallow::compiler::ast
     into.push_back(Instruction::Ptr(
       machineEnvironment->HasVariable(ID)
         ? dynamic_cast<Instruction *>(
-            new instruction::Push(machineEnvironment->GetOffset(ID).value()))
+          new instruction::Push(machineEnvironment->GetOffset(ID).value()))
 
         : dynamic_cast<Instruction *>(new instruction::PushGlobal(ID))));
   }
@@ -129,7 +129,7 @@ namespace swallow::compiler::ast
       constructorPattern->Params.rend(),
       [&](const auto &param) {
       newEnvironment = Environment::Ptr(new Variable(param, newEnvironment));
-    });
+      });
 
     branchInstructions.push_back(Instruction::Ptr(new instruction::Split()));
     branch->Expr->Compile(newEnvironment, branchInstructions);
@@ -218,7 +218,7 @@ namespace swallow::compiler::ast
     for (const auto &branch : Branches)
       CompileBranch(branch, jump, type, machineEnvironment, this->With->Location);
 
-    CheckCompileResult(jump, type, Location);
+    CheckCompileResult(jump, type, this->With->Location);
   }
 
   void Fn::Compile() noexcept