modules/interactive.js

   1 /**
   2  * (C) Copyright 2007-2009 John J. Foerch
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  *
   5  * Use, modification, and distribution are subject to the terms specified in the
   6  * COPYING file.
   7 **/
   8
   9 require("utils.js");
  10
  11 var interactive_commands = new string_hashmap();
  12
  13 /**
  14  * name: string name of the command.
  15  *
  16  * doc: Documentation string, may be null.
  17  *
  18  * handler: A function to handle the command.
  19  *
  20  * The $prefix keyword, when true, means that the command
  21  * is a prefix-command.
  22  */
  23 define_keywords("$prefix", "$browser_object", "$prompt");
  24 function interactive (name, doc, handler) {
  25     keywords(arguments);
  26     var cmd = {
  27         name: name,
  28         handler: handler,
  29         browser_object: arguments.$browser_object,
  30         prefix: arguments.$prefix,
  31         doc: doc,
  32         shortdoc: get_shortdoc_string(doc),
  33         prompt: arguments.$prompt,
  34         source_code_reference: get_caller_source_code_reference() };
  35
  36     interactive_commands.put(name, cmd);
  37     return name;
  38 }
  39
  40 function interactive_error (str) {
  41     var e = new Error(str);
  42     e.__proto__ = interactive_error.prototype;
  43     return e;
  44 }
  45 interactive_error.prototype.__proto__ = Error.prototype;
  46
  47
  48 function interactive_context (buffer) {
  49     this.local = conkeror;
  50     this.buffer = buffer;
  51     if (buffer) {
  52         this.window = this.buffer.window;
  53         if (buffer.page) {
  54             this.local = buffer.page.local;
  55         } else {
  56             this.local = buffer.local;
  57         }
  58     }
  59 }
  60 interactive_context.prototype = {
  61
  62     get P () this.prefix_argument,
  63
  64     get p () univ_arg_to_number(this.prefix_argument),
  65
  66     set p (default_value) univ_arg_to_number(this.prefix_argument, default_value),
  67
  68     get minibuffer () this.window.minibuffer,
  69 };
  70
  71
  72 function handle_interactive_error (window, e) {
  73     if (! window)
  74         throw e;
  75     if (e instanceof interactive_error) {
  76         window.minibuffer.message(e.message);
  77     } else if (e instanceof abort) {
  78         window.minibuffer.message("Quit");
  79     } else {
  80         dump_error(e);
  81         window.minibuffer.message("call interactively: " + e);
  82     }
  83 }
  84
  85 function call_interactively (I, command) {
  86     var handler;
  87     var window = I.window;
  88
  89     if (typeof command == "function") {
  90         // Special interactive command
  91         command(I);
  92         yield co_return();
  93     }
  94
  95     var cmd = interactive_commands.get(command);
  96     if (!cmd) {
  97         handle_interactive_error(
  98             window,
  99             interactive_error("Invalid command: " + command));
 100         yield co_return();
 101     }
 102
 103     I.command = cmd;
 104
 105
 106     // if there was no interactive browser-object,
 107     // binding_browser_object becomes the default.
 108     if (I.browser_object == null) {
 109         I.browser_object = I.binding_browser_object;
 110     }
 111     // if the command's default browser object is a non-null literal,
 112     // it overrides an interactive browser-object, but not a binding
 113     // browser object.
 114     if (cmd.browser_object != null &&
 115         (! (cmd.browser_object instanceof browser_object_class)) &&
 116         (I.binding_browser_object == null))
 117     {
 118         I.browser_object = cmd.browser_object;
 119     }
 120     // if we still have no browser-object, look for a page-mode
 121     // default, or finally the command default.
 122     if (I.browser_object == null) {
 123         I.browser_object =
 124             (I.buffer && I.buffer.default_browser_object_classes[command]) ||
 125             cmd.browser_object;
 126     }
 127
 128     handler = cmd.handler;
 129
 130     try {
 131         while (typeof handler == "string") {
 132             let parent = interactive_commands.get(handler);
 133             handler = parent.handler;
 134             if (handler == command) {
 135                 throw (interactive_error("circular command alias, "+command));
 136             }
 137         }
 138
 139         try {
 140             yield handler(I);
 141         } catch (e) {
 142             handle_interactive_error(window, e);
 143         }
 144     } catch (e) {
 145         handle_interactive_error(window, e);
 146     }
 147 }
 148
 149
 150 function alternates () {
 151     let alts = Array.prototype.slice.call(arguments, 0);
 152     return function (I) {
 153         var index = 0;
 154         if (I.prefix_argument instanceof Array) {
 155             let num = I.prefix_argument = I.prefix_argument[0];
 156             while (num >= 4 && index + 1 < alts.length) {
 157                 num = num / 4;
 158                 index++;
 159             }
 160         }
 161         yield alts[index](I);
 162     };
 163 }
 164
 165
 166 /*
 167  * Utility functions for use in the rc to alter the behavior
 168  * of interactive commands.
 169  */
 170 function set_handler (name, handler) {
 171     var cmd = interactive_commands.get(name);
 172     cmd.handler = handler;
 173 }
 174
 175 function set_default_browser_object (name, browser_object) {
 176     var cmd = interactive_commands.get(name);
 177     cmd.browser_object = browser_object;
 178 }
 179