README.md

Swallow

A minimalist functional programming language

• Copyright (c) 2023 Muqiu Han

• This project is built using xmake: https://xmake.io/

• FAQ: https://github.com/muqiuhan/Swallow/blob/main/FAQ

• Issues: https://github.com/muqiuhan/Swallow/issues

• Contribution: https://github.com/muqiuhan/Swallow/pulls

• 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

  • To build: xmake f --toolchain=gcc -m release -y && xmake build -j$(expr $(nproc) / 2)

  or clang xmake f --toolchain=clang -m release -y && xmake build -j$(expr $(nproc) / 2)

  • To run: xmake run

  • To install: xmake install

  • Cross-compile to windows or other platforms on Linux

    • Setup: Install the llvm
    • Build: xmake f --toolchain=mingw -m release -y && xmake build -j$(expr $(nproc) / 2)

    If the LLVM header files cannot be found, you can manually run ln -s to the corresponding directory of mingw, for example:

    ln -s /usr/include/llvm /usr/lib64/gcc/x86_64-w64-mingw32/13.2.0/include
    
    ln -s /usr/include/llvm-c /usr/lib64/gcc/x86_64-w64-mingw32/13.2.0/include
    

• Tools

  • XMake: A cross-platform build utility based on Lua
  • GNU Bison: A general-purpose parser generator
  • Flex: The Fast Lexical Analyzer - scanner generator for lexing in C and C++

• Library/Frameworks

  • llvm: LLVM project
  • tl_optional: C++11/14/17 std::optional with functional-style extensions and reference support
  • tl_expected: C++11/14/17 std::expected with functional-style extensions
  • spdlog: Fast C++ logging library

• REFERENCE

  • Theory of computation
  • Functional programming
  • Finite-state machine
  • Implementing Fun tional Languages: a tutorial
  • The G-machine: A fast, graph-reduction evaluator
  • Panic better using modern C++
  • Hindley–Milner type system
  • Unification
  • Compiling a Functional Language Using C++

• 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.