Jump to definition doesn't work on Windows

[jiribenes]

On Windows, jumping to definition in VSCode doesn't work correctly.

When it should jump to file:

C:/.../effekt/lib/foo.effekt

it instead tries to jump to file with a trailing slash:

C:/.../effekt/lib/foo.effekt/

Unfortunately, this tends to confuse VSCode so that it thinks it's an invalid folder.

I'm not sure it's a VSCode bug per se, that's why I'm filing the issue here (since I think it might be an LSP issue).
As a workaround, we could just always remove trailing slashes, I think? 🤔

[b-studios]

Here is the kiama code that computes the source file location:

  def locationOfNode(node: N): Location = {
    (positions.getStart(node), positions.getFinish(node)) match {
      case (start @ Some(st), finish @ Some(_)) =>
        st.source match {
          case StringSource(_, name) =>
            val s = convertPosition(start)
            val f = convertPosition(finish)
            new Location(name, new LSPRange(s, f))
          case _ =>
            null
        }
      case _ =>
        null
    }
  }

https://github.com/effekt-lang/kiama/blob/ab6aef78fc4ce99a9ad2db8555718d00b03f7b8a/jvm/src/main/scala/kiama/util/Server.scala#L337C7-L351

It just returns the path and shouldn't mess with it.

The constructor of Location also just stores the uri.

The URI should be introduced here:

@JsonNotification("textDocument/didSave")
  def didSave(params: DidSaveTextDocumentParams): Unit = {
    process(params.getTextDocument.getUri, params.getText)
  }

https://github.com/effekt-lang/kiama/blob/ab6aef78fc4ce99a9ad2db8555718d00b03f7b8a/jvm/src/main/scala/kiama/util/Server.scala#L496-L499

which ends up invoking

def compileString(name: String, input: String, config: C): Unit = {
    compileSource(StringSource(input, name), config)
}

https://github.com/effekt-lang/kiama/blob/ab6aef78fc4ce99a9ad2db8555718d00b03f7b8a/jvm/src/main/scala/kiama/util/Compiler.scala#L112-L114

which in turn ends up calling

effekt/effekt/jvm/src/main/scala/effekt/Driver.scala

Line 52 in 898c86c

override def compileSource(source: Source, config: EffektConfig): Unit = try {

on the string source.

[b-studios]

Here is a gem, that I didn't know about:

effekt/effekt/jvm/src/main/scala/effekt/Server.scala

Lines 99 to 107 in 898c86c

	def toURI(filename: String): String = {
	if (filename startsWith "file://")
	filename
	else
	if (filename startsWith "./")
	"file://" ++ Filenames.cwd() ++ "/" ++ Filenames.dropPrefix(filename, ".")
	else
	s"file://$filename"
	}

Not sure this is related to the bug, though. However, this should be a source of bugs on windows since it doesn't use path separator, but literal /, which might not work on Win.

[b-studios]

@jiribenes do you know whether this also happens when jumping to definition within the same file?

[TheDying0fLight]

@jiribenes do you know whether this also happens when jumping to definition within the same file?

Jumping to definitions within the same file works without a problem