octaspire / acme-setup

Scripts to be used with the Acme editor.

Octaspire's Acme Setup

Scripts to be used with the Acme editor; mainly when using Plan 9 from User Space. Contains:

• octaspire_acme: Run this command instead of acme to make sure that plumber and fontsrv are running before Acme is started. Will start Acme with some specific settings and font. Will also load acme.dump if available (this restores the workspace and gives also functionality similar to 'Goto Last Change' in GNU/Emacs).

• octaspire_project_root: Run command '. octaspire_project_root' (please note the dot in the beginning) in the root directory of the project you want to work with. This command can be used to set or change environment variable OCTASPIRE_PROJECT_ROOT that should point to the root directory of the project.

• octaspire_tags_up: Takes care of creating and updating TAGS (universal-ctags) files so that the user never has to do it. Detects changes currently using modification time of files; more robust solution would be checksumming the files.

• octaspire_tags_find: Locates definition of the highlighted name and reports it as filename:linenum pair, so that the file and correct line can be easily jumped to using the third mouse button.

• octaspire_tags_complete: Lists completion suggestions for the highlighted (partial) name. Matches are looked for and sorted fuzzily using Levenshtein distances. Philosophical Note: I think that code completion might encourage use of overlong names and thus it might be something that should not be done; instead the situation might be fixed by just using shorter names.

• octaspire_tags_signature: Reports function signature for the C function, that has its name highlighted.

Requirements

UNIX like operating system, Plan 9 from User Space, universal ctags and Python 3 with fuzzywuzzy package, that can be installed using:

pip install --user fuzzywuzzy[speedup]

To lint the scripts, shellcheck and pylint are also needed. To proofread the README.md as HTML, markdown_py is required.

Acme is started with font Inconsolata-Regular, and thus that font should be available on the system (otherwise another font should be selected in the octaspire_acme-script).

Usage

Copy executables into a directory that is on your path. If $HOME/bin is on your path, you can copy files like this:

make install

First of all, the environment variable OCTASPIRE_PROJECT_ROOT must point to the root directory of the project you want to work with. It can be exported like any other environment variable in .profile or some other file, but it can be also set and changed using command:

cd some/project/
. octaspire_project_root

Then Acme can be started using:

octaspire_acme

Other commands can be run by writing and selecting them from the tag:

> octaspire_tags_find  > octaspire_tags_complete  > octaspire_tags_signature

License

Apache License, Version 2.0