aboutsummaryrefslogtreecommitdiffstats
path: root/xpathBlink.js
blob: 1f950a9ad0632d48c701fb7f3aaa94371f92755c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
let INFO =
<plugin name="xpathBlink" version="1.1.1"
        href="http://svn.coderepos.org/share/lang/javascript/vimperator-plugins/trunk/xpathBlink.js"
        summary="blink elements by XPath"
        xmlns="http://vimperator.org/namespaces/liberator">
    <author email="teramako@gmail.com">teramako</author>
    <license href="http://www.mozilla.org/MPL/MPL-1.1.txt">MPL 1.1</license>
    <project name="Vimperator" minVersion="2.2"/>
    <p>
        For test XPath.
    </p>
    <p>CAUTION: This plugin needs "DOM Inspector" addon.</p>
    <item>
        <tags>:xpathb :xpathblink</tags>
        <spec>:xpathb<oa>link</oa> <a>expression</a></spec>
        <description>
            <p>
                blink specified elements with XPath <a>expression</a>
            </p>
        </description>
    </item>
</plugin>;

let PLUGIN_INFO =
<VimperatorPlugin>
<name>{NAME}</name>
<description>blink elements by XPath</description>
<author mail="teramako@gmail.com" homepage="http://vimperator.g.hatena.ne.jp/teramako/">teramako</author>
<require type="extension" id="inspector@mozilla.org">DOM Inspector</require>
<license>MPL 1.1</license>
<version>1.1.1</version>
<minVersion>2.2</minVersion>
<maxVersion>2.3</maxVersion>
<updateURL>http://svn.coderepos.org/share/lang/javascript/vimperator-plugins/trunk/xpathBlink.js</updateURL>
<detail><![CDATA[
for test xpath

== Usage==
:xpathb[link] {expression}:
:xb {expression}
    blink specified elements with XPath {expression} 

== Caution ==
It's need "DOM Inspector" addon
]]></detail>
</VimperatorPlugin>;

(function(){
let extid = "inspector@mozilla.org";
if (!Application.extensions.has(extid) || !Application.extensions.get(extid).enabled){
    liberator.echomsg("DOM Inspector is not installed or enabled", 2);
    return;
}
let flasher = null;
function getFlasher(){
	if (!flasher){
		flasher = Cc['@mozilla.org/inspector/flasher;1'].createInstance(Ci.inIFlasher);
		flasher.color = '#FF0000';
		flasher.thickness = 2;
	}
	return flasher;
}
/**
 * @param {Node} aNode
 */
function blink(aNode){
	if (aNode.nodeType == 3) aNode = aNode.parentNode;
	let toggle = true;
	let flasher = getFlasher();
	function setOutline(){
		if (toggle){
			flasher.drawElementOutline(aNode);
		} else {
			flasher.repaintElement(aNode);
		}
		toggle = !toggle;
	}
	for (let i=1; i<7; ++i){
		setTimeout(setOutline, i * 100);
	}
}
commands.addUserCommand(['xpathb[link]','xb'],'XPath blink nodes',
	function(expression){
		let result;
		try {
			result = util.evaluateXPath(expression.string);
		} catch(e) {
			liberator.echoerr('XPath blink: ' + e);
		}
		if (!result.snapshotLength){
			liberator.echo('XPath blink: none');
			return;
		}
		for (let i=0; i<result.snapshotLength; i++){
			blink(result.snapshotItem(i));
		}
	},{}
);
})();

// vim: set fdm=marker sw=4 ts=4 et:
#n442'>442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
/* ***** BEGIN LICENSE BLOCK ***** {{{
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Spatial Navigation.
 *
 * The Initial Developer of the Original Code is Mozilla Corporation
 * Portions created by the Initial Developer are Copyright (C) 2008
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Doug Turner <dougt@meer.net>  (Original Author)
 *  anekos <anekos@snca.net>  (Vimperator plugin version Author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** }}} */

/* Original version is "SpatialNavigation.js" of Firefox. */

// PLUGIN_INFO {{{
let PLUGIN_INFO =
<VimperatorPlugin>
  <name>Spatial Navigation</name>
  <name lang="ja">空間ナビゲーション</name>
  <description>Spatial Navigation</description>
  <description lang="ja">空間ナビゲーション</description>
  <version>1.0.0</version>
  <updateURL>https://github.com/vimpr/vimperator-plugins/raw/master/spatial-navigation.js</updateURL>
  <minVersion>2.3</minVersion>
  <maxVersion>2.3</maxVersion>
  <detail><![CDATA[
    Read the help. (:help SpatialNavigation-plugin)
  ]]></detail>
  <detail lang="ja"><![CDATA[
    Read the help. (:help SpatialNavigation-plugin)
  ]]></detail>
</VimperatorPlugin>;
// }}}
// INFO {{{
let INFO =
<>
  <plugin name="SpatialNavigation" version="1.0.0"
          href="http://svn.coderepos.org/share/lang/javascript/vimperator-plugins/trunk/spatial-navigation.js"
          summary="Spatial navigation"
          lang="en-US"
          xmlns="http://vimperator.org/namespaces/liberator">
    <project name="Vimperator" minVersion="2.3"/>
    <item>
      <tags>g:spatial_navigation_mappings</tags>
      <spec>let g:spatial_navigation_mappings=<a>keys</a></spec>
      <description>
        <p>
        </p>
        <code><ex>
let g:spatial_navigation_mappings="&lt;A-h> &lt;A-j> &lt;A-k> &lt;A-l>"
        </ex></code>
      </description>
    </item>
  </plugin>
  <plugin name="SpatialNavigation" version="1.0.0"
          href="http://svn.coderepos.org/share/lang/javascript/vimperator-plugins/trunk/spatial-navigation.js"
          summary="空間ナビゲーション"
          lang="ja"
          xmlns="http://vimperator.org/namespaces/liberator">
    <project name="Vimperator" minVersion="2.3"/>
    <item>
      <tags>g:spatial_navigation_mappings</tags>
      <spec>let g:spatial_navigation_mappings=<a>keys</a></spec>
      <description>
        <p>
        </p>
        <code><ex>
let g:spatial_navigation_mappings="&lt;A-h> &lt;A-j> &lt;A-k> &lt;A-l>"
        </ex></code>
      </description>
    </item>
  </plugin>
</>;
// }}}


(function () {

  // constant {{{

  const DIR = {L: 1, D: 2, U: 3, R: 4};
  const gDirectionalBias = 10;
  const gRectFudge = 1;

  // }}}

  // Functions {{{

  function getFocusedElement ()
    window.document.commandDispatcher.focusedElement;

  function flashFocusedElement () {
    const flasher =
      let (f = Cc['@mozilla.org/inspector/flasher;1'].createInstance(Ci.inIFlasher))
        (f.color = '#FF0000', f.thickness = 2, f);

    let elem = getFocusedElement();
    if (!elem)
      return;

    setTimeout(
      function () {
        flasher.drawElementOutline(elem);
        elem.addEventListener(
          'blur',
          function () {
            elem.removeEventListener(arguments.callee);
            flasher.repaintElement(elem);
          },
          false
        );
      },
      0
    );
  }

  function focusElement (elem) {
    // doc.defaultView.QueryInterface(Ci.nsIInterfaceRequestor).getInterface(Ci.nsIDOMWindowUtils).focus(bestElementToFocus);
    elem.focus();
    flashFocusedElement();
  }

  function defaultMove (dir) {
    if (dir === DIR.R || dir === DIR.D) {
      window.document.commandDispatcher.advanceFocus();
    } else {
      window.document.commandDispatcher.rewindFocus();
    }
    flashFocusedElement();
  }

  function move (dir, target) {
    // Subs {{{
    function isRectInDirection (dir, focusedRect, anotherRect) {
      switch (dir) {
        case DIR.L:
          return anotherRect.left < focusedRect.left;
        case DIR.R:
          return anotherRect.right > focusedRect.right;
        case DIR.U:
          return anotherRect.top < focusedRect.top;
        case DIR.D:
          return anotherRect.bottom > focusedRect.bottom
      }
      return false;
    }

    function inflateRect (rect, value) ({
      left: rect.left - value,
      top: rect.top - value,
      right: rect.right  + value,
      bottom: rect.bottom + value
    });

    function containsRect (a, b)
      ((b.left <= a.right) && (b.right >= a.left) && (b.top <= a.bottom) && (b.bottom >= a.top));

    function spatialDistance (dir, a, b) {
      let inlineNavigation = false;
      let mx, my, nx, ny;

      if (dir === DIR.L) {
        //  |---|
        //  |---|
        //
        //  |---|  |---|
        //  |---|  |---|
        //
        //  |---|
        //  |---|
        if (a.top > b.bottom) {
          // the b rect is above a.
          mx = a.left;
          my = a.top;
          nx = b.right;
          ny = b.bottom;
        } else if (a.bottom < b.top) {
          // the b rect is below a.
          mx = a.left;
          my = a.bottom;
          nx = b.right;
          ny = b.top;
        } else {
          mx = a.left;
          my = 0;
          nx = b.right;
          ny = 0;
        }
      } else if (dir === DIR.R) {
        //         |---|
        //         |---|
        //
        //  |---|  |---|
        //  |---|  |---|
        //
        //         |---|
        //         |---|
        if (a.top > b.bottom) {
          // the b rect is above a.
          mx = a.right;
          my = a.top;
          nx = b.left;
          ny = b.bottom;
        } else if (a.bottom < b.top) {
          // the b rect is below a.
          mx = a.right;
          my = a.bottom;
          nx = b.left;
          ny = b.top;
        } else {
          mx = a.right;
          my = 0;
          nx = b.left;
          ny = 0;
        }
      } else if (dir === DIR.U) {
        //  |---|  |---|  |---|
        //  |---|  |---|  |---|
        //
        //         |---|
        //         |---|
        if (a.left > b.right) {
          // the b rect is to the left of a.
          mx = a.left;
          my = a.top;
          nx = b.right;
          ny = b.bottom;
        } else if (a.right < b.left) {
          // the b rect is to the right of a
          mx = a.right;
          my = a.top;
          nx = b.left;
          ny = b.bottom;
        } else {
          // both b and a share some common x's.
          mx = 0;
          my = a.top;
          nx = 0;
          ny = b.bottom;
        }
      } else if (dir === DIR.D) {
        //         |---|
        //         |---|
        //
        //  |---|  |---|  |---|
        //  |---|  |---|  |---|
        if (a.left > b.right) {
          // the b rect is to the left of a.
          mx = a.left;
          my = a.bottom;
          nx = b.right;
          ny = b.top;
        } else if (a.right < b.left) {
          // the b rect is to the right of a
          mx = a.right;
          my = a.bottom;
          nx = b.left;
          ny = b.top;
        } else {
          // both b and a share some common x's.
          mx = 0;
          my = a.bottom;
          nx = 0;
          ny = b.top;
        }
      }

      let scopedRect = inflateRect(a, gRectFudge);

      if (dir === DIR.L || dir === DIR.R) {
        scopedRect.left = 0;
        scopedRect.right = Infinity;
        inlineNavigation = containsRect(scopedRect, b);
      } else if (dir === DIR.U || dir === DIR.D) {
        scopedRect.top = 0;
        scopedRect.bottom = Infinity;
        inlineNavigation = containsRect(scopedRect, b);
      }

      let d = Math.pow((mx - nx), 2) + Math.pow((my - ny), 2);

      // prefer elements directly aligned with the focused element
      if (inlineNavigation)
        d /= gDirectionalBias;

      return d;
    }
    // }}}

    let doc = target.ownerDocument;

    if (doc instanceof Ci.nsIDOMXULDocument)
      return ;

    // XXX いらないかも
    if (
      (target instanceof Ci.nsIDOMHTMLInputElement && (target.type == "text" || target.type == "password"))
      ||
      target instanceof Ci.nsIDOMHTMLTextAreaElement
    ) {

      // if there is any selection at all, just ignore
      if (target.selectionEnd - target.selectionStart > 0)
        return;

      // if there is no text, there is nothing special to do.
      if (target.textLength > 0) {
        if (dir === DIR.R || dir === DIR.D) {
          // we are moving forward into the document
          if (target.textLength != target.selectionEnd)
            return;
        } else {
          // we are at the start of the text, okay to move
          if (target.selectionStart != 0)
            return;
        }
      }
    }

    // Check to see if we are in a select
    if (target instanceof Ci.nsIDOMHTMLSelectElement) {
      if (dir === DIR.D) {
        if (target.selectedIndex + 1 < target.length)
          return;
      }

      if (dir === DIR.U) {
        if (target.selectedIndex > 0)
          return;
      }
    }

    function snavfilter (node) {
      if (node instanceof Ci.nsIDOMHTMLLinkElement || node instanceof Ci.nsIDOMHTMLAnchorElement) {
        // if a anchor doesn't have a href, don't target it.
        if (node.href == "")
          return Ci.nsIDOMNodeFilter.FILTER_SKIP;
        return  Ci.nsIDOMNodeFilter.FILTER_ACCEPT;
      }
      if (
        (node instanceof Ci.nsIDOMHTMLButtonElement ||
         node instanceof Ci.nsIDOMHTMLLinkElement ||
         node instanceof Ci.nsIDOMHTMLOptGroupElement ||
         node instanceof Ci.nsIDOMHTMLSelectElement)
        &&
        !node.disabled
      )
        return Ci.nsIDOMNodeFilter.FILTER_ACCEPT;
      return Ci.nsIDOMNodeFilter.FILTER_SKIP;
    }

    let bestElementToFocus = null;
    let distanceToBestElement = Infinity;
    let focusedRect = inflateRect(target.getBoundingClientRect(), -gRectFudge);

    let treeWalker = doc.createTreeWalker(doc, Ci.nsIDOMNodeFilter.SHOW_ELEMENT, snavfilter, false);
    let nextNode;

    while (nextNode = treeWalker.nextNode()) {
      if (nextNode == target)
        continue;

      let nextRect = inflateRect(nextNode.getBoundingClientRect(), -gRectFudge);
      if (!isRectInDirection(dir, focusedRect, nextRect))
        continue;

      let distance = spatialDistance(dir, focusedRect, nextRect);
      if (distance <= distanceToBestElement && distance > 0) {
        distanceToBestElement = distance;
        bestElementToFocus = nextNode;
      }
    }

    if (bestElementToFocus != null) {
      // Wishing we could do element.focus()
      focusElement(bestElementToFocus);

      // if it is a text element, select all.
      if (
        (bestElementToFocus instanceof Ci.nsIDOMHTMLInputElement &&
         (bestElementToFocus.type == "text" || bestElementToFocus.type == "password"))
        ||
        bestElementToFocus instanceof Ci.nsIDOMHTMLTextAreaElement
      ) {
        bestElementToFocus.selectionStart = 0;
        bestElementToFocus.selectionEnd = bestElementToFocus.textLength;
      }

    } else {
      // couldn't find anything.  just advance and hope.
      // XXX XUL をフォーカスしてしまう場合があるので、とりあえずコメントアウト
      // defaultMove(dir);
    }

  }

  // }}}

  // Export API {{{

  __context__.API = {
    DIR: DIR,
    move: function (dir, target) {
      if (!target)
        target = getFocusedElement();
      if (typeof dir === 'string')
        dir = DIR[dir.slice(0, 1).toUpperCase()];
      return (target ? move : defaultMove)(dir, target);
    }
  };

  // }}}

  // Define mappings {{{

  {
    let ms =
      (
        liberator.globalVariables.spatial_navigation_mappings
        ||
        '<A-h> <A-j> <A-k> <A-l>'
      ).split(/\s+/);

    [
      DIR.L,
      DIR.D,
      DIR.U,
      DIR.R
    ].forEach(
      function (dir, index) {
        mappings.addUserMap(
          [modes.NORMAL],
          [ms[index]],
          'Spatial Navigation',
          function () {
            let (target = getFocusedElement())
              (target ? move : defaultMove)(dir, target);
          },
          {}
        )
      }
    );
  }

  // }}}

})();

// vim:sw=2 ts=2 et si fdm=marker: