SqPlus compiles and runs on Win32, Linux, Mac OS-X, Sony PSP; should work with any modern C++ compiler. Unicode is supported. Can be downloaded, compiled and run in under 5 minutes (.zip includes all necessary files (build files for *nix and VS8 ( Visual Studio 2005 Express Editions are free ))). Code::Blocks project files also included.
Source code (stable): http://www.brightland.com/sq/SQUIRREL2_1_1_sqplus_25.zip
Source code (snapshot): http://downloads.sourceforge.net/sqplus/SQUIRREL2_1_1_sqplus_snapshot_20071014.zip
VS7.1 project files: now included in main distribution (since VS8 now has free editions, VS7.1 will only be supported while source changes are minimal)
SqPlus FAQ
Note: use snapshot or version 23 for gcc: http://www.brightland.com/sq/SQUIRREL2_1_1_sqplus_23.zip
Changes
- 10/14/07 - SQUIRREL2
- Fixed const member function overloading by Tegan (http://squirrel-lang.org/forums/thread/2160.aspx)
- Updates for missing inline in DECLARE_INSTANCE_TYPE_NAME (http://squirrel-lang.org/forums/thread/2156.aspx)
- Fixed resolution in function overloading (http://squirrel-lang.org/forums/thread/2179.aspx)
- Added support for operator overloading suggested by Tegan (http://squirrel-lang.org/forums/thread/2160.aspx)
- 09/27/07 - SQUIRREL2
- Added ats's extensions : http://squirrel-lang.org/forums/1/2153/ShowThread.aspx
- GCC_INLINE_WORKAROUND (problems with inline functions with gcc)
- Set/get for short/char members
- Get for const SQChar*
- DECLARE_ENUM_TYPE - Allows enums to be used as arguments
- Support for more customized Push handlers
- SQPLUS_DISABLE_COPY_INSTANCES (disabling automatic use of copy constructors)
- Support for automatically generate TypeMasks (a template solution) on function registration
- 08/25/07 - SQUIRREL2
- Added m0pey's smart pointer support : http://squirrel-lang.org/forums/thread/1982.aspx
- 07/01/07 - SQUIRREL2
- Fixed `returning a pointer of a derived class' problem with gcc (http://squirrel-lang.org/forums/thread/1875.aspx) based on http://wiki.squirrel-lang.org/default.aspx/SquirrelWiki/SqPlusNativeCreatedInstancesWithCorrectAncestry.html
- 06/02/07 - SQUIRREL2
- Fix by Sebastien Frippiat : http://squirrel-lang.org/forums/thread/507.aspx
- 05/27/07 - SQUIRREL2
- Added sqplus/SqPlusOverload.h for function overloading. See testSqPlus2unit/test_FunctionOverloading.cpp.
- 03/04/07 - SQUIRREL2
- Fixed compilation problem on g++-3.4.4 (cygwin): http://squirrel-lang.org/forums/thread/1753.aspx
- 02/25/07 - SQUIRREL2
- Fix by Kamaitati: http://squirrel-lang.org/forums/thread/1748.aspx
- Modified sqplu.h (SquirrelObject::Set<>()) for gcc
- Added testSqPlus2unit directory for unit testing
- 10/09/06 - SQUIRREL2
- Fixed SqPlusConst.h , changed SquirrelObject Get/Set to default to pass-by-reference, where pass-by-copy requires extra parameter
- 10/08/06 - SQUIRREL2
- Added SQClassDefNoConstructor<> (allows binding abstract base classes/pure-virtual-interfaces), added Squirrel Set/Get objects
- 09/30/06 - SQUIRREL2
- Fixed return type for sq_std_string Get()
- 08/21/06 - SQUIRREL2
- Merged in Squirrel 2.1.1 Stable
- 08/20/06 - SQUIRREL2
- Changed code order to be compatible with GCC 4.1.x. Added jflanglois' suggestion for std::basic_string<SQChar>
- 06/27/06 - SQUIRREL2
- Added Katsuaki Kawachi's GetInstance()/Match() changes
- 06/02/06 - SQUIRREL2
- Added VS7.1 make/project files with 71 suffix: can be used alongside VS8 without directory changes
- Added optional debug string argument to SquirrelVM::CompileBuffer()
- 05/28/06 - SQUIRREL2
- Added Kamaitati's changes: bug fix, C++ style inheritance support, null instance argument support
- 04/25/06 - SQUIRREL2
- Changed SquirrelObject::GetInstanceUP() to return NULL and clear internal error state on invalid instance type request
- Added SquirrelObject::GetTypeName(const SQChar * key), SquirrelObject::GetTypeName(INT key) and SquirrelObject::GetTypeName(). Added SQ_SUPPORT_INSTANCE_TYPE_INFO compile time option
- Added missing template arguments (7 argument case)
- Source changes to support VS7.1 and VS8 compilation (standard and UNICODE builds)
- Added Code::Blocks project files
- 03/26/06 - SQUIRREL2
- 03/19/06 - SQUIRREL2
- Updated to Squirrel 2.1
- 02/27/06 - SQUIRREL2
- Added Ben's changes to implement DECLARE_INSTANCE_TYPE_NAME
- 12/22/05 - SQUIRREL2
- Added GetVMSys() and SetVMSys() to better support multiple VM's
- 11/21/05 - SQUIRREL2
- Added modular support for const member functions. Defining SQPLUS_CONST_OPT before including sqplus.h enables the added functionality
- SqPlus tested on Mac OS-X
- 11/03/05 - SQUIRREL2
- Fixed inheritance issue: tables added to classes are not newly created upon instantiation- they must be cloned during construction (language design)
- Reworked projects build settings to better allow building all projects types: Debug, Release, Debug - Unicode, Release - Unicode
- 11/01/05 - SQUIRREL2
- Added Unicode support
- 10/23/05 - SQUIRREL2
- Added gcc support:
- Added simple GNU Makefiles for gcc
- Minor code changes for gcc compilation
- Tested on RH Linux gcc 3.2.3, Cygwin gcc 3.4.4, and gcc on Sony PSP
- Added ClassDef::enumInt() for registering enums as ints (to replace ClassDef::constant((int)myEnum))
- 10/14/05 - SQUIRREL2
- Added support for SquirrelObject as a function argument and return value. Tables and arrays can be directly accessed without using the stack. This also makes it possible to return tables, arrays, classes, and closures for later use at runtime, saving look-up overhead
- Added GetRet() for SquirrelFunction<> to ensure proper stack behavior
- Added additional error return info to help with debugging
- Removed unused code
Documentation
- See the following examples for getting started with SqPlus
- Stepping through the examples with the debugger will provide insight into how the system works
- Forum questions are typically answered by adding a test case to testSqPlus2.cpp
- SqPlus is being used for a game in development. Updates are posted after changes during game development and/or to answer forum post questions
- Using the Wiki system is very easy: those wishing to add examples and/or documentation, feel free to make contributions
Features
- Easy to use: compiler does most of the work
- Simple design
- One header provides all template code
- One library for non-template code
- The template design will not cause the compiler to slow down or cause symbol bloat with debug builds
- Lightweight interfacing code: as fast as possible
- Relatively easy to understand and trace through
- Call system derived from LuaPlusCD: stable and tested design for many shipped PC and console games
- DXSquirrel MACRO type registration and utility classes and functions supported
- Relatively simple template usage: should work with any modern C/C++ compiler; VS.NET 2003 solutions and projects included
- Automatic type checking
- Automatic argument marshaling between script and C/C++
- boost::python/luabind/squadd style class registration: simple, concise syntax
- Function arguments
- Fixed
- Variable
- Class constructor arguments
- Fixed
- Variable
- Function return values
- Fixed
- Variable
- Multiple values of arbitratry type returned on stack
- Static support
- Class static variables and functions
- Any global variable or function can be registered in a class namespace
- Variables
- int, float, bool, string
- Fast+simple fixed length strings
- Can be registered as read-only in script
- New types can be created as classes and passed by value or address
- Easy to pass class instances between script and C++
- Constants
- int, float, bool, constant string types supported
- enums are registered as int
- All constants are read-only
- Class binding
- No proxy classes required
- Proxy/wrapper classes can be used if desired
- Automatic constructor/destructor creation
- Custom constructor/destructor support
- Static/global custom constructor/destructor can be used to prevent modification of original class
- Class inheritance
- Squirrel-style class inheritance supported
- C++ classes can inherit from Squirrel classes
- Squirrel classes can inherit from C++ classes
- Tables
- Simplified access and manipulation of Squirrel Tables
- Arrays
- Simplified access and manipulation of Squirrel Arrays
- Namespaces
- Can be created with tables, classes, or instances
Experimental
There is an experimental version of SqPlus available at http://www.tactile3d.com/bucket/squirrel/squirrel.php that implements Squirrel virtual machines as proper objects. If you want to have more than one VM running, you simply construct more than one VM object. This modification is currently experimental. Comments in the forum are appreciated.
ExperimentalCode
SqPlusFeaturesToAdd
BugSubmissions
Script binding before SqPlus:
After SqPlus:
