Merge pull request #702 from JunoLab/sp/terminaltooltips

terminal tooltips

Author: pfitzseb

lib/julia-client.coffee

@@ -8,7 +8,7 @@ toolbar = require './package/toolbar'
 semver = require 'semver'
 
 # TODO: Update me when tagging a new relase:
-INK_VERSION_COMPAT  = "^0.12.2"
+INK_VERSION_COMPAT  = "^0.12.3"
 
 INK_LINK            = '[`ink`](https://github.com/JunoLab/atom-ink)'
 LANGUAGE_JULIA_LINK = '[`language-julia`](https://github.com/JuliaEditorSupport/atom-language-julia)'

lib/runtime/console.js

@@ -15,12 +15,10 @@ import * as ssh from 'ssh2'
 const { changeprompt, changemodule, fullpath } =
   client.import({ msg: ['changeprompt', 'changemodule', 'resetprompt'], rpc: ['validatepath', 'fullpath'] })
 
-let uriRegex
-if (process.platform === 'win32') {
-  uriRegex = /(@ ([^\s]+)\s(.*?)\:(\d+)|((([a-zA-Z]:|\.\.?|\~)|([^\0<>\?\|\/\s!$`&*()\[\]+'":;])+)?((\\|\/)([^\0<>\?\|\/\s!$`&*()\[\]+'":;])+)+)(\:\d+)?)/
-} else {
-  uriRegex = /(@ ([^\s]+)\s(.*?)\:(\d+)|(((\.\.?|\~)|([^\0\s!$`&*()\[\]+'":;\\])+)?(\/([^\0\s!$`&*()\[\]+'":;\\])+)+)(\:\d+)?)/
-}
+const isWindows = process.platform === 'win32'
+const uriRegex = isWindows ?
+  /(@ ([^\s]+)\s(.*?)\:(\d+)|((([a-zA-Z]:|\.\.?|\~)|([^\0<>\?\|\/\s!$`&*()\[\]+'":;])+)?((\\|\/)([^\0<>\?\|\/\s!$`&*()\[\]+'":;])+)+)(\:\d+)?)/ :
+  /(@ ([^\s]+)\s(.*?)\:(\d+)|(((\.\.?|\~)|([^\0\s!$`&*()\[\]+'":;\\])+)?(\/([^\0\s!$`&*()\[\]+'":;\\])+)+)(\:\d+)?)/
 
 var whitelistedKeybindingsREPL = []
 var whitelistedKeybindingsTerminal = []
@@ -52,6 +50,7 @@ export function activate (_ink) {
   terminal = ink.InkTerminal.fromId('julia-terminal', terminalOptions())
   terminal.setTitle('REPL', true)
   terminal.onDidOpenLink(hasKeyboardModifier)
+  terminal.registerTooltipHandler(showTooltip, hideTooltip)
   terminal.class = 'julia-terminal'
 
   subs.add(atom.config.observe('julia-client.uiOptions.layouts.console.defaultLocation', (defaultLocation) => {
@@ -157,6 +156,7 @@ export function activate (_ink) {
       item.attachCustomKeyEventHandler((e) => handleKeybinding(e, item))
       addLinkHandler(item.terminal)
       item.onDidOpenLink(hasKeyboardModifier)
+      item.registerTooltipHandler(showTooltip, hideTooltip)
       shellPty(item.persistentState.cwd)
         .then(({pty, cwd}) => item.attach(pty, true, cwd))
         .catch(() => {})
@@ -179,6 +179,7 @@ function newTerminal (cwd) {
   const term = ink.InkTerminal.fromId(`terminal-julia-${Math.floor(Math.random()*10000000)}`, terminalOptions())
   term.attachCustomKeyEventHandler((e) => handleKeybinding(e, term))
   term.onDidOpenLink(hasKeyboardModifier)
+  term.registerTooltipHandler(showTooltip, hideTooltip)
   addLinkHandler(term.terminal)
   shellPty(cwd).then(({pty, cwd}) => {
     term.attach(pty, true, cwd)
@@ -195,6 +196,7 @@ function newRemoteTerminal () {
   const term = ink.InkTerminal.fromId(`terminal-remote-julia-${Math.floor(Math.random()*10000000)}`, terminalOptions())
   term.attachCustomKeyEventHandler((e) => handleKeybinding(e, term))
   term.onDidOpenLink(hasKeyboardModifier)
+  term.registerTooltipHandler(showTooltip, hideTooltip)
   addLinkHandler(term.terminal)
   remotePty().then(({pty, cwd, conf}) => {
     term.attach(pty, true, cwd)
@@ -260,7 +262,10 @@ function handleLink (event, uri) {
         pending: atom.config.get('core.allowPendingPaneItems')
       })
     } else {
-      urimatch = uri.match(/([^\:]+)(?:\:(\d+))?/)
+      const matchregex = isWindows ?
+        /(([a-zA-Z]\:)?[^\:]+)(?:\:(\d+))?/ :
+        /([^\:]+)(?:\:(\d+))?/
+      urimatch = uri.match(matchregex)
       if (urimatch) {
         const line = urimatch[2] !== null ? parseInt(urimatch[2]) : 0
         ink.Opener.open(urimatch[1], line - 1, {
@@ -274,9 +279,53 @@ function handleLink (event, uri) {
 function addLinkHandler (terminal) {
   terminal.registerLinkMatcher(uriRegex, handleLink, {
     willLinkActivate: ev => hasKeyboardModifier(ev),
+    tooltipCallback: (ev, uri, location) => showTooltip(ev, uri, location, terminal),
+    leaveCallback: () => hideTooltip()
   })
 }
 
+let tooltip = null
+
+function showTooltip (event, uri, location, terminal) {
+  hideTooltip()
+  
+  if (atom.config.get('julia-client.consoleOptions.linkModifier')) {
+    const el = document.createElement('div')
+    el.classList.add('terminal-link-tooltip')
+
+    const terminalRect = terminal.element.getBoundingClientRect()
+    const colWidth = terminalRect.width / terminal.cols
+    const rowHeight = terminalRect.height / terminal.rows
+
+    const leftPosition = location.start.x * colWidth + terminalRect.left
+    const topPosition = (location.start.y - 1.5) * rowHeight + terminalRect.top
+
+    el.style.top = topPosition + 'px'
+    el.style.left = leftPosition + 'px'
+
+    el.innerText = (process.platform == 'darwin' ? 'Cmd' : 'Ctrl') + '-Click to open link.'
+
+    tooltip = el
+    document.body.appendChild(el)
+
+    return true
+  } else {
+    return false
+  }
+}
+
+function hideTooltip () {
+  if (tooltip) {
+    try {
+      document.body.removeChild(tooltip)
+    } catch (err) {
+
+    } finally {
+      tooltip = null
+    }
+  }
+}
+
 function handleKeybinding (e, term, binds = whitelistedKeybindingsTerminal) {
   if (process.platform !== 'win32' && e.keyCode === 13 && (e.altKey || e.metaKey) && e.type === 'keydown') {
     // Meta-Enter doesn't work properly with xterm.js atm, so we send the right escape sequence ourselves:

styles/julia-client.less

@@ -182,3 +182,12 @@ atom-text-editor.editor[data-grammar$="source weave latex"] {
     }
   }
 }
+
+.terminal-link-tooltip {
+  z-index: 100;
+  color: @text-color;
+  background-color: @app-background-color;
+  padding: 0.2em 0.5em;
+  position: absolute;
+  border: 1px solid fade(@text-color, 70%);
+}