To be able to edit code and run cells, you need to run the notebook yourself. Where would you like to run the notebook?

In the cloud (experimental)

Binder is a free, open source service that runs scientific notebooks in the cloud! It will take a while, usually 2-7 minutes to get a session.

On your computer

(Recommended if you want to store your changes.)

  1. Copy the notebook URL:
  2. Run Pluto

    (Also see: How to install Julia and Pluto)

  3. Paste URL in the Open box

Frontmatter

If you are publishing this notebook on the web, you can set the parameters below to provide HTML metadata. This is useful for search engines and social media.

Author 1

Pinot.jl

10.0 ms
using Pinot
3.0 ms

Pinot is a Julia package to perform Operational Transformation. That is, it offers tools to describe and reconcile plain-text edits to implement collaborative text editing features. Pinot is based on the Delta format to describe documents and edits.

A Delta is a series of edits, which can be one of the following three sorts:

  • retain

  • insert

  • delete

9.9 ms

Describing edits

6.6 ms
Pinot.Delta.retain(0x00000004)
retain(4)
12.1 μs
Pinot.Delta.delete(0x00000003)
delete(3)
11.4 μs
Pinot.Delta.insert("ok")
insert("ok")
10.7 μs
retain 
retain(l::Integer) -> Range

Retains l utf16 codepoints in the starting document.

retain(s::String) -> Range

Creates a range that retains the same length as s.

28.1 μs
"Hello"
let text = "Hello",
changes = [Pinot.retain(text)]
Pinot.apply(text, changes)
end
66.4 ms
insert 
insert(s::String) -> Range

Insertions of string s.

26.8 μs
"Hello World!"
let text = "Hello",
changes = [
Pinot.retain(5),
Pinot.insert(" World!"),
]
Pinot.apply(text, changes)
end
12.7 ms
delete 
delete(l::Integer) -> Range

Deletes l utf16 codepoints from the starting document.

delete(s::String) -> Range

Creates a range that deletes the same length as s.

23.6 μs
""
let text = "Hello",
changes = [
Pinot.delete(5),
]
Pinot.apply(text, changes)
end
38.0 μs

Warning

The length of range represents the number of utf16 codepoints. This is because the Delta format is meant to interoperate with Javascript which uses UTF16 encoding for its string encoding.

233 μs
Unicode

Helpers to work with UTF-16 codepoint indices on valid UTF-8 backed strings.

24.5 μs

Notice the difference in the following example when using the ncodeunits(::Char) base function which returns the number of UTF-8 codeunits. Using Pinot.Unicode.utf16_ncodeunits(::String) is required instead to have the right delta length.

285 μs
"🍕 i🍍s great"
let text = "🍕 is great",
changes = [
Pinot.retain(ncodeunits('🍕')),
Pinot.insert("🍍"),
]
Pinot.apply(text, changes)
end
62.0 μs
"🍕🍍 is great"
let text = "🍕 is great",
changes = [
Pinot.retain(Pinot.Unicode.utf16_ncodeunits('🍕')),
Pinot.insert("🍍"),
]
Pinot.apply(text, changes)
end
13.5 ms

Throughout this section, we have been using the Pinot.apply(::String, ::Vector{Range})::String function which applies a set of edits to a string.

262 μs
apply 
apply(text::String, ranges::Vector{Range}) -> String

Applies the changes to a text.

20.5 μs

Operational Transformation

198 μs
Loading more cells...