Skip to content

No syntax highlighting until the first edit #254 #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
L-TChen merged 1 commit into from
Jan 31, 2026
Merged

No syntax highlighting until the first edit #254 #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions src/Editor.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,20 @@ module Provider = {
}

module Mock = {
// https://code.visualstudio.com/api/references/vscode-api#Event
module Event = {
type t<'a>
}

// https://code.visualstudio.com/api/references/vscode-api#EventEmitter
module EventEmitter = {
type t<'a>
@module("vscode") @new external make: unit => t<'a> = "EventEmitter"
@get external event: t<'a> => Event.t<'a> = "event"
@send external fire: (t<'a>, 'a) => unit = "fire"
@send external dispose: t<'a> => unit = "dispose"
}

// https://code.visualstudio.com/api/references/vscode-api#SemanticsTokens
module SemanticsTokens = {
type t
Expand Down Expand Up @@ -294,8 +308,6 @@ module Provider = {

// https://code.visualstudio.com/api/references/vscode-api#DocumentSemanticTokensProvider
module DocumentSemanticTokensProvider = {
// missing: onDidChangeSemanticTokens

type provideDocumentSemanticTokens = (
TextDocument.t,
CancellationToken.t,
Expand All @@ -314,15 +326,18 @@ module Provider = {
>

type t = {
onDidChangeSemanticTokens: option<Event.t<unit>>,
provideDocumentSemanticTokens: option<provideDocumentSemanticTokens>,
provideDocumentSemanticTokensEdits: option<provideDocumentSemanticTokensEdits>,
}

let make = (
~onDidChangeSemanticTokens: option<Event.t<unit>>=?,
~provideDocumentSemanticTokens: option<provideDocumentSemanticTokens>=?,
~provideDocumentSemanticTokensEdits: option<provideDocumentSemanticTokensEdits>=?,
(),
) => {
onDidChangeSemanticTokens,
provideDocumentSemanticTokens,
provideDocumentSemanticTokensEdits,
}
Expand All @@ -340,9 +355,11 @@ module Provider = {

let registerDocumentSemanticTokensProvider = (
~provideDocumentSemanticTokens: Mock.DocumentSemanticTokensProvider.provideDocumentSemanticTokens,
~onDidChangeSemanticTokens: option<Mock.Event.t<unit>>=?,
(tokenTypes, tokenModifiers),
) => {
let documentSemanticTokensProvider = Mock.DocumentSemanticTokensProvider.make(
~onDidChangeSemanticTokens?,
~provideDocumentSemanticTokens,
// =(textDocument, _cancel) => {
// let builder = Mock.SemanticTokensBuilder.makeWithLegend(semanticTokensLegend)
Expand Down
20 changes: 18 additions & 2 deletions src/Main/Main.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ let initialize = (
memento,
editor,
semanticTokensRequest,
semanticTokensEventEmitter,
) => {
let panel = Singleton.Panel.make(extensionUri)
// if the panel is destroyed, destroy all every State in the Registry
Expand Down Expand Up @@ -80,6 +81,13 @@ let initialize = (

let subscribe = disposable => state.subscriptions->Array.push(disposable)->ignore

// trigger semantic tokens update when highlighting is generated
semanticTokensEventEmitter->Option.forEach(emitter => {
state.tokens->Tokens.onUpdate->Chan.on(() => {
emitter->Editor.Provider.Mock.EventEmitter.fire()
})->VSCode.Disposable.make->subscribe
})

let getCurrentEditor = () =>
switch VSCode.Window.activeTextEditor {
| Some(editor) => Some(editor)
Expand Down Expand Up @@ -141,7 +149,7 @@ let initialize = (
state
}

let registerDocumentSemanticTokensProvider = () => {
let registerDocumentSemanticTokensProvider = onDidChangeSemanticTokens => {
// these two arrays are called "legends"
let tokenTypes = Highlighting__SemanticToken.TokenType.enumurate
let tokenModifiers = Highlighting__SemanticToken.TokenModifier.enumurate
Expand Down Expand Up @@ -175,6 +183,7 @@ let registerDocumentSemanticTokensProvider = () => {

Editor.Provider.registerDocumentSemanticTokensProvider(
~provideDocumentSemanticTokens,
~onDidChangeSemanticTokens?,
(tokenTypes, tokenModifiers),
)
}
Expand Down Expand Up @@ -269,6 +278,11 @@ let activateWithoutContext = (
let subscribe = x => subscriptions->Array.push(x)->ignore
let subscribeMany = xs => subscriptions->Array.pushMany(xs)->ignore

// Semantic Tokens Event
let semanticTokensEventEmitter = Editor.Provider.Mock.EventEmitter.make()
subscribe(VSCode.Disposable.make(() => semanticTokensEventEmitter->Editor.Provider.Mock.EventEmitter.dispose))
let onDidChangeSemanticTokens = semanticTokensEventEmitter->Editor.Provider.Mock.EventEmitter.event

// Channel for testing, emits events when something has been completed,
// for example, when the input method has translated a key sequence into a symbol
let channels = {
Expand Down Expand Up @@ -363,6 +377,7 @@ let activateWithoutContext = (
memento,
editor,
None,
Some(semanticTokensEventEmitter),
)
Registry.add(document, state)
| Some(entry) =>
Expand All @@ -377,6 +392,7 @@ let activateWithoutContext = (
memento,
editor,
Some(entry.semanticTokens),
Some(semanticTokensEventEmitter),
)
Registry.add(document, state)
| Some(_) => () // should not happen
Expand All @@ -394,7 +410,7 @@ let activateWithoutContext = (
}
})->subscribeMany

registerDocumentSemanticTokensProvider()->subscribe
registerDocumentSemanticTokensProvider(Some(onDidChangeSemanticTokens))->subscribe
registerInputMethodHintHoverProvider()->subscribe

// expose the channel for testing
Expand Down
1 change: 1 addition & 0 deletions src/State/State.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ let destroy = async (state, alsoRemoveFromRegistry) => {
state.channels.log->Chan.emit(Others("State.destroy: Disposed subscriptions"))
state.channels.log->Chan.emit(TokensReset("State.destroy"))
state.tokens->Tokens.reset
state.tokens->Tokens.destroyUpdateChannel
state.channels.log->Chan.emit(Others("State.destroy: Tokens reset completed"))
let result = await Connection.destroy(state.connection, state.channels.log)
state.channels.log->Chan.emit(Others("State.destroy: Connection destroyed, destruction complete"))
Expand Down
11 changes: 11 additions & 0 deletions src/Tokens.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ module type Module = {

// Remove everything
let reset: t => unit
let destroyUpdateChannel: t => unit

// definition provider for go-to-definition
let goToDefinition: (
Expand All @@ -41,6 +42,8 @@ module type Module = {

let toOriginalOffset: (t, int) => option<int>

let onUpdate: t => Chan.t<unit>

let getVSCodeTokens: t => Resource.t<array<Highlighting__SemanticToken.t>>
let getHolePositionsFromLoad: t => Resource.t<Map.t<int, int>>
let getHoles: t => Map.t<int, Token.t<vscodeOffset>>
Expand Down Expand Up @@ -118,6 +121,7 @@ module Module: Module = {
// ranges of holes
mutable holes: Map.t<int, Token.t<vscodeOffset>>,
mutable holePositions: Resource.t<Map.t<int, int>>,
onUpdate: Chan.t<unit>,
}

let toString = self => {
Expand Down Expand Up @@ -153,6 +157,7 @@ module Module: Module = {
decorations: Map.make(),
holes: Map.make(),
holePositions: Resource.make(),
onUpdate: Chan.make(),
}

let insertWithVSCodeOffsets = (self, token: Token.t<vscodeOffset>) => {
Expand Down Expand Up @@ -254,6 +259,8 @@ module Module: Module = {
}
}

let destroyUpdateChannel = self => self.onUpdate->Chan.destroy

let toTokenArray = self => self.agdaTokens->AVLTree.toArray->Array.map(snd)
let toDecorations = self => self.decorations

Expand Down Expand Up @@ -448,6 +455,8 @@ module Module: Module = {
applyDecorations(self, editor)
// set the holes positions
self.holePositions->Resource.set(holePositions)

self.onUpdate->Chan.emit()
}

// Update the deltas and generate new tokens
Expand Down Expand Up @@ -482,6 +491,8 @@ module Module: Module = {
None,
)

let onUpdate = self => self.onUpdate

let getVSCodeTokens = self => self.vscodeTokens
let getHolePositionsFromLoad = self => self.holePositions
let getHoles = self => {
Expand Down
15 changes: 15 additions & 0 deletions test/tests/Test__Tokens.res
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ open Tokens
describe("Tokens", () => {
This.timeout(10000)
describe("Token generation", () => {
Async.it(
"should emit `onUpdate` event when highlighting is generated",
async () => {
let ctx = await AgdaMode.makeAndLoad("GotoDefinition.agda")
let (promise, resolve, _) = Util.Promise_.pending()

let _disposable = ctx.state.tokens->Tokens.onUpdate->Chan.on(resolve)

ctx.state.tokens->Tokens.generateHighlighting(ctx.state.editor)

await promise
Assert.ok(true)
},
)

Async.it(
"should produce 28 tokens",
async () => {
Expand Down
Loading