/blitzmax-commandstack

Command stack module for BlitzMax

Primary LanguageBlitzMaxArtistic License 2.0Artistic-2.0

About

This module provides a command stack implementation that allows you to easily add undo/redo functionality to your applications.

Dependencies

This module requires the muttley.stack module.

Also, the Unit Tests for this module rely on Bruce Henderson's bah.maxunit module available from his maxmods/bah.mod GitHub repository.

Installation

To install this module, copy the commandstack.mod directory into a folder called muttley.mod in your BlitzMax\mod directory.

For example, on Windows:

xcopy commandstack.mod C:\BlitzMax\mod\muttley.mod\. /E /I

On Linux:

mkdir /opt/BlitzMax/mod/muttley.mod
cp -r commandstack.mod /opt/BlitzMax/mod/muttley.mod/.

Then build the module as follows (assuming bmk is in your path):

bmk makemods -a muttley.commandstack

Unit Tests

Unit Tests for the module are included in the commandstack.mod\UnitTests folder, and these can be run as follows:

bmk makeapp -a -r -t console -x commandstack.mod\UnitTests\Main.bmx

Example

The commandstack.mod\Example directory contains a small graphical application that shows how this module can be used. This can be compiled and run as follows:

bmk makeapp -a -r -t gui -x commandstack.mod\Example\Main.bmx

Sublime Project

For Sublime Text users there is a project file which can be used if you wish modify this module in any way. The project file includes build systems for building the module, and building and running both the Unit Tests and Example application. These build systems rely on the Gradle build automation system.

License

Copyright (c) 2009-2017 Paul Maskelyne (muttley@muttleyville.org).

All rights reserved. Use of this code is allowed under the Artistic License 2.0 terms, as specified in the LICENSE file distributed with this code, or available from http://www.opensource.org/licenses/artistic-license-2.0.php