Implementation of the Hover feature

README.md

@@ -22,6 +22,10 @@ features:
 
   ![Goto Declaration](images/goto_declaration_demo.png)
 
+- Hover provider for declared symbols.
+
+  ![Hover](images/hover_demo.png)
+
 ## Configuration
 
 ### Loading external Modelica libraries

client/package.json

@@ -3,7 +3,7 @@
   "description": "VSCode part of a language server",
   "author": "Andreas Heuermann, Osman Karabel, Evan Hedbor, PaddiM8",
   "license": "OSMC-PL-1-8",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "publisher": "vscode",
   "repository": {
     "type": "git",

client/src/test/onHover.test.ts

@@ -0,0 +1,108 @@
+/*
+ * This file is part of OpenModelica.
+ *
+ * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
+ * c/o Linköpings universitet, Department of Computer and Information Science,
+ * SE-58183 Linköping, Sweden.
+ *
+ * All rights reserved.
+ *
+ * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
+ * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
+ * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
+ * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
+ * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
+ *
+ * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
+ * Public License (OSMC-PL) are obtained from OSMC, either from the above
+ * address, from the URLs:
+ * http://www.openmodelica.org or
+ * https://github.com/OpenModelica/ or
+ * http://www.ida.liu.se/projects/OpenModelica,
+ * and in the OpenModelica distribution.
+ *
+ * GNU AGPL version 3 is obtained from:
+ * https://www.gnu.org/licenses/licenses.html#GPL
+ *
+ * This program is distributed WITHOUT ANY WARRANTY; without
+ * even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
+ * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
+ *
+ * See the full OSMC Public License conditions for more details.
+ *
+ */
+
+import * as fs from 'fs';
+import * as vscode from 'vscode';
+import * as assert from 'assert';
+import { getDocUri, getDocPath, activate, executeProviderUntilResult } from './helper';
+
+suite('onHover information', async () => {
+  test('Step', async () => {
+    const docUri = getDocUri('step.mo');
+    const position = new vscode.Position(19, 25);
+    const content = new vscode.MarkdownString(
+      fs.readFileSync(getDocPath('step.md'), 'utf-8'));
+    const expectedHoverInstances: vscode.Hover[] = [
+      new vscode.Hover(content)
+    ];
+
+    await testOnHover(docUri, position, expectedHoverInstances);
+  });
+
+  test('velocityOfSound_ph', async () => {
+    const docUri = getDocUri('velocityOfSound_ph.mo');
+    const position = new vscode.Position(0, 20);
+    const content = new vscode.MarkdownString(
+      fs.readFileSync(getDocPath('velocityOfSound_ph.md'), 'utf-8'));
+    const expectedHoverInstances: vscode.Hover[] = [
+      new vscode.Hover(content)
+    ];
+
+    await testOnHover(docUri, position, expectedHoverInstances);
+  });
+});
+
+async function testOnHover(
+  uri: vscode.Uri,
+  position: vscode.Position,
+  expectedHoverInstances: vscode.Hover[]
+) {
+  await activate(uri);
+
+  // Execute `vscode.executeHoverProvider` to execute all hover providers
+  const actualHoverInstances = await executeProviderUntilResult<vscode.Hover[]>(
+    "vscode.executeHoverProvider",
+    [uri, position],
+  );
+
+  assertHoverInstancesEqual(expectedHoverInstances, actualHoverInstances);
+}
+
+function assertHoverInstancesEqual(expected: vscode.Hover[], actual: vscode.Hover[]) {
+  assert.strictEqual(expected.length, actual.length, 'Array lengths do not match.');
+
+  for (let i = 0; i < expected.length; i++) {
+    const expectedHover = expected[i];
+    const actualHover = actual[i];
+
+    let expectedContent = "";
+    for (let j = 0; j < expectedHover.contents.length; j++) {
+      const content = expectedHover.contents[j];
+      if (content instanceof vscode.MarkdownString) {
+        expectedContent += content.value;
+      }
+    }
+
+    let actualContent = "";
+    for (let j = 0; j < actualHover.contents.length; j++) {
+      const content = actualHover.contents[j];
+      if (content instanceof vscode.MarkdownString) {
+        actualContent += content.value;
+      }
+    }
+
+    assert.strictEqual(actualContent.trim(), expectedContent.trim(), `Content does not match expected content.`);
+  }
+}

client/testFixture/MyLibrary/Examples/M.mo

@@ -0,0 +1,7 @@
+within MyLibrary.Examples;
+
+model M "MWE Modelica Model"
+  Real x(start = 1.0, fixed = true);
+equation
+  der(x) = -0.5*x;
+end M;

client/testFixture/MyLibrary/Examples/package.mo

@@ -0,0 +1,4 @@
+within MyLibrary;
+
+package Examples
+end Examples;

client/testFixture/MyLibrary/Examples/package.order

@@ -0,0 +1 @@
+M

client/testFixture/MyLibrary/package.mo

@@ -0,0 +1,2 @@
+package MyLibrary "My Modelica Library"
+end MyLibrary;

client/testFixture/MyLibrary/package.order

@@ -0,0 +1 @@
+Examples

client/testFixture/step.md

@@ -0,0 +1,20 @@
+```modelica
+class Modelica_Blocks_Sources_Step "Generate step signal of type Real"
+```
+---
+
+**Parameter Inputs**
+```modelica
+parameter input Real height = 1.0 "Height of step";
+```
+**Outputs**
+```modelica
+output Real y "Connector of Real output signal";
+```
+
+**Parameter**
+```modelica
+parameter input Real height = 1.0 "Height of step";
+parameter Real offset = 0.0 "Offset of output signal y";
+parameter Real startTime(quantity = "Time", unit = "s") = 0.0 "Output y = offset for time < startTime";
+```