my-basic/README.md
2015-09-08 22:09:08 +08:00

87 lines
5.0 KiB
Markdown
Executable File

![](resource/icon.ico)
Copyright (C) 2011 - 2015 [Wang Renxin](https://twitter.com/wangrenxin)
[LinkedIn](https://cn.linkedin.com/pub/wang-renxin/43/494/20)
Why are existing script interpreters so complex? Why is it so difficult to integrate with them? Why not try MY-BASIC today!
## Introduction
MY-BASIC is a tiny cross-platform easy extendable BASIC interpreter written in pure C with about 7000 lines of source code. Its grammar is similar to structured BASIC. It is aimed to be either an embeddable scripting language or a standalone interpreter. The core is pretty light; all in a C source file and an associated header file. You can combine MY-BASIC with an existing C, C++, Objective-C, etc. project easily, scripting driven can make your projects more powerful, elegant and neat.
## Main features
* It is free
* Written in clean ANSI C, source code portable
* With most common BASIC syntax
* Small (within memory usage less than 128KB) and fast
* Case-insensitive tokenization
* Integer, float point, string, boolean, user defined data types with array support, etc.
* Structured `IF-THEN-ELSEIF-ELSE-ENDIF` support
* Structured `FOR-TO-STEP-NEXT/WHILE-WEND/DO-UNTIL` support
* Structured user costomized sub routine definition by `DEF/ENDDEF` support
* `GOTO/GOSUB-RETURN` support
* Standard numeric functions
* Standard string functions
* Debug APIs
* High expansibility, easy to use APIs, easy to write customized scripting interfaces
* It's able to use it as a standalone interpreter, or integrate it with existing C, C++, Objective-C, etc. projects
* It's able to learn how to build an interpreter from scratch from MY-BASIC
* It's able to build your own dialect based on MY-BASIC
* More features/modules under developing
## [Interpreter workflow diagram](https://github.com/paladin-t/my_basic/wiki/Interpreter-workflow-diagram)
![](https://github.com/paladin-t/my_basic/blob/master/interpreter%20workflow%20diagram.png)
## Installation
### Use standalone interpreter binary
This repository contains precompiled binaries for [Windows](output/my_basic.exe) and [OS X](output/my_basic_mac), it's efficient to download it and have a first impressive playground. Or you could make a build as follow.
* Open the Visual Studio solution `my_basic.sln` on Windows, open the XCode solution `my_basic_mac.xcodeproj` on OS X, or use the `makefile` with "make" toolchain to build an interpreter binary
To compile an interpreter binary for your own platform manually, please follow the steps.
* Retrieve at least `core` and `shell` folders for minimum build
* Setup your compile toolchain configuration
* Use your compiler to compile `core/my_basic.c` and `shell/main.c`, including `core/my_basic.h` is required for both source files, then link up your own executable
### Combine with exist projects
MY-BASIC is cleanly written in a single C source file and an associated header file. Just copy `my_basic.c` and `my_basic.h` to your project folder and add them to a build configuration.
You can definitely [link with MY-BASIC as a lib](https://github.com/paladin-t/my_basic/wiki/Link-with-MY_BASIC) as well.
For more details about using MY-BASIC when it's already integrated with exist projects, please see [MY-BASIC Quick Reference](MY-BASIC%20Quick%20Reference.pdf).
## [WIKI](https://github.com/paladin-t/my_basic/wiki)
* [Passes](https://github.com/paladin-t/my_basic/wiki/Passes)
* [Interpreter workflow diagram](https://github.com/paladin-t/my_basic/wiki/Interpreter-workflow-diagram)
* [Link with MY-BASIC](https://github.com/paladin-t/my_basic/wiki/Link-with-MY_BASIC)
* [Customize a memory allocator](https://github.com/paladin-t/my_basic/wiki/Customize-a-memory-allocator)
* [Redirect PRINT and INPUT](https://github.com/paladin-t/my_basic/wiki/Redirect-PRINT-and-INPUT)
* [Redefine int_t and real_t](https://github.com/paladin-t/my_basic/wiki/Redefine-int_t-and-real_t)
* [Use usertype values](https://github.com/paladin-t/my_basic/wiki/Use-usertype-values)
* [Manipulate an array](https://github.com/paladin-t/my_basic/wiki/Manipulate-an-array)
* [Customize macros](https://github.com/paladin-t/my_basic/wiki/Customize-macros)
* [Write a debugger](https://github.com/paladin-t/my_basic/wiki/Write-a-debugger)
* [More scripting APIs](https://github.com/paladin-t/my_basic/wiki/More-scripting-APIs)
* [File module](https://github.com/paladin-t/my_basic/wiki/File-module)
* [Bit operation module](https://github.com/paladin-t/my_basic/wiki/Bit-operation-module)
* [FAQ](https://github.com/paladin-t/my_basic/wiki/FAQ)
## References
* [MY-BASIC Quick Reference](MY-BASIC%20Quick%20Reference.pdf)
* [BASIC - Wikipedia](http://en.wikipedia.org/wiki/BASIC)
-----
You can support MY-BASIC development with a donation:
<br>
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hellotony521%40gmail%2ecom&lc=US&item_name=my-basic&no_note=0&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHostedGuest)