captainflasmr / wowee

Windows Operating With Emacs Enhancements, Allows Emacs-like commands and keybinds in Windows and is based on EWOW -- Emacs Way of Operating Windows
GNU General Public License v3.0
7 stars 0 forks source link

+title: README of wowee

+author: James Dyer

+email: captainflasmr@gmail.com

+language: en

+options: ':t toc:nil author:nil email:nil num:nil title:nil

+todo: DOING TODO | DONE IGNORE

+startup: showall

+attr_org: :width 300px

+attr_html: :width 100%

[[file:img/WOWEE---Windows-Operating-With-Emacs-Enhancements_banner.jpg]]

WOWEE is a set of AutoHotKey scripts designed to bring Emacs-like commands and keybindings to the Windows operating system. Based on the concept of EWOW (Emacs Way of Operating Windows), WOWEE allows you to use Emacs-style navigation and commands throughout your Windows environment.

** v0.3.5 <2024-08-03>

feat: Add global keybinds and minor refactor

Details:

** v0.3.4 <2024-07-19>

feat: Add xref navigation functions and keybindings

** v0.3.3 <2024-07-01>

A little support for Notepad++:

** v0.3.2 <2024-07-01>

Separated individual ergonomic key-mappings as thus:

These are extra files that can be run in addition to the main wowee.ahk for some common ergonomic keyboard Emacs mappings.

** v0.3.1 <2024-06-30>

This commit has added windows, frames support

** v0.3.0 <2024-06-28>

This commit has split out ahk files into apps, core and init:

** v0.2.0 <2024-06-26>

This commit introduces several new functions to enhance the usability and functionality of the commands.ahk script. Notable additions include:

** v0.1.0 <2024-06-19>

Initial version

  1. Install AutoHotKey: Download and install AutoHotKey from AutoHotKey's official website.
  2. Run WOWEE: Double-click on the wowee.ahk script to start WOWEE. Once running, Emacs commands will be available in your Windows environment.
  3. Quit WOWEE: To quit WOWEE, right-click the AutoHotKey icon in the task tray and select "Exit."

** Development

*** =(a) Ergonomic keyboard layout options=

Additional AHK files that can be run in parallel with the main wowee.ahk file if you would prefer some extra ergonomic mappings.

For example it is common to map the Caps Lock key to the Control key to avoid the dreaded Emacs pinky, which can be performed by running up :

+begin_src

wowee--caps_to_ctrl.ahk

+end_src

I prefer to map the right hand Alt key to the Control key by running:

+begin_src

wowee--ralt_to_ctrl.ahk

+end_src

Both can also be run if desired!

*** =(a) Bindings bespoke to individual applications=

** Foibles

  1. I have yet to implement C-x C- but these functions, for example like save-buffer (C-x C-s) and save-buffers-kill-terminal (C-x C-z) are still accessible, but without the second Control, for example C-x s and C-x z
  2. Any application shortcut re-mappings are using the convention C-p C-, this is temporary as I never use C-p (print) and thought this would be a good unique leader key combination.

** Applications

The applications I am currently looking to support are the following:

** kanban

This kanban board is keeping track of those original EWOW functions.

The IGNORE column includes functions that I am definitely not going to implement.

The EXTRA section are additional commands that I am adding.

There is a prefix type indicator for each command referring to the specific type:

(C) - Core Emacs commands (VS) - Visual Studio specific (VC) - VSCode specific (N++) - NotePad++ specific (E) - Extra

and any command with an asterisk is an unconventional Emacs keybinding which will probably get fixed sometime in the future!

+begin: kanban :layout ("..." . 50) :scope nil :range ("TODO" . "IGNORE") :sort "O" :depth 3 :compressed t

| TODO | DOING | DONE | IGNORE | |---------------------------------+-------------------------------------------+------------------------------------+---------------------------------| | [[file:README.org::(C) REGION COMMANDS][(C) REGION COMMANDS]] | [[file:README.org::(E) global windows navigation keybindings][(E) global windows navigation keybindings]] | [[file:README.org::(C) MOTION COMMANDS][(C) MOTION COMMANDS]] | [[file:README.org::(C) JUMPING AROUND COMMANDS][(C) JUMPING AROUND COMMANDS]] | | [[file:README.org::- (C) mark_word][- (C) mark_word]] | [[file:README.org::(VS) VISUAL STUDIO][(VS) VISUAL STUDIO]] | [[file:README.org::- (C) forward_char (C-f)][- (C) forward_char (C-f)]] | [[file:README.org::- (C) scroll_left][- (C) scroll_left]] | | [[file:README.org::- (C) yank_pop][- (C) yank_pop]] | [[file:README.org::- (VS) recenter_line (C-l)][- (VS) recenter_line (C-l)]] | [[file:README.org::- (C) backward_char (C-b)][- (C) backward_char (C-b)]] | [[file:README.org::- (C) scroll_right][- (C) scroll_right]] | | [[file:README.org::- (C) kill_region][- (C) kill_region]] | [[file:README.org::- (VS) indent_line (C-i)][- (VS) indent_line (C-i)]] | [[file:README.org::- (C) forward_word (M-f)][- (C) forward_word (M-f)]] | [[file:README.org::(C) NEWLINE AND INDENT COMMANDS][(C) NEWLINE AND INDENT COMMANDS]] | | [[file:README.org::- (C) delete_backward_char][- (C) delete_backward_char]] | [[file:README.org::(VC) VSCODE][(VC) VSCODE]] | [[file:README.org::- (C) backward_word (M-b)][- (C) backward_word (M-b)]] | [[file:README.org::- (C) open_line][- (C) open_line]] | | [[file:README.org::- (C) kill_word][- (C) kill_word]] | [[file:README.org::- (VC) isearch_backwards (C-r)][- (VC) isearch_backwards (C-r)]] | [[file:README.org::- (C) next_line (C-n)][- (C) next_line (C-n)]] | [[file:README.org::(C) EDIT COMMANDS][(C) EDIT COMMANDS]] | | [[file:README.org::- (C) kill_whole_line][- (C) kill_whole_line]] | [[file:README.org::- (VC) isearch_forwards (C-s)][- (VC) isearch_forwards (C-s)]] | [[file:README.org::- (C) previous_line (C-p)][- (C) previous_line (C-p)]] | [[file:README.org::- (C) transpose_chars][- (C) transpose_chars]] | | [[file:README.org::(C) NEWLINE AND INDENT COMMANDS][(C) NEWLINE AND INDENT COMMANDS]] | [[file:README.org::- (VC) comment_line (C-;)][- (VC) comment_line (C-;)]] | [[file:README.org::(C) JUMPING AROUND COMMANDS][(C) JUMPING AROUND COMMANDS]] | [[file:README.org::- (C) transpose_words][- (C) transpose_words]] | | [[file:README.org::- (C) newline][- (C) newline]] | [[file:README.org::- (VC) recenter_line (C-l)][- (VC) recenter_line (C-l)]] | [[file:README.org::- (C) scroll_down (C-v)][- (C) scroll_down (C-v)]] | [[file:README.org::- (C) transpose_lines][- (C) transpose_lines]] | | [[file:README.org::- (C) delete_indentation][- (C) delete_indentation]] | [[file:README.org::(N++) NOTEPAD++][(N++) NOTEPAD++]] | [[file:README.org::- (C) scroll_up (M-v)][- (C) scroll_up (M-v)]] | [[file:README.org::(C) CASE CONVERSION COMMANDS][(C) CASE CONVERSION COMMANDS]] | | [[file:README.org::(C) EDIT COMMANDS][(C) EDIT COMMANDS]] | [[file:README.org::(E) PROGRAM SPECIFIC PRESETS][(E) PROGRAM SPECIFIC PRESETS]] | [[file:README.org::- (C) move_beginning_of_line (C-a)][- (C) move_beginning_of_line (C-a)]] | [[file:README.org::- (C) upcase_region][- (C) upcase_region]] | | [[file:README.org::- (C) redo][- (C) redo]] | [[file:README.org::(E) ERGO PRESET SELECTION][(E) ERGO PRESET SELECTION]] | [[file:README.org::- (C) move_end_of_line (C-e)][- (C) move_end_of_line (C-e)]] | [[file:README.org::- (C) downcase_region][- (C) downcase_region]] | | [[file:README.org::- (C) query_replace][- (C) query_replace]] | [[file:README.org::(E) xref_go_back][(E) xref_go_back]] | [[file:README.org::- (C) beginning_of_buffer (M-<)][- (C) beginning_of_buffer (M-<)]] | [[file:README.org::- (C) upcase_word][- (C) upcase_word]] | | [[file:README.org::- (C) overwrite_mode][- (C) overwrite_mode]] | | [[file:README.org::- (C) end_of_buffer (M->)][- (C) end_of_buffer (M->)]] | [[file:README.org::- (C) downcase_word][- (C) downcase_word]] | | [[file:README.org::(C) INSERT PAIRS COMMANDS][(C) INSERT PAIRS COMMANDS]] | | [[file:README.org::- (C) goto_line (M-g g)][- (C) goto_line (M-g g)]] | [[file:README.org::- (C) capitalize_word][- (C) capitalize_word]] | | [[file:README.org::- (C) insert_parentheses][- (C) insert_parentheses]] | | [[file:README.org::(C) REGION COMMANDS][(C) REGION COMMANDS]] | [[file:README.org::(C) MACRO RECORDING COMMANDS][(C) MACRO RECORDING COMMANDS]] | | [[file:README.org::- (C) insert_comment][- (C) insert_comment]] | | [[file:README.org::- (E) mark_whole_line (M-s ,)][- (E) mark_whole_line (M-s ,)]] | [[file:README.org::(C) ADD IGNORE FRAMES][(C) ADD IGNORE FRAMES]] | | [[file:README.org::- (C) indent_new_comment_line][- (C) indent_new_comment_line]] | | [[file:README.org::- (C) mark_whole_buffer (C-x h)][- (C) mark_whole_buffer (C-x h)]] | [[file:README.org::(C) ADD MOUSE EVENTS][(C) ADD MOUSE EVENTS]] | | [[file:README.org::(C) OTHER COMMANDS][(C) OTHER COMMANDS]] | | [[file:README.org::- (C) kill_ring_save (M-w)][- (C) kill_ring_save (M-w)]] | | | [[file:README.org::- (C) shell][- (C) shell]] | | [[file:README.org::- (C) yank (C-y)][- (C) yank (C-y)]] | | | [[file:README.org::- (C) shell_command][- (C) shell_command]] | | [[file:README.org::- (C) delete_char (C-d)][- (C) delete_char (C-d)]] | | | [[file:README.org::- (C) facemenu][- (C) facemenu]] | | [[file:README.org::- (C) backward_kill_word (M-BKSP)][- (C) backward_kill_word (M-BKSP)]] | | | [[file:README.org::- (C) help][- (C) help]] | | [[file:README.org::- (C) kill_line (C-k)][- (C) kill_line (C-k)]] | | | [[file:README.org::(C) SYSTEM COMMANDS][(C) SYSTEM COMMANDS]] | | [[file:README.org::(C) NEWLINE AND INDENT COMMANDS][(C) NEWLINE AND INDENT COMMANDS]] | | | [[file:README.org::- (C) ignore][- (C) ignore]] | | [[file:README.org::- (C) indent_for_tab_command (C-i)][- (C) indent_for_tab_command (C-i)]] | | | [[file:README.org::- (C) repeat][- (C) repeat]] | | [[file:README.org::(C) EDIT COMMANDS][(C) EDIT COMMANDS]] | | | [[file:README.org::(C) UNIVERSAL ARGUMENT COMMANDS][(C) UNIVERSAL ARGUMENT COMMANDS]] | | [[file:README.org::- (C) undo_only (C-/)][- (C) undo_only (C-/)]] | | | [[file:README.org::(C) FILES COMMANDS][(C) FILES COMMANDS]] | | [[file:README.org::- (C) search_forward (C-s)][- (C) search_forward (C-s)]] | | | [[file:README.org::- (C) write_file][- (C) write_file]] | | [[file:README.org::- (C) search_backward (C-r)][- (C) search_backward (C-r)]] | | | [[file:README.org::- (C) find_file][- (C) find_file]] | | [[file:README.org::(C) SYSTEM COMMANDS][(C) SYSTEM COMMANDS]] | | | [[file:README.org::- (C) dired][- (C) dired]] | | [[file:README.org::- (C) set_mark_command (C-SPC)][- (C) set_mark_command (C-SPC)]] | | | [[file:README.org::(C) WINDOWS FRAMES COMMANDS][(C) WINDOWS FRAMES COMMANDS]] | | [[file:README.org::- (C) set_c-x_command (C-x)][- (C) set_c-x_command (C-x)]] | | | [[file:README.org::- (C) delete_window][- (C) delete_window]] | | [[file:README.org::- (C) keyboard_quit (C-g)][- (C) keyboard_quit (C-g)]] | | | [[file:README.org::- (C) split_window][- (C) split_window]] | | [[file:README.org::(C) FILES COMMANDS][(C) FILES COMMANDS]] | | | [[file:README.org::(C) ADD HOOKS][(C) ADD HOOKS]] | | [[file:README.org::- (C) save_buffer (C-x s)][- (C) save_buffer (C-x s)]] | | | [[file:README.org::(C) ADD GENERIC GOTO LINE][(C) ADD GENERIC GOTO LINE]] | | [[file:README.org::(C) WINDOWS FRAMES COMMANDS][(C) WINDOWS FRAMES COMMANDS]] | | | [[file:README.org::(C) ADD KILL RING][(C) ADD KILL RING]] | | [[file:README.org::- (C) kill_frame (C-x c)][- (C) kill_frame (C-x c)]] | | | [[file:README.org::(VC) VSCODE][(VC) VSCODE]] | | [[file:README.org::- (C) next_window (C-x o)][- (C) next_window (C-x o)]] | | | [[file:README.org::- (VC) indent_line (C-i)][- (VC) indent_line (C-i)]] | | [[file:README.org::- (C) suspend_frame (C-z)][- (C) suspend_frame (C-z)]] | | | [[file:README.org::- (E) isearch-yank-word-or-char][- (E) isearch-yank-word-or-char]] | | [[file:README.org::(C) ADD C-X (C-x)][(C) ADD C-X (C-x)]] | | | [[file:README.org::- (C) previous_window][- (C) previous_window]] | | [[file:README.org::(VS) VISUAL STUDIO][(VS) VISUAL STUDIO]] | | | | | [[file:README.org::- (VS) isearch_backwards (C-r)][- (VS) isearch_backwards (C-r)]] | | | | | [[file:README.org::- (VS) isearch_forwards (C-s)][- (VS) isearch_forwards (C-s)]] | | | | | [[file:README.org::- (VS) comment_line (C-;)][- (VS) comment_line (C-;)]] | | | | | [[file:README.org::- (VS) split window vert (C-x 3)][- (VS) split window vert (C-x 3)]] | | | | | [[file:README.org::(N++) NOTEPAD++][(N++) NOTEPAD++]] | | | | | [[file:README.org::- (N++) isearch_backwards (C-r)][- (N++) isearch_backwards (C-r)]] | | | | | [[file:README.org::- (N++) isearch_forwards (C-s)][- (N++) isearch_forwards (C-s)]] | | | | | [[file:README.org::- (N++) comment_line (C-;)][- (N++) comment_line (C-;)]] | | | | | [[file:README.org::(E) xref_find_definitions][(E) xref_find_definitions]] | | | | | [[file:README.org::*(E) xref_find_references][(E) xref_find_references]] | |

+end:

WOWEE is composed of several AutoHotKey scripts, each serving a specific purpose to replicate Emacs functionalities:

** wowee.ahk

The top level script to be run, contains the following scripts along with some potential ergonomic key-mappings which if not desired can be commented out:

+begin_src ahk

RAlt::Control CapsLock::Control

Include fundamental.ahk

Include commands.ahk

Include keybinds-apps.ahk

HotIf !WinActive("ahk_class Emacs")

Include keybinds-core.ahk

Include keybinds-init.ahk

HotIf

+end_src

** fundamental.ahk

This script provides a set of fundamental functions and variables that are used to implement Emacs-like commands and keybindings.

** commands.ahk

This script includes the basic implementation of Emacs commands.

** commands_util.ahk

This script contains simple utility functions used by the command scripts.

** keybinds-core.ahk

This script defines the default core keybindings for Emacs-like commands, which will be a fallback for any windows application.

** keybinds-apps.ahk

This script defines the application specific commands, typically commands that have been remapped to accommodate the chosen commands.

Comments within the ahk file indicate the potential re-mappings.

** keybinds-init.ahk

Analogous to the init.el file or Emacs init file in which all the users bespoke keybindings will exist. An example of my preferred keybindings has been supplied.

** keybinds-global.ahk

Essential keybindings for workspace switching, quitting windows, and starting applications like Emacs and Firefox.

  1. Download WOWEE: Download the WOWEE scripts from the repository.
  2. Extract Files: Extract the files to a directory of your choice.
  3. Run the Script: Double-click wowee.ahk to start using WOWEE.

** Editing Keybindings

You can customize the keybindings by editing the keybinds.ahk file. Open the file in any text editor and modify the keybindings according to your preferences. Refer to the AutoHotKey documentation for the syntax and available key options.

** Adding New Commands

To add new commands, you can edit the commands.ahk and commands_util.ahk files. Define your new commands and utility functions, and then bind them to keys in keybinds.ahk.

If you encounter any issues while using WOWEE, try the following steps:

  1. Check AutoHotKey Version: Ensure you have the latest version of AutoHotKey installed.
  2. Script Errors: If there are errors in the script, AutoHotKey will usually display a message with details. Use this information to debug and fix the issue.
  3. Conflicting Programs: Some programs might have conflicting keybindings. Try closing other programs to see if the issue is resolved.

Contributions to WOWEE are welcome! If you have suggestions for improvements or want to add new features, feel free to submit a pull request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -am 'Add your feature')
  4. Push to the branch (git push origin feature/YourFeature)
  5. Create a new pull request

WOWEE is licensed under the MIT License. See the LICENSE file for more details.

Special thanks to the creators of AutoHotKey and the Emacs community for their inspiration and contributions to keyboard efficiency.

For any questions or issues, please open an issue on the GitHub repository or contact the maintainer at [email@example.com].


Enjoy using WOWEE and bring the power of Emacs navigation to your Windows experience!

TODO (C) REGION COMMANDS ** TODO - (C) mark_word TODO - (C) yank_pop TODO - (C) kill_region TODO - (C) delete_backward_char TODO - (C) kill_word TODO - (C) kill_whole_line TODO (C) NEWLINE AND INDENT COMMANDS ** TODO - (C) newline TODO - (C) delete_indentation TODO (C) EDIT COMMANDS ** TODO - (C) redo TODO - (C) query_replace * TODO - (C) overwrite_mode * TODO (C) INSERT PAIRS COMMANDS TODO - (C) insert_parentheses TODO - (C) insert_comment TODO - (C) indent_new_comment_line TODO (C) OTHER COMMANDS ** TODO - (C) shell TODO - (C) shell_command TODO - (C) facemenu TODO - (C) help TODO (C) SYSTEM COMMANDS ** TODO - (C) ignore TODO - (C) repeat TODO (C) UNIVERSAL ARGUMENT COMMANDS TODO (C) FILES COMMANDS TODO - (C) write_file TODO - (C) find_file * TODO - (C) dired * TODO (C) WINDOWS FRAMES COMMANDS TODO - (C) delete_window TODO - (C) split_window TODO (C) ADD HOOKS TODO (C) ADD GENERIC GOTO LINE TODO (C) ADD KILL RING TODO (VC) VSCODE TODO - (VC) indent_line (C-i) DOING (E) global windows navigation keybindings DOING (VS) VISUAL STUDIO DOING - (VS) recenter_line (C-l) DOING - (VS) indent_line (C-i) DOING (VC) VSCODE ** DOING - (VC) isearch_backwards (C-r) DOING - (VC) isearch_forwards (C-s) DOING - (VC) comment_line (C-;) DOING - (VC) recenter_line (C-l) DOING (N++) NOTEPAD++ DOING (E) PROGRAM SPECIFIC PRESETS DOING (E) ERGO PRESET SELECTION DOING (E) xref_go_back IGNORE (C) JUMPING AROUND COMMANDS ** IGNORE - (C) scroll_left IGNORE - (C) scroll_right IGNORE (C) NEWLINE AND INDENT COMMANDS IGNORE - (C) open_line IGNORE (C) EDIT COMMANDS IGNORE - (C) transpose_chars IGNORE - (C) transpose_words IGNORE - (C) transpose_lines IGNORE (C) CASE CONVERSION COMMANDS ** IGNORE - (C) upcase_region IGNORE - (C) downcase_region IGNORE - (C) upcase_word IGNORE - (C) downcase_word IGNORE - (C) capitalize_word IGNORE (C) MACRO RECORDING COMMANDS IGNORE (C) ADD IGNORE FRAMES IGNORE (C) ADD MOUSE EVENTS DONE (C) MOTION COMMANDS DONE - (C) forward_char (C-f) DONE - (C) backward_char (C-b) DONE - (C) forward_word (M-f) DONE - (C) backward_word (M-b) DONE - (C) next_line (C-n) * DONE - (C) previous_line (C-p) * DONE (C) JUMPING AROUND COMMANDS DONE - (C) scroll_down (C-v) DONE - (C) scroll_up (M-v) DONE - (C) move_beginning_of_line (C-a) DONE - (C) move_end_of_line (C-e) DONE - (C) beginning_of_buffer (M-<) DONE - (C) end_of_buffer (M->) DONE - (C) goto_line (M-g g) DONE (C) REGION COMMANDS ** DONE - (E) mark_whole_line (M-s ,) DONE - (C) mark_whole_buffer (C-x h) DONE - (C) kill_ring_save (M-w) DONE - (C) yank (C-y) DONE - (C) delete_char (C-d) DONE - (C) backward_kill_word (M-BKSP) * DONE - (C) kill_line (C-k) * DONE (C) NEWLINE AND INDENT COMMANDS DONE - (C) indent_for_tab_command (C-i) DONE (C) EDIT COMMANDS ** DONE - (C) undo_only (C-/) DONE - (C) search_forward (C-s) DONE - (C) search_backward (C-r) TODO - (E) isearch-yank-word-or-char DONE (C) SYSTEM COMMANDS ** DONE - (C) set_mark_command (C-SPC) DONE - (C) set_c-x_command (C-x) * DONE - (C) keyboard_quit (C-g) * DONE (C) FILES COMMANDS DONE - (C) save_buffer (C-x s) DONE (C) WINDOWS FRAMES COMMANDS DONE - (*C) kill_frame (C-x c) DONE - (C) next_window (C-x o) TODO - (C) previous_window DONE - (C) suspend_frame (C-z) DONE (C) ADD C-X (C-x) DONE (VS) VISUAL STUDIO DONE - (VS) isearch_backwards (C-r) DONE - (VS) isearch_forwards (C-s) DONE - (VS) comment_line (C-;) * DONE - (VS) split window vert (C-x 3) * DONE (N++) NOTEPAD++ DONE - (N++) isearch_backwards (C-r) DONE - (N++) isearch_forwards (C-s) DONE - (N++) comment_line (C-;) DONE (E) xref_find_definitions DONE (E) xref_find_references