Giter Club home page Giter Club logo

lcool's Introduction

LCool

LCool is a compiler for the Cool programming language that uses LLVM as its backend.

Compiling

You need boost with the "program options" library, and LLVM to compile lcool.

This project is written in C++ and uses CMake as its build system. To compile and install it, run something like:

mkdir build
cd build
cmake ..
make
make install

LLVM

Currently lcool only works with LLVM 3.8. LLVM is detected using CMake's config system. If you installed LLVM from your distribution's repository it should work (eg on Debian install llvm-3.8-dev). If you compiled LLVM manually, you may need to set the -DCMAKE_PREFIX_PATH variable to the root of your LLVM installation.

On older versions of Ubuntu (pre xenial), the CMake scripts are broken so you will get errors when running CMake. There is a workaround which you can activate by passing -DBROKEN_UBUNTU_LLVM=Y and -DLLVM_ROOT=/usr/lib/llvm-<version> to CMake.

License

Copyright (C) 2014-2016 James Cowgill

LCool is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

LCool is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with LCool. If not, see http://www.gnu.org/licenses/.

lcool's People

Contributors

jcowgill avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

lcool's Issues

Improve LLVM CMake detection

Hello, Sorry for bothering you. I'm a LLVM beginner. I found your project lcool in github which is really cool and I want to learn llvm by reading your code. But I have a problem when I build lcool. My llvm version is LLVM_3.50svn

When I run "cmake ..", It generates an error: Could NOT find LLVM (missing: LLVM_LIBRARIES). I found the code you write in FindLLVM.cmake:

find_library(
LLVM_LIBRARIES
"LLVM-${LLVM_VERSION}"
PATHS "${LLVM_LIBRARY_DIRS}")

I have no library named "LLVM-3.50svn" in /usr/local/lib(LLVM_LIBRARY_DIRS), so i changed "LLVM-${LLVM_VERSION}" to NAMES "LLVMCore" "LLVMSupport", then it can generate makefile, but when i run make, It will still generate link error, such as "undefined reference to `llvm::Module::getTypeByName(llvm::StringRef) const'".

So how should I modify the FindLLVM.cmake in order to build the lcool successfully?

Thanks.

Test suite

LCool should have a test suite with lots of cool programs which can be fed into the compiler. This also serves as examples for cool programs since there aren't too many about.

Build only tests

  • Lexer: comments (single and multi line)
  • Lexer: identifiers
  • Lexer: strings (inc escape codes)
  • Lexer: unexpected EOF (in comments, strings, etc)
  • Parser: multiple input files
  • Parser: functions, attributes
  • Parser: integers (inc overflow)
  • Parser: strings (inc escape codes)
  • Layout: classes and inheritance (varying orders, circular inheritance, final classes, redefinition)
  • Layout: prohibit attribute redefinition, attributes are effectively "protected" (not private)
  • Layout: methods (valid types, redefinitions, overrides)
  • CodeGen: Main method
  • CodeGen: type conversions and assignments
  • CodeGen: valid types to operators
  • CodeGen: dispatch

Semantic tests

  • Basic hello world
  • Numeric expressions (+ - * / < <= >)
  • Division by zero
  • Let expressions
  • Loop expressions
  • Conditional expressions
  • Class inheritance, dispatch, overrides
  • Invalid downcasts.
  • Void pointers
  • Pointer comparisons
  • Object class methods
  • IO class methods
  • String class methods
  • Int / Bool boxing
  • SELF_TYPE
  • Valgrind (or equivalent) for refcount testing

Fix refcounting

Currently the ref-counting isn't quite right. This should be resolved to prevent (or at least reduce) memory leaks. This will probably be done after the test suite so I have some programs to test this against.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.