Cling - The Interactive C++ Interpreter

Go to file

Simeon Ehrig 2489cf13b1 Replaced incremental PTX compiler with a internal implementation Replaced the old version of the PTX compiler which used external tools and llvm::ExecuteAndWait with an internal implementation. The new incremental PTX compiler uses a modified version of the cling::Interpreter instance. The instance can process the PTX built-ins and generates LLVM IR. The LLVM IR is be compiled to PTX via an additional NVPTX backend implemented in the IncrementalCUDADeviceCompiler. The new implementation has many advantages: - it's much faster than the old version - less error-prone because the ASTPrinter and some unnecessary cling transformations are avoided - reduction of problems in searching for external tools (can be very complicated on HPC systems) The IncrementalCUDADeviceCompiler is moved from the cling::IncrementalParser to the cling::Interpreter, because the second interpreter needs the input without wrappers or transformations.		2019-11-07 19:29:15 +01:00
cmake/modules	fix Clang name in cmake file	2017-07-23 22:59:34 +02:00
demo	Remove trailing spaces	2014-08-13 16:08:36 +02:00
docs	Bump version to 0.7~dev.	2019-08-16 09:14:06 +02:00
include/cling	Replaced incremental PTX compiler with a internal implementation	2019-11-07 19:29:15 +01:00
lib	Replaced incremental PTX compiler with a internal implementation	2019-11-07 19:29:15 +01:00
patches	Remove old file.	2016-07-22 20:54:47 +02:00
test	Replaced incremental PTX compiler with a internal implementation	2019-11-07 19:29:15 +01:00
tools	Only install necessary packages using cpt if missing requirements	2019-09-27 07:01:54 +02:00
www	Fix typo.	2019-09-25 21:14:08 +02:00
.clang-format	Do not allow single line if statements.	2019-05-31 11:29:15 +02:00
.travis.yml	Only install necessary packages using cpt if missing requirements	2019-09-27 07:01:54 +02:00
appveyor.yml	Appveyor: Build with Ninja on Windows.	2017-03-09 08:29:28 +01:00
CMakeLists.txt	Enable warnings for cling, disable them for llvm.	2019-09-10 16:29:09 +02:00
CREDITS.txt	Improvements for Pull Request #240	2018-06-25 08:29:07 +02:00
LastKnownGoodLLVMSVNRevision.txt	Bump the last known good llvm revision to point to release 5.0	2017-11-02 17:59:25 +01:00
LICENSE.TXT	Remove trailing spaces	2014-08-13 16:08:36 +02:00
README.md	Add a note how to cite Cling.	2019-04-09 22:44:08 +02:00
VERSION	Bump version to 0.7~dev.	2019-08-16 09:14:06 +02:00

README.md

Cling - The Interactive C++ Interpreter

The main repository is at https://github.com/root-project/cling

Overview

Cling is an interactive C++ interpreter, built on top of Clang and LLVM compiler infrastructure. Cling realizes the read-eval-print loop (REPL) concept, in order to leverage rapid application development. Implemented as a small extension to LLVM and Clang, the interpreter reuses their strengths such as the praised concise and expressive compiler diagnostics.

Installation

Release Notes

See our release notes to find what's new.

Binaries

Our nightly binary snapshots can be found here.

Building from Source with Cling Packaging Tool

Cling's tree has a user-friendly, command-line utility written in Python called Cling Packaging Tool (CPT) which can build Cling from source and generate installer bundles for a wide range of platforms. CPT requires Python 2.7 or later.

If you have Cling's source cloned locally, you can find the tool in tools/packaging directory. Alternatively, you can download the script manually, or by using wget:

wget https://raw.githubusercontent.com/root-project/cling/master/tools/packaging/cpt.py
chmod +x cpt.py
./cpt.py --check-requirements && ./cpt.py --create-dev-env Debug --with-workdir=./cling-build/

Full documentation of CPT can be found in tools/packaging.

Usage

./cling '#include <stdio.h>' 'printf("Hello World!\n")'

To get started run:

./cling --help

or type

./cling
[cling]$ .help

Jupyter

Cling comes with a Jupyter kernel. After building cling, install Jupyter and cling's kernel by following the README.md in tools/Jupyter. Make sure cling is in your PATH when you start jupyter!

Citing Cling

% Peer-Reviewed Publication
%
% 19th International Conference on Computing in High Energy and Nuclear Physics (CHEP)
% 21-25 May, 2012, New York, USA
%
@inproceedings{Cling,
  author = {Vassilev,V. and Canal,Ph. and Naumann,A. and Moneta,L. and Russo,P.},
  title = {{Cling} -- The New Interactive Interpreter for {ROOT} 6}},
  journal = {Journal of Physics: Conference Series},
  year = 2012,
  month = {dec},
  volume = {396},
  number = {5},
  pages = {052071},
  doi = {10.1088/1742-6596/396/5/052071},
  url = {https://iopscience.iop.org/article/10.1088/1742-6596/396/5/052071/pdf},
  publisher = {{IOP} Publishing}
}

Developers' Corner

Cling's latest doxygen documentation

Contributions

Every contribution is considered a donation and its copyright and any other related rights become exclusive ownership of the person who merged the code or in any other case the main developers of the "Cling Project".

We warmly welcome external contributions to the Cling! By providing code, you agree to transfer your copyright on the code to the "Cling project". Of course you will be duly credited and your name will appear on the contributors page, the release notes, and in the CREDITS file shipped with every binary and source distribution. The copyright transfer is necessary for us to be able to effectively defend the project in case of litigation.

License

Please see our LICENSE.

Releases

Our release steps to follow when cutting a new release:

Update release notes
Remove ~dev suffix from VERSION
Add a new entry in the news section of our website
Commit the changes.
git tag -a v0.x -m "Tagging release v0.x"
Create a draft release in github and copy the contents of the release notes.
Wait for green builds.
Upload binaries to github (Travis should do this automatically).
Publish the tag and announce it on the mailing list.
Increment the current version and append ~dev.