Sublime Text 3 Plugin

[rageandqq]

This won't fully work yet, but it's a start. It works with the version of the tandem agent from just before the write request work was added.

How it works:

• Sublime plugins need to be in the /users/${User}/Library/Application Support/Sublime Text 3/ to load. The Makefile currently does this (see README), but needs root access. The crdt, agent, and enum dependencies are copied as well (directories made if required).
• Architecture same as vim - plugin spawns instance of agent on "start" command, kills it on "stop". Communicates via messages the same way as well
• To run a command, open the Sublime console with Ctrl+backtick. Run view.run_command("tandem") to start (start as a host for now, joining as a listener support to come). view.run_command("tandem_stop") to stop. If you look at the code, there is no binding between the string and the command - this is done automagically. The command string is converted from snake case to camel case, so tandem_stop invokes the TandemStopCommand.
• The buffer is represented as a string (not an array of lines like vim), so transformations are made as required when calculating row/column and start/stop indexes for patches.
• The output checker thread enqueues its message handling logic onto the main thread
• The input checker is now changed to an event. Sublime invokes a listener callback in another thread (I think) - this will have to be dealt with later to make sure that it doesn't interfere with patches being applied on the main thread.

Additional notes:

• You can ignore everything in enum-dist, this is all library code.
• only ST3 is supported, calls in ST2 are not thread-safe.
• the edit.py file is a helper for ST3. Basically, modifications to the buffer require access to an Edit object - used by Sublime internal to group modifications to the buffer so that undo/redo can be handled well. edit references are only received on commands and listener events. We need a reference to edit in order to make changes to the buffer. However, if you retain a reference to an edit instance, and use it in the handle_message method to try to apply a patch, it errors. This is because edit instances are unique and cannot be shared/re-used. The alternative approach here is to use view commands (like what we used to invoke the start/stop commands), and this works since we can hang on to the reference of the View that we get (a View is basically the open tab). Unfortunately View only supports insert and delete, and not replace which is ideal for our needs. This utility helps converting replace (and other API if we need it) to view commands. Sorry for the long write-up, I thought it necessary.

I will work on bringing this up to par with the state of [neo]vim in future diffs, namely adding support for the write request and write request ack features.
Also, this won't be super resilient to text buffer changes while processing messages from the agent as noted above, but that can also be added in later.

[rageandqq]

https://github.com/geoffxy/tandem/issues/54

[rageandqq]

RE using a lib folder: sgtm. Will add that in the next diff (needs

The symlinking is a good idea - I didn't want to spend too much time on it earlier so I just had a build script (that I later changed to a Makefile). I'll try to set that up before merging this PR.

[geoffxy]

Yeah no rush on those changes (can both be done separately). Especially since we will need to share those utilities with the neovim plugin too.

[rageandqq]