Gladiator 0.7.3 - Ugliest Text Editor Ever!
Gladiator (short for Glimmer Editor) is a Glimmer DSL for SWT sample beta project under on-going development that demonstrates how to build a text editor in Ruby using Glimmer DSL for SWT (JRuby Desktop Development GUI Library). It is not intended to be a full-fledged editor by any means, yet mostly a fun educational exercise in using Glimmer. Gladiator is also a personal tool for shaping an editor exactly the way I like, with all the keyboard shortcuts I prefer. I leave building truly professional text editors to software tooling experts who would hopefully use Glimmer one day. Otherwise, I have been happily using Gladiator to develop all my open-source projects since May of 2020.
Gladiator currently supports the following text editing features (including keyboard shortcuts with Mac CMD=CTRL on Windows/Linux)
- Text Editor with Colored Ruby Syntax Highlighting
- Show Line Numbers
- Multi-tab support (CMD+SHIFT+[ & CMD+SHIFT+] for tab navigation. CMD+1-9 to jump to a specific tab)
- Drag and drop split pane (drag a file from File Tree or File Lookup List, and it splits the pane)
- Duplicate Line(s)/selection (CMD+D)
- Kill Line(s)/selection (CMD+K)
- Move line/selection up (CMD+UP)
- Move line/selection down (CMD+DOWN)
- Comment/Uncomment line/selection (CMD+/)
- Indent/Unindent line/selection (CMD+] & CMD+[)
- Insert/Prefix New Line (CMD+ENTER & CMD+SHIFT+ENTER)
File Explorer Tree
- Collapsable file explorer tree listing files and directories for open project
- Context menu to open file, rename, delete, add new file, add new directory, and refresh tree
- Jump to open file in tree (CMD+T)
File Lookup List Filter
- Collapsable file lookup list filter (CMD+R)
- Semi-fuzzy filtering by ignoring slashes, underscores, and dots to ease lookup
- Show current text editor file name
- Show file navigation stats (Caret Position / Line Position / Selection Count / Top Pixel)
- Jump to Line (CMD+L)
- Find & Replace (CMD+F)
- File Menu:
- Open Project (CMD+O)
- Quit Project (CMD+ALT+Q)
- New Scratchpad for running arbitrary Ruby/Glimmer code without saving to disk (CMD+SHIFT+S)
- View Menu
- Split Pane
- Orientation change to Horizontal/Vertical (CMD+SHIFT+O)
- Maximize Pane: maximizes current pane in split pane to take entire area (CMD+SHIFT+M)
- Reset Panes: resets pane sizes if split width/height was adjusted (CMD+SHIFT+P)
- Unsplit: closes the second pane (CMD+SHIFT+U)
- Maximize Editor: maximizes editor area to hide file lookup list and file explorer tree (CMD+CTRL+M)
- Reset All: resizes sizes of all areas in the editor (CMD+CTRL+R)
- Split Pane
- Run Menu to run Ruby code (CMD+SHIFT+R)
Watch External Changes
- Watch open file for external changes to automatically refresh in editor
- Watch project subdirectories for changes to automatically refresh in file explorer/file lookup
Automatic Data Management
- Autosave on focus out/quit/open new file
- Remember opened tabs, caret position, top pixel, window size, and window location
- Default "ignore paths" to avoid bogging down editor with irrelevant directory files
- Mac: Gladiator works best on the Mac. This is the platform it is most used on and receives the most maintenance for.
- Windows: Gladiator works OK on Windows, but has some annoying bugs. Contributers could help fix.
- Linux: Gladiator works with handicaps on Linux (performing some text editing operations causes scroll jitter). Contributers could help fix.
- JDK: Same version required by Glimmer
- JRuby: Same version required by Glimmer
- Glimmer DSL for SWT (JRuby Desktop Development GUI Framework): '>= 188.8.131.52', '< 184.108.40.206' (dependency included in Ruby gem).
You may download a packaged version of the Gladiator app on the Mac.
Otherwise, if you prefer a command line version, then follow the Setup Instructions below.
Note: if you encounter any issues, check if they are documented in TODO.md, issues, or pull requests as they might be on my radar to fix. Otherwise, please report as an issue or better yet fix and submit a pull request.
Install Gladiator gem by running (
jruby -S gem, or
gem directly if you have RVM):
jgem install glimmer-cs-gladiator
Or add to a JRuby project Bundler
Gemfile under the
group :development do gem 'glimmer-cs-gladiator' end
jruby -S bundle or
bundle directly if you have RVM):
jruby -S bundle
Afterwards, to ensure system wide availablility of the
gladiator command, run this command in an environment that has JRuby:
Finally, start a new terminal session or source .gladiator_source:
You should be able to run
gladiator from anywhere now, even cross-rubies in RVM.
You may run the
gladiator command to bring up the text editor in the project directory you would like to edit:
On Linux, you may need to run with extra memory via this command instead:
On Windows, you may need to run with extra memory via this command instead:
If you are in a different directory from the project you would like to edit, then pass its path as an argument:
Note: If you cloned this project and bundle installed, you may invoke via
Glimmer Custom Shell Reuse
To reuse Gladiator as a Glimmer Custom Shell inside another Glimmer application, add the
following to the application's
gem 'glimmer-cs-gladiator', '>= 0.7.3'
jruby -S bundle
Env Var Options
Gladiator opens with the current directory as the root by default.
If you would like to open another directory, set
LOCAL_DIR environment variable.
Opens Gladiator with "/Users/User/code" as the root directory.
Gladiator automatically saves configuration data in a
.gladiator file at the directory it is run from. It may be edited to add extra ignore paths.
It currently remembers:
- Last opened files (in both split panes if split)
- Window size and position
- Ignore Paths (default: '.gladiator', '.git', 'coverage', 'packages', 'node_modules', 'tmp', 'vendor')
Gladiator repetitively displays a signaling error that is harmless in practice:
The signal HUP is in use by the JVM and will not work correctly on this platform The signal INT is in use by the JVM and will not work correctly on this platform The signal TERM is in use by the JVM and will not work correctly on this platform
Contributing to glimmer-cs-gladiator
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
- Fork the project.
- Start a feature/bugfix branch.
- Commit and push until you are happy with your contribution.
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Copyright (c) 2020-2021 Andy Maleh. See LICENSE.txt for further details.
Built with Glimmer DSL for SWT (JRuby Desktop Development GUI Framework)