From bd7671f6289eb35d5c2d4c2dca43d0a3c7a75c13 Mon Sep 17 00:00:00 2001
From: Stephen Blott
Date: Thu, 4 Jun 2015 12:45:39 +0100
Subject: Global marks; better comments and fix typo.

---
 background_scripts/marks.coffee | 18 +++++++++++-------
 1 file changed, 11 insertions(+), 7 deletions(-)

(limited to 'background_scripts')

diff --git a/background_scripts/marks.coffee b/background_scripts/marks.coffee
index ab39883b..f599cfe3 100644
--- a/background_scripts/marks.coffee
+++ b/background_scripts/marks.coffee
@@ -7,20 +7,23 @@ Marks =
   getBaseUrl: (url) -> url.split("#")[0]
 
   # Create a global mark.  We record vimiumSecret with the mark so that we can tell later, when the mark is
-  # used, whether this is the original Vimium instantiation or a subsequent instantiation.  This affects
-  # whether or not tabId can be considered valid.
+  # used, whether this is the original Vimium session or a subsequent session.  This affects whether or not
+  # tabId can be considered valid.
   create: (req, sender) ->
     chrome.storage.local.get "vimiumSecret", (items) =>
       item = {}
       item[@getLocationKey req.markName] =
         vimiumSecret: items.vimiumSecret
-        tabId: sender.tab.id
+        markName: req.markName
         url: @getBaseUrl sender.tab.url
+        tabId: sender.tab.id
         scrollX: req.scrollX
         scrollY: req.scrollY
-        markName: req.markName
       chrome.storage.sync.set item
 
+  # Goto a global mark.  We try to find the original tab.  If we can't find that, then we try to find another
+  # tab with the original URL, and use that.  And if we can't find such an existing tab, then we create a new
+  # one.  Whichever of those we do, we then set the scroll position to the original scroll position.
   goto: (req, sender) ->
     chrome.storage.local.get "vimiumSecret", (items) =>
       vimiumSecret = items.vimiumSecret
@@ -33,12 +36,12 @@ Marks =
             name: "showHUDforDuration",
             text: "Global mark not set: '#{req.markName}'."
             duration: 1000
-        else if markInfo.vimiumSecret != items.vimiumSecret
+        else if markInfo.vimiumSecret != vimiumSecret
           # This is a different Vimium instantiation, so markInfo.tabId is definitely out of date.
           @focusOrLaunch markInfo
         else
           # Check whether markInfo.tabId still exists.  According to here (https://developer.chrome.com/extensions/tabs),
-          # tab Ids are unqiue within a Chrome session.  So, if we find a match, we can use.
+          # tab Ids are unqiue within a Chrome session.  So, if we find a match, we can use it.
           chrome.tabs.get markInfo.tabId, (tab) =>
             if not chrome.runtime.lastError and tab?.url and markInfo.url == @getBaseUrl tab.url
               # The original tab still exists.
@@ -47,6 +50,7 @@ Marks =
               # The original tab no longer exists.
               @focusOrLaunch markInfo
 
+  # Focus an existing tab and scroll to the given position within it.
   gotoPositionInTab: ({ tabId, scrollX, scrollY, markName }) ->
     chrome.tabs.update tabId, { selected: true }, ->
       chrome.tabs.sendMessage tabId,
@@ -67,7 +71,7 @@ Marks =
             @gotoPositionInTab extend markInfo, tabId: tab.id
             return
       # There is no existing matching tab, we'll have to create one.
-      chrome.tabs.create { url: @getBaseUrl(markInfo.url) }, (tab) =>
+      chrome.tabs.create { url: @getBaseUrl markInfo.url }, (tab) =>
         # Note. tabLoadedHandlers is defined in "main.coffee".  The handler below will be called when the tab
         # is loaded, its DOM is ready and it registers with the background page.
         tabLoadedHandlers[tab.id] = => @gotoPositionInTab extend markInfo, tabId: tab.id
-- 
cgit v1.2.3