https://github.com/dykstrom/basic-mode

Emacs major mode for editing BASIC code
https://github.com/dykstrom/basic-mode

basic emacs-lisp emacs-mode programming

Last synced: 9 months ago
JSON representation

Emacs major mode for editing BASIC code

• Host: GitHub
• URL: https://github.com/dykstrom/basic-mode
• Owner: dykstrom
• License: gpl-3.0
• Created: 2017-09-28T18:09:39.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-27T09:37:13.000Z (about 2 years ago)
• Last Synced: 2023-12-16T05:38:50.472Z (about 2 years ago)
• Topics: basic, emacs-lisp, emacs-mode, programming
• Language: Emacs Lisp
• Size: 87.9 KB
• Stars: 6
• Watchers: 1
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# basic-mode



[![MELPA](https://melpa.org/packages/basic-mode-badge.svg)](https://melpa.org/#/basic-mode)

[![MELPA Stable](https://stable.melpa.org/packages/basic-mode-badge.svg)](https://stable.melpa.org/#/basic-mode)

[![Open Issues](https://img.shields.io/github/issues/dykstrom/basic-mode)](https://github.com/dykstrom/basic-mode/issues)

![License](https://img.shields.io/github/license/dykstrom/basic-mode)



Package basic-mode provides a major mode for editing BASIC code in GNU Emacs.

Features include syntax highlighting and indentation, as well as support for

auto-numbering and renumbering of code lines.

* [basic-mode](#basic-mode)

  * [Installation](#installation)

  * [BASIC Dialects](#basic-dialects)

    * [Setting Sub Mode](#setting-sub-mode)

      * [Manually](#manually)

      * [File Variable](#file-variable)

      * [Init File](#init-file)

    * [Available Sub Modes](#available-sub-modes)

  * [Usage](#usage)

    * [Formatting Code](#formatting-code)

    * [Line Numbers](#line-numbers)

    * [Navigation](#navigation)

  * [Configuration](#configuration)

## Installation

The recommended way to install basic-mode is from [MELPA](https://melpa.org).

To install manually, place basic-mode.el in your load-path, and add the

following lines of code to your init file:

```elisp

(autoload 'basic-generic-mode "basic-mode" "Major mode for editing BASIC code." t)

(add-to-list 'auto-mode-alist '("\\.bas\\'" . basic-generic-mode))

```

## BASIC Dialects

Package basic-mode supports some of the many

[BASIC dialects](https://en.wikipedia.org/wiki/List_of_BASIC_dialects) using

sub modes derived from the main basic-mode. Section

[Available Sub Modes](#available-sub-modes) lists the currently existing

sub modes. In addition, basic-mode also provides a generic sub mode that will

be used if no sub mode is specified.

The sub mode configures, among other things, syntax highlighting and indentation,

which differs between dialects.

### Setting Sub Mode

By default, basic-mode will open BASIC files in sub mode _basic-generic-mode_.

There are several ways to change that behaviour if you prefer a specific sub mode.

#### Manually

After opening a file in Emacs, you can type _M-x MODE-NAME_ to set the sub mode,

e.g. _M-x basic-zx81-mode_ to set the Sinclair ZX81 sub mode.

#### File Variable

You can specify the sub mode as a file variable in the first line of the file, see

[Specifying File Variables](https://www.gnu.org/software/emacs/manual/html_node/emacs/Specifying-File-Variables.html)

in the GNU Emacs Manual. For example, a file beginning with this line, will open in

the TRS-80 Model 100 sub mode.

```BASIC

10 REM -*- basic-m100 -*-

```

#### Init File

If you are always working with a specific BASIC dialect, you can configure Emacs to

always open BASIC files in that sub mode. For example, adding the below line to your

init file will open all BASIC files in the Sinclair ZX81 sub mode.

```elisp

(add-to-list 'auto-mode-alist '("\\.bas\\'" . basic-zx81-mode))

```

### Available Sub Modes

This table lists the existing sub modes. If you feel that a sub mode

is missing, the best way to bring it into existence is to create it

yourself, and submit a pull request to include it in basic-mode.

  

    BASIC Dialect

    Sub Mode

  

  

    Dartmouth

    basic-dartmouth-mode

  

  

    Microsoft QuickBasic 4.5

    basic-qb45-mode

  

  

    Sinclair ZX81

    basic-zx81-mode

  

  

    Sinclair ZX Spectrum

    basic-spectrum-mode

  

  

    TRS-80 Model I and III

    basic-trs80-mode

  

  

    TRS-80 Model 100

    basic-m100-mode

  

## Usage

### Formatting Code

TAB indents the current line of BASIC code, including line numbers if available.

If the region is active, TAB indents all lines in the region.

_C-c C-f_ formats the entire buffer; indents all lines, and removes any extra

whitespace. If the region is active, _C-c C-f_ formats all lines in the region.

### Line Numbers

For classic BASIC, basic-mode provides several functions to manage line numbers.

Customize variables basic-auto-number and basic-line-number-cols to your liking

to turn on line numbers.

With line numbers turned on, RET will start new lines with a fresh line number.

The line number increment is defined by variable basic-auto-number. _C-c C-r_

will renumber all lines in the entire buffer, including any jumps in the code.

The line number increment used when renumbering is defined by variable

basic-renumber-increment. If the region is active, _C-c C-r_ renumbers all lines

in the region instead.

With line numbers turned on, _C-c C-f_ will also respect line numbers, and the

value configured in basic-line-number-cols while formatting.

### Navigation

Package basic-mode also provides additional functionality to navigate in the

source code. _M-._ will find and move to the definition of the identifier at

point, and _M-,_ will move back again. For more information, see function

xref-find-definitions.

## Configuration

The following table lists the customizable variables that affect basic-mode

in some way:

  

    Name

    Description

    Default Value

  

  

    basic-auto-number

    If non-nil, auto-number new lines by incrementing the line number with this value.

    nil

  

  

    basic-delete-trailing-whitespace

    If non-nil, basic-format-code deletes trailing whitespace while formatting.

    t

  

  

    basic-indent-offset

    The number of columns to indent code blocks, for example inside an IF statement.

    4

  

  

    basic-line-number-cols

    The number of columns allocated to line numbers at the beginning of the line.

    0

  

  

    basic-mode-hook

    Hook run when entering BASIC mode.

    nil

  

  

    basic-renumber-increment

    Default line number increment when renumbering lines.

    10

  

  

    basic-renumber-unnumbered-lines

    If non-nil, lines without line numbers are also renumbered when renumbering lines.

    t

  

  

    basic-syntax-highlighting-require-separator

    

    If non-nil, only keywords separated by separators will be highlighted.

    If nil, keywords separated by numbers will also be highlighted.

    

    t

  

  

    delete-trailing-lines (simple.el)

    If non-nil, basic-format-code deletes trailing empty lines while formatting.

    t

  

Additionally, each sub mode will also define a hook variable, named like

the sub mode, e.g. _basic-generic-mode-hook_ for the generic sub mode.