Skip to content

Latest commit

 

History

History
96 lines (49 loc) · 3.61 KB

intellij-docs.md

File metadata and controls

96 lines (49 loc) · 3.61 KB

Codio Intellij

Getting Started

TODO!

Architecture

Codio Intellij consists of three seperate parts:

Codio Format Player/Recorder

Overview

Recorder

The Codio recorder records intellij events, such as textChanged, cursorPositionChanged etc, as well as audio, using ffmpeg. Those events save the the relevant data for the event (e.g where was the text changed, what is the selection range...) and the time the event happend. Those events are saved in a timline - an array of editor events.

Once a recording ends, the timeline of events is serialized and saved into codio.json file, the audio recording saved into an audio.mp3 file and a meta.json file is saved with the codio name and metadata. Those files are then zipped into codio file.

Player

The Codio player starts by unzipping and deserializing the codio timeline. The player can then run through the timeline. When running through the timeline, a timer is created for every event. Each event goes through the event dispatcher, where it is applied to the intellij IDE using the intellij platform API (e.g a textChanged event will change the text of a document using the intellij API).

Lets see some code...

The Codio player and recorder are the core of how Codio works. Their logic is seperated into a few modules:

  • Codio Events
  • Timeline
  • Frame
  • Player
  • Recorder

Fred Brooks once said: "Show me your code and conceal your data structures and I shall continue to be mystified. Show me your data structures, and I won't usually need your code. it'll be obvious" 1

For this reason, we will start with the data structures:

Timeline

The Codio timeline is composed of an array of codio events and the initial frame of the IDE (more about frame soon).

The same file currently includes Timeline utils as well

Codio Events

Codio is a recording of editor events and audio. The editor events are recorded by listening to the intellij API event listeners and creating Codio events from their data. On the player side, we take those Codio events and dispatch them, using the intellij API, to emulate the same change we listened to.

The codioEvents package contains:

  • The Codio Events Data Structure Classes

    • The Definition of the codio events data structures.
    • Currently this includes 5 different events.

  • A Codio Event Dispatcher

    • The event dispatcher takes a codio event, and applies it to the editor.

  • A Codio Event Creator

    • The event creator takes raw data from intellij API listeners (e.g documentListener, selectionListener) and creates codio events.

Codio Frame

Player

The player is the play controller - the glue that holds together the audio player, the event dispatcher moving into frames and time. It also serves as the interface, with functions such as play, rewind, forward, playFrom and pause.

Recorder

FileSystem

What happens on Save Codio

What happens on Load Codio

User Interface

Tool Window

Codio Notifier

1 He Actually used "flowcharts" and "tables", but the point is the same. Credit goes to Eric S. Reymond, The Cathedral and The Bazaar