aboutsummaryrefslogtreecommitdiff
path: root/tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js')
-rw-r--r--tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js169
1 files changed, 0 insertions, 169 deletions
diff --git a/tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js b/tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js
deleted file mode 100644
index ebbc340..0000000
--- a/tools/addon-sdk-1.5/packages/api-utils/lib/content/loader.js
+++ /dev/null
@@ -1,169 +0,0 @@
-/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
-/* vim:set ts=2 sw=2 sts=2 et: */
-/* This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
-
-"use strict";
-
-const { EventEmitter } = require('../events');
-const { validateOptions, getTypeOf } = require('../api-utils');
-const { URL } = require('../url');
-const file = require('../file');
-
-// map of property validations
-const valid = {
- contentURL: {
- ok: function (value) {
- try {
- URL(value);
- }
- catch(e) {
- return false;
- }
- return true;
- },
- msg: 'The `contentURL` option must be a valid URL.'
- },
- contentScriptFile: {
- is: ['undefined', 'null', 'string', 'array'],
- map: function(value) 'undefined' === getTypeOf(value) ? null : value,
- ok: function(value) {
- if (getTypeOf(value) === 'array') {
- // Make sure every item is a local file URL.
- return value.every(function (item) {
- try {
- return URL(item).scheme === 'resource'
- }
- catch(e) {
- return false;
- }
- });
- }
- return true;
- },
- msg: 'The `contentScriptFile` option must be a local URL or an array of'
- + 'URLs.'
- },
- contentScript: {
- is: ['undefined', 'null', 'string', 'array'],
- map: function(value) 'undefined' === getTypeOf(value) ? null : value,
- ok: function(value) 'array' !== getTypeOf(value) ? true :
- value.every(function(item) 'string' === getTypeOf(item))
- ,
- msg: 'The `contentScript` option must be a string or an array of strings.'
- },
- contentScriptWhen: {
- is: ['string'],
- ok: function(value) ['start', 'ready', 'end'].indexOf(value) >= 0,
- map: function(value) {
- return value || 'end';
- },
- msg: 'The `contentScriptWhen` option must be either "start", "ready" or "end".'
- }
-};
-exports.validationAttributes = valid;
-
-/**
- * Shortcut function to validate property with validation.
- * @param {Object|Number|String} suspect
- * value to validate
- * @param {Object} validation
- * validation rule passed to `api-utils`
- */
-function validate(suspect, validation) validateOptions(
- { $: suspect },
- { $: validation }
-).$
-
-function Allow(script) ({
- get script() script,
- set script(value) script = !!value
-})
-
-/**
- * Trait is intended to be used in some composition. It provides set of core
- * properties and bounded validations to them. Trait is useful for all the
- * compositions providing high level APIs for interaction with content.
- * Property changes emit `"propertyChange"` events on instances.
- */
-const Loader = EventEmitter.compose({
- /**
- * Permissions for the content, with the following keys:
- * @property {Object} [allow = { script: true }]
- * @property {Boolean} [allow.script = true]
- * Whether or not to execute script in the content. Defaults to true.
- */
- get allow() this._allow || (this._allow = Allow(true)),
- set allow(value) this.allow.script = value && value.script,
- _allow: null,
- /**
- * The content to load. Either a string of HTML or a URL.
- * @type {String}
- */
- get contentURL() this._contentURL,
- set contentURL(value) {
- value = validate(value, valid.contentURL);
- if (this._contentURL != value) {
- this._emit('propertyChange', {
- contentURL: this._contentURL = value
- });
- }
- },
- _contentURL: null,
- /**
- * When to load the content scripts.
- * Possible values are "end" (default), which loads them once all page
- * contents have been loaded, "ready", which loads them once DOM nodes are
- * ready (ie like DOMContentLoaded event), and "start", which loads them once
- * the `window` object for the page has been created, but before any scripts
- * specified by the page have been loaded.
- * Property change emits `propertyChange` event on instance with this key
- * and new value.
- * @type {'start'|'ready'|'end'}
- */
- get contentScriptWhen() this._contentScriptWhen,
- set contentScriptWhen(value) {
- value = validate(value, valid.contentScriptWhen);
- if (value !== this._contentScriptWhen) {
- this._emit('propertyChange', {
- contentScriptWhen: this._contentScriptWhen = value
- });
- }
- },
- _contentScriptWhen: 'end',
- /**
- * The URLs of content scripts.
- * Property change emits `propertyChange` event on instance with this key
- * and new value.
- * @type {String[]}
- */
- get contentScriptFile() this._contentScriptFile,
- set contentScriptFile(value) {
- value = validate(value, valid.contentScriptFile);
- if (value != this._contentScriptFile) {
- this._emit('propertyChange', {
- contentScriptFile: this._contentScriptFile = value
- });
- }
- },
- _contentScriptFile: null,
- /**
- * The texts of content script.
- * Property change emits `propertyChange` event on instance with this key
- * and new value.
- * @type {String|undefined}
- */
- get contentScript() this._contentScript,
- set contentScript(value) {
- value = validate(value, valid.contentScript);
- if (value != this._contentScript) {
- this._emit('propertyChange', {
- contentScript: this._contentScript = value
- });
- }
- },
- _contentScript: null
-});
-exports.Loader = Loader;
-