C++ CMake Other
Latest commit 0f9d9ca Mar 21, 2017 @lefticus lefticus committed on GitHub Merge pull request #332 from ftk/develop
Ability to disable module loading support at compile time
Permalink
Failed to load latest commit information.
.github Create CONTRIBUTING.md Feb 23, 2016
contrib sublime now at ChaiScript/sublimetext-chaiscript Feb 2, 2017
include/chaiscript Merge pull request #332 from ftk/develop Mar 21, 2017
performance_tests Add some cpp<->chai performance tests Feb 5, 2016
samples Compile out module path search code when module support is disabled Mar 5, 2017
src Compile out module path search code when module support is disabled Mar 5, 2017
static_libs Cleanups and split up into _basic options Aug 27, 2016
unittests Merge pull request #332 from ftk/develop Mar 21, 2017
.decent_ci-Linux.yaml Remove g++ 4.8 from builds Mar 10, 2016
.decent_ci-MacOS.yaml Move debug over to windows build Mar 5, 2016
.decent_ci-Windows.yaml Merge branch 'develop' into update_travis_toolchain Mar 6, 2016
.decent_ci.yaml Fix results location Sep 14, 2014
.travis.yml Simplified travis.yml Mar 11, 2017
CMakeLists.txt Merge pull request #332 from ftk/develop Mar 21, 2017
DesignGoals.md Create DesignGoals.md Jun 28, 2016
Doxyfile.in Fix Doxygen configuration Jan 6, 2015
LICENSE Update copyrights Feb 15, 2016
appveyor.yml Add gitter appveyor webhook Mar 6, 2016
biicode.conf Update biicode and get master updated to v5.6.0 Mar 20, 2015
cheatsheet.md Merge pull request #310 from M2tM/patch-1 Dec 3, 2016
description.txt Get cpack working for source and deb distribtions. Still need to chec… Mar 29, 2010
license.txt Update copyrights Feb 15, 2016
readme.md Fixes path reference and code formatting in readme. Mar 2, 2017
releasenotes.md Update release notes for 6.0.0 Feb 22, 2017
supporters.md Create supporters.md Mar 6, 2016

readme.md

Master Status: Linux Build Status Windows Build status codecov.io

Develop Status: Linux Build Status Windows Build status codecov.io

Coverity Scan Build Status

ChaiScript

http://www.chaiscript.com

(c) 2009-2012 Jonathan Turner (c) 2009-2017 Jason Turner

Release under the BSD license, see "license.txt" for details.

Introduction

![Gitter](https://badges.gitter.im/Join Chat.svg)

ChaiScript is one of the only embedded scripting language designed from the ground up to directly target C++ and take advantage of modern C++ development techniques, working with the developer like he expects it to work. Being a native C++ application, it has some advantages over existing embedded scripting languages:

  1. It uses a header-only approach, which makes it easy to integrate with existing projects.
  2. It maintains type safety between your C++ application and the user scripts.
  3. It supports a variety of C++ techniques including callbacks, overloaded functions, class methods, and stl containers.

Requirements

ChaiScript requires a C++14 compiler to build with support for variadic templates. It has been tested with gcc 4.9 and clang 3.6 (with libcxx). For more information see the build dashboard.

Usage

  • Add the ChaiScript include directory to your project's header search path
  • Add #include <chaiscript/chaiscript.hpp> to your source file
  • Instantiate the ChaiScript engine in your application. For example, create a new engine with the name chai like so: chaiscript::ChaiScript chai
  • The default behavior is to load the ChaiScript standard library from a loadable module. A second option is to compile the library into your code, see below for an example.

Once instantiated, the engine is ready to start running ChaiScript source. You have two main options for processing ChaiScript source: a line at a time using chai.eval(string) and a file at a time using chai.eval_file(fname)

To make functions in your C++ code visible to scripts, they must be registered with the scripting engine. To do so, call add:

chai.add(chaiscript::fun(&my_function), "my_function_name");

Once registered the function will be visible to scripts as "my_function_name"

Examples

ChaiScript is similar to ECMAScript (aka JavaScript(tm)), but with some modifications to make it easier to use. For usage examples see the "samples" directory, and for more in-depth look at the language, the unit tests in the "unittests" directory cover the most ground.

For examples of how to register parts of your C++ application, see "example.cpp" in the "samples" directory. Example.cpp is verbose and shows every possible way of working with the library. For further documentation generate the doxygen documentation in the build folder or see the website http://www.chaiscript.com.

The shortest complete example possible follows:

/// main.cpp

#include <chaiscript/chaiscript.hpp>

double function(int i, double j)
{
  return i * j;
}

int main()
{
  chaiscript::ChaiScript chai;
  chai.add(chaiscript::fun(&function), "function");

  double d = chai.eval<double>("function(3, 4.75);");
}