https://github.com/hezkore/vim-blitzmax
Vim plugin that provides syntax highlighting, indentation, error matching, Ctags, tagbar scopes and compiler options for BlitzMax
https://github.com/hezkore/vim-blitzmax
blitzmax vim vim-plugin
Last synced: 10 months ago
JSON representation
Vim plugin that provides syntax highlighting, indentation, error matching, Ctags, tagbar scopes and compiler options for BlitzMax
- Host: GitHub
- URL: https://github.com/hezkore/vim-blitzmax
- Owner: Hezkore
- Created: 2021-01-20T22:21:23.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-09T12:05:48.000Z (about 4 years ago)
- Last Synced: 2025-09-01T09:40:02.969Z (10 months ago)
- Topics: blitzmax, vim, vim-plugin
- Language: Vim script
- Homepage:
- Size: 653 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BlitzMax for Vim
[Vim](https://www.vim.org) plugin that provides [syntax highlighting](https://vimhelp.org/syntax.txt.html#%3Asyn-qstart), indentation, [error matching](https://vimhelp.org/quickfix.txt.html#quickfix-window), [Ctags](https://vimhelp.org/tagsrch.txt.html#tag-commands), [tagbar scopes](https://github.com/preservim/tagbar) and [compiler options](https://vimhelp.org/quickfix.txt.html#%3Amake_makeprg) for [BlitzMax](https://blitzmax.org).
## Installation
| Method | Instructions
| ------------- | ------
| Vim 8 package | `git clone https://github.com/Hezkore/vim-blitzmax ~/.vim/pack/hezkore/start/bmx`
| [vim-plug](https://github.com/junegunn/vim-plug) | Plug 'Hezkore/vim-blitzmax', { 'for': 'blitzmax' }
| Manual | Copy files to `~/.vim/` on Unix or `%USERPROFILE%\vimfiles\` on Windows
Open or create the `vimrc` file in `~/.vim/` on Unix or `%USERPROFILE%\vimfiles\` on Windows and add\
`let g:blitzmax_path=`
## Learning Vim
Install [Vim](https://www.vim.org/download.php) and run the [vimtutor](https://vimhelp.org/usr_01.txt.html#vimtutor).\
Alternatively you can read the online documentations at [vimhelp.org](https://vimhelp.org/).
## Compiling
Opening a `.bmx` file will set the Vim compiler to `bmk`\
You can manually set it if needed with the command `:compiler bmk`\
Use the command `:make [blitzmax bmk options]` to build your executable.\
For example `:make makeapp -x %` to compile the current file _(`%`)_ and execute it _(`-x`)_.
Or something more advanced `:make makeapp -d -t console -w -a -x -o %<.debug %`\
This will create a debug console application.
Add `nnoremap :make makeapp -d -t console -w -a -x -o %<.debug %` to your `vimrc` for a quick way of compiling a debug console application by pressing F5.
You can read more about the BlitzMax bmk compile operations and options [here](https://blitzmax.org/docs/en/tools/bmk/), and about Vim's `make` command [here](https://vimhelp.org/quickfix.txt.html#%3Amake_makeprg).
## Debugging
Use the command `:clist` `:cl` or `:copen` `:cw` to view any compiling warnings or errors.\
`:cnext` `:cn` and `:cprev` `:cp` will move to the next and previous problem respectively.\
More about Vim's quickfix view can be found [here](https://vimhelp.org/quickfix.txt.html#quickfix-window).
The internal BlitzMax debugger is used for live-debugging.
| Key | Action
| --------- | ------
| T | Stack trace
| R | Run from here
| S | Step through source code
| E | Step into function call
| L | Leave function or local block
| Q | Quit
| H | Help text
| Dxxxxxxxx | Dump object at hex address xxxxxxxx
## Ctags and tagbar
The [tagbar plugin](https://github.com/preservim/tagbar) is supported right out of the box.
You can generate your own ctags with the command `:MakeBmxCtags`\
This will generate ctags for the file in the current buffer, files in the same folder, as well as sub-folders.\
`:MakeBmxCtags` also accepts a path, for example `:MakeBmxCtags ~/Code/MyBmxProject`
Use `:MakeBmxModuleCtags` to generate ctags for all your BlitzMax modules.\
Remember to add `exe 'set tags+='.g:blitzmax_path.'/mod/tags'` to your `vimrc` file in order to match tags from your modules.
You can read more about Vim tags [here](https://vimhelp.org/tagsrch.txt.html).
## FAQ
* **Q: I'm getting `Error creating Ctags!` when creating ctags.**
* A: The `MakeBmxCtags` commands relies on the external program 'ctags', which you can find [here](https://github.com/universal-ctags/ctags#universal-ctags).
* **Q: The compiler, tagbar and ctags don't match/update with my code.**
* A: The document is read from disk, you'll have to save _(`:w`)_ first!
* **Q: Jumping to a tag jumps to the wrong location.**
* A: You can press g ] to view multiple tag matches.\
You can read more about Vim tags [here](https://vimhelp.org/tagsrch.txt.html).
* **Q: Jumping to a tag makes me lose my current document.**
* A: You can use Ctr + t to jump a step back in the tag stack.\
Alternatively, use Ctr + W ] or Ctrl + W g ] to open the tag in a split view.\
You can read more about Vim tags [here](https://vimhelp.org/tagsrch.txt.html).
* **Q: Tags from my modules aren't matched.**
* A: Make sure you've added `exe 'set tags+='.g:blitzmax_path.'/mod/tags'` to your `vimrc` file, and that you've called `:MakeBmxModuleCtags` at least once.
* **Q: I'm getting `Undefined variable: g:blitzmax_path` at start.**
* A: If you've added `exe 'set tags+='.g:blitzmax_path.'/mod/tags'` to your `vimrc` file, then make sure it's entered _after/below_ the `let g:blitzmax_path=` line.
* **Q: I'm having other issues with the plugin.**
* A: Post your issue in the [GitHub issues](https://github.com/Hezkore/vim-blitzmax/issues) section.