selenium-webdriver
Version:
The official WebDriver JavaScript bindings from the Selenium project
1 lines • 14.6 kB
HTML
<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>entrypointregistry.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article class="srcfile"><h1>lib/goog/debug/entrypointregistry.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2010 The Closure Library Authors. All Rights Reserved.<tr><td><a id="l2"></a><a href="#l2">2</a><td>//<tr><td><a id="l3"></a><a href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a id="l4"></a><a href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a id="l5"></a><a href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a id="l6"></a><a href="#l6">6</a><td>//<tr><td><a id="l7"></a><a href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a id="l10"></a><a href="#l10">10</a><td>// distributed under the License is distributed on an "AS-IS" BASIS,<tr><td><a id="l11"></a><a href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a id="l12"></a><a href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a id="l13"></a><a href="#l13">13</a><td>// limitations under the License.<tr><td><a id="l14"></a><a href="#l14">14</a><td><tr><td><a id="l15"></a><a href="#l15">15</a><td>/**<tr><td><a id="l16"></a><a href="#l16">16</a><td> * @fileoverview A global registry for entry points into a program,<tr><td><a id="l17"></a><a href="#l17">17</a><td> * so that they can be instrumented. Each module should register their<tr><td><a id="l18"></a><a href="#l18">18</a><td> * entry points with this registry. Designed to be compiled out<tr><td><a id="l19"></a><a href="#l19">19</a><td> * if no instrumentation is requested.<tr><td><a id="l20"></a><a href="#l20">20</a><td> *<tr><td><a id="l21"></a><a href="#l21">21</a><td> * Entry points may be registered before or after a call to<tr><td><a id="l22"></a><a href="#l22">22</a><td> * goog.debug.entryPointRegistry.monitorAll. If an entry point is registered<tr><td><a id="l23"></a><a href="#l23">23</a><td> * later, the existing monitor will instrument the new entry point.<tr><td><a id="l24"></a><a href="#l24">24</a><td> *<tr><td><a id="l25"></a><a href="#l25">25</a><td> * @author nicksantos@google.com (Nick Santos)<tr><td><a id="l26"></a><a href="#l26">26</a><td> */<tr><td><a id="l27"></a><a href="#l27">27</a><td><tr><td><a id="l28"></a><a href="#l28">28</a><td>goog.provide('goog.debug.EntryPointMonitor');<tr><td><a id="l29"></a><a href="#l29">29</a><td>goog.provide('goog.debug.entryPointRegistry');<tr><td><a id="l30"></a><a href="#l30">30</a><td><tr><td><a id="l31"></a><a href="#l31">31</a><td>goog.require('goog.asserts');<tr><td><a id="l32"></a><a href="#l32">32</a><td><tr><td><a id="l33"></a><a href="#l33">33</a><td><tr><td><a id="l34"></a><a href="#l34">34</a><td><tr><td><a id="l35"></a><a href="#l35">35</a><td>/**<tr><td><a id="l36"></a><a href="#l36">36</a><td> * @interface<tr><td><a id="l37"></a><a href="#l37">37</a><td> */<tr><td><a id="l38"></a><a href="#l38">38</a><td>goog.debug.EntryPointMonitor = function() {};<tr><td><a id="l39"></a><a href="#l39">39</a><td><tr><td><a id="l40"></a><a href="#l40">40</a><td><tr><td><a id="l41"></a><a href="#l41">41</a><td>/**<tr><td><a id="l42"></a><a href="#l42">42</a><td> * Instruments a function.<tr><td><a id="l43"></a><a href="#l43">43</a><td> *<tr><td><a id="l44"></a><a href="#l44">44</a><td> * @param {!Function} fn A function to instrument.<tr><td><a id="l45"></a><a href="#l45">45</a><td> * @return {!Function} The instrumented function.<tr><td><a id="l46"></a><a href="#l46">46</a><td> */<tr><td><a id="l47"></a><a href="#l47">47</a><td>goog.debug.EntryPointMonitor.prototype.wrap;<tr><td><a id="l48"></a><a href="#l48">48</a><td><tr><td><a id="l49"></a><a href="#l49">49</a><td><tr><td><a id="l50"></a><a href="#l50">50</a><td>/**<tr><td><a id="l51"></a><a href="#l51">51</a><td> * Try to remove an instrumentation wrapper created by this monitor.<tr><td><a id="l52"></a><a href="#l52">52</a><td> * If the function passed to unwrap is not a wrapper created by this<tr><td><a id="l53"></a><a href="#l53">53</a><td> * monitor, then we will do nothing.<tr><td><a id="l54"></a><a href="#l54">54</a><td> *<tr><td><a id="l55"></a><a href="#l55">55</a><td> * Notice that some wrappers may not be unwrappable. For example, if other<tr><td><a id="l56"></a><a href="#l56">56</a><td> * monitors have applied their own wrappers, then it will be impossible to<tr><td><a id="l57"></a><a href="#l57">57</a><td> * unwrap them because their wrappers will have captured our wrapper.<tr><td><a id="l58"></a><a href="#l58">58</a><td> *<tr><td><a id="l59"></a><a href="#l59">59</a><td> * So it is important that entry points are unwrapped in the reverse<tr><td><a id="l60"></a><a href="#l60">60</a><td> * order that they were wrapped.<tr><td><a id="l61"></a><a href="#l61">61</a><td> *<tr><td><a id="l62"></a><a href="#l62">62</a><td> * @param {!Function} fn A function to unwrap.<tr><td><a id="l63"></a><a href="#l63">63</a><td> * @return {!Function} The unwrapped function, or {@code fn} if it was not<tr><td><a id="l64"></a><a href="#l64">64</a><td> * a wrapped function created by this monitor.<tr><td><a id="l65"></a><a href="#l65">65</a><td> */<tr><td><a id="l66"></a><a href="#l66">66</a><td>goog.debug.EntryPointMonitor.prototype.unwrap;<tr><td><a id="l67"></a><a href="#l67">67</a><td><tr><td><a id="l68"></a><a href="#l68">68</a><td><tr><td><a id="l69"></a><a href="#l69">69</a><td>/**<tr><td><a id="l70"></a><a href="#l70">70</a><td> * An array of entry point callbacks.<tr><td><a id="l71"></a><a href="#l71">71</a><td> * @type {!Array<function(!Function)>}<tr><td><a id="l72"></a><a href="#l72">72</a><td> * @private<tr><td><a id="l73"></a><a href="#l73">73</a><td> */<tr><td><a id="l74"></a><a href="#l74">74</a><td>goog.debug.entryPointRegistry.refList_ = [];<tr><td><a id="l75"></a><a href="#l75">75</a><td><tr><td><a id="l76"></a><a href="#l76">76</a><td><tr><td><a id="l77"></a><a href="#l77">77</a><td>/**<tr><td><a id="l78"></a><a href="#l78">78</a><td> * Monitors that should wrap all the entry points.<tr><td><a id="l79"></a><a href="#l79">79</a><td> * @type {!Array<!goog.debug.EntryPointMonitor>}<tr><td><a id="l80"></a><a href="#l80">80</a><td> * @private<tr><td><a id="l81"></a><a href="#l81">81</a><td> */<tr><td><a id="l82"></a><a href="#l82">82</a><td>goog.debug.entryPointRegistry.monitors_ = [];<tr><td><a id="l83"></a><a href="#l83">83</a><td><tr><td><a id="l84"></a><a href="#l84">84</a><td><tr><td><a id="l85"></a><a href="#l85">85</a><td>/**<tr><td><a id="l86"></a><a href="#l86">86</a><td> * Whether goog.debug.entryPointRegistry.monitorAll has ever been called.<tr><td><a id="l87"></a><a href="#l87">87</a><td> * Checking this allows the compiler to optimize out the registrations.<tr><td><a id="l88"></a><a href="#l88">88</a><td> * @type {boolean}<tr><td><a id="l89"></a><a href="#l89">89</a><td> * @private<tr><td><a id="l90"></a><a href="#l90">90</a><td> */<tr><td><a id="l91"></a><a href="#l91">91</a><td>goog.debug.entryPointRegistry.monitorsMayExist_ = false;<tr><td><a id="l92"></a><a href="#l92">92</a><td><tr><td><a id="l93"></a><a href="#l93">93</a><td><tr><td><a id="l94"></a><a href="#l94">94</a><td>/**<tr><td><a id="l95"></a><a href="#l95">95</a><td> * Register an entry point with this module.<tr><td><a id="l96"></a><a href="#l96">96</a><td> *<tr><td><a id="l97"></a><a href="#l97">97</a><td> * The entry point will be instrumented when a monitor is passed to<tr><td><a id="l98"></a><a href="#l98">98</a><td> * goog.debug.entryPointRegistry.monitorAll. If this has already occurred, the<tr><td><a id="l99"></a><a href="#l99">99</a><td> * entry point is instrumented immediately.<tr><td><a id="l100"></a><a href="#l100">100</a><td> *<tr><td><a id="l101"></a><a href="#l101">101</a><td> * @param {function(!Function)} callback A callback function which is called<tr><td><a id="l102"></a><a href="#l102">102</a><td> * with a transforming function to instrument the entry point. The callback<tr><td><a id="l103"></a><a href="#l103">103</a><td> * is responsible for wrapping the relevant entry point with the<tr><td><a id="l104"></a><a href="#l104">104</a><td> * transforming function.<tr><td><a id="l105"></a><a href="#l105">105</a><td> */<tr><td><a id="l106"></a><a href="#l106">106</a><td>goog.debug.entryPointRegistry.register = function(callback) {<tr><td><a id="l107"></a><a href="#l107">107</a><td> // Don't use push(), so that this can be compiled out.<tr><td><a id="l108"></a><a href="#l108">108</a><td> goog.debug.entryPointRegistry.refList_[<tr><td><a id="l109"></a><a href="#l109">109</a><td> goog.debug.entryPointRegistry.refList_.length] = callback;<tr><td><a id="l110"></a><a href="#l110">110</a><td> // If no one calls monitorAll, this can be compiled out.<tr><td><a id="l111"></a><a href="#l111">111</a><td> if (goog.debug.entryPointRegistry.monitorsMayExist_) {<tr><td><a id="l112"></a><a href="#l112">112</a><td> var monitors = goog.debug.entryPointRegistry.monitors_;<tr><td><a id="l113"></a><a href="#l113">113</a><td> for (var i = 0; i < monitors.length; i++) {<tr><td><a id="l114"></a><a href="#l114">114</a><td> callback(goog.bind(monitors[i].wrap, monitors[i]));<tr><td><a id="l115"></a><a href="#l115">115</a><td> }<tr><td><a id="l116"></a><a href="#l116">116</a><td> }<tr><td><a id="l117"></a><a href="#l117">117</a><td>};<tr><td><a id="l118"></a><a href="#l118">118</a><td><tr><td><a id="l119"></a><a href="#l119">119</a><td><tr><td><a id="l120"></a><a href="#l120">120</a><td>/**<tr><td><a id="l121"></a><a href="#l121">121</a><td> * Configures a monitor to wrap all entry points.<tr><td><a id="l122"></a><a href="#l122">122</a><td> *<tr><td><a id="l123"></a><a href="#l123">123</a><td> * Entry points that have already been registered are immediately wrapped by<tr><td><a id="l124"></a><a href="#l124">124</a><td> * the monitor. When an entry point is registered in the future, it will also<tr><td><a id="l125"></a><a href="#l125">125</a><td> * be wrapped by the monitor when it is registered.<tr><td><a id="l126"></a><a href="#l126">126</a><td> *<tr><td><a id="l127"></a><a href="#l127">127</a><td> * @param {!goog.debug.EntryPointMonitor} monitor An entry point monitor.<tr><td><a id="l128"></a><a href="#l128">128</a><td> */<tr><td><a id="l129"></a><a href="#l129">129</a><td>goog.debug.entryPointRegistry.monitorAll = function(monitor) {<tr><td><a id="l130"></a><a href="#l130">130</a><td> goog.debug.entryPointRegistry.monitorsMayExist_ = true;<tr><td><a id="l131"></a><a href="#l131">131</a><td> var transformer = goog.bind(monitor.wrap, monitor);<tr><td><a id="l132"></a><a href="#l132">132</a><td> for (var i = 0; i < goog.debug.entryPointRegistry.refList_.length; i++) {<tr><td><a id="l133"></a><a href="#l133">133</a><td> goog.debug.entryPointRegistry.refList_[i](transformer);<tr><td><a id="l134"></a><a href="#l134">134</a><td> }<tr><td><a id="l135"></a><a href="#l135">135</a><td> goog.debug.entryPointRegistry.monitors_.push(monitor);<tr><td><a id="l136"></a><a href="#l136">136</a><td>};<tr><td><a id="l137"></a><a href="#l137">137</a><td><tr><td><a id="l138"></a><a href="#l138">138</a><td><tr><td><a id="l139"></a><a href="#l139">139</a><td>/**<tr><td><a id="l140"></a><a href="#l140">140</a><td> * Try to unmonitor all the entry points that have already been registered. If<tr><td><a id="l141"></a><a href="#l141">141</a><td> * an entry point is registered in the future, it will not be wrapped by the<tr><td><a id="l142"></a><a href="#l142">142</a><td> * monitor when it is registered. Note that this may fail if the entry points<tr><td><a id="l143"></a><a href="#l143">143</a><td> * have additional wrapping.<tr><td><a id="l144"></a><a href="#l144">144</a><td> *<tr><td><a id="l145"></a><a href="#l145">145</a><td> * @param {!goog.debug.EntryPointMonitor} monitor The last monitor to wrap<tr><td><a id="l146"></a><a href="#l146">146</a><td> * the entry points.<tr><td><a id="l147"></a><a href="#l147">147</a><td> * @throws {Error} If the monitor is not the most recently configured monitor.<tr><td><a id="l148"></a><a href="#l148">148</a><td> */<tr><td><a id="l149"></a><a href="#l149">149</a><td>goog.debug.entryPointRegistry.unmonitorAllIfPossible = function(monitor) {<tr><td><a id="l150"></a><a href="#l150">150</a><td> var monitors = goog.debug.entryPointRegistry.monitors_;<tr><td><a id="l151"></a><a href="#l151">151</a><td> goog.asserts.assert(monitor == monitors[monitors.length - 1],<tr><td><a id="l152"></a><a href="#l152">152</a><td> 'Only the most recent monitor can be unwrapped.');<tr><td><a id="l153"></a><a href="#l153">153</a><td> var transformer = goog.bind(monitor.unwrap, monitor);<tr><td><a id="l154"></a><a href="#l154">154</a><td> for (var i = 0; i < goog.debug.entryPointRegistry.refList_.length; i++) {<tr><td><a id="l155"></a><a href="#l155">155</a><td> goog.debug.entryPointRegistry.refList_[i](transformer);<tr><td><a id="l156"></a><a href="#l156">156</a><td> }<tr><td><a id="l157"></a><a href="#l157">157</a><td> monitors.length--;<tr><td><a id="l158"></a><a href="#l158">158</a><td>};</table></div></article><nav><h3><a href="../../../../index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="../../../../Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>