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