gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-20 05:37:58 +01:00
Code Issues Projects Releases Wiki Activity

Document some more crap.

Browse Source
This commit is contained in:
Kris Maglione
2008-12-19 13:27:01 -05:00
parent 669043da71
commit 057d66ce65
17 changed files with 285 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
common/content/buffer.js
View File

@@ -26,8 +26,16 @@ 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 *****/
/** @scope modules */
const Point = new Struct("x", "y");
/**
* A class to manage the primary web content buffer. The name comes
* from vim's term, 'buffer', which signifies instances of open
* files.
* @instance buffer
*/
function Buffer() //{{{
{
////////////////////////////////////////////////////////////////////////////////
@@ -809,6 +817,10 @@ function Buffer() //{{{
return {
/**
* The alternative stylesheets for the current buffer. Only
* returns stylesheets for the 'screen' media type.
*/
get alternateStyleSheets()
{
let stylesheets = window.getAllStyleSheets(window.content);
@@ -818,9 +830,18 @@ function Buffer() //{{{
);
},
/**
* @property {Object} A map of page info sections to their
* content generating functions.
*/
get pageInfo() pageInfo,
// 0 if loading, 1 if loaded or 2 if load failed
/**
* Returns whether the buffer is loaded. Values may be:
* 0 - Loading.
* 1 - Fully loaded.
* 2 - Load failed.
*/
get loaded()
{
if (window.content.document.pageIsFullyLoaded !== undefined)
@@ -833,7 +854,10 @@ function Buffer() //{{{
window.content.document.pageIsFullyLoaded = value;
},
// used to keep track of the right field for "gi"
/**
* The last focused input field in the buffer. Used by the
* "gi" key binding.
*/
get lastInputField()
{
if (window.content.document.lastInputField)
@@ -846,6 +870,9 @@ function Buffer() //{{{
window.content.document.lastInputField = value;
},
/**
* The current top-level document's URL.
*/
get URL()
{
return window.content.document.location.href;
@@ -856,6 +883,10 @@ function Buffer() //{{{
return window.content.innerHeight;
},
/**
* The current browser's text zoom level, as a percentage with
* 100 as 'normal'. Only affects text size.
*/
get textZoom()
{
return getBrowser().markupDocumentViewer.textZoom * 100;
@@ -865,6 +896,11 @@ function Buffer() //{{{
setZoom(value, false);
},
/**
* The current browser's text zoom level, as a percentage with
* 100 as 'normal'. Affects text size, as well as image size
* and block size.
*/
get fullZoom()
{
return getBrowser().markupDocumentViewer.fullZoom * 100;
@@ -874,14 +910,37 @@ function Buffer() //{{{
setZoom(value, true);
},
/**
* The current document's title.
*/
get title()
{
return window.content.document.title;
},
/**
*
* @param {string} option The section's value in 'pageinfo'.
* @param {string} title The heading for this section's
* output.
* @param {function} fn The function to generate this
* section's output.
*/
addPageInfoSection: addPageInfoSection,
// returns an XPathResult object
/**
* Evaluates an XPath expression in the current or provided
* document. It provides the xhtml and liberator XML
* namespaces. The result may be used as an iterator.
*
* @param {string} expression The XPath expression to evaluate.
* @param {Document} doc The document to evaluate the expression in.
* @default The current document.
* @param {Node} elem The context element.
* @default <b>doc</b>
* @param {boolean} asIterator Whether to return the results as an XPath
* iterator.
*/
evaluateXPath: function (expression, doc, elem, asIterator)
{
if (!doc)
@@ -892,15 +951,10 @@ function Buffer() //{{{
let result = doc.evaluate(expression, elem,
function lookupNamespaceURI(prefix)
{
switch (prefix)
{
case "xhtml":
return "http://www.w3.org/1999/xhtml";
case "liberator":
return NS.uri;
default:
return null;
}
return {
xhtml: "http://www.w3.org/1999/xhtml",
liberator: NS.uri
}[prefix] || null;
},
asIterator ? XPathResult.ORDERED_NODE_ITERATOR_TYPE : XPathResult.ORDERED_NODE_SNAPSHOT_TYPE,
null
@@ -913,9 +967,13 @@ function Buffer() //{{{
return result;
},
// in contrast to vim, returns the selection if one is made,
// otherwise tries to guess the current word under the text cursor
// NOTE: might change the selection
/**
* Returns the currently selected word. If the selection is
* null, it tries to guess the word that the caret is
* positioned in.
*
* NOTE: might change the selection
*/
// FIXME: getSelection() doesn't always preserve line endings, see:
// https://www.mozdev.org/bugs/show_bug.cgi?id=19303
getCurrentWord: function ()
@@ -937,8 +995,13 @@ function Buffer() //{{{
return String(selection);
},
// more advanced than a simple elem.focus() as it also works for iframes
// and image maps
/**
* Focuses the given element. In contrast to a simple
* elem.focus() call, this function works for iframes and
* image maps.
*
* @param {Node} elem The element to focus.
*/
// TODO: merge with followLink()?
focusElement: function (elem)
{
@@ -963,6 +1026,17 @@ function Buffer() //{{{
elem.dispatchEvent(evt);
},
/**
* Try to guess links the like of "next" and "prev". Though it
* has a singularly horrendous name, it turns out to be quite
* useful.
*
* @param {string} rel The relationship to look for. Looks for
* links with matching @rel or @rev attributes, and,
* failing that, looks for an option named rel +
* "pattern", and finds the last link matching that
* RegExp.
*/
followDocumentRelationship: function (rel)
{
let regexps = options.get(rel + "pattern").values
@@ -1019,7 +1093,13 @@ function Buffer() //{{{
liberator.beep();
},
// artificially "clicks" a link in order to open it
/**
* Fakes a click on a link.
*
* @param {Node} elem The element to click.
* @param {number} where Where to open the link. See
* {@link liberator.open}.
*/
followLink: function (elem, where)
{
let doc = elem.ownerDocument;
@@ -1067,6 +1147,9 @@ function Buffer() //{{{
});
},
/**
* The current document's selection controller.
*/
get selectionController() getBrowser().docShell
.QueryInterface(Ci.nsIInterfaceRequestor)
.getInterface(Ci.nsISelectionDisplay)
@@ -1091,11 +1174,19 @@ function Buffer() //{{{
}
},
/**
* Scrolls to the bottom of the current buffer.
*/
scrollBottom: function ()
{
scrollToPercentiles(-1, 100);
},
/**
* Scrolls the window laterally <b>cols</b> columns.
*
* @param {number} cols The number of columns to scroll.
*/
scrollColumns: function (cols)
{
let win = findScrollableWindow();
@@ -1107,11 +1198,19 @@ function Buffer() //{{{
win.scrollBy(COL_WIDTH * cols, 0);
},
/**
* Scrolls the buffer to its rightmost position.
*/
scrollEnd: function ()
{
scrollToPercentiles(100, -1);
},
/**
* Scrolls the buffer vertically <b>lines</b> rows.
*
* @param {number} lines The number of lines to scroll.
*/
scrollLines: function (lines)
{
let win = findScrollableWindow();
@@ -1119,6 +1218,11 @@ function Buffer() //{{{
win.scrollByLines(lines);
},
/**
* Scrolls the buffer vertically <b>pages</b> pages.
*
* @param {number} pages The number of pages to scroll.
*/
scrollPages: function (pages)
{
let win = findScrollableWindow();
@@ -1140,6 +1244,9 @@ function Buffer() //{{{
win.scrollBy(0, win.innerHeight / 2 * direction);
},
/**
* Scrolls the current buffer vertically to <b>percentage</b>
*/
scrollToPercentile: function (percentage)
{
scrollToPercentiles(-1, percentage);
@@ -1156,11 +1263,17 @@ function Buffer() //{{{
content.scrollTo(x, y);
},
/**
* Scrolls the current buffer laterally to its leftmost.
*/
scrollStart: function ()
{
scrollToPercentiles(0, -1);
},
/**
* Scrolls the current buffer vertically to its top.
*/
scrollTop: function ()
{
scrollToPercentiles(-1, 0);
@@ -1322,6 +1435,9 @@ function Buffer() //{{{
//}}}
}; //}}}
/**
* @instance marks
*/
function Marks() //{{{
{
////////////////////////////////////////////////////////////////////////////////