quinn-os/my-basic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

-removed some twaddle words in readme.

Browse Source
This commit is contained in:
Wang Renxin 2018-05-25 13:58:41 +08:00
parent 74971e5df7
commit bb7b573a20
1 changed files with 37 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -5,68 +5,60 @@
|_|_|_| |_| |_____|__|__|_____|_____|_____| |_|_|_| |_| |_____|__|__|_____|_____|_____|
~~~~~~~~~~ ~~~~~~~~~~
**Copyright (C) 2011 - 2018 Wang Renxin. All rights reserved.** **Copyright (C) 2011 - 2018 Wang Renxin**
[![Build status](https://travis-ci.org/paladin-t/my_basic.svg?branch=master)](https://travis-ci.org/paladin-t/my_basic) [![Build status](https://travis-ci.org/paladin-t/my_basic.svg?branch=master)](https://travis-ci.org/paladin-t/my_basic)
[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT) [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
[开发日志](http://blog.sina.com.cn/s/articlelist_1584387113_12_1.html)
## Contents ## Contents
* [Introduction](#introduction) * [Introduction](#introduction)
* [Main features](#main-features) * [Main features](#main-features)
* [BASIC at a glance](#basic-at-a-glance) * [BASIC at a glance](#basic-at-a-glance)
* [Awesome](#awesome)
* [Installation](#installation) * [Installation](#installation)
* [Interpreter workflow diagram](#interpreter-workflow-diagram) * [Interpreter workflow diagram](#interpreter-workflow-diagram)
* [Wiki](#wiki) * [Wiki](#wiki)
* [References](#references) * [Donate](#donate)
* [Donate/List of donors](#donatelist-of-donors)
## Introduction ## Introduction
MY-BASIC is a lightweight BASIC interpreter written in standard C, with only dual files. It is a dynamic typed programming language, and aimed to be embeddable, extendable and portable. MY-BASIC supports structured syntax; implements a style of OOP called [prototype-based programming](https://en.wikipedia.org/wiki/Prototype-based_programming) paradigm; and it offers a functional programming ability with [lambda abstraction](https://en.wikipedia.org/wiki/Anonymous_function). The kernel is written with a C source file and an associated header file. It's easy to either embed it or use it as a standalone interpreter. You can get how to use it and how to add new scripting interfaces in five minutes. It's possible to combine MY-BASIC with existing projects in C, C++, Java, Objective-C, Swift, C# and many other languages. Script driven can make your projects configurable, scalable and elegant. It's also possible to learn how to build an interpreter from scratch with MY-BASIC, or build your own dialect based on it. MY-BASIC is a lightweight BASIC interpreter written in standard C in dual files. It's aimed to be embeddable, extendable and portable. It is a dynamic typed programming language, and supports structured syntax, implements a style of [prototype-based programming](https://en.wikipedia.org/wiki/Prototype-based_programming) (OOP), and it also implements a functional paradigm by [lambda abstraction](https://en.wikipedia.org/wiki/Anonymous_function). The core is written in a C source file and an associated header file. It's easy to either use it as a standalone interpreter or embed it with existing projects in C, C++, Java, Objective-C, Swift, C#, etc. and totally customizable by adding your own scripting interfaces.
The prefix "MY-" in the name means either literally "My" or "Make Your".
## Main features ## Main features
MY-BASIC is a dynamic typed programming language with BASIC syntax and has a very dynamic nature; it makes it flexible and easy to use. MY-BASIC offers a wide range of features including: MY-BASIC offers a wide range of features including:
* It is totally **free** to use MY-BASIC for commercial or noncommercial purposes under the MIT license * Written in **pure C**, source code is portable to a dozen of platforms
* Written in clean **standard C**, source code is portable to a dozen of platforms
* **Lightweight** (within less than 128KB footprint), fast, and configurable * **Lightweight** (within less than 128KB footprint), fast, and configurable
* With both retro and modern BASIC syntax * With both retro and modern BASIC syntax
* Case-insensitive tokenization, and many other indelible BASIC feelings * Case-insensitive tokenization, and many other indelible BASIC flavour
* [Unicode support](https://github.com/paladin-t/my_basic/wiki/Using-Unicode) * [Unicode support](https://github.com/paladin-t/my_basic/wiki/Using-Unicode)
* **[Prototype-based programming](https://en.wikipedia.org/wiki/Prototype-based_programming)** (OOP) paradigm, with reflection support * **[Prototype-based programming](https://en.wikipedia.org/wiki/Prototype-based_programming)**, with reflection support
* **[Lambda abstraction](https://en.wikipedia.org/wiki/Anonymous_function)** enhanced functional programming * **[Lambda abstraction](https://en.wikipedia.org/wiki/Anonymous_function)** enhanced functional programming
* Customizable referenced usertype * Customizable referenced/non-referenced usertype
* Collection construction and manipulation functions for **`LIST`** and **`DICT`** * Collection construction and manipulation functions for **`LIST`** and **`DICT`**
* Automatic releasing of referenced objects (prototype, lambda, referenced usertype, list, dictionary, etc.) benefited from **Reference Counting** and **Garbage Collection** * Automatic releasing for referenced values (prototype, lambda, referenced usertype, list, dictionary, etc.) benefited from reference counting and garbage collection
* Dynamic typed integer, real, string, boolean, usertype, and other advanced types with array support * Common numeric and string functions
* Standard numeric functions, and standard string functions
* Importing multiple source files with the `IMPORT` statement
* Structured **sub routine** definition with the **`DEF/ENDDEF`** statements * Structured **sub routine** definition with the **`DEF/ENDDEF`** statements
* Structured `IF/THEN/ELSEIF/ELSE/ENDIF` * Structured `IF/THEN/ELSEIF/ELSE/ENDIF`
* Structured `FOR/TO/STEP/NEXT`, `FOR/IN/NEXT`, `WHILE/WEND`, `DO/UNTIL` * Structured `FOR/TO/STEP/NEXT`, `FOR/IN/NEXT`, `WHILE/WEND`, `DO/UNTIL`
* Reserved retro `GOTO`, `GOSUB/RETURN` * Reserved retro `GOTO`, `GOSUB/RETURN`
* Importing multiple source files with the `IMPORT` statement
* Debug API * Debug API
* Customizable memory pool * Customizable memory pool
* High expansibility, easy to use API, easy to extend new BASIC functions * Easy API, for extending new BASIC functions
* Powerful interactive ability to manipulate BASIC facilities at native side; or to use native functionalities in BASIC * Easy interacting BASIC facilities at native side, and vice versa
* More features under development * More features under development
I write some of my plans in the [language design](https://github.com/paladin-t/my_basic/wiki/Language-design) page. [![BASIC8](https://github.com/paladin-t/my_basic/wiki/img/basic8_banner.png)](https://paladin-t.github.io/b8/)
[![Homepage](https://github.com/paladin-t/my_basic/wiki/img/basic8_banner.png)](https://paladin-t.github.io/b8/) Get [BASIC8](https://paladin-t.github.io/b8/) - the **fantasy computer** - on [Steam](http://store.steampowered.com/app/767240/) for game and other program development powered by MY-BASIC.
Get [BASIC8](https://paladin-t.github.io/b8/) on [Steam](http://store.steampowered.com/app/767240/); a **fantasy computer** for game and other program development powered by MY-BASIC! See more awesome [user creations](https://my-basic.github.io/awesome/).
## BASIC at a glance ## BASIC at a glance
Come along with a "Hello World" convention in MY-BASIC: A "Hello World" convention in MY-BASIC:
~~~~~~~~~~bas ~~~~~~~~~~bas
input "What is your name: ", n$ input "What is your name: ", n$
@ -78,54 +70,44 @@ enddef
print greeting("Hello", "world"); print greeting("Hello", "world");
~~~~~~~~~~ ~~~~~~~~~~
Read the [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Quick%20Reference.pdf) (especially the "**Programming with BASIC**" section) to get more details about how to program in MY-BASIC. Read the [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Quick%20Reference.pdf) to get details about how to program in MY-BASIC.
## Awesome
See the list for some user creations.
* [Awesome projects powered by MY-BASIC](https://my-basic.github.io/awesome/)
Don't forget to share with us about your creativity!
## Installation ## Installation
### Using standalone interpreter binary ### Using standalone interpreter binary
This repository contains precompiled binaries for [Windows](output/my_basic.exe) and [macOS](output/my_basic_mac), the easiest way is to download one of them to get a playground. Or you could make a build as follow: This repository contains precompiled binaries for [Windows](output/my_basic.exe) and [macOS](output/my_basic_mac), the easiest way is to download one of them to get a playground. Or you can make a build as:
* Open the Visual Studio solution `my_basic.sln` on Windows to build an executable * Use the Visual Studio workspace `my_basic.sln` on Windows to build an executable
* Open the Xcode solution `my_basic_mac.xcodeproj` on macOS to build a macOS executable * Use the Xcode workspace `my_basic_mac.xcodeproj` on macOS to build an executable
* If you are using other *nix OS, use the `makefile` with a "make" toolchain to build an interpreter binary according to your specific platform * Use the `makefile` on *nix OS to build an executable
To compile an interpreter binary for your own platform manually, please follow these steps: To compile an interpreter binary for any platform manually, follow these steps:
1. Retrieve everything under the [`core`](core) and [`shell`](shell) folders for a minimum build 1. Retrieve everything under the [`core`](core) and [`shell`](shell) folders for a minimum build
2. Setup your compiling toolchain configuration 2. Setup your toolchain for compiling and linking
3. Compile [`core/my_basic.c`](core/my_basic.c) and [`shell/main.c`](shell/main.c), they both require [`core/my_basic.h`](core/my_basic.h); then link up an executable 3. Compile [`core/my_basic.c`](core/my_basic.c) and [`shell/main.c`](shell/main.c), with both including [`core/my_basic.h`](core/my_basic.h); then link up an executable
The standalone interpreter supports three running modes: The standalone interpreter supports three running modes:
* Execute the binary without arguments to enter the interactive mode * Execute the binary without arguments to use the interactive mode
* Type "HELP" and hint Enter to get detail usages of the interpreter * Type "HELP" and hint Enter to get detail usages of it
* Pass a file path to the binary to load and run that BASIC file directly * Pass a file to the binary to load and run that BASIC source
* Pass an argument `-e` followed by an expression to evaluate and print instantly, as a simple calculator, eg. `-e "2 * (3 + 4)"` * Pass an argument `-e` followed with an expression to evaluate and print instantly, as a simple calculator, eg. `-e "2 * (3 + 4)"`
### Combining with existing projects ### Combining with existing projects
MY-BASIC is cleanly written in a single C source file and an associated header file. Just copy [`core/my_basic.c`](core/my_basic.c) and [`core/my_basic.h`](core/my_basic.h) to the folder of your project and add them to a build configuration. Just copy [`core/my_basic.c`](core/my_basic.c) and [`core/my_basic.h`](core/my_basic.h) to your project and add them to the build configuration. You can [link with MY-BASIC as a lib](https://github.com/paladin-t/my_basic/wiki/Linking-with-MY_BASIC) as well.
You can definitely [link with MY-BASIC as a lib](https://github.com/paladin-t/my_basic/wiki/Linking-with-MY_BASIC) as well. For details about using MY-BASIC after integration, see [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Quick%20Reference.pdf) and read the [Wiki](#wiki) pages.
For more details about using MY-BASIC when it has been integrated with a project, see [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Quick%20Reference.pdf) or read the [Wiki](#wiki) pages.
## [Interpreter workflow diagram](https://github.com/paladin-t/my_basic/wiki/Interpreter-workflow-diagram) ## [Interpreter workflow diagram](https://github.com/paladin-t/my_basic/wiki/Interpreter-workflow-diagram)
It's necessary to know some principle of MY-BASIC before doing deep customization; nothing's better than a workflow diagram to get a first image. It's recommended to know the basic principle of MY-BASIC before customizing; nothing's better than a workflow diagram to get a first image.
![](https://github.com/paladin-t/my_basic/wiki/img/workflow.png) ![](https://github.com/paladin-t/my_basic/wiki/img/workflow.png)
A simplest setup as follow: A simple setup as follow:
~~~~~~~~~~c ~~~~~~~~~~c
int main() { int main() {
@ -144,7 +126,7 @@ int main() {
## [Wiki](https://github.com/paladin-t/my_basic/wiki) ## [Wiki](https://github.com/paladin-t/my_basic/wiki)
The [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Quick%20Reference.pdf) includes most of the fundamental topics, however, it hasn't covered everything, such as the design principle, machinism behind MY-BASIC, efficient practice, etc; some of these topics are mentioned in the [Wiki](https://github.com/paladin-t/my_basic/wiki): The manual explains most of the fundamental topics, however it doesn't cover everything; read the [Wiki](https://github.com/paladin-t/my_basic/wiki) as supplemental instructions, such as machinism behind MY-BASIC, efficient practice, etc:
* Principles * Principles
* [Language design](https://github.com/paladin-t/my_basic/wiki/Language-design) * [Language design](https://github.com/paladin-t/my_basic/wiki/Language-design)
@ -195,20 +177,14 @@ The [MY-BASIC Quick Reference](https://paladin-t.github.io/my_basic/MY-BASIC%20Q
* [FAQ](https://github.com/paladin-t/my_basic/wiki/FAQ) * [FAQ](https://github.com/paladin-t/my_basic/wiki/FAQ)
* [Is it possible to introduce another feature](https://github.com/paladin-t/my_basic/wiki/Is-it-possible-to-introduce-another-feature) * [Is it possible to introduce another feature](https://github.com/paladin-t/my_basic/wiki/Is-it-possible-to-introduce-another-feature)
## References ## Donate
* [BASIC - Wikipedia](http://en.wikipedia.org/wiki/BASIC) [List of donors](http://paladin-t.github.io/my_basic/donate.html).
* [Prototype-based programming - Wikipedia](https://en.wikipedia.org/wiki/Prototype-based_programming)
* [Lambda abstraction - Wikipedia](https://en.wikipedia.org/wiki/Anonymous_function)
## Donate/List of donors Consider supporting MY-BASIC development with a donation if you like this project.
I need your supports to keep this project alive. Consider supporting MY-BASIC development with a donation.
One-off [donation](http://paladin-t.github.io/my_basic/donate.html) via PayPal. One-off [donation](http://paladin-t.github.io/my_basic/donate.html) via PayPal.
<a href="http://paladin-t.github.io/my_basic/donate.html"> <a href="http://paladin-t.github.io/my_basic/donate.html">
<img src="https://github.com/paladin-t/my_basic/wiki/img/button_donate.png" width="92"> <img src="https://github.com/paladin-t/my_basic/wiki/img/button_donate.png" width="92">
</a> </a>
[List of donors](http://paladin-t.github.io/my_basic/donate.html).