docs/bootstrap.html

   1 <!DOCTYPE html>  <html> <head>   <title>bootstrap.coffee</title>   <meta http-equiv="content-type" content="text/html; charset=UTF-8">   <link rel="stylesheet" media="all" href="docco.css" /> </head> <body>   <div id="container">     <div id="background"></div>            <div id="jump_to">         Jump To &hellip;         <div id="jump_wrapper">           <div id="jump_page">                                           <a class="source" href="bootstrap.html">                 bootstrap.coffee               </a>                                           <a class="source" href="chrome.html">                 chrome.coffee               </a>                                           <a class="source" href="console.html">                 console.coffee               </a>                                           <a class="source" href="unload.html">                 unload.coffee               </a>                                           <a class="source" href="window-utils.html">                 window-utils.coffee               </a>                                           <a class="source" href="button.html">                 button.coffee               </a>                                           <a class="source" href="commands.html">                 commands.coffee               </a>                                           <a class="source" href="events.html">                 events.coffee               </a>                                           <a class="source" href="help.html">                 help.coffee               </a>                                           <a class="source" href="hints.html">                 hints.coffee               </a>                                           <a class="source" href="marker.html">                 marker.coffee               </a>                                           <a class="source" href="prefs.html">                 prefs.coffee               </a>                                           <a class="source" href="utils.html">                 utils.coffee               </a>                                           <a class="source" href="vim.html">                 vim.coffee               </a>                        </div>         </div>       </div>          <table cellpadding="0" cellspacing="0">       <thead>         <tr>           <th class="docs">             <h1>               bootstrap.coffee             </h1>           </th>           <th class="code">           </th>         </tr>       </thead>       <tbody>                               <tr id="section-1">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-1">&#182;</a>               </div>                            </td>             <td class="code">               <div class="highlight"><pre><span class="s">&quot;use strict&quot;</span>
   2
   3 <span class="p">{</span> <span class="nv">utils: </span><span class="nx">Cu</span> <span class="p">}</span> <span class="o">=</span> <span class="nx">Components</span>
   4
   5 <span class="nx">Cu</span><span class="p">.</span><span class="nx">import</span> <span class="s">&quot;resource://gre/modules/Services.jsm&quot;</span>
   6 <span class="nx">Cu</span><span class="p">.</span><span class="nx">import</span> <span class="s">&quot;resource://gre/modules/AddonManager.jsm&quot;</span></pre></div>             </td>           </tr>                               <tr id="section-2">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-2">&#182;</a>               </div>               <p>Populate the global namespace with console, require, and include</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nx">do</span> <span class="nf">(global = this) -&gt;</span>
   7   <span class="nv">baseURI = </span><span class="nx">Services</span><span class="p">.</span><span class="nx">io</span><span class="p">.</span><span class="nx">newURI</span> <span class="nx">__SCRIPT_URI_SPEC__</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="kc">null</span>
   8   <span class="nv">getResourceURI = </span><span class="nf">(path) -&gt;</span> <span class="nx">Services</span><span class="p">.</span><span class="nx">io</span><span class="p">.</span><span class="nx">newURI</span> <span class="nx">path</span><span class="p">,</span> <span class="kc">null</span><span class="p">,</span> <span class="nx">baseURI</span>
   9
  10   <span class="nv">include = </span><span class="nf">(src, scope = {}) -&gt;</span>
  11     <span class="k">try</span>
  12       <span class="nv">uri = </span><span class="nx">getResourceURI</span> <span class="s">&quot;packages/</span><span class="si">#{</span> <span class="nx">src</span> <span class="si">}</span><span class="s">.js&quot;</span>
  13       <span class="nx">Services</span><span class="p">.</span><span class="nx">scriptloader</span><span class="p">.</span><span class="nx">loadSubScript</span> <span class="nx">uri</span><span class="p">.</span><span class="nx">spec</span><span class="p">,</span> <span class="nx">scope</span>
  14     <span class="k">catch</span> <span class="nx">error</span>
  15       <span class="nv">uri = </span><span class="nx">getResourceURI</span> <span class="nx">src</span>
  16       <span class="nx">Services</span><span class="p">.</span><span class="nx">scriptloader</span><span class="p">.</span><span class="nx">loadSubScript</span> <span class="nx">uri</span><span class="p">.</span><span class="nx">spec</span><span class="p">,</span> <span class="nx">scope</span>
  17
  18     <span class="k">return</span> <span class="nx">scope</span>
  19
  20
  21   <span class="nv">modules = </span><span class="p">{}</span>
  22   <span class="nv">require = </span><span class="nf">(src) -&gt;</span>
  23     <span class="k">if</span> <span class="nx">modules</span><span class="p">[</span><span class="nx">src</span><span class="p">]</span>
  24       <span class="k">return</span> <span class="nx">modules</span><span class="p">[</span><span class="nx">src</span><span class="p">]</span>
  25     <span class="k">else</span>
  26       <span class="nv">scope = </span>
  27         <span class="nv">require: </span><span class="nx">require</span>
  28         <span class="nv">include: </span><span class="nx">include</span>
  29         <span class="nv">exports: </span><span class="p">{}</span>
  30
  31       <span class="nx">include</span> <span class="nx">src</span><span class="p">,</span> <span class="nx">scope</span>
  32
  33       <span class="k">return</span> <span class="nx">modules</span><span class="p">[</span><span class="nx">src</span><span class="p">]</span> <span class="o">=</span> <span class="nx">scope</span><span class="p">.</span><span class="nx">exports</span><span class="p">;</span>
  34
  35   <span class="nv">global.include = </span><span class="nx">include</span>
  36   <span class="nv">global.require = </span><span class="nx">require</span>
  37   <span class="nv">global.getResourceURI = </span><span class="nx">getResourceURI</span></pre></div>             </td>           </tr>                               <tr id="section-3">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-3">&#182;</a>               </div>               <p>Include into global scope</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nx">include</span><span class="p">(</span><span class="s">&quot;includes/</span><span class="si">#{</span> <span class="nx">name</span> <span class="si">}</span><span class="s">.js&quot;</span><span class="p">,</span> <span class="k">this</span><span class="p">)</span> <span class="k">for</span> <span class="nx">name</span> <span class="k">in</span> <span class="p">[</span>
  38   <span class="s">&#39;chrome&#39;</span><span class="p">,</span>
  39   <span class="s">&#39;console&#39;</span><span class="p">,</span>
  40   <span class="s">&#39;unload&#39;</span><span class="p">,</span>
  41   <span class="s">&#39;window-utils&#39;</span><span class="p">,</span>
  42 <span class="p">]</span>
  43
  44 <span class="p">{</span> <span class="nx">loadCss</span> <span class="p">}</span>             <span class="o">=</span> <span class="nx">require</span> <span class="s">&#39;utils&#39;</span>
  45 <span class="p">{</span> <span class="nx">addEventListeners</span> <span class="p">}</span>   <span class="o">=</span> <span class="nx">require</span> <span class="s">&#39;events&#39;</span>
  46 <span class="p">{</span> <span class="nx">getPref</span>
  47 <span class="p">,</span> <span class="nx">installPrefObserver</span> <span class="p">}</span> <span class="o">=</span> <span class="nx">require</span> <span class="s">&#39;prefs&#39;</span>
  48 <span class="p">{</span> <span class="nx">setButtonDefaultPosition</span>
  49 <span class="p">,</span> <span class="nx">addToolbarButton</span> <span class="p">}</span>    <span class="o">=</span> <span class="nx">require</span> <span class="s">&#39;button&#39;</span></pre></div>             </td>           </tr>                               <tr id="section-4">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-4">&#182;</a>               </div>               <p>Firefox will call this method on startup/enabling</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">startup = </span><span class="nf">(data, reason) -&gt;</span>
  50   <span class="k">if</span> <span class="nv">reason = </span><span class="nx">ADDON_INSTALL</span>
  51     <span class="nx">setButtonDefaultPosition</span> <span class="nx">getPref</span><span class="p">(</span><span class="s">&#39;button_id&#39;</span><span class="p">),</span> <span class="s">&#39;nav-bar&#39;</span><span class="p">,</span> <span class="s">&#39;bookmarks-menu-button-container&#39;</span>
  52
  53   <span class="nx">loadCss</span> <span class="s">&#39;style&#39;</span>
  54   <span class="nx">watchWindows</span> <span class="nx">addEventListeners</span><span class="p">,</span> <span class="s">&#39;navigator:browser&#39;</span>
  55   <span class="nx">watchWindows</span> <span class="nx">addToolbarButton</span><span class="p">,</span> <span class="s">&#39;navigator:browser&#39;</span>
  56   <span class="nx">installPrefObserver</span><span class="p">()</span></pre></div>             </td>           </tr>                               <tr id="section-5">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-5">&#182;</a>               </div>               <p>Firefox will call this method on shutdown/disabling</p>             </td>             <td class="code">               <div class="highlight"><pre><span class="nv">shutdown = </span><span class="nf">(data, reason) -&gt;</span></pre></div>             </td>           </tr>                               <tr id="section-6">             <td class="docs">               <div class="pilwrap">                 <a class="pilcrow" href="#section-6">&#182;</a>               </div>               <p>Don't bother to clean up if the browser is shutting down</p>             </td>             <td class="code">               <div class="highlight"><pre>  <span class="k">if</span> <span class="nx">reason</span> <span class="o">!=</span> <span class="nx">APP_SHUTDOWN</span>
  57     <span class="nx">unload</span><span class="p">()</span>
  58
  59 </pre></div>             </td>           </tr>                </tbody>     </table>   </div> </body> </html>