selenium-webdriver 2.48.2 → 2.52.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (524) hide show
  1. package/CHANGES.md +57 -0
  2. package/NOTICE +1 -1
  3. package/README.md +56 -6
  4. package/builder.js +375 -358
  5. package/chrome.js +549 -586
  6. package/edge.js +378 -0
  7. package/error.js +597 -5
  8. package/example/google_search_generator.js +2 -4
  9. package/example/logging.js +6 -2
  10. package/executors.js +11 -27
  11. package/firefox/binary.js +79 -87
  12. package/firefox/extension.js +10 -18
  13. package/firefox/index.js +173 -173
  14. package/firefox/profile.js +220 -240
  15. package/http/index.js +396 -79
  16. package/http/util.js +35 -35
  17. package/ie.js +288 -309
  18. package/index.js +34 -125
  19. package/io/exec.js +58 -39
  20. package/io/index.js +54 -48
  21. package/lib/actions.js +594 -0
  22. package/lib/by.js +276 -0
  23. package/lib/capabilities.js +404 -0
  24. package/lib/{webdriver/command.js → command.js} +88 -72
  25. package/lib/{webdriver/button.js → devmode.js} +13 -8
  26. package/lib/events.js +210 -0
  27. package/lib/firefox/amd64/libnoblur64.so +0 -0
  28. package/lib/firefox/i386/libnoblur.so +0 -0
  29. package/lib/firefox/webdriver.json +5 -1
  30. package/lib/firefox/webdriver.xpi +0 -0
  31. package/lib/{webdriver/key.js → input.js} +82 -2
  32. package/lib/logging.js +668 -0
  33. package/lib/{webdriver/promise.js → promise.js} +688 -644
  34. package/lib/session.js +79 -0
  35. package/lib/{webdriver/serializable.js → symbols.js} +11 -16
  36. package/lib/test/build.js +4 -4
  37. package/lib/test/data/click_tests/html5_submit_buttons.html +2 -1
  38. package/lib/test/data/click_tests/overlapping_elements.html +15 -4
  39. package/lib/test/data/click_tests/partially_overlapping_elements.html +124 -0
  40. package/lib/test/data/click_tests/wrapped_overlapping_elements.html +13 -0
  41. package/lib/test/data/readOnlyPage.html +1 -1
  42. package/lib/test/data/selectPage.html +18 -2
  43. package/lib/test/fileserver.js +3 -4
  44. package/lib/test/index.js +7 -3
  45. package/lib/test/resources.js +1 -1
  46. package/lib/until.js +428 -0
  47. package/lib/webdriver.js +2351 -0
  48. package/net/portprober.js +15 -11
  49. package/opera.js +295 -314
  50. package/package.json +6 -5
  51. package/phantomjs.js +135 -140
  52. package/proxy.js +6 -4
  53. package/remote/index.js +229 -221
  54. package/safari.js +319 -310
  55. package/test/chrome/options_test.js +11 -9
  56. package/test/element_finding_test.js +51 -13
  57. package/test/error_test.js +163 -0
  58. package/test/execute_script_test.js +1 -1
  59. package/test/http/http_test.js +317 -55
  60. package/test/http/util_test.js +25 -23
  61. package/test/io_test.js +6 -1
  62. package/test/lib/by_test.js +127 -0
  63. package/test/lib/capabilities_test.js +84 -0
  64. package/test/lib/events_test.js +177 -0
  65. package/test/lib/logging_test.js +272 -0
  66. package/test/{promise_aplus_test.js → lib/promise_aplus_test.js} +4 -13
  67. package/test/lib/promise_error_test.js +808 -0
  68. package/test/lib/promise_flow_test.js +2282 -0
  69. package/test/lib/promise_generator_test.js +308 -0
  70. package/test/lib/promise_test.js +996 -0
  71. package/test/lib/testutil.js +90 -0
  72. package/test/lib/until_test.js +436 -0
  73. package/test/lib/webdriver_test.js +2207 -0
  74. package/test/page_loading_test.js +7 -9
  75. package/test/stale_element_test.js +2 -2
  76. package/test/testing/assert_test.js +374 -0
  77. package/test/testing/index_test.js +9 -11
  78. package/testing/assert.js +334 -17
  79. package/testing/index.js +10 -0
  80. package/_base.js +0 -200
  81. package/docs/Changes.html +0 -356
  82. package/docs/class_bot_Error.html +0 -15
  83. package/docs/class_webdriver_ActionSequence.html +0 -115
  84. package/docs/class_webdriver_Alert.html +0 -24
  85. package/docs/class_webdriver_AlertPromise.html +0 -92
  86. package/docs/class_webdriver_Capabilities.html +0 -60
  87. package/docs/class_webdriver_Command.html +0 -15
  88. package/docs/class_webdriver_EventEmitter.html +0 -35
  89. package/docs/class_webdriver_FileDetector.html +0 -21
  90. package/docs/class_webdriver_Locator.html +0 -12
  91. package/docs/class_webdriver_Serializable.html +0 -9
  92. package/docs/class_webdriver_Session.html +0 -13
  93. package/docs/class_webdriver_TouchSequence.html +0 -49
  94. package/docs/class_webdriver_UnhandledAlertError.html +0 -18
  95. package/docs/class_webdriver_WebDriver.html +0 -313
  96. package/docs/class_webdriver_WebDriver_Logs.html +0 -15
  97. package/docs/class_webdriver_WebDriver_Navigation.html +0 -16
  98. package/docs/class_webdriver_WebDriver_Options.html +0 -41
  99. package/docs/class_webdriver_WebDriver_TargetLocator.html +0 -38
  100. package/docs/class_webdriver_WebDriver_Timeouts.html +0 -29
  101. package/docs/class_webdriver_WebDriver_Window.html +0 -27
  102. package/docs/class_webdriver_WebElement.html +0 -223
  103. package/docs/class_webdriver_WebElementPromise.html +0 -274
  104. package/docs/class_webdriver_http_Executor.html +0 -22
  105. package/docs/class_webdriver_http_Request.html +0 -12
  106. package/docs/class_webdriver_http_Response.html +0 -13
  107. package/docs/class_webdriver_logging_Entry.html +0 -15
  108. package/docs/class_webdriver_logging_Level.html +0 -55
  109. package/docs/class_webdriver_logging_LogRecord.html +0 -45
  110. package/docs/class_webdriver_logging_Logger.html +0 -119
  111. package/docs/class_webdriver_logging_Preferences.html +0 -8
  112. package/docs/class_webdriver_promise_CancellationError.html +0 -17
  113. package/docs/class_webdriver_promise_ControlFlow.html +0 -153
  114. package/docs/class_webdriver_promise_Deferred.html +0 -84
  115. package/docs/class_webdriver_promise_MultipleUnhandledRejectionError.html +0 -14
  116. package/docs/class_webdriver_promise_Promise.html +0 -75
  117. package/docs/class_webdriver_stacktrace_Frame.html +0 -20
  118. package/docs/class_webdriver_stacktrace_Snapshot.html +0 -6
  119. package/docs/class_webdriver_testing_Assertion.html +0 -99
  120. package/docs/class_webdriver_testing_Assertion_DelegatingMatcher_.html +0 -13
  121. package/docs/class_webdriver_testing_ContainsMatcher.html +0 -11
  122. package/docs/class_webdriver_testing_NegatedAssertion.html +0 -97
  123. package/docs/class_webdriver_until_Condition.html +0 -7
  124. package/docs/dossier.css +0 -1
  125. package/docs/dossier.js +0 -86
  126. package/docs/enum_bot_ErrorCode.html +0 -3
  127. package/docs/enum_bot_Error_State.html +0 -2
  128. package/docs/enum_webdriver_Browser.html +0 -2
  129. package/docs/enum_webdriver_Button.html +0 -2
  130. package/docs/enum_webdriver_Capability.html +0 -33
  131. package/docs/enum_webdriver_CommandName.html +0 -3
  132. package/docs/enum_webdriver_Key.html +0 -12
  133. package/docs/enum_webdriver_logging_Type.html +0 -6
  134. package/docs/enum_webdriver_promise_ControlFlow_EventType.html +0 -9
  135. package/docs/index.html +0 -125
  136. package/docs/interface_webdriver_CommandExecutor.html +0 -9
  137. package/docs/interface_webdriver_http_Client.html +0 -10
  138. package/docs/interface_webdriver_promise_Thenable.html +0 -77
  139. package/docs/module_selenium-webdriver.html +0 -23
  140. package/docs/module_selenium-webdriver__base.html +0 -23
  141. package/docs/module_selenium-webdriver__base_class_Context.html +0 -5
  142. package/docs/module_selenium-webdriver_builder.html +0 -2
  143. package/docs/module_selenium-webdriver_builder_class_Builder.html +0 -138
  144. package/docs/module_selenium-webdriver_chrome.html +0 -90
  145. package/docs/module_selenium-webdriver_chrome_class_Driver.html +0 -280
  146. package/docs/module_selenium-webdriver_chrome_class_Options.html +0 -127
  147. package/docs/module_selenium-webdriver_chrome_class_ServiceBuilder.html +0 -46
  148. package/docs/module_selenium-webdriver_class_ActionSequence.html +0 -115
  149. package/docs/module_selenium-webdriver_class_Builder.html +0 -138
  150. package/docs/module_selenium-webdriver_class_Capabilities.html +0 -60
  151. package/docs/module_selenium-webdriver_class_Command.html +0 -15
  152. package/docs/module_selenium-webdriver_class_EventEmitter.html +0 -35
  153. package/docs/module_selenium-webdriver_class_FileDetector.html +0 -21
  154. package/docs/module_selenium-webdriver_class_Serializable.html +0 -9
  155. package/docs/module_selenium-webdriver_class_Session.html +0 -13
  156. package/docs/module_selenium-webdriver_class_WebDriver.html +0 -313
  157. package/docs/module_selenium-webdriver_class_WebElement.html +0 -223
  158. package/docs/module_selenium-webdriver_class_WebElementPromise.html +0 -274
  159. package/docs/module_selenium-webdriver_enum_Browser.html +0 -2
  160. package/docs/module_selenium-webdriver_enum_Button.html +0 -2
  161. package/docs/module_selenium-webdriver_enum_Capability.html +0 -33
  162. package/docs/module_selenium-webdriver_enum_CommandName.html +0 -3
  163. package/docs/module_selenium-webdriver_enum_Key.html +0 -12
  164. package/docs/module_selenium-webdriver_error.html +0 -4
  165. package/docs/module_selenium-webdriver_error_class_Error.html +0 -15
  166. package/docs/module_selenium-webdriver_error_enum_ErrorCode.html +0 -3
  167. package/docs/module_selenium-webdriver_executors.html +0 -10
  168. package/docs/module_selenium-webdriver_executors_class_DeferredExecutor.html +0 -12
  169. package/docs/module_selenium-webdriver_firefox.html +0 -68
  170. package/docs/module_selenium-webdriver_firefox_binary.html +0 -5
  171. package/docs/module_selenium-webdriver_firefox_binary_class_Binary.html +0 -20
  172. package/docs/module_selenium-webdriver_firefox_class_Binary.html +0 -20
  173. package/docs/module_selenium-webdriver_firefox_class_Driver.html +0 -276
  174. package/docs/module_selenium-webdriver_firefox_class_Options.html +0 -19
  175. package/docs/module_selenium-webdriver_firefox_class_Profile.html +0 -50
  176. package/docs/module_selenium-webdriver_firefox_extension.html +0 -8
  177. package/docs/module_selenium-webdriver_firefox_profile.html +0 -13
  178. package/docs/module_selenium-webdriver_firefox_profile_class_Profile.html +0 -50
  179. package/docs/module_selenium-webdriver_http.html +0 -9
  180. package/docs/module_selenium-webdriver_http_class_Executor.html +0 -22
  181. package/docs/module_selenium-webdriver_http_class_HttpClient.html +0 -16
  182. package/docs/module_selenium-webdriver_http_class_Request.html +0 -12
  183. package/docs/module_selenium-webdriver_http_class_Response.html +0 -13
  184. package/docs/module_selenium-webdriver_http_util.html +0 -17
  185. package/docs/module_selenium-webdriver_ie.html +0 -11
  186. package/docs/module_selenium-webdriver_ie_class_Driver.html +0 -274
  187. package/docs/module_selenium-webdriver_ie_class_Options.html +0 -89
  188. package/docs/module_selenium-webdriver_ie_enum_Level.html +0 -1
  189. package/docs/module_selenium-webdriver_io.html +0 -37
  190. package/docs/module_selenium-webdriver_io_exec.html +0 -6
  191. package/docs/module_selenium-webdriver_namespace_By.html +0 -56
  192. package/docs/module_selenium-webdriver_namespace_error.html +0 -4
  193. package/docs/module_selenium-webdriver_namespace_logging.html +0 -18
  194. package/docs/module_selenium-webdriver_namespace_promise.html +0 -163
  195. package/docs/module_selenium-webdriver_namespace_stacktrace.html +0 -17
  196. package/docs/module_selenium-webdriver_namespace_until.html +0 -82
  197. package/docs/module_selenium-webdriver_net.html +0 -7
  198. package/docs/module_selenium-webdriver_net_portprober.html +0 -12
  199. package/docs/module_selenium-webdriver_opera.html +0 -62
  200. package/docs/module_selenium-webdriver_opera_class_Driver.html +0 -276
  201. package/docs/module_selenium-webdriver_opera_class_Options.html +0 -44
  202. package/docs/module_selenium-webdriver_opera_class_ServiceBuilder.html +0 -35
  203. package/docs/module_selenium-webdriver_phantomjs.html +0 -2
  204. package/docs/module_selenium-webdriver_phantomjs_class_Driver.html +0 -299
  205. package/docs/module_selenium-webdriver_proxy.html +0 -28
  206. package/docs/module_selenium-webdriver_remote.html +0 -8
  207. package/docs/module_selenium-webdriver_remote_class_DriverService.html +0 -32
  208. package/docs/module_selenium-webdriver_remote_class_FileDetector.html +0 -22
  209. package/docs/module_selenium-webdriver_remote_class_SeleniumServer.html +0 -41
  210. package/docs/module_selenium-webdriver_safari.html +0 -9
  211. package/docs/module_selenium-webdriver_safari_class_Driver.html +0 -279
  212. package/docs/module_selenium-webdriver_safari_class_Options.html +0 -23
  213. package/docs/module_selenium-webdriver_testing.html +0 -74
  214. package/docs/module_selenium-webdriver_testing_assert.html +0 -9
  215. package/docs/namespace_bot.html +0 -4
  216. package/docs/namespace_bot_json.html +0 -20
  217. package/docs/namespace_bot_response.html +0 -18
  218. package/docs/namespace_bot_userAgent.html +0 -33
  219. package/docs/namespace_webdriver.html +0 -30
  220. package/docs/namespace_webdriver_By.html +0 -56
  221. package/docs/namespace_webdriver_http.html +0 -6
  222. package/docs/namespace_webdriver_logging.html +0 -70
  223. package/docs/namespace_webdriver_promise.html +0 -688
  224. package/docs/namespace_webdriver_stacktrace.html +0 -17
  225. package/docs/namespace_webdriver_testing.html +0 -7
  226. package/docs/namespace_webdriver_testing_assert.html +0 -9
  227. package/docs/namespace_webdriver_testing_asserts.html +0 -18
  228. package/docs/namespace_webdriver_until.html +0 -82
  229. package/docs/source/_base.js.src.html +0 -1
  230. package/docs/source/builder.js.src.html +0 -1
  231. package/docs/source/chrome.js.src.html +0 -1
  232. package/docs/source/error.js.src.html +0 -1
  233. package/docs/source/executors.js.src.html +0 -1
  234. package/docs/source/firefox/binary.js.src.html +0 -1
  235. package/docs/source/firefox/extension.js.src.html +0 -1
  236. package/docs/source/firefox/index.js.src.html +0 -1
  237. package/docs/source/firefox/profile.js.src.html +0 -1
  238. package/docs/source/http/index.js.src.html +0 -1
  239. package/docs/source/http/util.js.src.html +0 -1
  240. package/docs/source/ie.js.src.html +0 -1
  241. package/docs/source/index.js.src.html +0 -1
  242. package/docs/source/io/exec.js.src.html +0 -1
  243. package/docs/source/io/index.js.src.html +0 -1
  244. package/docs/source/lib/atoms/error.js.src.html +0 -1
  245. package/docs/source/lib/atoms/json.js.src.html +0 -1
  246. package/docs/source/lib/atoms/response.js.src.html +0 -1
  247. package/docs/source/lib/atoms/userAgent.js.src.html +0 -1
  248. package/docs/source/lib/goog/array/array.js.src.html +0 -1
  249. package/docs/source/lib/goog/asserts/asserts.js.src.html +0 -1
  250. package/docs/source/lib/goog/async/freelist.js.src.html +0 -1
  251. package/docs/source/lib/goog/async/nexttick.js.src.html +0 -1
  252. package/docs/source/lib/goog/async/run.js.src.html +0 -1
  253. package/docs/source/lib/goog/async/workqueue.js.src.html +0 -1
  254. package/docs/source/lib/goog/base.js.src.html +0 -1
  255. package/docs/source/lib/goog/debug/debug.js.src.html +0 -1
  256. package/docs/source/lib/goog/debug/entrypointregistry.js.src.html +0 -1
  257. package/docs/source/lib/goog/debug/error.js.src.html +0 -1
  258. package/docs/source/lib/goog/debug/logbuffer.js.src.html +0 -1
  259. package/docs/source/lib/goog/debug/logger.js.src.html +0 -1
  260. package/docs/source/lib/goog/debug/logrecord.js.src.html +0 -1
  261. package/docs/source/lib/goog/deps.js.src.html +0 -1
  262. package/docs/source/lib/goog/disposable/disposable.js.src.html +0 -1
  263. package/docs/source/lib/goog/disposable/idisposable.js.src.html +0 -1
  264. package/docs/source/lib/goog/dom/browserfeature.js.src.html +0 -1
  265. package/docs/source/lib/goog/dom/dom.js.src.html +0 -1
  266. package/docs/source/lib/goog/dom/nodetype.js.src.html +0 -1
  267. package/docs/source/lib/goog/dom/safe.js.src.html +0 -1
  268. package/docs/source/lib/goog/dom/tagname.js.src.html +0 -1
  269. package/docs/source/lib/goog/dom/tags.js.src.html +0 -1
  270. package/docs/source/lib/goog/dom/vendor.js.src.html +0 -1
  271. package/docs/source/lib/goog/events/browserevent.js.src.html +0 -1
  272. package/docs/source/lib/goog/events/browserfeature.js.src.html +0 -1
  273. package/docs/source/lib/goog/events/event.js.src.html +0 -1
  274. package/docs/source/lib/goog/events/eventid.js.src.html +0 -1
  275. package/docs/source/lib/goog/events/events.js.src.html +0 -1
  276. package/docs/source/lib/goog/events/eventtarget.js.src.html +0 -1
  277. package/docs/source/lib/goog/events/eventtype.js.src.html +0 -1
  278. package/docs/source/lib/goog/events/keycodes.js.src.html +0 -1
  279. package/docs/source/lib/goog/events/listenable.js.src.html +0 -1
  280. package/docs/source/lib/goog/events/listener.js.src.html +0 -1
  281. package/docs/source/lib/goog/events/listenermap.js.src.html +0 -1
  282. package/docs/source/lib/goog/fs/url.js.src.html +0 -1
  283. package/docs/source/lib/goog/functions/functions.js.src.html +0 -1
  284. package/docs/source/lib/goog/html/safehtml.js.src.html +0 -1
  285. package/docs/source/lib/goog/html/safescript.js.src.html +0 -1
  286. package/docs/source/lib/goog/html/safestyle.js.src.html +0 -1
  287. package/docs/source/lib/goog/html/safestylesheet.js.src.html +0 -1
  288. package/docs/source/lib/goog/html/safeurl.js.src.html +0 -1
  289. package/docs/source/lib/goog/html/trustedresourceurl.js.src.html +0 -1
  290. package/docs/source/lib/goog/html/uncheckedconversions.js.src.html +0 -1
  291. package/docs/source/lib/goog/i18n/bidi.js.src.html +0 -1
  292. package/docs/source/lib/goog/iter/iter.js.src.html +0 -1
  293. package/docs/source/lib/goog/json/json.js.src.html +0 -1
  294. package/docs/source/lib/goog/labs/testing/assertthat.js.src.html +0 -1
  295. package/docs/source/lib/goog/labs/testing/logicmatcher.js.src.html +0 -1
  296. package/docs/source/lib/goog/labs/testing/matcher.js.src.html +0 -1
  297. package/docs/source/lib/goog/labs/testing/numbermatcher.js.src.html +0 -1
  298. package/docs/source/lib/goog/labs/testing/objectmatcher.js.src.html +0 -1
  299. package/docs/source/lib/goog/labs/testing/stringmatcher.js.src.html +0 -1
  300. package/docs/source/lib/goog/labs/useragent/browser.js.src.html +0 -1
  301. package/docs/source/lib/goog/labs/useragent/engine.js.src.html +0 -1
  302. package/docs/source/lib/goog/labs/useragent/platform.js.src.html +0 -1
  303. package/docs/source/lib/goog/labs/useragent/util.js.src.html +0 -1
  304. package/docs/source/lib/goog/log/log.js.src.html +0 -1
  305. package/docs/source/lib/goog/math/box.js.src.html +0 -1
  306. package/docs/source/lib/goog/math/coordinate.js.src.html +0 -1
  307. package/docs/source/lib/goog/math/math.js.src.html +0 -1
  308. package/docs/source/lib/goog/math/rect.js.src.html +0 -1
  309. package/docs/source/lib/goog/math/size.js.src.html +0 -1
  310. package/docs/source/lib/goog/net/wrapperxmlhttpfactory.js.src.html +0 -1
  311. package/docs/source/lib/goog/net/xhrlike.js.src.html +0 -1
  312. package/docs/source/lib/goog/net/xmlhttp.js.src.html +0 -1
  313. package/docs/source/lib/goog/net/xmlhttpfactory.js.src.html +0 -1
  314. package/docs/source/lib/goog/object/object.js.src.html +0 -1
  315. package/docs/source/lib/goog/promise/promise.js.src.html +0 -1
  316. package/docs/source/lib/goog/promise/resolver.js.src.html +0 -1
  317. package/docs/source/lib/goog/promise/thenable.js.src.html +0 -1
  318. package/docs/source/lib/goog/reflect/reflect.js.src.html +0 -1
  319. package/docs/source/lib/goog/string/const.js.src.html +0 -1
  320. package/docs/source/lib/goog/string/string.js.src.html +0 -1
  321. package/docs/source/lib/goog/string/typedstring.js.src.html +0 -1
  322. package/docs/source/lib/goog/structs/collection.js.src.html +0 -1
  323. package/docs/source/lib/goog/structs/map.js.src.html +0 -1
  324. package/docs/source/lib/goog/structs/set.js.src.html +0 -1
  325. package/docs/source/lib/goog/structs/structs.js.src.html +0 -1
  326. package/docs/source/lib/goog/style/style.js.src.html +0 -1
  327. package/docs/source/lib/goog/testing/asserts.js.src.html +0 -1
  328. package/docs/source/lib/goog/testing/events/events.js.src.html +0 -1
  329. package/docs/source/lib/goog/testing/functionmock.js.src.html +0 -1
  330. package/docs/source/lib/goog/testing/jsunit.js.src.html +0 -1
  331. package/docs/source/lib/goog/testing/loosemock.js.src.html +0 -1
  332. package/docs/source/lib/goog/testing/mock.js.src.html +0 -1
  333. package/docs/source/lib/goog/testing/mockclock.js.src.html +0 -1
  334. package/docs/source/lib/goog/testing/mockcontrol.js.src.html +0 -1
  335. package/docs/source/lib/goog/testing/mockinterface.js.src.html +0 -1
  336. package/docs/source/lib/goog/testing/mockmatchers.js.src.html +0 -1
  337. package/docs/source/lib/goog/testing/objectpropertystring.js.src.html +0 -1
  338. package/docs/source/lib/goog/testing/propertyreplacer.js.src.html +0 -1
  339. package/docs/source/lib/goog/testing/recordfunction.js.src.html +0 -1
  340. package/docs/source/lib/goog/testing/stacktrace.js.src.html +0 -1
  341. package/docs/source/lib/goog/testing/strictmock.js.src.html +0 -1
  342. package/docs/source/lib/goog/testing/testcase.js.src.html +0 -1
  343. package/docs/source/lib/goog/testing/testrunner.js.src.html +0 -1
  344. package/docs/source/lib/goog/uri/uri.js.src.html +0 -1
  345. package/docs/source/lib/goog/uri/utils.js.src.html +0 -1
  346. package/docs/source/lib/goog/useragent/product.js.src.html +0 -1
  347. package/docs/source/lib/goog/useragent/product_isversion.js.src.html +0 -1
  348. package/docs/source/lib/goog/useragent/useragent.js.src.html +0 -1
  349. package/docs/source/lib/webdriver/actionsequence.js.src.html +0 -1
  350. package/docs/source/lib/webdriver/button.js.src.html +0 -1
  351. package/docs/source/lib/webdriver/capabilities.js.src.html +0 -1
  352. package/docs/source/lib/webdriver/command.js.src.html +0 -1
  353. package/docs/source/lib/webdriver/events.js.src.html +0 -1
  354. package/docs/source/lib/webdriver/http/http.js.src.html +0 -1
  355. package/docs/source/lib/webdriver/key.js.src.html +0 -1
  356. package/docs/source/lib/webdriver/locators.js.src.html +0 -1
  357. package/docs/source/lib/webdriver/logging.js.src.html +0 -1
  358. package/docs/source/lib/webdriver/promise.js.src.html +0 -1
  359. package/docs/source/lib/webdriver/serializable.js.src.html +0 -1
  360. package/docs/source/lib/webdriver/session.js.src.html +0 -1
  361. package/docs/source/lib/webdriver/stacktrace.js.src.html +0 -1
  362. package/docs/source/lib/webdriver/testing/asserts.js.src.html +0 -1
  363. package/docs/source/lib/webdriver/touchsequence.js.src.html +0 -1
  364. package/docs/source/lib/webdriver/until.js.src.html +0 -1
  365. package/docs/source/lib/webdriver/webdriver.js.src.html +0 -1
  366. package/docs/source/net/index.js.src.html +0 -1
  367. package/docs/source/net/portprober.js.src.html +0 -1
  368. package/docs/source/opera.js.src.html +0 -1
  369. package/docs/source/phantomjs.js.src.html +0 -1
  370. package/docs/source/proxy.js.src.html +0 -1
  371. package/docs/source/remote/index.js.src.html +0 -1
  372. package/docs/source/safari.js.src.html +0 -1
  373. package/docs/source/testing/assert.js.src.html +0 -1
  374. package/docs/source/testing/index.js.src.html +0 -1
  375. package/docs/types.js +0 -1
  376. package/lib/atoms/error.js +0 -202
  377. package/lib/atoms/json.js +0 -80
  378. package/lib/atoms/response.js +0 -110
  379. package/lib/atoms/userAgent.js +0 -257
  380. package/lib/goog/LICENSE +0 -176
  381. package/lib/goog/array/array.js +0 -1654
  382. package/lib/goog/asserts/asserts.js +0 -365
  383. package/lib/goog/async/freelist.js +0 -88
  384. package/lib/goog/async/nexttick.js +0 -241
  385. package/lib/goog/async/run.js +0 -133
  386. package/lib/goog/async/workqueue.js +0 -139
  387. package/lib/goog/base.js +0 -2548
  388. package/lib/goog/debug/debug.js +0 -653
  389. package/lib/goog/debug/entrypointregistry.js +0 -158
  390. package/lib/goog/debug/error.js +0 -63
  391. package/lib/goog/debug/logbuffer.js +0 -148
  392. package/lib/goog/debug/logger.js +0 -873
  393. package/lib/goog/debug/logrecord.js +0 -242
  394. package/lib/goog/deps.js +0 -151
  395. package/lib/goog/disposable/disposable.js +0 -307
  396. package/lib/goog/disposable/idisposable.js +0 -45
  397. package/lib/goog/dom/browserfeature.js +0 -72
  398. package/lib/goog/dom/dom.js +0 -2991
  399. package/lib/goog/dom/nodetype.js +0 -48
  400. package/lib/goog/dom/safe.js +0 -347
  401. package/lib/goog/dom/tagname.js +0 -160
  402. package/lib/goog/dom/tags.js +0 -41
  403. package/lib/goog/dom/vendor.js +0 -96
  404. package/lib/goog/events/browserevent.js +0 -400
  405. package/lib/goog/events/browserfeature.js +0 -85
  406. package/lib/goog/events/event.js +0 -143
  407. package/lib/goog/events/eventid.js +0 -47
  408. package/lib/goog/events/events.js +0 -984
  409. package/lib/goog/events/eventtarget.js +0 -394
  410. package/lib/goog/events/eventtype.js +0 -237
  411. package/lib/goog/events/keycodes.js +0 -427
  412. package/lib/goog/events/listenable.js +0 -335
  413. package/lib/goog/events/listener.js +0 -131
  414. package/lib/goog/events/listenermap.js +0 -308
  415. package/lib/goog/fs/url.js +0 -109
  416. package/lib/goog/functions/functions.js +0 -442
  417. package/lib/goog/html/safehtml.js +0 -757
  418. package/lib/goog/html/safescript.js +0 -234
  419. package/lib/goog/html/safestyle.js +0 -442
  420. package/lib/goog/html/safestylesheet.js +0 -276
  421. package/lib/goog/html/safeurl.js +0 -398
  422. package/lib/goog/html/trustedresourceurl.js +0 -224
  423. package/lib/goog/html/uncheckedconversions.js +0 -232
  424. package/lib/goog/i18n/bidi.js +0 -908
  425. package/lib/goog/iter/iter.js +0 -1302
  426. package/lib/goog/json/json.js +0 -363
  427. package/lib/goog/labs/testing/assertthat.js +0 -58
  428. package/lib/goog/labs/testing/logicmatcher.js +0 -212
  429. package/lib/goog/labs/testing/matcher.js +0 -80
  430. package/lib/goog/labs/testing/numbermatcher.js +0 -346
  431. package/lib/goog/labs/testing/objectmatcher.js +0 -317
  432. package/lib/goog/labs/testing/stringmatcher.js +0 -415
  433. package/lib/goog/labs/useragent/browser.js +0 -341
  434. package/lib/goog/labs/useragent/engine.js +0 -160
  435. package/lib/goog/labs/useragent/platform.js +0 -160
  436. package/lib/goog/labs/useragent/util.js +0 -148
  437. package/lib/goog/log/log.js +0 -197
  438. package/lib/goog/math/box.js +0 -398
  439. package/lib/goog/math/coordinate.js +0 -268
  440. package/lib/goog/math/math.js +0 -451
  441. package/lib/goog/math/rect.js +0 -476
  442. package/lib/goog/math/size.js +0 -227
  443. package/lib/goog/net/wrapperxmlhttpfactory.js +0 -71
  444. package/lib/goog/net/xhrlike.js +0 -124
  445. package/lib/goog/net/xmlhttp.js +0 -246
  446. package/lib/goog/net/xmlhttpfactory.js +0 -67
  447. package/lib/goog/object/object.js +0 -686
  448. package/lib/goog/promise/promise.js +0 -1350
  449. package/lib/goog/promise/resolver.js +0 -48
  450. package/lib/goog/promise/thenable.js +0 -126
  451. package/lib/goog/reflect/reflect.js +0 -77
  452. package/lib/goog/string/const.js +0 -182
  453. package/lib/goog/string/string.js +0 -1599
  454. package/lib/goog/string/typedstring.js +0 -48
  455. package/lib/goog/structs/collection.js +0 -56
  456. package/lib/goog/structs/map.js +0 -457
  457. package/lib/goog/structs/set.js +0 -279
  458. package/lib/goog/structs/structs.js +0 -354
  459. package/lib/goog/style/style.js +0 -2037
  460. package/lib/goog/testing/asserts.js +0 -1278
  461. package/lib/goog/testing/events/events.js +0 -767
  462. package/lib/goog/testing/functionmock.js +0 -175
  463. package/lib/goog/testing/jsunit.js +0 -162
  464. package/lib/goog/testing/loosemock.js +0 -242
  465. package/lib/goog/testing/mock.js +0 -645
  466. package/lib/goog/testing/mockclock.js +0 -606
  467. package/lib/goog/testing/mockcontrol.js +0 -220
  468. package/lib/goog/testing/mockinterface.js +0 -45
  469. package/lib/goog/testing/mockmatchers.js +0 -400
  470. package/lib/goog/testing/objectpropertystring.js +0 -68
  471. package/lib/goog/testing/propertyreplacer.js +0 -262
  472. package/lib/goog/testing/recordfunction.js +0 -215
  473. package/lib/goog/testing/stacktrace.js +0 -594
  474. package/lib/goog/testing/strictmock.js +0 -130
  475. package/lib/goog/testing/testcase.js +0 -1629
  476. package/lib/goog/testing/testrunner.js +0 -440
  477. package/lib/goog/uri/uri.js +0 -1524
  478. package/lib/goog/uri/utils.js +0 -1064
  479. package/lib/goog/useragent/product.js +0 -183
  480. package/lib/goog/useragent/product_isversion.js +0 -144
  481. package/lib/goog/useragent/useragent.js +0 -572
  482. package/lib/webdriver/actionsequence.js +0 -356
  483. package/lib/webdriver/builder.js +0 -207
  484. package/lib/webdriver/capabilities.js +0 -412
  485. package/lib/webdriver/events.js +0 -179
  486. package/lib/webdriver/firefoxdomexecutor.js +0 -175
  487. package/lib/webdriver/http/corsclient.js +0 -133
  488. package/lib/webdriver/http/http.js +0 -525
  489. package/lib/webdriver/http/xhrclient.js +0 -67
  490. package/lib/webdriver/locators.js +0 -257
  491. package/lib/webdriver/logging.js +0 -347
  492. package/lib/webdriver/session.js +0 -74
  493. package/lib/webdriver/stacktrace.js +0 -619
  494. package/lib/webdriver/test/builder_test.js +0 -53
  495. package/lib/webdriver/test/capabilities_test.js +0 -72
  496. package/lib/webdriver/test/events_test.js +0 -203
  497. package/lib/webdriver/test/http/corsclient_test.js +0 -151
  498. package/lib/webdriver/test/http/http_test.js +0 -428
  499. package/lib/webdriver/test/http/xhrclient_test.js +0 -196
  500. package/lib/webdriver/test/locators_test.js +0 -59
  501. package/lib/webdriver/test/logging_test.js +0 -85
  502. package/lib/webdriver/test/promise_error_test.js +0 -892
  503. package/lib/webdriver/test/promise_flow_test.js +0 -2365
  504. package/lib/webdriver/test/promise_generator_test.js +0 -323
  505. package/lib/webdriver/test/promise_test.js +0 -2012
  506. package/lib/webdriver/test/stacktrace_test.js +0 -480
  507. package/lib/webdriver/test/test_bootstrap.js +0 -67
  508. package/lib/webdriver/test/testing/asserts_test.js +0 -117
  509. package/lib/webdriver/test/testing/client_test.js +0 -88
  510. package/lib/webdriver/test/testing/testcase_test.js +0 -229
  511. package/lib/webdriver/test/testutil.js +0 -209
  512. package/lib/webdriver/test/testutil_test.js +0 -104
  513. package/lib/webdriver/test/until_test.js +0 -411
  514. package/lib/webdriver/test/webdriver_generator_test.js +0 -92
  515. package/lib/webdriver/test/webdriver_test.js +0 -2369
  516. package/lib/webdriver/testing/asserts.js +0 -487
  517. package/lib/webdriver/testing/client.js +0 -179
  518. package/lib/webdriver/testing/jsunit.js +0 -363
  519. package/lib/webdriver/testing/testcase.js +0 -168
  520. package/lib/webdriver/testing/window.js +0 -244
  521. package/lib/webdriver/touchsequence.js +0 -248
  522. package/lib/webdriver/until.js +0 -412
  523. package/lib/webdriver/webdriver.js +0 -2511
  524. package/test/_base_test.js +0 -129
package/docs/source/lib/goog/fs/url.js.src.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE 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>url.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/fs/url.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2015 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 &quot;License&quot;);<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 &quot;AS-IS&quot; 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 Wrapper for URL and its createObjectUrl and revokeObjectUrl<tr><td><a id="l17"></a><a href="#l17">17</a><td> * methods that are part of the HTML5 File API.<tr><td><a id="l18"></a><a href="#l18">18</a><td> */<tr><td><a id="l19"></a><a href="#l19">19</a><td><tr><td><a id="l20"></a><a href="#l20">20</a><td>goog.provide(&#39;goog.fs.url&#39;);<tr><td><a id="l21"></a><a href="#l21">21</a><td><tr><td><a id="l22"></a><a href="#l22">22</a><td><tr><td><a id="l23"></a><a href="#l23">23</a><td>/**<tr><td><a id="l24"></a><a href="#l24">24</a><td> * Creates a blob URL for a blob object.<tr><td><a id="l25"></a><a href="#l25">25</a><td> * Throws an error if the browser does not support Object Urls.<tr><td><a id="l26"></a><a href="#l26">26</a><td> *<tr><td><a id="l27"></a><a href="#l27">27</a><td> * @param {!Blob} blob The object for which to create the URL.<tr><td><a id="l28"></a><a href="#l28">28</a><td> * @return {string} The URL for the object.<tr><td><a id="l29"></a><a href="#l29">29</a><td> */<tr><td><a id="l30"></a><a href="#l30">30</a><td>goog.fs.url.createObjectUrl = function(blob) {<tr><td><a id="l31"></a><a href="#l31">31</a><td> return goog.fs.url.getUrlObject_().createObjectURL(blob);<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> * Revokes a URL created by {@link goog.fs.url.createObjectUrl}.<tr><td><a id="l37"></a><a href="#l37">37</a><td> * Throws an error if the browser does not support Object Urls.<tr><td><a id="l38"></a><a href="#l38">38</a><td> *<tr><td><a id="l39"></a><a href="#l39">39</a><td> * @param {string} url The URL to revoke.<tr><td><a id="l40"></a><a href="#l40">40</a><td> */<tr><td><a id="l41"></a><a href="#l41">41</a><td>goog.fs.url.revokeObjectUrl = function(url) {<tr><td><a id="l42"></a><a href="#l42">42</a><td> goog.fs.url.getUrlObject_().revokeObjectURL(url);<tr><td><a id="l43"></a><a href="#l43">43</a><td>};<tr><td><a id="l44"></a><a href="#l44">44</a><td><tr><td><a id="l45"></a><a href="#l45">45</a><td><tr><td><a id="l46"></a><a href="#l46">46</a><td>/**<tr><td><a id="l47"></a><a href="#l47">47</a><td> * @typedef {{createObjectURL: (function(!Blob): string),<tr><td><a id="l48"></a><a href="#l48">48</a><td> * revokeObjectURL: function(string): void}}<tr><td><a id="l49"></a><a href="#l49">49</a><td> */<tr><td><a id="l50"></a><a href="#l50">50</a><td>goog.fs.url.UrlObject_;<tr><td><a id="l51"></a><a href="#l51">51</a><td><tr><td><a id="l52"></a><a href="#l52">52</a><td><tr><td><a id="l53"></a><a href="#l53">53</a><td>/**<tr><td><a id="l54"></a><a href="#l54">54</a><td> * Get the object that has the createObjectURL and revokeObjectURL functions for<tr><td><a id="l55"></a><a href="#l55">55</a><td> * this browser.<tr><td><a id="l56"></a><a href="#l56">56</a><td> *<tr><td><a id="l57"></a><a href="#l57">57</a><td> * @return {goog.fs.url.UrlObject_} The object for this browser.<tr><td><a id="l58"></a><a href="#l58">58</a><td> * @private<tr><td><a id="l59"></a><a href="#l59">59</a><td> */<tr><td><a id="l60"></a><a href="#l60">60</a><td>goog.fs.url.getUrlObject_ = function() {<tr><td><a id="l61"></a><a href="#l61">61</a><td> var urlObject = goog.fs.url.findUrlObject_();<tr><td><a id="l62"></a><a href="#l62">62</a><td> if (urlObject != null) {<tr><td><a id="l63"></a><a href="#l63">63</a><td> return urlObject;<tr><td><a id="l64"></a><a href="#l64">64</a><td> } else {<tr><td><a id="l65"></a><a href="#l65">65</a><td> throw Error(&#39;This browser doesn\&#39;t seem to support blob URLs&#39;);<tr><td><a id="l66"></a><a href="#l66">66</a><td> }<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>/**<tr><td><a id="l71"></a><a href="#l71">71</a><td> * Finds the object that has the createObjectURL and revokeObjectURL functions<tr><td><a id="l72"></a><a href="#l72">72</a><td> * for this browser.<tr><td><a id="l73"></a><a href="#l73">73</a><td> *<tr><td><a id="l74"></a><a href="#l74">74</a><td> * @return {?goog.fs.url.UrlObject_} The object for this browser or null if the<tr><td><a id="l75"></a><a href="#l75">75</a><td> * browser does not support Object Urls.<tr><td><a id="l76"></a><a href="#l76">76</a><td> * @suppress {unnecessaryCasts} Depending on how the code is compiled, casting<tr><td><a id="l77"></a><a href="#l77">77</a><td> * goog.global to UrlObject_ may result in unnecessary cast warning.<tr><td><a id="l78"></a><a href="#l78">78</a><td> * However, the cast cannot be removed because with different set of<tr><td><a id="l79"></a><a href="#l79">79</a><td> * compiler flags, the cast is indeed necessary. As such, silencing it.<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.fs.url.findUrlObject_ = function() {<tr><td><a id="l83"></a><a href="#l83">83</a><td> // This is what the spec says to do<tr><td><a id="l84"></a><a href="#l84">84</a><td> // http://dev.w3.org/2006/webapi/FileAPI/#dfn-createObjectURL<tr><td><a id="l85"></a><a href="#l85">85</a><td> if (goog.isDef(goog.global.URL) &amp;&amp;<tr><td><a id="l86"></a><a href="#l86">86</a><td> goog.isDef(goog.global.URL.createObjectURL)) {<tr><td><a id="l87"></a><a href="#l87">87</a><td> return /** @type {goog.fs.url.UrlObject_} */ (goog.global.URL);<tr><td><a id="l88"></a><a href="#l88">88</a><td> // This is what Chrome does (as of 10.0.648.6 dev)<tr><td><a id="l89"></a><a href="#l89">89</a><td> } else if (goog.isDef(goog.global.webkitURL) &amp;&amp;<tr><td><a id="l90"></a><a href="#l90">90</a><td> goog.isDef(goog.global.webkitURL.createObjectURL)) {<tr><td><a id="l91"></a><a href="#l91">91</a><td> return /** @type {goog.fs.url.UrlObject_} */ (goog.global.webkitURL);<tr><td><a id="l92"></a><a href="#l92">92</a><td> // This is what the spec used to say to do<tr><td><a id="l93"></a><a href="#l93">93</a><td> } else if (goog.isDef(goog.global.createObjectURL)) {<tr><td><a id="l94"></a><a href="#l94">94</a><td> return /** @type {goog.fs.url.UrlObject_} */ (goog.global);<tr><td><a id="l95"></a><a href="#l95">95</a><td> } else {<tr><td><a id="l96"></a><a href="#l96">96</a><td> return null;<tr><td><a id="l97"></a><a href="#l97">97</a><td> }<tr><td><a id="l98"></a><a href="#l98">98</a><td>};<tr><td><a id="l99"></a><a href="#l99">99</a><td><tr><td><a id="l100"></a><a href="#l100">100</a><td><tr><td><a id="l101"></a><a href="#l101">101</a><td>/**<tr><td><a id="l102"></a><a href="#l102">102</a><td> * Checks whether this browser supports Object Urls. If not, calls to<tr><td><a id="l103"></a><a href="#l103">103</a><td> * createObjectUrl and revokeObjectUrl will result in an error.<tr><td><a id="l104"></a><a href="#l104">104</a><td> *<tr><td><a id="l105"></a><a href="#l105">105</a><td> * @return {boolean} True if this browser supports Object Urls.<tr><td><a id="l106"></a><a href="#l106">106</a><td> */<tr><td><a id="l107"></a><a href="#l107">107</a><td>goog.fs.url.browserSupportsObjectUrls = function() {<tr><td><a id="l108"></a><a href="#l108">108</a><td> return goog.fs.url.findUrlObject_() != null;<tr><td><a id="l109"></a><a href="#l109">109</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>
package/docs/source/lib/goog/functions/functions.js.src.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE 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>functions.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/functions/functions.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2008 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 &quot;License&quot;);<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 &quot;AS-IS&quot; 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 Utilities for creating functions. Loosely inspired by the<tr><td><a id="l17"></a><a href="#l17">17</a><td> * java classes: http://goo.gl/GM0Hmu and http://goo.gl/6k7nI8.<tr><td><a id="l18"></a><a href="#l18">18</a><td> *<tr><td><a id="l19"></a><a href="#l19">19</a><td> * @author nicksantos@google.com (Nick Santos)<tr><td><a id="l20"></a><a href="#l20">20</a><td> */<tr><td><a id="l21"></a><a href="#l21">21</a><td><tr><td><a id="l22"></a><a href="#l22">22</a><td><tr><td><a id="l23"></a><a href="#l23">23</a><td>goog.provide(&#39;goog.functions&#39;);<tr><td><a id="l24"></a><a href="#l24">24</a><td><tr><td><a id="l25"></a><a href="#l25">25</a><td><tr><td><a id="l26"></a><a href="#l26">26</a><td>/**<tr><td><a id="l27"></a><a href="#l27">27</a><td> * Creates a function that always returns the same value.<tr><td><a id="l28"></a><a href="#l28">28</a><td> * @param {T} retValue The value to return.<tr><td><a id="l29"></a><a href="#l29">29</a><td> * @return {function():T} The new function.<tr><td><a id="l30"></a><a href="#l30">30</a><td> * @template T<tr><td><a id="l31"></a><a href="#l31">31</a><td> */<tr><td><a id="l32"></a><a href="#l32">32</a><td>goog.functions.constant = function(retValue) {<tr><td><a id="l33"></a><a href="#l33">33</a><td> return function() {<tr><td><a id="l34"></a><a href="#l34">34</a><td> return retValue;<tr><td><a id="l35"></a><a href="#l35">35</a><td> };<tr><td><a id="l36"></a><a href="#l36">36</a><td>};<tr><td><a id="l37"></a><a href="#l37">37</a><td><tr><td><a id="l38"></a><a href="#l38">38</a><td><tr><td><a id="l39"></a><a href="#l39">39</a><td>/**<tr><td><a id="l40"></a><a href="#l40">40</a><td> * Always returns false.<tr><td><a id="l41"></a><a href="#l41">41</a><td> * @type {function(...): boolean}<tr><td><a id="l42"></a><a href="#l42">42</a><td> */<tr><td><a id="l43"></a><a href="#l43">43</a><td>goog.functions.FALSE = goog.functions.constant(false);<tr><td><a id="l44"></a><a href="#l44">44</a><td><tr><td><a id="l45"></a><a href="#l45">45</a><td><tr><td><a id="l46"></a><a href="#l46">46</a><td>/**<tr><td><a id="l47"></a><a href="#l47">47</a><td> * Always returns true.<tr><td><a id="l48"></a><a href="#l48">48</a><td> * @type {function(...): boolean}<tr><td><a id="l49"></a><a href="#l49">49</a><td> */<tr><td><a id="l50"></a><a href="#l50">50</a><td>goog.functions.TRUE = goog.functions.constant(true);<tr><td><a id="l51"></a><a href="#l51">51</a><td><tr><td><a id="l52"></a><a href="#l52">52</a><td><tr><td><a id="l53"></a><a href="#l53">53</a><td>/**<tr><td><a id="l54"></a><a href="#l54">54</a><td> * Always returns NULL.<tr><td><a id="l55"></a><a href="#l55">55</a><td> * @type {function(...): null}<tr><td><a id="l56"></a><a href="#l56">56</a><td> */<tr><td><a id="l57"></a><a href="#l57">57</a><td>goog.functions.NULL = goog.functions.constant(null);<tr><td><a id="l58"></a><a href="#l58">58</a><td><tr><td><a id="l59"></a><a href="#l59">59</a><td><tr><td><a id="l60"></a><a href="#l60">60</a><td>/**<tr><td><a id="l61"></a><a href="#l61">61</a><td> * A simple function that returns the first argument of whatever is passed<tr><td><a id="l62"></a><a href="#l62">62</a><td> * into it.<tr><td><a id="l63"></a><a href="#l63">63</a><td> * @param {T=} opt_returnValue The single value that will be returned.<tr><td><a id="l64"></a><a href="#l64">64</a><td> * @param {...*} var_args Optional trailing arguments. These are ignored.<tr><td><a id="l65"></a><a href="#l65">65</a><td> * @return {T} The first argument passed in, or undefined if nothing was passed.<tr><td><a id="l66"></a><a href="#l66">66</a><td> * @template T<tr><td><a id="l67"></a><a href="#l67">67</a><td> */<tr><td><a id="l68"></a><a href="#l68">68</a><td>goog.functions.identity = function(opt_returnValue, var_args) {<tr><td><a id="l69"></a><a href="#l69">69</a><td> return opt_returnValue;<tr><td><a id="l70"></a><a href="#l70">70</a><td>};<tr><td><a id="l71"></a><a href="#l71">71</a><td><tr><td><a id="l72"></a><a href="#l72">72</a><td><tr><td><a id="l73"></a><a href="#l73">73</a><td>/**<tr><td><a id="l74"></a><a href="#l74">74</a><td> * Creates a function that always throws an error with the given message.<tr><td><a id="l75"></a><a href="#l75">75</a><td> * @param {string} message The error message.<tr><td><a id="l76"></a><a href="#l76">76</a><td> * @return {!Function} The error-throwing function.<tr><td><a id="l77"></a><a href="#l77">77</a><td> */<tr><td><a id="l78"></a><a href="#l78">78</a><td>goog.functions.error = function(message) {<tr><td><a id="l79"></a><a href="#l79">79</a><td> return function() {<tr><td><a id="l80"></a><a href="#l80">80</a><td> throw Error(message);<tr><td><a id="l81"></a><a href="#l81">81</a><td> };<tr><td><a id="l82"></a><a href="#l82">82</a><td>};<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> * Creates a function that throws the given object.<tr><td><a id="l87"></a><a href="#l87">87</a><td> * @param {*} err An object to be thrown.<tr><td><a id="l88"></a><a href="#l88">88</a><td> * @return {!Function} The error-throwing function.<tr><td><a id="l89"></a><a href="#l89">89</a><td> */<tr><td><a id="l90"></a><a href="#l90">90</a><td>goog.functions.fail = function(err) {<tr><td><a id="l91"></a><a href="#l91">91</a><td> return function() {<tr><td><a id="l92"></a><a href="#l92">92</a><td> throw err;<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><tr><td><a id="l96"></a><a href="#l96">96</a><td><tr><td><a id="l97"></a><a href="#l97">97</a><td>/**<tr><td><a id="l98"></a><a href="#l98">98</a><td> * Given a function, create a function that keeps opt_numArgs arguments and<tr><td><a id="l99"></a><a href="#l99">99</a><td> * silently discards all additional arguments.<tr><td><a id="l100"></a><a href="#l100">100</a><td> * @param {Function} f The original function.<tr><td><a id="l101"></a><a href="#l101">101</a><td> * @param {number=} opt_numArgs The number of arguments to keep. Defaults to 0.<tr><td><a id="l102"></a><a href="#l102">102</a><td> * @return {!Function} A version of f that only keeps the first opt_numArgs<tr><td><a id="l103"></a><a href="#l103">103</a><td> * arguments.<tr><td><a id="l104"></a><a href="#l104">104</a><td> */<tr><td><a id="l105"></a><a href="#l105">105</a><td>goog.functions.lock = function(f, opt_numArgs) {<tr><td><a id="l106"></a><a href="#l106">106</a><td> opt_numArgs = opt_numArgs || 0;<tr><td><a id="l107"></a><a href="#l107">107</a><td> return function() {<tr><td><a id="l108"></a><a href="#l108">108</a><td> return f.apply(this, Array.prototype.slice.call(arguments, 0, opt_numArgs));<tr><td><a id="l109"></a><a href="#l109">109</a><td> };<tr><td><a id="l110"></a><a href="#l110">110</a><td>};<tr><td><a id="l111"></a><a href="#l111">111</a><td><tr><td><a id="l112"></a><a href="#l112">112</a><td><tr><td><a id="l113"></a><a href="#l113">113</a><td>/**<tr><td><a id="l114"></a><a href="#l114">114</a><td> * Creates a function that returns its nth argument.<tr><td><a id="l115"></a><a href="#l115">115</a><td> * @param {number} n The position of the return argument.<tr><td><a id="l116"></a><a href="#l116">116</a><td> * @return {!Function} A new function.<tr><td><a id="l117"></a><a href="#l117">117</a><td> */<tr><td><a id="l118"></a><a href="#l118">118</a><td>goog.functions.nth = function(n) {<tr><td><a id="l119"></a><a href="#l119">119</a><td> return function() {<tr><td><a id="l120"></a><a href="#l120">120</a><td> return arguments[n];<tr><td><a id="l121"></a><a href="#l121">121</a><td> };<tr><td><a id="l122"></a><a href="#l122">122</a><td>};<tr><td><a id="l123"></a><a href="#l123">123</a><td><tr><td><a id="l124"></a><a href="#l124">124</a><td><tr><td><a id="l125"></a><a href="#l125">125</a><td>/**<tr><td><a id="l126"></a><a href="#l126">126</a><td> * Given a function, create a new function that swallows its return value<tr><td><a id="l127"></a><a href="#l127">127</a><td> * and replaces it with a new one.<tr><td><a id="l128"></a><a href="#l128">128</a><td> * @param {Function} f A function.<tr><td><a id="l129"></a><a href="#l129">129</a><td> * @param {T} retValue A new return value.<tr><td><a id="l130"></a><a href="#l130">130</a><td> * @return {function(...?):T} A new function.<tr><td><a id="l131"></a><a href="#l131">131</a><td> * @template T<tr><td><a id="l132"></a><a href="#l132">132</a><td> */<tr><td><a id="l133"></a><a href="#l133">133</a><td>goog.functions.withReturnValue = function(f, retValue) {<tr><td><a id="l134"></a><a href="#l134">134</a><td> return goog.functions.sequence(f, goog.functions.constant(retValue));<tr><td><a id="l135"></a><a href="#l135">135</a><td>};<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> * Creates a function that returns whether its arguement equals the given value.<tr><td><a id="l140"></a><a href="#l140">140</a><td> *<tr><td><a id="l141"></a><a href="#l141">141</a><td> * Example:<tr><td><a id="l142"></a><a href="#l142">142</a><td> * var key = goog.object.findKey(obj, goog.functions.equalTo(&#39;needle&#39;));<tr><td><a id="l143"></a><a href="#l143">143</a><td> *<tr><td><a id="l144"></a><a href="#l144">144</a><td> * @param {*} value The value to compare to.<tr><td><a id="l145"></a><a href="#l145">145</a><td> * @param {boolean=} opt_useLooseComparison Whether to use a loose (==)<tr><td><a id="l146"></a><a href="#l146">146</a><td> * comparison rather than a strict (===) one. Defaults to false.<tr><td><a id="l147"></a><a href="#l147">147</a><td> * @return {function(*):boolean} The new function.<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.functions.equalTo = function(value, opt_useLooseComparison) {<tr><td><a id="l150"></a><a href="#l150">150</a><td> return function(other) {<tr><td><a id="l151"></a><a href="#l151">151</a><td> return opt_useLooseComparison ? (value == other) : (value === other);<tr><td><a id="l152"></a><a href="#l152">152</a><td> };<tr><td><a id="l153"></a><a href="#l153">153</a><td>};<tr><td><a id="l154"></a><a href="#l154">154</a><td><tr><td><a id="l155"></a><a href="#l155">155</a><td><tr><td><a id="l156"></a><a href="#l156">156</a><td>/**<tr><td><a id="l157"></a><a href="#l157">157</a><td> * Creates the composition of the functions passed in.<tr><td><a id="l158"></a><a href="#l158">158</a><td> * For example, (goog.functions.compose(f, g))(a) is equivalent to f(g(a)).<tr><td><a id="l159"></a><a href="#l159">159</a><td> * @param {function(...?):T} fn The final function.<tr><td><a id="l160"></a><a href="#l160">160</a><td> * @param {...Function} var_args A list of functions.<tr><td><a id="l161"></a><a href="#l161">161</a><td> * @return {function(...?):T} The composition of all inputs.<tr><td><a id="l162"></a><a href="#l162">162</a><td> * @template T<tr><td><a id="l163"></a><a href="#l163">163</a><td> */<tr><td><a id="l164"></a><a href="#l164">164</a><td>goog.functions.compose = function(fn, var_args) {<tr><td><a id="l165"></a><a href="#l165">165</a><td> var functions = arguments;<tr><td><a id="l166"></a><a href="#l166">166</a><td> var length = functions.length;<tr><td><a id="l167"></a><a href="#l167">167</a><td> return function() {<tr><td><a id="l168"></a><a href="#l168">168</a><td> var result;<tr><td><a id="l169"></a><a href="#l169">169</a><td> if (length) {<tr><td><a id="l170"></a><a href="#l170">170</a><td> result = functions[length - 1].apply(this, arguments);<tr><td><a id="l171"></a><a href="#l171">171</a><td> }<tr><td><a id="l172"></a><a href="#l172">172</a><td><tr><td><a id="l173"></a><a href="#l173">173</a><td> for (var i = length - 2; i &gt;= 0; i--) {<tr><td><a id="l174"></a><a href="#l174">174</a><td> result = functions[i].call(this, result);<tr><td><a id="l175"></a><a href="#l175">175</a><td> }<tr><td><a id="l176"></a><a href="#l176">176</a><td> return result;<tr><td><a id="l177"></a><a href="#l177">177</a><td> };<tr><td><a id="l178"></a><a href="#l178">178</a><td>};<tr><td><a id="l179"></a><a href="#l179">179</a><td><tr><td><a id="l180"></a><a href="#l180">180</a><td><tr><td><a id="l181"></a><a href="#l181">181</a><td>/**<tr><td><a id="l182"></a><a href="#l182">182</a><td> * Creates a function that calls the functions passed in in sequence, and<tr><td><a id="l183"></a><a href="#l183">183</a><td> * returns the value of the last function. For example,<tr><td><a id="l184"></a><a href="#l184">184</a><td> * (goog.functions.sequence(f, g))(x) is equivalent to f(x),g(x).<tr><td><a id="l185"></a><a href="#l185">185</a><td> * @param {...Function} var_args A list of functions.<tr><td><a id="l186"></a><a href="#l186">186</a><td> * @return {!Function} A function that calls all inputs in sequence.<tr><td><a id="l187"></a><a href="#l187">187</a><td> */<tr><td><a id="l188"></a><a href="#l188">188</a><td>goog.functions.sequence = function(var_args) {<tr><td><a id="l189"></a><a href="#l189">189</a><td> var functions = arguments;<tr><td><a id="l190"></a><a href="#l190">190</a><td> var length = functions.length;<tr><td><a id="l191"></a><a href="#l191">191</a><td> return function() {<tr><td><a id="l192"></a><a href="#l192">192</a><td> var result;<tr><td><a id="l193"></a><a href="#l193">193</a><td> for (var i = 0; i &lt; length; i++) {<tr><td><a id="l194"></a><a href="#l194">194</a><td> result = functions[i].apply(this, arguments);<tr><td><a id="l195"></a><a href="#l195">195</a><td> }<tr><td><a id="l196"></a><a href="#l196">196</a><td> return result;<tr><td><a id="l197"></a><a href="#l197">197</a><td> };<tr><td><a id="l198"></a><a href="#l198">198</a><td>};<tr><td><a id="l199"></a><a href="#l199">199</a><td><tr><td><a id="l200"></a><a href="#l200">200</a><td><tr><td><a id="l201"></a><a href="#l201">201</a><td>/**<tr><td><a id="l202"></a><a href="#l202">202</a><td> * Creates a function that returns true if each of its components evaluates<tr><td><a id="l203"></a><a href="#l203">203</a><td> * to true. The components are evaluated in order, and the evaluation will be<tr><td><a id="l204"></a><a href="#l204">204</a><td> * short-circuited as soon as a function returns false.<tr><td><a id="l205"></a><a href="#l205">205</a><td> * For example, (goog.functions.and(f, g))(x) is equivalent to f(x) &amp;&amp; g(x).<tr><td><a id="l206"></a><a href="#l206">206</a><td> * @param {...Function} var_args A list of functions.<tr><td><a id="l207"></a><a href="#l207">207</a><td> * @return {function(...?):boolean} A function that ANDs its component<tr><td><a id="l208"></a><a href="#l208">208</a><td> * functions.<tr><td><a id="l209"></a><a href="#l209">209</a><td> */<tr><td><a id="l210"></a><a href="#l210">210</a><td>goog.functions.and = function(var_args) {<tr><td><a id="l211"></a><a href="#l211">211</a><td> var functions = arguments;<tr><td><a id="l212"></a><a href="#l212">212</a><td> var length = functions.length;<tr><td><a id="l213"></a><a href="#l213">213</a><td> return function() {<tr><td><a id="l214"></a><a href="#l214">214</a><td> for (var i = 0; i &lt; length; i++) {<tr><td><a id="l215"></a><a href="#l215">215</a><td> if (!functions[i].apply(this, arguments)) {<tr><td><a id="l216"></a><a href="#l216">216</a><td> return false;<tr><td><a id="l217"></a><a href="#l217">217</a><td> }<tr><td><a id="l218"></a><a href="#l218">218</a><td> }<tr><td><a id="l219"></a><a href="#l219">219</a><td> return true;<tr><td><a id="l220"></a><a href="#l220">220</a><td> };<tr><td><a id="l221"></a><a href="#l221">221</a><td>};<tr><td><a id="l222"></a><a href="#l222">222</a><td><tr><td><a id="l223"></a><a href="#l223">223</a><td><tr><td><a id="l224"></a><a href="#l224">224</a><td>/**<tr><td><a id="l225"></a><a href="#l225">225</a><td> * Creates a function that returns true if any of its components evaluates<tr><td><a id="l226"></a><a href="#l226">226</a><td> * to true. The components are evaluated in order, and the evaluation will be<tr><td><a id="l227"></a><a href="#l227">227</a><td> * short-circuited as soon as a function returns true.<tr><td><a id="l228"></a><a href="#l228">228</a><td> * For example, (goog.functions.or(f, g))(x) is equivalent to f(x) || g(x).<tr><td><a id="l229"></a><a href="#l229">229</a><td> * @param {...Function} var_args A list of functions.<tr><td><a id="l230"></a><a href="#l230">230</a><td> * @return {function(...?):boolean} A function that ORs its component<tr><td><a id="l231"></a><a href="#l231">231</a><td> * functions.<tr><td><a id="l232"></a><a href="#l232">232</a><td> */<tr><td><a id="l233"></a><a href="#l233">233</a><td>goog.functions.or = function(var_args) {<tr><td><a id="l234"></a><a href="#l234">234</a><td> var functions = arguments;<tr><td><a id="l235"></a><a href="#l235">235</a><td> var length = functions.length;<tr><td><a id="l236"></a><a href="#l236">236</a><td> return function() {<tr><td><a id="l237"></a><a href="#l237">237</a><td> for (var i = 0; i &lt; length; i++) {<tr><td><a id="l238"></a><a href="#l238">238</a><td> if (functions[i].apply(this, arguments)) {<tr><td><a id="l239"></a><a href="#l239">239</a><td> return true;<tr><td><a id="l240"></a><a href="#l240">240</a><td> }<tr><td><a id="l241"></a><a href="#l241">241</a><td> }<tr><td><a id="l242"></a><a href="#l242">242</a><td> return false;<tr><td><a id="l243"></a><a href="#l243">243</a><td> };<tr><td><a id="l244"></a><a href="#l244">244</a><td>};<tr><td><a id="l245"></a><a href="#l245">245</a><td><tr><td><a id="l246"></a><a href="#l246">246</a><td><tr><td><a id="l247"></a><a href="#l247">247</a><td>/**<tr><td><a id="l248"></a><a href="#l248">248</a><td> * Creates a function that returns the Boolean opposite of a provided function.<tr><td><a id="l249"></a><a href="#l249">249</a><td> * For example, (goog.functions.not(f))(x) is equivalent to !f(x).<tr><td><a id="l250"></a><a href="#l250">250</a><td> * @param {!Function} f The original function.<tr><td><a id="l251"></a><a href="#l251">251</a><td> * @return {function(...?):boolean} A function that delegates to f and returns<tr><td><a id="l252"></a><a href="#l252">252</a><td> * opposite.<tr><td><a id="l253"></a><a href="#l253">253</a><td> */<tr><td><a id="l254"></a><a href="#l254">254</a><td>goog.functions.not = function(f) {<tr><td><a id="l255"></a><a href="#l255">255</a><td> return function() {<tr><td><a id="l256"></a><a href="#l256">256</a><td> return !f.apply(this, arguments);<tr><td><a id="l257"></a><a href="#l257">257</a><td> };<tr><td><a id="l258"></a><a href="#l258">258</a><td>};<tr><td><a id="l259"></a><a href="#l259">259</a><td><tr><td><a id="l260"></a><a href="#l260">260</a><td><tr><td><a id="l261"></a><a href="#l261">261</a><td>/**<tr><td><a id="l262"></a><a href="#l262">262</a><td> * Generic factory function to construct an object given the constructor<tr><td><a id="l263"></a><a href="#l263">263</a><td> * and the arguments. Intended to be bound to create object factories.<tr><td><a id="l264"></a><a href="#l264">264</a><td> *<tr><td><a id="l265"></a><a href="#l265">265</a><td> * Example:<tr><td><a id="l266"></a><a href="#l266">266</a><td> *<tr><td><a id="l267"></a><a href="#l267">267</a><td> * var factory = goog.partial(goog.functions.create, Class);<tr><td><a id="l268"></a><a href="#l268">268</a><td> *<tr><td><a id="l269"></a><a href="#l269">269</a><td> * @param {function(new:T, ...)} constructor The constructor for the Object.<tr><td><a id="l270"></a><a href="#l270">270</a><td> * @param {...*} var_args The arguments to be passed to the constructor.<tr><td><a id="l271"></a><a href="#l271">271</a><td> * @return {T} A new instance of the class given in {@code constructor}.<tr><td><a id="l272"></a><a href="#l272">272</a><td> * @template T<tr><td><a id="l273"></a><a href="#l273">273</a><td> */<tr><td><a id="l274"></a><a href="#l274">274</a><td>goog.functions.create = function(constructor, var_args) {<tr><td><a id="l275"></a><a href="#l275">275</a><td> /**<tr><td><a id="l276"></a><a href="#l276">276</a><td> * @constructor<tr><td><a id="l277"></a><a href="#l277">277</a><td> * @final<tr><td><a id="l278"></a><a href="#l278">278</a><td> */<tr><td><a id="l279"></a><a href="#l279">279</a><td> var temp = function() {};<tr><td><a id="l280"></a><a href="#l280">280</a><td> temp.prototype = constructor.prototype;<tr><td><a id="l281"></a><a href="#l281">281</a><td><tr><td><a id="l282"></a><a href="#l282">282</a><td> // obj will have constructor&#39;s prototype in its chain and<tr><td><a id="l283"></a><a href="#l283">283</a><td> // &#39;obj instanceof constructor&#39; will be true.<tr><td><a id="l284"></a><a href="#l284">284</a><td> var obj = new temp();<tr><td><a id="l285"></a><a href="#l285">285</a><td><tr><td><a id="l286"></a><a href="#l286">286</a><td> // obj is initialized by constructor.<tr><td><a id="l287"></a><a href="#l287">287</a><td> // arguments is only array-like so lacks shift(), but can be used with<tr><td><a id="l288"></a><a href="#l288">288</a><td> // the Array prototype function.<tr><td><a id="l289"></a><a href="#l289">289</a><td> constructor.apply(obj, Array.prototype.slice.call(arguments, 1));<tr><td><a id="l290"></a><a href="#l290">290</a><td> return obj;<tr><td><a id="l291"></a><a href="#l291">291</a><td>};<tr><td><a id="l292"></a><a href="#l292">292</a><td><tr><td><a id="l293"></a><a href="#l293">293</a><td><tr><td><a id="l294"></a><a href="#l294">294</a><td>/**<tr><td><a id="l295"></a><a href="#l295">295</a><td> * @define {boolean} Whether the return value cache should be used.<tr><td><a id="l296"></a><a href="#l296">296</a><td> * This should only be used to disable caches when testing.<tr><td><a id="l297"></a><a href="#l297">297</a><td> */<tr><td><a id="l298"></a><a href="#l298">298</a><td>goog.define(&#39;goog.functions.CACHE_RETURN_VALUE&#39;, true);<tr><td><a id="l299"></a><a href="#l299">299</a><td><tr><td><a id="l300"></a><a href="#l300">300</a><td><tr><td><a id="l301"></a><a href="#l301">301</a><td>/**<tr><td><a id="l302"></a><a href="#l302">302</a><td> * Gives a wrapper function that caches the return value of a parameterless<tr><td><a id="l303"></a><a href="#l303">303</a><td> * function when first called.<tr><td><a id="l304"></a><a href="#l304">304</a><td> *<tr><td><a id="l305"></a><a href="#l305">305</a><td> * When called for the first time, the given function is called and its<tr><td><a id="l306"></a><a href="#l306">306</a><td> * return value is cached (thus this is only appropriate for idempotent<tr><td><a id="l307"></a><a href="#l307">307</a><td> * functions). Subsequent calls will return the cached return value. This<tr><td><a id="l308"></a><a href="#l308">308</a><td> * allows the evaluation of expensive functions to be delayed until first used.<tr><td><a id="l309"></a><a href="#l309">309</a><td> *<tr><td><a id="l310"></a><a href="#l310">310</a><td> * To cache the return values of functions with parameters, see goog.memoize.<tr><td><a id="l311"></a><a href="#l311">311</a><td> *<tr><td><a id="l312"></a><a href="#l312">312</a><td> * @param {!function():T} fn A function to lazily evaluate.<tr><td><a id="l313"></a><a href="#l313">313</a><td> * @return {!function():T} A wrapped version the function.<tr><td><a id="l314"></a><a href="#l314">314</a><td> * @template T<tr><td><a id="l315"></a><a href="#l315">315</a><td> */<tr><td><a id="l316"></a><a href="#l316">316</a><td>goog.functions.cacheReturnValue = function(fn) {<tr><td><a id="l317"></a><a href="#l317">317</a><td> var called = false;<tr><td><a id="l318"></a><a href="#l318">318</a><td> var value;<tr><td><a id="l319"></a><a href="#l319">319</a><td><tr><td><a id="l320"></a><a href="#l320">320</a><td> return function() {<tr><td><a id="l321"></a><a href="#l321">321</a><td> if (!goog.functions.CACHE_RETURN_VALUE) {<tr><td><a id="l322"></a><a href="#l322">322</a><td> return fn();<tr><td><a id="l323"></a><a href="#l323">323</a><td> }<tr><td><a id="l324"></a><a href="#l324">324</a><td><tr><td><a id="l325"></a><a href="#l325">325</a><td> if (!called) {<tr><td><a id="l326"></a><a href="#l326">326</a><td> value = fn();<tr><td><a id="l327"></a><a href="#l327">327</a><td> called = true;<tr><td><a id="l328"></a><a href="#l328">328</a><td> }<tr><td><a id="l329"></a><a href="#l329">329</a><td><tr><td><a id="l330"></a><a href="#l330">330</a><td> return value;<tr><td><a id="l331"></a><a href="#l331">331</a><td> }<tr><td><a id="l332"></a><a href="#l332">332</a><td>};<tr><td><a id="l333"></a><a href="#l333">333</a><td><tr><td><a id="l334"></a><a href="#l334">334</a><td><tr><td><a id="l335"></a><a href="#l335">335</a><td>/**<tr><td><a id="l336"></a><a href="#l336">336</a><td> * Wraps a function to allow it to be called, at most, once. All<tr><td><a id="l337"></a><a href="#l337">337</a><td> * additional calls are no-ops.<tr><td><a id="l338"></a><a href="#l338">338</a><td> *<tr><td><a id="l339"></a><a href="#l339">339</a><td> * This is particularly useful for initialization functions<tr><td><a id="l340"></a><a href="#l340">340</a><td> * that should be called, at most, once.<tr><td><a id="l341"></a><a href="#l341">341</a><td> *<tr><td><a id="l342"></a><a href="#l342">342</a><td> * @param {function():*} f Function to call.<tr><td><a id="l343"></a><a href="#l343">343</a><td> * @return {function():undefined} Wrapped function.<tr><td><a id="l344"></a><a href="#l344">344</a><td> */<tr><td><a id="l345"></a><a href="#l345">345</a><td>goog.functions.once = function(f) {<tr><td><a id="l346"></a><a href="#l346">346</a><td> // Keep a reference to the function that we null out when we&#39;re done with<tr><td><a id="l347"></a><a href="#l347">347</a><td> // it -- that way, the function can be GC&#39;d when we&#39;re done with it.<tr><td><a id="l348"></a><a href="#l348">348</a><td> var inner = f;<tr><td><a id="l349"></a><a href="#l349">349</a><td> return function() {<tr><td><a id="l350"></a><a href="#l350">350</a><td> if (inner) {<tr><td><a id="l351"></a><a href="#l351">351</a><td> var tmp = inner;<tr><td><a id="l352"></a><a href="#l352">352</a><td> inner = null;<tr><td><a id="l353"></a><a href="#l353">353</a><td> tmp();<tr><td><a id="l354"></a><a href="#l354">354</a><td> }<tr><td><a id="l355"></a><a href="#l355">355</a><td> };<tr><td><a id="l356"></a><a href="#l356">356</a><td>};<tr><td><a id="l357"></a><a href="#l357">357</a><td><tr><td><a id="l358"></a><a href="#l358">358</a><td><tr><td><a id="l359"></a><a href="#l359">359</a><td>/**<tr><td><a id="l360"></a><a href="#l360">360</a><td> * Wraps a function to allow it to be called, at most, once for each sequence of<tr><td><a id="l361"></a><a href="#l361">361</a><td> * calls fired repeatedly so long as they are fired less than a specified<tr><td><a id="l362"></a><a href="#l362">362</a><td> * interval apart (in milliseconds). Whether it receives one signal or multiple,<tr><td><a id="l363"></a><a href="#l363">363</a><td> * it will always wait until a full interval has elapsed since the last signal<tr><td><a id="l364"></a><a href="#l364">364</a><td> * before performing the action, passing the arguments from the last call of the<tr><td><a id="l365"></a><a href="#l365">365</a><td> * debouncing decorator into the decorated function.<tr><td><a id="l366"></a><a href="#l366">366</a><td> *<tr><td><a id="l367"></a><a href="#l367">367</a><td> * This is particularly useful for bulking up repeated user actions (e.g. only<tr><td><a id="l368"></a><a href="#l368">368</a><td> * refreshing a view once a user finishes typing rather than updating with every<tr><td><a id="l369"></a><a href="#l369">369</a><td> * keystroke). For more stateful debouncing with support for pausing, resuming,<tr><td><a id="l370"></a><a href="#l370">370</a><td> * and canceling debounced actions, use {@code goog.async.Debouncer}.<tr><td><a id="l371"></a><a href="#l371">371</a><td> *<tr><td><a id="l372"></a><a href="#l372">372</a><td> * @param {function(this:SCOPE, ...?)} f Function to call.<tr><td><a id="l373"></a><a href="#l373">373</a><td> * @param {number} interval Interval over which to debounce. The function will<tr><td><a id="l374"></a><a href="#l374">374</a><td> * only be called after the full interval has elapsed since the last call.<tr><td><a id="l375"></a><a href="#l375">375</a><td> * @param {SCOPE=} opt_scope Object in whose scope to call the function.<tr><td><a id="l376"></a><a href="#l376">376</a><td> * @return {function(...?): undefined} Wrapped function.<tr><td><a id="l377"></a><a href="#l377">377</a><td> * @template SCOPE<tr><td><a id="l378"></a><a href="#l378">378</a><td> */<tr><td><a id="l379"></a><a href="#l379">379</a><td>goog.functions.debounce = function(f, interval, opt_scope) {<tr><td><a id="l380"></a><a href="#l380">380</a><td> if (opt_scope) {<tr><td><a id="l381"></a><a href="#l381">381</a><td> f = goog.bind(f, opt_scope);<tr><td><a id="l382"></a><a href="#l382">382</a><td> }<tr><td><a id="l383"></a><a href="#l383">383</a><td> var timeout = null;<tr><td><a id="l384"></a><a href="#l384">384</a><td> return /** @type {function(...?)} */ (function(var_args) {<tr><td><a id="l385"></a><a href="#l385">385</a><td> goog.global.clearTimeout(timeout);<tr><td><a id="l386"></a><a href="#l386">386</a><td> var args = arguments;<tr><td><a id="l387"></a><a href="#l387">387</a><td> timeout = goog.global.setTimeout(function() {<tr><td><a id="l388"></a><a href="#l388">388</a><td> f.apply(null, args);<tr><td><a id="l389"></a><a href="#l389">389</a><td> }, interval);<tr><td><a id="l390"></a><a href="#l390">390</a><td> });<tr><td><a id="l391"></a><a href="#l391">391</a><td>};<tr><td><a id="l392"></a><a href="#l392">392</a><td><tr><td><a id="l393"></a><a href="#l393">393</a><td><tr><td><a id="l394"></a><a href="#l394">394</a><td>/**<tr><td><a id="l395"></a><a href="#l395">395</a><td> * Wraps a function to allow it to be called, at most, once per interval<tr><td><a id="l396"></a><a href="#l396">396</a><td> * (specified in milliseconds). If it is called multiple times while it is<tr><td><a id="l397"></a><a href="#l397">397</a><td> * waiting, it will only perform the action once at the end of the interval,<tr><td><a id="l398"></a><a href="#l398">398</a><td> * passing the arguments from the last call of the throttling decorator into the<tr><td><a id="l399"></a><a href="#l399">399</a><td> * decorated function.<tr><td><a id="l400"></a><a href="#l400">400</a><td> *<tr><td><a id="l401"></a><a href="#l401">401</a><td> * This is particularly useful for limiting repeated user requests (e.g.<tr><td><a id="l402"></a><a href="#l402">402</a><td> * preventing a user from spamming a server with frequent view refreshes). For<tr><td><a id="l403"></a><a href="#l403">403</a><td> * more stateful throttling with support for pausing, resuming, and canceling<tr><td><a id="l404"></a><a href="#l404">404</a><td> * throttled actions, use {@code goog.async.Throttle}.<tr><td><a id="l405"></a><a href="#l405">405</a><td> *<tr><td><a id="l406"></a><a href="#l406">406</a><td> * @param {function(this:SCOPE, ...?)} f Function to call.<tr><td><a id="l407"></a><a href="#l407">407</a><td> * @param {number} interval Interval over which to throttle. The function can<tr><td><a id="l408"></a><a href="#l408">408</a><td> * only be called once per interval.<tr><td><a id="l409"></a><a href="#l409">409</a><td> * @param {SCOPE=} opt_scope Object in whose scope to call the function.<tr><td><a id="l410"></a><a href="#l410">410</a><td> * @return {function(...?): undefined} Wrapped function.<tr><td><a id="l411"></a><a href="#l411">411</a><td> * @template SCOPE<tr><td><a id="l412"></a><a href="#l412">412</a><td> */<tr><td><a id="l413"></a><a href="#l413">413</a><td>goog.functions.throttle = function(f, interval, opt_scope) {<tr><td><a id="l414"></a><a href="#l414">414</a><td> if (opt_scope) {<tr><td><a id="l415"></a><a href="#l415">415</a><td> f = goog.bind(f, opt_scope);<tr><td><a id="l416"></a><a href="#l416">416</a><td> }<tr><td><a id="l417"></a><a href="#l417">417</a><td> var timeout = null;<tr><td><a id="l418"></a><a href="#l418">418</a><td> var shouldFire = false;<tr><td><a id="l419"></a><a href="#l419">419</a><td> var args = [];<tr><td><a id="l420"></a><a href="#l420">420</a><td><tr><td><a id="l421"></a><a href="#l421">421</a><td> var handleTimeout = function() {<tr><td><a id="l422"></a><a href="#l422">422</a><td> timeout = null;<tr><td><a id="l423"></a><a href="#l423">423</a><td> if (shouldFire) {<tr><td><a id="l424"></a><a href="#l424">424</a><td> shouldFire = false;<tr><td><a id="l425"></a><a href="#l425">425</a><td> fire();<tr><td><a id="l426"></a><a href="#l426">426</a><td> }<tr><td><a id="l427"></a><a href="#l427">427</a><td> };<tr><td><a id="l428"></a><a href="#l428">428</a><td><tr><td><a id="l429"></a><a href="#l429">429</a><td> var fire = function() {<tr><td><a id="l430"></a><a href="#l430">430</a><td> timeout = goog.global.setTimeout(handleTimeout, interval);<tr><td><a id="l431"></a><a href="#l431">431</a><td> f.apply(null, args);<tr><td><a id="l432"></a><a href="#l432">432</a><td> };<tr><td><a id="l433"></a><a href="#l433">433</a><td><tr><td><a id="l434"></a><a href="#l434">434</a><td> return /** @type {function(...?)} */ (function(var_args) {<tr><td><a id="l435"></a><a href="#l435">435</a><td> args = arguments;<tr><td><a id="l436"></a><a href="#l436">436</a><td> if (!timeout) {<tr><td><a id="l437"></a><a href="#l437">437</a><td> fire();<tr><td><a id="l438"></a><a href="#l438">438</a><td> } else {<tr><td><a id="l439"></a><a href="#l439">439</a><td> shouldFire = true;<tr><td><a id="l440"></a><a href="#l440">440</a><td> }<tr><td><a id="l441"></a><a href="#l441">441</a><td> });<tr><td><a id="l442"></a><a href="#l442">442</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>
package/docs/source/lib/goog/html/safehtml.js.src.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE 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>safehtml.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/html/safehtml.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2013 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 &quot;License&quot;);<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 &quot;AS-IS&quot; 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>/**<tr><td><a id="l17"></a><a href="#l17">17</a><td> * @fileoverview The SafeHtml type and its builders.<tr><td><a id="l18"></a><a href="#l18">18</a><td> *<tr><td><a id="l19"></a><a href="#l19">19</a><td> * TODO(xtof): Link to document stating type contract.<tr><td><a id="l20"></a><a href="#l20">20</a><td> */<tr><td><a id="l21"></a><a href="#l21">21</a><td><tr><td><a id="l22"></a><a href="#l22">22</a><td>goog.provide(&#39;goog.html.SafeHtml&#39;);<tr><td><a id="l23"></a><a href="#l23">23</a><td><tr><td><a id="l24"></a><a href="#l24">24</a><td>goog.require(&#39;goog.array&#39;);<tr><td><a id="l25"></a><a href="#l25">25</a><td>goog.require(&#39;goog.asserts&#39;);<tr><td><a id="l26"></a><a href="#l26">26</a><td>goog.require(&#39;goog.dom.TagName&#39;);<tr><td><a id="l27"></a><a href="#l27">27</a><td>goog.require(&#39;goog.dom.tags&#39;);<tr><td><a id="l28"></a><a href="#l28">28</a><td>goog.require(&#39;goog.html.SafeStyle&#39;);<tr><td><a id="l29"></a><a href="#l29">29</a><td>goog.require(&#39;goog.html.SafeStyleSheet&#39;);<tr><td><a id="l30"></a><a href="#l30">30</a><td>goog.require(&#39;goog.html.SafeUrl&#39;);<tr><td><a id="l31"></a><a href="#l31">31</a><td>goog.require(&#39;goog.html.TrustedResourceUrl&#39;);<tr><td><a id="l32"></a><a href="#l32">32</a><td>goog.require(&#39;goog.i18n.bidi.Dir&#39;);<tr><td><a id="l33"></a><a href="#l33">33</a><td>goog.require(&#39;goog.i18n.bidi.DirectionalString&#39;);<tr><td><a id="l34"></a><a href="#l34">34</a><td>goog.require(&#39;goog.object&#39;);<tr><td><a id="l35"></a><a href="#l35">35</a><td>goog.require(&#39;goog.string&#39;);<tr><td><a id="l36"></a><a href="#l36">36</a><td>goog.require(&#39;goog.string.Const&#39;);<tr><td><a id="l37"></a><a href="#l37">37</a><td>goog.require(&#39;goog.string.TypedString&#39;);<tr><td><a id="l38"></a><a href="#l38">38</a><td><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> * A string that is safe to use in HTML context in DOM APIs and HTML documents.<tr><td><a id="l43"></a><a href="#l43">43</a><td> *<tr><td><a id="l44"></a><a href="#l44">44</a><td> * A SafeHtml is a string-like object that carries the security type contract<tr><td><a id="l45"></a><a href="#l45">45</a><td> * that its value as a string will not cause untrusted script execution when<tr><td><a id="l46"></a><a href="#l46">46</a><td> * evaluated as HTML in a browser.<tr><td><a id="l47"></a><a href="#l47">47</a><td> *<tr><td><a id="l48"></a><a href="#l48">48</a><td> * Values of this type are guaranteed to be safe to use in HTML contexts,<tr><td><a id="l49"></a><a href="#l49">49</a><td> * such as, assignment to the innerHTML DOM property, or interpolation into<tr><td><a id="l50"></a><a href="#l50">50</a><td> * a HTML template in HTML PC_DATA context, in the sense that the use will not<tr><td><a id="l51"></a><a href="#l51">51</a><td> * result in a Cross-Site-Scripting vulnerability.<tr><td><a id="l52"></a><a href="#l52">52</a><td> *<tr><td><a id="l53"></a><a href="#l53">53</a><td> * Instances of this type must be created via the factory methods<tr><td><a id="l54"></a><a href="#l54">54</a><td> * ({@code goog.html.SafeHtml.create}, {@code goog.html.SafeHtml.htmlEscape}),<tr><td><a id="l55"></a><a href="#l55">55</a><td> * etc and not by invoking its constructor. The constructor intentionally<tr><td><a id="l56"></a><a href="#l56">56</a><td> * takes no parameters and the type is immutable; hence only a default instance<tr><td><a id="l57"></a><a href="#l57">57</a><td> * corresponding to the empty string can be obtained via constructor invocation.<tr><td><a id="l58"></a><a href="#l58">58</a><td> *<tr><td><a id="l59"></a><a href="#l59">59</a><td> * @see goog.html.SafeHtml#create<tr><td><a id="l60"></a><a href="#l60">60</a><td> * @see goog.html.SafeHtml#htmlEscape<tr><td><a id="l61"></a><a href="#l61">61</a><td> * @constructor<tr><td><a id="l62"></a><a href="#l62">62</a><td> * @final<tr><td><a id="l63"></a><a href="#l63">63</a><td> * @struct<tr><td><a id="l64"></a><a href="#l64">64</a><td> * @implements {goog.i18n.bidi.DirectionalString}<tr><td><a id="l65"></a><a href="#l65">65</a><td> * @implements {goog.string.TypedString}<tr><td><a id="l66"></a><a href="#l66">66</a><td> */<tr><td><a id="l67"></a><a href="#l67">67</a><td>goog.html.SafeHtml = function() {<tr><td><a id="l68"></a><a href="#l68">68</a><td> /**<tr><td><a id="l69"></a><a href="#l69">69</a><td> * The contained value of this SafeHtml. The field has a purposely ugly<tr><td><a id="l70"></a><a href="#l70">70</a><td> * name to make (non-compiled) code that attempts to directly access this<tr><td><a id="l71"></a><a href="#l71">71</a><td> * field stand out.<tr><td><a id="l72"></a><a href="#l72">72</a><td> * @private {string}<tr><td><a id="l73"></a><a href="#l73">73</a><td> */<tr><td><a id="l74"></a><a href="#l74">74</a><td> this.privateDoNotAccessOrElseSafeHtmlWrappedValue_ = &#39;&#39;;<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> * A type marker used to implement additional run-time type checking.<tr><td><a id="l78"></a><a href="#l78">78</a><td> * @see goog.html.SafeHtml#unwrap<tr><td><a id="l79"></a><a href="#l79">79</a><td> * @const<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> this.SAFE_HTML_TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ =<tr><td><a id="l83"></a><a href="#l83">83</a><td> goog.html.SafeHtml.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_;<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> * This SafeHtml&#39;s directionality, or null if unknown.<tr><td><a id="l87"></a><a href="#l87">87</a><td> * @private {?goog.i18n.bidi.Dir}<tr><td><a id="l88"></a><a href="#l88">88</a><td> */<tr><td><a id="l89"></a><a href="#l89">89</a><td> this.dir_ = null;<tr><td><a id="l90"></a><a href="#l90">90</a><td>};<tr><td><a id="l91"></a><a href="#l91">91</a><td><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> * @override<tr><td><a id="l95"></a><a href="#l95">95</a><td> * @const<tr><td><a id="l96"></a><a href="#l96">96</a><td> */<tr><td><a id="l97"></a><a href="#l97">97</a><td>goog.html.SafeHtml.prototype.implementsGoogI18nBidiDirectionalString = true;<tr><td><a id="l98"></a><a href="#l98">98</a><td><tr><td><a id="l99"></a><a href="#l99">99</a><td><tr><td><a id="l100"></a><a href="#l100">100</a><td>/** @override */<tr><td><a id="l101"></a><a href="#l101">101</a><td>goog.html.SafeHtml.prototype.getDirection = function() {<tr><td><a id="l102"></a><a href="#l102">102</a><td> return this.dir_;<tr><td><a id="l103"></a><a href="#l103">103</a><td>};<tr><td><a id="l104"></a><a href="#l104">104</a><td><tr><td><a id="l105"></a><a href="#l105">105</a><td><tr><td><a id="l106"></a><a href="#l106">106</a><td>/**<tr><td><a id="l107"></a><a href="#l107">107</a><td> * @override<tr><td><a id="l108"></a><a href="#l108">108</a><td> * @const<tr><td><a id="l109"></a><a href="#l109">109</a><td> */<tr><td><a id="l110"></a><a href="#l110">110</a><td>goog.html.SafeHtml.prototype.implementsGoogStringTypedString = true;<tr><td><a id="l111"></a><a href="#l111">111</a><td><tr><td><a id="l112"></a><a href="#l112">112</a><td><tr><td><a id="l113"></a><a href="#l113">113</a><td>/**<tr><td><a id="l114"></a><a href="#l114">114</a><td> * Returns this SafeHtml&#39;s value a string.<tr><td><a id="l115"></a><a href="#l115">115</a><td> *<tr><td><a id="l116"></a><a href="#l116">116</a><td> * IMPORTANT: In code where it is security relevant that an object&#39;s type is<tr><td><a id="l117"></a><a href="#l117">117</a><td> * indeed {@code SafeHtml}, use {@code goog.html.SafeHtml.unwrap} instead of<tr><td><a id="l118"></a><a href="#l118">118</a><td> * this method. If in doubt, assume that it&#39;s security relevant. In particular,<tr><td><a id="l119"></a><a href="#l119">119</a><td> * note that goog.html functions which return a goog.html type do not guarantee<tr><td><a id="l120"></a><a href="#l120">120</a><td> * that the returned instance is of the right type. For example:<tr><td><a id="l121"></a><a href="#l121">121</a><td> *<tr><td><a id="l122"></a><a href="#l122">122</a><td> * &lt;pre&gt;<tr><td><a id="l123"></a><a href="#l123">123</a><td> * var fakeSafeHtml = new String(&#39;fake&#39;);<tr><td><a id="l124"></a><a href="#l124">124</a><td> * fakeSafeHtml.__proto__ = goog.html.SafeHtml.prototype;<tr><td><a id="l125"></a><a href="#l125">125</a><td> * var newSafeHtml = goog.html.SafeHtml.htmlEscape(fakeSafeHtml);<tr><td><a id="l126"></a><a href="#l126">126</a><td> * // newSafeHtml is just an alias for fakeSafeHtml, it&#39;s passed through by<tr><td><a id="l127"></a><a href="#l127">127</a><td> * // goog.html.SafeHtml.htmlEscape() as fakeSafeHtml<tr><td><a id="l128"></a><a href="#l128">128</a><td> * // instanceof goog.html.SafeHtml.<tr><td><a id="l129"></a><a href="#l129">129</a><td> * &lt;/pre&gt;<tr><td><a id="l130"></a><a href="#l130">130</a><td> *<tr><td><a id="l131"></a><a href="#l131">131</a><td> * @see goog.html.SafeHtml#unwrap<tr><td><a id="l132"></a><a href="#l132">132</a><td> * @override<tr><td><a id="l133"></a><a href="#l133">133</a><td> */<tr><td><a id="l134"></a><a href="#l134">134</a><td>goog.html.SafeHtml.prototype.getTypedStringValue = function() {<tr><td><a id="l135"></a><a href="#l135">135</a><td> return this.privateDoNotAccessOrElseSafeHtmlWrappedValue_;<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>if (goog.DEBUG) {<tr><td><a id="l140"></a><a href="#l140">140</a><td> /**<tr><td><a id="l141"></a><a href="#l141">141</a><td> * Returns a debug string-representation of this value.<tr><td><a id="l142"></a><a href="#l142">142</a><td> *<tr><td><a id="l143"></a><a href="#l143">143</a><td> * To obtain the actual string value wrapped in a SafeHtml, use<tr><td><a id="l144"></a><a href="#l144">144</a><td> * {@code goog.html.SafeHtml.unwrap}.<tr><td><a id="l145"></a><a href="#l145">145</a><td> *<tr><td><a id="l146"></a><a href="#l146">146</a><td> * @see goog.html.SafeHtml#unwrap<tr><td><a id="l147"></a><a href="#l147">147</a><td> * @override<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.html.SafeHtml.prototype.toString = function() {<tr><td><a id="l150"></a><a href="#l150">150</a><td> return &#39;SafeHtml{&#39; + this.privateDoNotAccessOrElseSafeHtmlWrappedValue_ +<tr><td><a id="l151"></a><a href="#l151">151</a><td> &#39;}&#39;;<tr><td><a id="l152"></a><a href="#l152">152</a><td> };<tr><td><a id="l153"></a><a href="#l153">153</a><td>}<tr><td><a id="l154"></a><a href="#l154">154</a><td><tr><td><a id="l155"></a><a href="#l155">155</a><td><tr><td><a id="l156"></a><a href="#l156">156</a><td>/**<tr><td><a id="l157"></a><a href="#l157">157</a><td> * Performs a runtime check that the provided object is indeed a SafeHtml<tr><td><a id="l158"></a><a href="#l158">158</a><td> * object, and returns its value.<tr><td><a id="l159"></a><a href="#l159">159</a><td> * @param {!goog.html.SafeHtml} safeHtml The object to extract from.<tr><td><a id="l160"></a><a href="#l160">160</a><td> * @return {string} The SafeHtml object&#39;s contained string, unless the run-time<tr><td><a id="l161"></a><a href="#l161">161</a><td> * type check fails. In that case, {@code unwrap} returns an innocuous<tr><td><a id="l162"></a><a href="#l162">162</a><td> * string, or, if assertions are enabled, throws<tr><td><a id="l163"></a><a href="#l163">163</a><td> * {@code goog.asserts.AssertionError}.<tr><td><a id="l164"></a><a href="#l164">164</a><td> */<tr><td><a id="l165"></a><a href="#l165">165</a><td>goog.html.SafeHtml.unwrap = function(safeHtml) {<tr><td><a id="l166"></a><a href="#l166">166</a><td> // Perform additional run-time type-checking to ensure that safeHtml is indeed<tr><td><a id="l167"></a><a href="#l167">167</a><td> // an instance of the expected type. This provides some additional protection<tr><td><a id="l168"></a><a href="#l168">168</a><td> // against security bugs due to application code that disables type checks.<tr><td><a id="l169"></a><a href="#l169">169</a><td> // Specifically, the following checks are performed:<tr><td><a id="l170"></a><a href="#l170">170</a><td> // 1. The object is an instance of the expected type.<tr><td><a id="l171"></a><a href="#l171">171</a><td> // 2. The object is not an instance of a subclass.<tr><td><a id="l172"></a><a href="#l172">172</a><td> // 3. The object carries a type marker for the expected type. &quot;Faking&quot; an<tr><td><a id="l173"></a><a href="#l173">173</a><td> // object requires a reference to the type marker, which has names intended<tr><td><a id="l174"></a><a href="#l174">174</a><td> // to stand out in code reviews.<tr><td><a id="l175"></a><a href="#l175">175</a><td> if (safeHtml instanceof goog.html.SafeHtml &amp;&amp;<tr><td><a id="l176"></a><a href="#l176">176</a><td> safeHtml.constructor === goog.html.SafeHtml &amp;&amp;<tr><td><a id="l177"></a><a href="#l177">177</a><td> safeHtml.SAFE_HTML_TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ ===<tr><td><a id="l178"></a><a href="#l178">178</a><td> goog.html.SafeHtml.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_) {<tr><td><a id="l179"></a><a href="#l179">179</a><td> return safeHtml.privateDoNotAccessOrElseSafeHtmlWrappedValue_;<tr><td><a id="l180"></a><a href="#l180">180</a><td> } else {<tr><td><a id="l181"></a><a href="#l181">181</a><td> goog.asserts.fail(&#39;expected object of type SafeHtml, got \&#39;&#39; +<tr><td><a id="l182"></a><a href="#l182">182</a><td> safeHtml + &#39;\&#39;&#39;);<tr><td><a id="l183"></a><a href="#l183">183</a><td> return &#39;type_error:SafeHtml&#39;;<tr><td><a id="l184"></a><a href="#l184">184</a><td> }<tr><td><a id="l185"></a><a href="#l185">185</a><td>};<tr><td><a id="l186"></a><a href="#l186">186</a><td><tr><td><a id="l187"></a><a href="#l187">187</a><td><tr><td><a id="l188"></a><a href="#l188">188</a><td>/**<tr><td><a id="l189"></a><a href="#l189">189</a><td> * Shorthand for union of types that can sensibly be converted to strings<tr><td><a id="l190"></a><a href="#l190">190</a><td> * or might already be SafeHtml (as SafeHtml is a goog.string.TypedString).<tr><td><a id="l191"></a><a href="#l191">191</a><td> * @private<tr><td><a id="l192"></a><a href="#l192">192</a><td> * @typedef {string|number|boolean|!goog.string.TypedString|<tr><td><a id="l193"></a><a href="#l193">193</a><td> * !goog.i18n.bidi.DirectionalString}<tr><td><a id="l194"></a><a href="#l194">194</a><td> */<tr><td><a id="l195"></a><a href="#l195">195</a><td>goog.html.SafeHtml.TextOrHtml_;<tr><td><a id="l196"></a><a href="#l196">196</a><td><tr><td><a id="l197"></a><a href="#l197">197</a><td><tr><td><a id="l198"></a><a href="#l198">198</a><td>/**<tr><td><a id="l199"></a><a href="#l199">199</a><td> * Returns HTML-escaped text as a SafeHtml object.<tr><td><a id="l200"></a><a href="#l200">200</a><td> *<tr><td><a id="l201"></a><a href="#l201">201</a><td> * If text is of a type that implements<tr><td><a id="l202"></a><a href="#l202">202</a><td> * {@code goog.i18n.bidi.DirectionalString}, the directionality of the new<tr><td><a id="l203"></a><a href="#l203">203</a><td> * {@code SafeHtml} object is set to {@code text}&#39;s directionality, if known.<tr><td><a id="l204"></a><a href="#l204">204</a><td> * Otherwise, the directionality of the resulting SafeHtml is unknown (i.e.,<tr><td><a id="l205"></a><a href="#l205">205</a><td> * {@code null}).<tr><td><a id="l206"></a><a href="#l206">206</a><td> *<tr><td><a id="l207"></a><a href="#l207">207</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_} textOrHtml The text to escape. If<tr><td><a id="l208"></a><a href="#l208">208</a><td> * the parameter is of type SafeHtml it is returned directly (no escaping<tr><td><a id="l209"></a><a href="#l209">209</a><td> * is done).<tr><td><a id="l210"></a><a href="#l210">210</a><td> * @return {!goog.html.SafeHtml} The escaped text, wrapped as a SafeHtml.<tr><td><a id="l211"></a><a href="#l211">211</a><td> */<tr><td><a id="l212"></a><a href="#l212">212</a><td>goog.html.SafeHtml.htmlEscape = function(textOrHtml) {<tr><td><a id="l213"></a><a href="#l213">213</a><td> if (textOrHtml instanceof goog.html.SafeHtml) {<tr><td><a id="l214"></a><a href="#l214">214</a><td> return textOrHtml;<tr><td><a id="l215"></a><a href="#l215">215</a><td> }<tr><td><a id="l216"></a><a href="#l216">216</a><td> var dir = null;<tr><td><a id="l217"></a><a href="#l217">217</a><td> if (textOrHtml.implementsGoogI18nBidiDirectionalString) {<tr><td><a id="l218"></a><a href="#l218">218</a><td> dir = textOrHtml.getDirection();<tr><td><a id="l219"></a><a href="#l219">219</a><td> }<tr><td><a id="l220"></a><a href="#l220">220</a><td> var textAsString;<tr><td><a id="l221"></a><a href="#l221">221</a><td> if (textOrHtml.implementsGoogStringTypedString) {<tr><td><a id="l222"></a><a href="#l222">222</a><td> textAsString = textOrHtml.getTypedStringValue();<tr><td><a id="l223"></a><a href="#l223">223</a><td> } else {<tr><td><a id="l224"></a><a href="#l224">224</a><td> textAsString = String(textOrHtml);<tr><td><a id="l225"></a><a href="#l225">225</a><td> }<tr><td><a id="l226"></a><a href="#l226">226</a><td> return goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l227"></a><a href="#l227">227</a><td> goog.string.htmlEscape(textAsString), dir);<tr><td><a id="l228"></a><a href="#l228">228</a><td>};<tr><td><a id="l229"></a><a href="#l229">229</a><td><tr><td><a id="l230"></a><a href="#l230">230</a><td><tr><td><a id="l231"></a><a href="#l231">231</a><td>/**<tr><td><a id="l232"></a><a href="#l232">232</a><td> * Returns HTML-escaped text as a SafeHtml object, with newlines changed to<tr><td><a id="l233"></a><a href="#l233">233</a><td> * &amp;lt;br&amp;gt;.<tr><td><a id="l234"></a><a href="#l234">234</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_} textOrHtml The text to escape. If<tr><td><a id="l235"></a><a href="#l235">235</a><td> * the parameter is of type SafeHtml it is returned directly (no escaping<tr><td><a id="l236"></a><a href="#l236">236</a><td> * is done).<tr><td><a id="l237"></a><a href="#l237">237</a><td> * @return {!goog.html.SafeHtml} The escaped text, wrapped as a SafeHtml.<tr><td><a id="l238"></a><a href="#l238">238</a><td> */<tr><td><a id="l239"></a><a href="#l239">239</a><td>goog.html.SafeHtml.htmlEscapePreservingNewlines = function(textOrHtml) {<tr><td><a id="l240"></a><a href="#l240">240</a><td> if (textOrHtml instanceof goog.html.SafeHtml) {<tr><td><a id="l241"></a><a href="#l241">241</a><td> return textOrHtml;<tr><td><a id="l242"></a><a href="#l242">242</a><td> }<tr><td><a id="l243"></a><a href="#l243">243</a><td> var html = goog.html.SafeHtml.htmlEscape(textOrHtml);<tr><td><a id="l244"></a><a href="#l244">244</a><td> return goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l245"></a><a href="#l245">245</a><td> goog.string.newLineToBr(goog.html.SafeHtml.unwrap(html)),<tr><td><a id="l246"></a><a href="#l246">246</a><td> html.getDirection());<tr><td><a id="l247"></a><a href="#l247">247</a><td>};<tr><td><a id="l248"></a><a href="#l248">248</a><td><tr><td><a id="l249"></a><a href="#l249">249</a><td><tr><td><a id="l250"></a><a href="#l250">250</a><td>/**<tr><td><a id="l251"></a><a href="#l251">251</a><td> * Returns HTML-escaped text as a SafeHtml object, with newlines changed to<tr><td><a id="l252"></a><a href="#l252">252</a><td> * &amp;lt;br&amp;gt; and escaping whitespace to preserve spatial formatting. Character<tr><td><a id="l253"></a><a href="#l253">253</a><td> * entity #160 is used to make it safer for XML.<tr><td><a id="l254"></a><a href="#l254">254</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_} textOrHtml The text to escape. If<tr><td><a id="l255"></a><a href="#l255">255</a><td> * the parameter is of type SafeHtml it is returned directly (no escaping<tr><td><a id="l256"></a><a href="#l256">256</a><td> * is done).<tr><td><a id="l257"></a><a href="#l257">257</a><td> * @return {!goog.html.SafeHtml} The escaped text, wrapped as a SafeHtml.<tr><td><a id="l258"></a><a href="#l258">258</a><td> */<tr><td><a id="l259"></a><a href="#l259">259</a><td>goog.html.SafeHtml.htmlEscapePreservingNewlinesAndSpaces = function(<tr><td><a id="l260"></a><a href="#l260">260</a><td> textOrHtml) {<tr><td><a id="l261"></a><a href="#l261">261</a><td> if (textOrHtml instanceof goog.html.SafeHtml) {<tr><td><a id="l262"></a><a href="#l262">262</a><td> return textOrHtml;<tr><td><a id="l263"></a><a href="#l263">263</a><td> }<tr><td><a id="l264"></a><a href="#l264">264</a><td> var html = goog.html.SafeHtml.htmlEscape(textOrHtml);<tr><td><a id="l265"></a><a href="#l265">265</a><td> return goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l266"></a><a href="#l266">266</a><td> goog.string.whitespaceEscape(goog.html.SafeHtml.unwrap(html)),<tr><td><a id="l267"></a><a href="#l267">267</a><td> html.getDirection());<tr><td><a id="l268"></a><a href="#l268">268</a><td>};<tr><td><a id="l269"></a><a href="#l269">269</a><td><tr><td><a id="l270"></a><a href="#l270">270</a><td><tr><td><a id="l271"></a><a href="#l271">271</a><td>/**<tr><td><a id="l272"></a><a href="#l272">272</a><td> * Coerces an arbitrary object into a SafeHtml object.<tr><td><a id="l273"></a><a href="#l273">273</a><td> *<tr><td><a id="l274"></a><a href="#l274">274</a><td> * If {@code textOrHtml} is already of type {@code goog.html.SafeHtml}, the same<tr><td><a id="l275"></a><a href="#l275">275</a><td> * object is returned. Otherwise, {@code textOrHtml} is coerced to string, and<tr><td><a id="l276"></a><a href="#l276">276</a><td> * HTML-escaped. If {@code textOrHtml} is of a type that implements<tr><td><a id="l277"></a><a href="#l277">277</a><td> * {@code goog.i18n.bidi.DirectionalString}, its directionality, if known, is<tr><td><a id="l278"></a><a href="#l278">278</a><td> * preserved.<tr><td><a id="l279"></a><a href="#l279">279</a><td> *<tr><td><a id="l280"></a><a href="#l280">280</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_} textOrHtml The text or SafeHtml to<tr><td><a id="l281"></a><a href="#l281">281</a><td> * coerce.<tr><td><a id="l282"></a><a href="#l282">282</a><td> * @return {!goog.html.SafeHtml} The resulting SafeHtml object.<tr><td><a id="l283"></a><a href="#l283">283</a><td> * @deprecated Use goog.html.SafeHtml.htmlEscape.<tr><td><a id="l284"></a><a href="#l284">284</a><td> */<tr><td><a id="l285"></a><a href="#l285">285</a><td>goog.html.SafeHtml.from = goog.html.SafeHtml.htmlEscape;<tr><td><a id="l286"></a><a href="#l286">286</a><td><tr><td><a id="l287"></a><a href="#l287">287</a><td><tr><td><a id="l288"></a><a href="#l288">288</a><td>/**<tr><td><a id="l289"></a><a href="#l289">289</a><td> * @const<tr><td><a id="l290"></a><a href="#l290">290</a><td> * @private<tr><td><a id="l291"></a><a href="#l291">291</a><td> */<tr><td><a id="l292"></a><a href="#l292">292</a><td>goog.html.SafeHtml.VALID_NAMES_IN_TAG_ = /^[a-zA-Z0-9-]+$/;<tr><td><a id="l293"></a><a href="#l293">293</a><td><tr><td><a id="l294"></a><a href="#l294">294</a><td><tr><td><a id="l295"></a><a href="#l295">295</a><td>/**<tr><td><a id="l296"></a><a href="#l296">296</a><td> * Set of attributes containing URL as defined at<tr><td><a id="l297"></a><a href="#l297">297</a><td> * http://www.w3.org/TR/html5/index.html#attributes-1.<tr><td><a id="l298"></a><a href="#l298">298</a><td> * @private @const {!Object&lt;string,boolean&gt;}<tr><td><a id="l299"></a><a href="#l299">299</a><td> */<tr><td><a id="l300"></a><a href="#l300">300</a><td>goog.html.SafeHtml.URL_ATTRIBUTES_ = goog.object.createSet(&#39;action&#39;, &#39;cite&#39;,<tr><td><a id="l301"></a><a href="#l301">301</a><td> &#39;data&#39;, &#39;formaction&#39;, &#39;href&#39;, &#39;manifest&#39;, &#39;poster&#39;, &#39;src&#39;);<tr><td><a id="l302"></a><a href="#l302">302</a><td><tr><td><a id="l303"></a><a href="#l303">303</a><td><tr><td><a id="l304"></a><a href="#l304">304</a><td>/**<tr><td><a id="l305"></a><a href="#l305">305</a><td> * Tags which are unsupported via create(). They might be supported via a<tr><td><a id="l306"></a><a href="#l306">306</a><td> * tag-specific create method. These are tags which might require a<tr><td><a id="l307"></a><a href="#l307">307</a><td> * TrustedResourceUrl in one of their attributes or a restricted type for<tr><td><a id="l308"></a><a href="#l308">308</a><td> * their content.<tr><td><a id="l309"></a><a href="#l309">309</a><td> * @private @const {!Object&lt;string,boolean&gt;}<tr><td><a id="l310"></a><a href="#l310">310</a><td> */<tr><td><a id="l311"></a><a href="#l311">311</a><td>goog.html.SafeHtml.NOT_ALLOWED_TAG_NAMES_ = goog.object.createSet(<tr><td><a id="l312"></a><a href="#l312">312</a><td> goog.dom.TagName.EMBED, goog.dom.TagName.IFRAME, goog.dom.TagName.LINK,<tr><td><a id="l313"></a><a href="#l313">313</a><td> goog.dom.TagName.OBJECT, goog.dom.TagName.SCRIPT, goog.dom.TagName.STYLE,<tr><td><a id="l314"></a><a href="#l314">314</a><td> goog.dom.TagName.TEMPLATE);<tr><td><a id="l315"></a><a href="#l315">315</a><td><tr><td><a id="l316"></a><a href="#l316">316</a><td><tr><td><a id="l317"></a><a href="#l317">317</a><td>/**<tr><td><a id="l318"></a><a href="#l318">318</a><td> * @typedef {string|number|goog.string.TypedString|<tr><td><a id="l319"></a><a href="#l319">319</a><td> * goog.html.SafeStyle.PropertyMap}<tr><td><a id="l320"></a><a href="#l320">320</a><td> * @private<tr><td><a id="l321"></a><a href="#l321">321</a><td> */<tr><td><a id="l322"></a><a href="#l322">322</a><td>goog.html.SafeHtml.AttributeValue_;<tr><td><a id="l323"></a><a href="#l323">323</a><td><tr><td><a id="l324"></a><a href="#l324">324</a><td><tr><td><a id="l325"></a><a href="#l325">325</a><td>/**<tr><td><a id="l326"></a><a href="#l326">326</a><td> * Creates a SafeHtml content consisting of a tag with optional attributes and<tr><td><a id="l327"></a><a href="#l327">327</a><td> * optional content.<tr><td><a id="l328"></a><a href="#l328">328</a><td> *<tr><td><a id="l329"></a><a href="#l329">329</a><td> * For convenience tag names and attribute names are accepted as regular<tr><td><a id="l330"></a><a href="#l330">330</a><td> * strings, instead of goog.string.Const. Nevertheless, you should not pass<tr><td><a id="l331"></a><a href="#l331">331</a><td> * user-controlled values to these parameters. Note that these parameters are<tr><td><a id="l332"></a><a href="#l332">332</a><td> * syntactically validated at runtime, and invalid values will result in<tr><td><a id="l333"></a><a href="#l333">333</a><td> * an exception.<tr><td><a id="l334"></a><a href="#l334">334</a><td> *<tr><td><a id="l335"></a><a href="#l335">335</a><td> * Example usage:<tr><td><a id="l336"></a><a href="#l336">336</a><td> *<tr><td><a id="l337"></a><a href="#l337">337</a><td> * goog.html.SafeHtml.create(&#39;br&#39;);<tr><td><a id="l338"></a><a href="#l338">338</a><td> * goog.html.SafeHtml.create(&#39;div&#39;, {&#39;class&#39;: &#39;a&#39;});<tr><td><a id="l339"></a><a href="#l339">339</a><td> * goog.html.SafeHtml.create(&#39;p&#39;, {}, &#39;a&#39;);<tr><td><a id="l340"></a><a href="#l340">340</a><td> * goog.html.SafeHtml.create(&#39;p&#39;, {}, goog.html.SafeHtml.create(&#39;br&#39;));<tr><td><a id="l341"></a><a href="#l341">341</a><td> *<tr><td><a id="l342"></a><a href="#l342">342</a><td> * goog.html.SafeHtml.create(&#39;span&#39;, {<tr><td><a id="l343"></a><a href="#l343">343</a><td> * &#39;style&#39;: {&#39;margin&#39;: &#39;0&#39;}<tr><td><a id="l344"></a><a href="#l344">344</a><td> * });<tr><td><a id="l345"></a><a href="#l345">345</a><td> *<tr><td><a id="l346"></a><a href="#l346">346</a><td> * To guarantee SafeHtml&#39;s type contract is upheld there are restrictions on<tr><td><a id="l347"></a><a href="#l347">347</a><td> * attribute values and tag names.<tr><td><a id="l348"></a><a href="#l348">348</a><td> *<tr><td><a id="l349"></a><a href="#l349">349</a><td> * - For attributes which contain script code (on*), a goog.string.Const is<tr><td><a id="l350"></a><a href="#l350">350</a><td> * required.<tr><td><a id="l351"></a><a href="#l351">351</a><td> * - For attributes which contain style (style), a goog.html.SafeStyle or a<tr><td><a id="l352"></a><a href="#l352">352</a><td> * goog.html.SafeStyle.PropertyMap is required.<tr><td><a id="l353"></a><a href="#l353">353</a><td> * - For attributes which are interpreted as URLs (e.g. src, href) a<tr><td><a id="l354"></a><a href="#l354">354</a><td> * goog.html.SafeUrl, goog.string.Const or string is required. If a string<tr><td><a id="l355"></a><a href="#l355">355</a><td> * is passed, it will be sanitized with SafeUrl.sanitize().<tr><td><a id="l356"></a><a href="#l356">356</a><td> * - For tags which can load code, more specific goog.html.SafeHtml.create*()<tr><td><a id="l357"></a><a href="#l357">357</a><td> * functions must be used. Tags which can load code and are not supported by<tr><td><a id="l358"></a><a href="#l358">358</a><td> * this function are embed, iframe, link, object, script, style, and template.<tr><td><a id="l359"></a><a href="#l359">359</a><td> *<tr><td><a id="l360"></a><a href="#l360">360</a><td> * @param {string} tagName The name of the tag. Only tag names consisting of<tr><td><a id="l361"></a><a href="#l361">361</a><td> * [a-zA-Z0-9-] are allowed. Tag names documented above are disallowed.<tr><td><a id="l362"></a><a href="#l362">362</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=}<tr><td><a id="l363"></a><a href="#l363">363</a><td> * opt_attributes Mapping from attribute names to their values. Only<tr><td><a id="l364"></a><a href="#l364">364</a><td> * attribute names consisting of [a-zA-Z0-9-] are allowed. Value of null or<tr><td><a id="l365"></a><a href="#l365">365</a><td> * undefined causes the attribute to be omitted.<tr><td><a id="l366"></a><a href="#l366">366</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l367"></a><a href="#l367">367</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;=} opt_content Content to<tr><td><a id="l368"></a><a href="#l368">368</a><td> * HTML-escape and put inside the tag. This must be empty for void tags<tr><td><a id="l369"></a><a href="#l369">369</a><td> * like &lt;br&gt;. Array elements are concatenated.<tr><td><a id="l370"></a><a href="#l370">370</a><td> * @return {!goog.html.SafeHtml} The SafeHtml content with the tag.<tr><td><a id="l371"></a><a href="#l371">371</a><td> * @throws {Error} If invalid tag name, attribute name, or attribute value is<tr><td><a id="l372"></a><a href="#l372">372</a><td> * provided.<tr><td><a id="l373"></a><a href="#l373">373</a><td> * @throws {goog.asserts.AssertionError} If content for void tag is provided.<tr><td><a id="l374"></a><a href="#l374">374</a><td> */<tr><td><a id="l375"></a><a href="#l375">375</a><td>goog.html.SafeHtml.create = function(tagName, opt_attributes, opt_content) {<tr><td><a id="l376"></a><a href="#l376">376</a><td> if (!goog.html.SafeHtml.VALID_NAMES_IN_TAG_.test(tagName)) {<tr><td><a id="l377"></a><a href="#l377">377</a><td> throw Error(&#39;Invalid tag name &lt;&#39; + tagName + &#39;&gt;.&#39;);<tr><td><a id="l378"></a><a href="#l378">378</a><td> }<tr><td><a id="l379"></a><a href="#l379">379</a><td> if (tagName.toUpperCase() in goog.html.SafeHtml.NOT_ALLOWED_TAG_NAMES_) {<tr><td><a id="l380"></a><a href="#l380">380</a><td> throw Error(&#39;Tag name &lt;&#39; + tagName + &#39;&gt; is not allowed for SafeHtml.&#39;);<tr><td><a id="l381"></a><a href="#l381">381</a><td> }<tr><td><a id="l382"></a><a href="#l382">382</a><td> return goog.html.SafeHtml.createSafeHtmlTagSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l383"></a><a href="#l383">383</a><td> tagName, opt_attributes, opt_content);<tr><td><a id="l384"></a><a href="#l384">384</a><td>};<tr><td><a id="l385"></a><a href="#l385">385</a><td><tr><td><a id="l386"></a><a href="#l386">386</a><td><tr><td><a id="l387"></a><a href="#l387">387</a><td>/**<tr><td><a id="l388"></a><a href="#l388">388</a><td> * Creates a SafeHtml representing an iframe tag.<tr><td><a id="l389"></a><a href="#l389">389</a><td> *<tr><td><a id="l390"></a><a href="#l390">390</a><td> * By default the sandbox attribute is set to an empty value, which is the most<tr><td><a id="l391"></a><a href="#l391">391</a><td> * secure option, as it confers the iframe the least privileges. If this<tr><td><a id="l392"></a><a href="#l392">392</a><td> * is too restrictive then granting individual privileges is the preferable<tr><td><a id="l393"></a><a href="#l393">393</a><td> * option. Unsetting the attribute entirely is the least secure option and<tr><td><a id="l394"></a><a href="#l394">394</a><td> * should never be done unless it&#39;s stricly necessary.<tr><td><a id="l395"></a><a href="#l395">395</a><td> *<tr><td><a id="l396"></a><a href="#l396">396</a><td> * @param {goog.html.TrustedResourceUrl=} opt_src The value of the src<tr><td><a id="l397"></a><a href="#l397">397</a><td> * attribute. If null or undefined src will not be set.<tr><td><a id="l398"></a><a href="#l398">398</a><td> * @param {goog.html.SafeHtml=} opt_srcdoc The value of the srcdoc attribute.<tr><td><a id="l399"></a><a href="#l399">399</a><td> * If null or undefined srcdoc will not be set.<tr><td><a id="l400"></a><a href="#l400">400</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=}<tr><td><a id="l401"></a><a href="#l401">401</a><td> * opt_attributes Mapping from attribute names to their values. Only<tr><td><a id="l402"></a><a href="#l402">402</a><td> * attribute names consisting of [a-zA-Z0-9-] are allowed. Value of null or<tr><td><a id="l403"></a><a href="#l403">403</a><td> * undefined causes the attribute to be omitted.<tr><td><a id="l404"></a><a href="#l404">404</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l405"></a><a href="#l405">405</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;=} opt_content Content to<tr><td><a id="l406"></a><a href="#l406">406</a><td> * HTML-escape and put inside the tag. Array elements are concatenated.<tr><td><a id="l407"></a><a href="#l407">407</a><td> * @return {!goog.html.SafeHtml} The SafeHtml content with the tag.<tr><td><a id="l408"></a><a href="#l408">408</a><td> * @throws {Error} If invalid tag name, attribute name, or attribute value is<tr><td><a id="l409"></a><a href="#l409">409</a><td> * provided. If opt_attributes contains the src or srcdoc attributes.<tr><td><a id="l410"></a><a href="#l410">410</a><td> */<tr><td><a id="l411"></a><a href="#l411">411</a><td>goog.html.SafeHtml.createIframe = function(<tr><td><a id="l412"></a><a href="#l412">412</a><td> opt_src, opt_srcdoc, opt_attributes, opt_content) {<tr><td><a id="l413"></a><a href="#l413">413</a><td> var fixedAttributes = {};<tr><td><a id="l414"></a><a href="#l414">414</a><td> fixedAttributes[&#39;src&#39;] = opt_src || null;<tr><td><a id="l415"></a><a href="#l415">415</a><td> fixedAttributes[&#39;srcdoc&#39;] = opt_srcdoc || null;<tr><td><a id="l416"></a><a href="#l416">416</a><td> var defaultAttributes = {&#39;sandbox&#39;: &#39;&#39;};<tr><td><a id="l417"></a><a href="#l417">417</a><td> var attributes = goog.html.SafeHtml.combineAttributes(<tr><td><a id="l418"></a><a href="#l418">418</a><td> fixedAttributes, defaultAttributes, opt_attributes);<tr><td><a id="l419"></a><a href="#l419">419</a><td> return goog.html.SafeHtml.createSafeHtmlTagSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l420"></a><a href="#l420">420</a><td> &#39;iframe&#39;, attributes, opt_content);<tr><td><a id="l421"></a><a href="#l421">421</a><td>};<tr><td><a id="l422"></a><a href="#l422">422</a><td><tr><td><a id="l423"></a><a href="#l423">423</a><td><tr><td><a id="l424"></a><a href="#l424">424</a><td>/**<tr><td><a id="l425"></a><a href="#l425">425</a><td> * Creates a SafeHtml representing a style tag. The type attribute is set<tr><td><a id="l426"></a><a href="#l426">426</a><td> * to &quot;text/css&quot;.<tr><td><a id="l427"></a><a href="#l427">427</a><td> * @param {!goog.html.SafeStyleSheet|!Array&lt;!goog.html.SafeStyleSheet&gt;}<tr><td><a id="l428"></a><a href="#l428">428</a><td> * styleSheet Content to put inside the tag. Array elements are<tr><td><a id="l429"></a><a href="#l429">429</a><td> * concatenated.<tr><td><a id="l430"></a><a href="#l430">430</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=}<tr><td><a id="l431"></a><a href="#l431">431</a><td> * opt_attributes Mapping from attribute names to their values. Only<tr><td><a id="l432"></a><a href="#l432">432</a><td> * attribute names consisting of [a-zA-Z0-9-] are allowed. Value of null or<tr><td><a id="l433"></a><a href="#l433">433</a><td> * undefined causes the attribute to be omitted.<tr><td><a id="l434"></a><a href="#l434">434</a><td> * @return {!goog.html.SafeHtml} The SafeHtml content with the tag.<tr><td><a id="l435"></a><a href="#l435">435</a><td> * @throws {Error} If invalid attribute name or attribute value is provided. If<tr><td><a id="l436"></a><a href="#l436">436</a><td> * opt_attributes contains the type attribute.<tr><td><a id="l437"></a><a href="#l437">437</a><td> */<tr><td><a id="l438"></a><a href="#l438">438</a><td>goog.html.SafeHtml.createStyle = function(styleSheet, opt_attributes) {<tr><td><a id="l439"></a><a href="#l439">439</a><td> var fixedAttributes = {&#39;type&#39;: &#39;text/css&#39;};<tr><td><a id="l440"></a><a href="#l440">440</a><td> var defaultAttributes = {};<tr><td><a id="l441"></a><a href="#l441">441</a><td> var attributes = goog.html.SafeHtml.combineAttributes(<tr><td><a id="l442"></a><a href="#l442">442</a><td> fixedAttributes, defaultAttributes, opt_attributes);<tr><td><a id="l443"></a><a href="#l443">443</a><td><tr><td><a id="l444"></a><a href="#l444">444</a><td> var content = &#39;&#39;;<tr><td><a id="l445"></a><a href="#l445">445</a><td> styleSheet = goog.array.concat(styleSheet);<tr><td><a id="l446"></a><a href="#l446">446</a><td> for (var i = 0; i &lt; styleSheet.length; i++) {<tr><td><a id="l447"></a><a href="#l447">447</a><td> content += goog.html.SafeStyleSheet.unwrap(styleSheet[i]);<tr><td><a id="l448"></a><a href="#l448">448</a><td> }<tr><td><a id="l449"></a><a href="#l449">449</a><td> // Convert to SafeHtml so that it&#39;s not HTML-escaped.<tr><td><a id="l450"></a><a href="#l450">450</a><td> var htmlContent = goog.html.SafeHtml<tr><td><a id="l451"></a><a href="#l451">451</a><td> .createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l452"></a><a href="#l452">452</a><td> content, goog.i18n.bidi.Dir.NEUTRAL);<tr><td><a id="l453"></a><a href="#l453">453</a><td> return goog.html.SafeHtml.createSafeHtmlTagSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l454"></a><a href="#l454">454</a><td> &#39;style&#39;, attributes, htmlContent);<tr><td><a id="l455"></a><a href="#l455">455</a><td>};<tr><td><a id="l456"></a><a href="#l456">456</a><td><tr><td><a id="l457"></a><a href="#l457">457</a><td><tr><td><a id="l458"></a><a href="#l458">458</a><td>/**<tr><td><a id="l459"></a><a href="#l459">459</a><td> * @param {string} tagName The tag name.<tr><td><a id="l460"></a><a href="#l460">460</a><td> * @param {string} name The attribute name.<tr><td><a id="l461"></a><a href="#l461">461</a><td> * @param {!goog.html.SafeHtml.AttributeValue_} value The attribute value.<tr><td><a id="l462"></a><a href="#l462">462</a><td> * @return {string} A &quot;name=value&quot; string.<tr><td><a id="l463"></a><a href="#l463">463</a><td> * @throws {Error} If attribute value is unsafe for the given tag and attribute.<tr><td><a id="l464"></a><a href="#l464">464</a><td> * @private<tr><td><a id="l465"></a><a href="#l465">465</a><td> */<tr><td><a id="l466"></a><a href="#l466">466</a><td>goog.html.SafeHtml.getAttrNameAndValue_ = function(tagName, name, value) {<tr><td><a id="l467"></a><a href="#l467">467</a><td> // If it&#39;s goog.string.Const, allow any valid attribute name.<tr><td><a id="l468"></a><a href="#l468">468</a><td> if (value instanceof goog.string.Const) {<tr><td><a id="l469"></a><a href="#l469">469</a><td> value = goog.string.Const.unwrap(value);<tr><td><a id="l470"></a><a href="#l470">470</a><td> } else if (name.toLowerCase() == &#39;style&#39;) {<tr><td><a id="l471"></a><a href="#l471">471</a><td> value = goog.html.SafeHtml.getStyleValue_(value);<tr><td><a id="l472"></a><a href="#l472">472</a><td> } else if (/^on/i.test(name)) {<tr><td><a id="l473"></a><a href="#l473">473</a><td> // TODO(jakubvrana): Disallow more attributes with a special meaning.<tr><td><a id="l474"></a><a href="#l474">474</a><td> throw Error(&#39;Attribute &quot;&#39; + name +<tr><td><a id="l475"></a><a href="#l475">475</a><td> &#39;&quot; requires goog.string.Const value, &quot;&#39; + value + &#39;&quot; given.&#39;);<tr><td><a id="l476"></a><a href="#l476">476</a><td> // URL attributes handled differently accroding to tag.<tr><td><a id="l477"></a><a href="#l477">477</a><td> } else if (name.toLowerCase() in goog.html.SafeHtml.URL_ATTRIBUTES_) {<tr><td><a id="l478"></a><a href="#l478">478</a><td> if (value instanceof goog.html.TrustedResourceUrl) {<tr><td><a id="l479"></a><a href="#l479">479</a><td> value = goog.html.TrustedResourceUrl.unwrap(value);<tr><td><a id="l480"></a><a href="#l480">480</a><td> } else if (value instanceof goog.html.SafeUrl) {<tr><td><a id="l481"></a><a href="#l481">481</a><td> value = goog.html.SafeUrl.unwrap(value);<tr><td><a id="l482"></a><a href="#l482">482</a><td> } else if (goog.isString(value)) {<tr><td><a id="l483"></a><a href="#l483">483</a><td> value = goog.html.SafeUrl.sanitize(value).getTypedStringValue();<tr><td><a id="l484"></a><a href="#l484">484</a><td> } else {<tr><td><a id="l485"></a><a href="#l485">485</a><td> throw Error(&#39;Attribute &quot;&#39; + name + &#39;&quot; on tag &quot;&#39; + tagName +<tr><td><a id="l486"></a><a href="#l486">486</a><td> &#39;&quot; requires goog.html.SafeUrl, goog.string.Const, or string,&#39; +<tr><td><a id="l487"></a><a href="#l487">487</a><td> &#39; value &quot;&#39; + value + &#39;&quot; given.&#39;);<tr><td><a id="l488"></a><a href="#l488">488</a><td> }<tr><td><a id="l489"></a><a href="#l489">489</a><td> }<tr><td><a id="l490"></a><a href="#l490">490</a><td><tr><td><a id="l491"></a><a href="#l491">491</a><td> // Accept SafeUrl, TrustedResourceUrl, etc. for attributes which only require<tr><td><a id="l492"></a><a href="#l492">492</a><td> // HTML-escaping.<tr><td><a id="l493"></a><a href="#l493">493</a><td> if (value.implementsGoogStringTypedString) {<tr><td><a id="l494"></a><a href="#l494">494</a><td> // Ok to call getTypedStringValue() since there&#39;s no reliance on the type<tr><td><a id="l495"></a><a href="#l495">495</a><td> // contract for security here.<tr><td><a id="l496"></a><a href="#l496">496</a><td> value = value.getTypedStringValue();<tr><td><a id="l497"></a><a href="#l497">497</a><td> }<tr><td><a id="l498"></a><a href="#l498">498</a><td><tr><td><a id="l499"></a><a href="#l499">499</a><td> goog.asserts.assert(goog.isString(value) || goog.isNumber(value),<tr><td><a id="l500"></a><a href="#l500">500</a><td> &#39;String or number value expected, got &#39; +<tr><td><a id="l501"></a><a href="#l501">501</a><td> (typeof value) + &#39; with value: &#39; + value);<tr><td><a id="l502"></a><a href="#l502">502</a><td> return name + &#39;=&quot;&#39; + goog.string.htmlEscape(String(value)) + &#39;&quot;&#39;;<tr><td><a id="l503"></a><a href="#l503">503</a><td>};<tr><td><a id="l504"></a><a href="#l504">504</a><td><tr><td><a id="l505"></a><a href="#l505">505</a><td><tr><td><a id="l506"></a><a href="#l506">506</a><td>/**<tr><td><a id="l507"></a><a href="#l507">507</a><td> * Gets value allowed in &quot;style&quot; attribute.<tr><td><a id="l508"></a><a href="#l508">508</a><td> * @param {goog.html.SafeHtml.AttributeValue_} value It could be SafeStyle or a<tr><td><a id="l509"></a><a href="#l509">509</a><td> * map which will be passed to goog.html.SafeStyle.create.<tr><td><a id="l510"></a><a href="#l510">510</a><td> * @return {string} Unwrapped value.<tr><td><a id="l511"></a><a href="#l511">511</a><td> * @throws {Error} If string value is given.<tr><td><a id="l512"></a><a href="#l512">512</a><td> * @private<tr><td><a id="l513"></a><a href="#l513">513</a><td> */<tr><td><a id="l514"></a><a href="#l514">514</a><td>goog.html.SafeHtml.getStyleValue_ = function(value) {<tr><td><a id="l515"></a><a href="#l515">515</a><td> if (!goog.isObject(value)) {<tr><td><a id="l516"></a><a href="#l516">516</a><td> throw Error(&#39;The &quot;style&quot; attribute requires goog.html.SafeStyle or map &#39; +<tr><td><a id="l517"></a><a href="#l517">517</a><td> &#39;of style properties, &#39; + (typeof value) + &#39; given: &#39; + value);<tr><td><a id="l518"></a><a href="#l518">518</a><td> }<tr><td><a id="l519"></a><a href="#l519">519</a><td> if (!(value instanceof goog.html.SafeStyle)) {<tr><td><a id="l520"></a><a href="#l520">520</a><td> // Process the property bag into a style object.<tr><td><a id="l521"></a><a href="#l521">521</a><td> value = goog.html.SafeStyle.create(value);<tr><td><a id="l522"></a><a href="#l522">522</a><td> }<tr><td><a id="l523"></a><a href="#l523">523</a><td> return goog.html.SafeStyle.unwrap(value);<tr><td><a id="l524"></a><a href="#l524">524</a><td>};<tr><td><a id="l525"></a><a href="#l525">525</a><td><tr><td><a id="l526"></a><a href="#l526">526</a><td><tr><td><a id="l527"></a><a href="#l527">527</a><td>/**<tr><td><a id="l528"></a><a href="#l528">528</a><td> * Creates a SafeHtml content with known directionality consisting of a tag with<tr><td><a id="l529"></a><a href="#l529">529</a><td> * optional attributes and optional content.<tr><td><a id="l530"></a><a href="#l530">530</a><td> * @param {!goog.i18n.bidi.Dir} dir Directionality.<tr><td><a id="l531"></a><a href="#l531">531</a><td> * @param {string} tagName<tr><td><a id="l532"></a><a href="#l532">532</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=} opt_attributes<tr><td><a id="l533"></a><a href="#l533">533</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l534"></a><a href="#l534">534</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;=} opt_content<tr><td><a id="l535"></a><a href="#l535">535</a><td> * @return {!goog.html.SafeHtml} The SafeHtml content with the tag.<tr><td><a id="l536"></a><a href="#l536">536</a><td> */<tr><td><a id="l537"></a><a href="#l537">537</a><td>goog.html.SafeHtml.createWithDir = function(dir, tagName, opt_attributes,<tr><td><a id="l538"></a><a href="#l538">538</a><td> opt_content) {<tr><td><a id="l539"></a><a href="#l539">539</a><td> var html = goog.html.SafeHtml.create(tagName, opt_attributes, opt_content);<tr><td><a id="l540"></a><a href="#l540">540</a><td> html.dir_ = dir;<tr><td><a id="l541"></a><a href="#l541">541</a><td> return html;<tr><td><a id="l542"></a><a href="#l542">542</a><td>};<tr><td><a id="l543"></a><a href="#l543">543</a><td><tr><td><a id="l544"></a><a href="#l544">544</a><td><tr><td><a id="l545"></a><a href="#l545">545</a><td>/**<tr><td><a id="l546"></a><a href="#l546">546</a><td> * Creates a new SafeHtml object by concatenating values.<tr><td><a id="l547"></a><a href="#l547">547</a><td> * @param {...(!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l548"></a><a href="#l548">548</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;)} var_args Values to concatenate.<tr><td><a id="l549"></a><a href="#l549">549</a><td> * @return {!goog.html.SafeHtml}<tr><td><a id="l550"></a><a href="#l550">550</a><td> */<tr><td><a id="l551"></a><a href="#l551">551</a><td>goog.html.SafeHtml.concat = function(var_args) {<tr><td><a id="l552"></a><a href="#l552">552</a><td> var dir = goog.i18n.bidi.Dir.NEUTRAL;<tr><td><a id="l553"></a><a href="#l553">553</a><td> var content = &#39;&#39;;<tr><td><a id="l554"></a><a href="#l554">554</a><td><tr><td><a id="l555"></a><a href="#l555">555</a><td> /**<tr><td><a id="l556"></a><a href="#l556">556</a><td> * @param {!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l557"></a><a href="#l557">557</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;} argument<tr><td><a id="l558"></a><a href="#l558">558</a><td> */<tr><td><a id="l559"></a><a href="#l559">559</a><td> var addArgument = function(argument) {<tr><td><a id="l560"></a><a href="#l560">560</a><td> if (goog.isArray(argument)) {<tr><td><a id="l561"></a><a href="#l561">561</a><td> goog.array.forEach(argument, addArgument);<tr><td><a id="l562"></a><a href="#l562">562</a><td> } else {<tr><td><a id="l563"></a><a href="#l563">563</a><td> var html = goog.html.SafeHtml.htmlEscape(argument);<tr><td><a id="l564"></a><a href="#l564">564</a><td> content += goog.html.SafeHtml.unwrap(html);<tr><td><a id="l565"></a><a href="#l565">565</a><td> var htmlDir = html.getDirection();<tr><td><a id="l566"></a><a href="#l566">566</a><td> if (dir == goog.i18n.bidi.Dir.NEUTRAL) {<tr><td><a id="l567"></a><a href="#l567">567</a><td> dir = htmlDir;<tr><td><a id="l568"></a><a href="#l568">568</a><td> } else if (htmlDir != goog.i18n.bidi.Dir.NEUTRAL &amp;&amp; dir != htmlDir) {<tr><td><a id="l569"></a><a href="#l569">569</a><td> dir = null;<tr><td><a id="l570"></a><a href="#l570">570</a><td> }<tr><td><a id="l571"></a><a href="#l571">571</a><td> }<tr><td><a id="l572"></a><a href="#l572">572</a><td> };<tr><td><a id="l573"></a><a href="#l573">573</a><td><tr><td><a id="l574"></a><a href="#l574">574</a><td> goog.array.forEach(arguments, addArgument);<tr><td><a id="l575"></a><a href="#l575">575</a><td> return goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l576"></a><a href="#l576">576</a><td> content, dir);<tr><td><a id="l577"></a><a href="#l577">577</a><td>};<tr><td><a id="l578"></a><a href="#l578">578</a><td><tr><td><a id="l579"></a><a href="#l579">579</a><td><tr><td><a id="l580"></a><a href="#l580">580</a><td>/**<tr><td><a id="l581"></a><a href="#l581">581</a><td> * Creates a new SafeHtml object with known directionality by concatenating the<tr><td><a id="l582"></a><a href="#l582">582</a><td> * values.<tr><td><a id="l583"></a><a href="#l583">583</a><td> * @param {!goog.i18n.bidi.Dir} dir Directionality.<tr><td><a id="l584"></a><a href="#l584">584</a><td> * @param {...(!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l585"></a><a href="#l585">585</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;)} var_args Elements of array<tr><td><a id="l586"></a><a href="#l586">586</a><td> * arguments would be processed recursively.<tr><td><a id="l587"></a><a href="#l587">587</a><td> * @return {!goog.html.SafeHtml}<tr><td><a id="l588"></a><a href="#l588">588</a><td> */<tr><td><a id="l589"></a><a href="#l589">589</a><td>goog.html.SafeHtml.concatWithDir = function(dir, var_args) {<tr><td><a id="l590"></a><a href="#l590">590</a><td> var html = goog.html.SafeHtml.concat(goog.array.slice(arguments, 1));<tr><td><a id="l591"></a><a href="#l591">591</a><td> html.dir_ = dir;<tr><td><a id="l592"></a><a href="#l592">592</a><td> return html;<tr><td><a id="l593"></a><a href="#l593">593</a><td>};<tr><td><a id="l594"></a><a href="#l594">594</a><td><tr><td><a id="l595"></a><a href="#l595">595</a><td><tr><td><a id="l596"></a><a href="#l596">596</a><td>/**<tr><td><a id="l597"></a><a href="#l597">597</a><td> * Type marker for the SafeHtml type, used to implement additional run-time<tr><td><a id="l598"></a><a href="#l598">598</a><td> * type checking.<tr><td><a id="l599"></a><a href="#l599">599</a><td> * @const {!Object}<tr><td><a id="l600"></a><a href="#l600">600</a><td> * @private<tr><td><a id="l601"></a><a href="#l601">601</a><td> */<tr><td><a id="l602"></a><a href="#l602">602</a><td>goog.html.SafeHtml.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ = {};<tr><td><a id="l603"></a><a href="#l603">603</a><td><tr><td><a id="l604"></a><a href="#l604">604</a><td><tr><td><a id="l605"></a><a href="#l605">605</a><td>/**<tr><td><a id="l606"></a><a href="#l606">606</a><td> * Package-internal utility method to create SafeHtml instances.<tr><td><a id="l607"></a><a href="#l607">607</a><td> *<tr><td><a id="l608"></a><a href="#l608">608</a><td> * @param {string} html The string to initialize the SafeHtml object with.<tr><td><a id="l609"></a><a href="#l609">609</a><td> * @param {?goog.i18n.bidi.Dir} dir The directionality of the SafeHtml to be<tr><td><a id="l610"></a><a href="#l610">610</a><td> * constructed, or null if unknown.<tr><td><a id="l611"></a><a href="#l611">611</a><td> * @return {!goog.html.SafeHtml} The initialized SafeHtml object.<tr><td><a id="l612"></a><a href="#l612">612</a><td> * @package<tr><td><a id="l613"></a><a href="#l613">613</a><td> */<tr><td><a id="l614"></a><a href="#l614">614</a><td>goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse = function(<tr><td><a id="l615"></a><a href="#l615">615</a><td> html, dir) {<tr><td><a id="l616"></a><a href="#l616">616</a><td> return new goog.html.SafeHtml().initSecurityPrivateDoNotAccessOrElse_(<tr><td><a id="l617"></a><a href="#l617">617</a><td> html, dir);<tr><td><a id="l618"></a><a href="#l618">618</a><td>};<tr><td><a id="l619"></a><a href="#l619">619</a><td><tr><td><a id="l620"></a><a href="#l620">620</a><td><tr><td><a id="l621"></a><a href="#l621">621</a><td>/**<tr><td><a id="l622"></a><a href="#l622">622</a><td> * Called from createSafeHtmlSecurityPrivateDoNotAccessOrElse(). This<tr><td><a id="l623"></a><a href="#l623">623</a><td> * method exists only so that the compiler can dead code eliminate static<tr><td><a id="l624"></a><a href="#l624">624</a><td> * fields (like EMPTY) when they&#39;re not accessed.<tr><td><a id="l625"></a><a href="#l625">625</a><td> * @param {string} html<tr><td><a id="l626"></a><a href="#l626">626</a><td> * @param {?goog.i18n.bidi.Dir} dir<tr><td><a id="l627"></a><a href="#l627">627</a><td> * @return {!goog.html.SafeHtml}<tr><td><a id="l628"></a><a href="#l628">628</a><td> * @private<tr><td><a id="l629"></a><a href="#l629">629</a><td> */<tr><td><a id="l630"></a><a href="#l630">630</a><td>goog.html.SafeHtml.prototype.initSecurityPrivateDoNotAccessOrElse_ = function(<tr><td><a id="l631"></a><a href="#l631">631</a><td> html, dir) {<tr><td><a id="l632"></a><a href="#l632">632</a><td> this.privateDoNotAccessOrElseSafeHtmlWrappedValue_ = html;<tr><td><a id="l633"></a><a href="#l633">633</a><td> this.dir_ = dir;<tr><td><a id="l634"></a><a href="#l634">634</a><td> return this;<tr><td><a id="l635"></a><a href="#l635">635</a><td>};<tr><td><a id="l636"></a><a href="#l636">636</a><td><tr><td><a id="l637"></a><a href="#l637">637</a><td><tr><td><a id="l638"></a><a href="#l638">638</a><td>/**<tr><td><a id="l639"></a><a href="#l639">639</a><td> * Like create() but does not restrict which tags can be constructed.<tr><td><a id="l640"></a><a href="#l640">640</a><td> *<tr><td><a id="l641"></a><a href="#l641">641</a><td> * @param {string} tagName Tag name. Set or validated by caller.<tr><td><a id="l642"></a><a href="#l642">642</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=} opt_attributes<tr><td><a id="l643"></a><a href="#l643">643</a><td> * @param {(!goog.html.SafeHtml.TextOrHtml_|<tr><td><a id="l644"></a><a href="#l644">644</a><td> * !Array&lt;!goog.html.SafeHtml.TextOrHtml_&gt;)=} opt_content<tr><td><a id="l645"></a><a href="#l645">645</a><td> * @return {!goog.html.SafeHtml}<tr><td><a id="l646"></a><a href="#l646">646</a><td> * @throws {Error} If invalid or unsafe attribute name or value is provided.<tr><td><a id="l647"></a><a href="#l647">647</a><td> * @throws {goog.asserts.AssertionError} If content for void tag is provided.<tr><td><a id="l648"></a><a href="#l648">648</a><td> * @package<tr><td><a id="l649"></a><a href="#l649">649</a><td> */<tr><td><a id="l650"></a><a href="#l650">650</a><td>goog.html.SafeHtml.createSafeHtmlTagSecurityPrivateDoNotAccessOrElse =<tr><td><a id="l651"></a><a href="#l651">651</a><td> function(tagName, opt_attributes, opt_content) {<tr><td><a id="l652"></a><a href="#l652">652</a><td> var dir = null;<tr><td><a id="l653"></a><a href="#l653">653</a><td> var result = &#39;&lt;&#39; + tagName;<tr><td><a id="l654"></a><a href="#l654">654</a><td><tr><td><a id="l655"></a><a href="#l655">655</a><td> if (opt_attributes) {<tr><td><a id="l656"></a><a href="#l656">656</a><td> for (var name in opt_attributes) {<tr><td><a id="l657"></a><a href="#l657">657</a><td> if (!goog.html.SafeHtml.VALID_NAMES_IN_TAG_.test(name)) {<tr><td><a id="l658"></a><a href="#l658">658</a><td> throw Error(&#39;Invalid attribute name &quot;&#39; + name + &#39;&quot;.&#39;);<tr><td><a id="l659"></a><a href="#l659">659</a><td> }<tr><td><a id="l660"></a><a href="#l660">660</a><td> var value = opt_attributes[name];<tr><td><a id="l661"></a><a href="#l661">661</a><td> if (!goog.isDefAndNotNull(value)) {<tr><td><a id="l662"></a><a href="#l662">662</a><td> continue;<tr><td><a id="l663"></a><a href="#l663">663</a><td> }<tr><td><a id="l664"></a><a href="#l664">664</a><td> result += &#39; &#39; +<tr><td><a id="l665"></a><a href="#l665">665</a><td> goog.html.SafeHtml.getAttrNameAndValue_(tagName, name, value);<tr><td><a id="l666"></a><a href="#l666">666</a><td> }<tr><td><a id="l667"></a><a href="#l667">667</a><td> }<tr><td><a id="l668"></a><a href="#l668">668</a><td><tr><td><a id="l669"></a><a href="#l669">669</a><td> var content = opt_content;<tr><td><a id="l670"></a><a href="#l670">670</a><td> if (!goog.isDefAndNotNull(content)) {<tr><td><a id="l671"></a><a href="#l671">671</a><td> content = [];<tr><td><a id="l672"></a><a href="#l672">672</a><td> } else if (!goog.isArray(content)) {<tr><td><a id="l673"></a><a href="#l673">673</a><td> content = [content];<tr><td><a id="l674"></a><a href="#l674">674</a><td> }<tr><td><a id="l675"></a><a href="#l675">675</a><td><tr><td><a id="l676"></a><a href="#l676">676</a><td> if (goog.dom.tags.isVoidTag(tagName.toLowerCase())) {<tr><td><a id="l677"></a><a href="#l677">677</a><td> goog.asserts.assert(!content.length,<tr><td><a id="l678"></a><a href="#l678">678</a><td> &#39;Void tag &lt;&#39; + tagName + &#39;&gt; does not allow content.&#39;);<tr><td><a id="l679"></a><a href="#l679">679</a><td> result += &#39;&gt;&#39;;<tr><td><a id="l680"></a><a href="#l680">680</a><td> } else {<tr><td><a id="l681"></a><a href="#l681">681</a><td> var html = goog.html.SafeHtml.concat(content);<tr><td><a id="l682"></a><a href="#l682">682</a><td> result += &#39;&gt;&#39; + goog.html.SafeHtml.unwrap(html) + &#39;&lt;/&#39; + tagName + &#39;&gt;&#39;;<tr><td><a id="l683"></a><a href="#l683">683</a><td> dir = html.getDirection();<tr><td><a id="l684"></a><a href="#l684">684</a><td> }<tr><td><a id="l685"></a><a href="#l685">685</a><td><tr><td><a id="l686"></a><a href="#l686">686</a><td> var dirAttribute = opt_attributes &amp;&amp; opt_attributes[&#39;dir&#39;];<tr><td><a id="l687"></a><a href="#l687">687</a><td> if (dirAttribute) {<tr><td><a id="l688"></a><a href="#l688">688</a><td> if (/^(ltr|rtl|auto)$/i.test(dirAttribute)) {<tr><td><a id="l689"></a><a href="#l689">689</a><td> // If the tag has the &quot;dir&quot; attribute specified then its direction is<tr><td><a id="l690"></a><a href="#l690">690</a><td> // neutral because it can be safely used in any context.<tr><td><a id="l691"></a><a href="#l691">691</a><td> dir = goog.i18n.bidi.Dir.NEUTRAL;<tr><td><a id="l692"></a><a href="#l692">692</a><td> } else {<tr><td><a id="l693"></a><a href="#l693">693</a><td> dir = null;<tr><td><a id="l694"></a><a href="#l694">694</a><td> }<tr><td><a id="l695"></a><a href="#l695">695</a><td> }<tr><td><a id="l696"></a><a href="#l696">696</a><td><tr><td><a id="l697"></a><a href="#l697">697</a><td> return goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l698"></a><a href="#l698">698</a><td> result, dir);<tr><td><a id="l699"></a><a href="#l699">699</a><td>};<tr><td><a id="l700"></a><a href="#l700">700</a><td><tr><td><a id="l701"></a><a href="#l701">701</a><td><tr><td><a id="l702"></a><a href="#l702">702</a><td>/**<tr><td><a id="l703"></a><a href="#l703">703</a><td> * @param {!Object&lt;string, string&gt;} fixedAttributes<tr><td><a id="l704"></a><a href="#l704">704</a><td> * @param {!Object&lt;string, string&gt;} defaultAttributes<tr><td><a id="l705"></a><a href="#l705">705</a><td> * @param {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;=}<tr><td><a id="l706"></a><a href="#l706">706</a><td> * opt_attributes Optional attributes passed to create*().<tr><td><a id="l707"></a><a href="#l707">707</a><td> * @return {!Object&lt;string, goog.html.SafeHtml.AttributeValue_&gt;}<tr><td><a id="l708"></a><a href="#l708">708</a><td> * @throws {Error} If opt_attributes contains an attribute with the same name<tr><td><a id="l709"></a><a href="#l709">709</a><td> * as an attribute in fixedAttributes.<tr><td><a id="l710"></a><a href="#l710">710</a><td> * @package<tr><td><a id="l711"></a><a href="#l711">711</a><td> */<tr><td><a id="l712"></a><a href="#l712">712</a><td>goog.html.SafeHtml.combineAttributes = function(<tr><td><a id="l713"></a><a href="#l713">713</a><td> fixedAttributes, defaultAttributes, opt_attributes) {<tr><td><a id="l714"></a><a href="#l714">714</a><td> var combinedAttributes = {};<tr><td><a id="l715"></a><a href="#l715">715</a><td> var name;<tr><td><a id="l716"></a><a href="#l716">716</a><td><tr><td><a id="l717"></a><a href="#l717">717</a><td> for (name in fixedAttributes) {<tr><td><a id="l718"></a><a href="#l718">718</a><td> goog.asserts.assert(name.toLowerCase() == name, &#39;Must be lower case&#39;);<tr><td><a id="l719"></a><a href="#l719">719</a><td> combinedAttributes[name] = fixedAttributes[name];<tr><td><a id="l720"></a><a href="#l720">720</a><td> }<tr><td><a id="l721"></a><a href="#l721">721</a><td> for (name in defaultAttributes) {<tr><td><a id="l722"></a><a href="#l722">722</a><td> goog.asserts.assert(name.toLowerCase() == name, &#39;Must be lower case&#39;);<tr><td><a id="l723"></a><a href="#l723">723</a><td> combinedAttributes[name] = defaultAttributes[name];<tr><td><a id="l724"></a><a href="#l724">724</a><td> }<tr><td><a id="l725"></a><a href="#l725">725</a><td><tr><td><a id="l726"></a><a href="#l726">726</a><td> for (name in opt_attributes) {<tr><td><a id="l727"></a><a href="#l727">727</a><td> var nameLower = name.toLowerCase();<tr><td><a id="l728"></a><a href="#l728">728</a><td> if (nameLower in fixedAttributes) {<tr><td><a id="l729"></a><a href="#l729">729</a><td> throw Error(&#39;Cannot override &quot;&#39; + nameLower + &#39;&quot; attribute, got &quot;&#39; +<tr><td><a id="l730"></a><a href="#l730">730</a><td> name + &#39;&quot; with value &quot;&#39; + opt_attributes[name] + &#39;&quot;&#39;);<tr><td><a id="l731"></a><a href="#l731">731</a><td> }<tr><td><a id="l732"></a><a href="#l732">732</a><td> if (nameLower in defaultAttributes) {<tr><td><a id="l733"></a><a href="#l733">733</a><td> delete combinedAttributes[nameLower];<tr><td><a id="l734"></a><a href="#l734">734</a><td> }<tr><td><a id="l735"></a><a href="#l735">735</a><td> combinedAttributes[name] = opt_attributes[name];<tr><td><a id="l736"></a><a href="#l736">736</a><td> }<tr><td><a id="l737"></a><a href="#l737">737</a><td><tr><td><a id="l738"></a><a href="#l738">738</a><td> return combinedAttributes;<tr><td><a id="l739"></a><a href="#l739">739</a><td>};<tr><td><a id="l740"></a><a href="#l740">740</a><td><tr><td><a id="l741"></a><a href="#l741">741</a><td><tr><td><a id="l742"></a><a href="#l742">742</a><td>/**<tr><td><a id="l743"></a><a href="#l743">743</a><td> * A SafeHtml instance corresponding to the HTML doctype: &quot;&lt;!DOCTYPE html&gt;&quot;.<tr><td><a id="l744"></a><a href="#l744">744</a><td> * @const {!goog.html.SafeHtml}<tr><td><a id="l745"></a><a href="#l745">745</a><td> */<tr><td><a id="l746"></a><a href="#l746">746</a><td>goog.html.SafeHtml.DOCTYPE_HTML =<tr><td><a id="l747"></a><a href="#l747">747</a><td> goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l748"></a><a href="#l748">748</a><td> &#39;&lt;!DOCTYPE html&gt;&#39;, goog.i18n.bidi.Dir.NEUTRAL);<tr><td><a id="l749"></a><a href="#l749">749</a><td><tr><td><a id="l750"></a><a href="#l750">750</a><td><tr><td><a id="l751"></a><a href="#l751">751</a><td>/**<tr><td><a id="l752"></a><a href="#l752">752</a><td> * A SafeHtml instance corresponding to the empty string.<tr><td><a id="l753"></a><a href="#l753">753</a><td> * @const {!goog.html.SafeHtml}<tr><td><a id="l754"></a><a href="#l754">754</a><td> */<tr><td><a id="l755"></a><a href="#l755">755</a><td>goog.html.SafeHtml.EMPTY =<tr><td><a id="l756"></a><a href="#l756">756</a><td> goog.html.SafeHtml.createSafeHtmlSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l757"></a><a href="#l757">757</a><td> &#39;&#39;, goog.i18n.bidi.Dir.NEUTRAL);</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>
package/docs/source/lib/goog/html/safescript.js.src.html DELETED
@@ -1 +0,0 @@
1
- <!DOCTYPE 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>safescript.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/html/safescript.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2014 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 &quot;License&quot;);<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 &quot;AS-IS&quot; 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 The SafeScript type and its builders.<tr><td><a id="l17"></a><a href="#l17">17</a><td> *<tr><td><a id="l18"></a><a href="#l18">18</a><td> * TODO(xtof): Link to document stating type contract.<tr><td><a id="l19"></a><a href="#l19">19</a><td> */<tr><td><a id="l20"></a><a href="#l20">20</a><td><tr><td><a id="l21"></a><a href="#l21">21</a><td>goog.provide(&#39;goog.html.SafeScript&#39;);<tr><td><a id="l22"></a><a href="#l22">22</a><td><tr><td><a id="l23"></a><a href="#l23">23</a><td>goog.require(&#39;goog.asserts&#39;);<tr><td><a id="l24"></a><a href="#l24">24</a><td>goog.require(&#39;goog.string.Const&#39;);<tr><td><a id="l25"></a><a href="#l25">25</a><td>goog.require(&#39;goog.string.TypedString&#39;);<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><tr><td><a id="l29"></a><a href="#l29">29</a><td>/**<tr><td><a id="l30"></a><a href="#l30">30</a><td> * A string-like object which represents JavaScript code and that carries the<tr><td><a id="l31"></a><a href="#l31">31</a><td> * security type contract that its value, as a string, will not cause execution<tr><td><a id="l32"></a><a href="#l32">32</a><td> * of unconstrained attacker controlled code (XSS) when evaluated as JavaScript<tr><td><a id="l33"></a><a href="#l33">33</a><td> * in a browser.<tr><td><a id="l34"></a><a href="#l34">34</a><td> *<tr><td><a id="l35"></a><a href="#l35">35</a><td> * Instances of this type must be created via the factory method<tr><td><a id="l36"></a><a href="#l36">36</a><td> * {@code goog.html.SafeScript.fromConstant} and not by invoking its<tr><td><a id="l37"></a><a href="#l37">37</a><td> * constructor. The constructor intentionally takes no parameters and the type<tr><td><a id="l38"></a><a href="#l38">38</a><td> * is immutable; hence only a default instance corresponding to the empty string<tr><td><a id="l39"></a><a href="#l39">39</a><td> * can be obtained via constructor invocation.<tr><td><a id="l40"></a><a href="#l40">40</a><td> *<tr><td><a id="l41"></a><a href="#l41">41</a><td> * A SafeScript&#39;s string representation can safely be interpolated as the<tr><td><a id="l42"></a><a href="#l42">42</a><td> * content of a script element within HTML. The SafeScript string should not be<tr><td><a id="l43"></a><a href="#l43">43</a><td> * escaped before interpolation.<tr><td><a id="l44"></a><a href="#l44">44</a><td> *<tr><td><a id="l45"></a><a href="#l45">45</a><td> * Note that the SafeScript might contain text that is attacker-controlled but<tr><td><a id="l46"></a><a href="#l46">46</a><td> * that text should have been interpolated with appropriate escaping,<tr><td><a id="l47"></a><a href="#l47">47</a><td> * sanitization and/or validation into the right location in the script, such<tr><td><a id="l48"></a><a href="#l48">48</a><td> * that it is highly constrained in its effect (for example, it had to match a<tr><td><a id="l49"></a><a href="#l49">49</a><td> * set of whitelisted words).<tr><td><a id="l50"></a><a href="#l50">50</a><td> *<tr><td><a id="l51"></a><a href="#l51">51</a><td> * A SafeScript can be constructed via security-reviewed unchecked<tr><td><a id="l52"></a><a href="#l52">52</a><td> * conversions. In this case producers of SafeScript must ensure themselves that<tr><td><a id="l53"></a><a href="#l53">53</a><td> * the SafeScript does not contain unsafe script. Note in particular that<tr><td><a id="l54"></a><a href="#l54">54</a><td> * {@code &amp;lt;} is dangerous, even when inside JavaScript strings, and so should<tr><td><a id="l55"></a><a href="#l55">55</a><td> * always be forbidden or JavaScript escaped in user controlled input. For<tr><td><a id="l56"></a><a href="#l56">56</a><td> * example, if {@code &amp;lt;/script&amp;gt;&amp;lt;script&amp;gt;evil&amp;lt;/script&amp;gt;&quot;} were<tr><td><a id="l57"></a><a href="#l57">57</a><td> * interpolated inside a JavaScript string, it would break out of the context<tr><td><a id="l58"></a><a href="#l58">58</a><td> * of the original script element and {@code evil} would execute. Also note<tr><td><a id="l59"></a><a href="#l59">59</a><td> * that within an HTML script (raw text) element, HTML character references,<tr><td><a id="l60"></a><a href="#l60">60</a><td> * such as &quot;&amp;lt;&quot; are not allowed. See<tr><td><a id="l61"></a><a href="#l61">61</a><td> * http://www.w3.org/TR/html5/scripting-1.html#restrictions-for-contents-of-script-elements.<tr><td><a id="l62"></a><a href="#l62">62</a><td> *<tr><td><a id="l63"></a><a href="#l63">63</a><td> * @see goog.html.SafeScript#fromConstant<tr><td><a id="l64"></a><a href="#l64">64</a><td> * @constructor<tr><td><a id="l65"></a><a href="#l65">65</a><td> * @final<tr><td><a id="l66"></a><a href="#l66">66</a><td> * @struct<tr><td><a id="l67"></a><a href="#l67">67</a><td> * @implements {goog.string.TypedString}<tr><td><a id="l68"></a><a href="#l68">68</a><td> */<tr><td><a id="l69"></a><a href="#l69">69</a><td>goog.html.SafeScript = function() {<tr><td><a id="l70"></a><a href="#l70">70</a><td> /**<tr><td><a id="l71"></a><a href="#l71">71</a><td> * The contained value of this SafeScript. The field has a purposely<tr><td><a id="l72"></a><a href="#l72">72</a><td> * ugly name to make (non-compiled) code that attempts to directly access this<tr><td><a id="l73"></a><a href="#l73">73</a><td> * field stand out.<tr><td><a id="l74"></a><a href="#l74">74</a><td> * @private {string}<tr><td><a id="l75"></a><a href="#l75">75</a><td> */<tr><td><a id="l76"></a><a href="#l76">76</a><td> this.privateDoNotAccessOrElseSafeScriptWrappedValue_ = &#39;&#39;;<tr><td><a id="l77"></a><a href="#l77">77</a><td><tr><td><a id="l78"></a><a href="#l78">78</a><td> /**<tr><td><a id="l79"></a><a href="#l79">79</a><td> * A type marker used to implement additional run-time type checking.<tr><td><a id="l80"></a><a href="#l80">80</a><td> * @see goog.html.SafeScript#unwrap<tr><td><a id="l81"></a><a href="#l81">81</a><td> * @const<tr><td><a id="l82"></a><a href="#l82">82</a><td> * @private<tr><td><a id="l83"></a><a href="#l83">83</a><td> */<tr><td><a id="l84"></a><a href="#l84">84</a><td> this.SAFE_SCRIPT_TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ =<tr><td><a id="l85"></a><a href="#l85">85</a><td> goog.html.SafeScript.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_;<tr><td><a id="l86"></a><a href="#l86">86</a><td>};<tr><td><a id="l87"></a><a href="#l87">87</a><td><tr><td><a id="l88"></a><a href="#l88">88</a><td><tr><td><a id="l89"></a><a href="#l89">89</a><td>/**<tr><td><a id="l90"></a><a href="#l90">90</a><td> * @override<tr><td><a id="l91"></a><a href="#l91">91</a><td> * @const<tr><td><a id="l92"></a><a href="#l92">92</a><td> */<tr><td><a id="l93"></a><a href="#l93">93</a><td>goog.html.SafeScript.prototype.implementsGoogStringTypedString = true;<tr><td><a id="l94"></a><a href="#l94">94</a><td><tr><td><a id="l95"></a><a href="#l95">95</a><td><tr><td><a id="l96"></a><a href="#l96">96</a><td>/**<tr><td><a id="l97"></a><a href="#l97">97</a><td> * Type marker for the SafeScript type, used to implement additional<tr><td><a id="l98"></a><a href="#l98">98</a><td> * run-time type checking.<tr><td><a id="l99"></a><a href="#l99">99</a><td> * @const {!Object}<tr><td><a id="l100"></a><a href="#l100">100</a><td> * @private<tr><td><a id="l101"></a><a href="#l101">101</a><td> */<tr><td><a id="l102"></a><a href="#l102">102</a><td>goog.html.SafeScript.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ = {};<tr><td><a id="l103"></a><a href="#l103">103</a><td><tr><td><a id="l104"></a><a href="#l104">104</a><td><tr><td><a id="l105"></a><a href="#l105">105</a><td>/**<tr><td><a id="l106"></a><a href="#l106">106</a><td> * Creates a SafeScript object from a compile-time constant string.<tr><td><a id="l107"></a><a href="#l107">107</a><td> *<tr><td><a id="l108"></a><a href="#l108">108</a><td> * @param {!goog.string.Const} script A compile-time-constant string from which<tr><td><a id="l109"></a><a href="#l109">109</a><td> * to create a SafeScript.<tr><td><a id="l110"></a><a href="#l110">110</a><td> * @return {!goog.html.SafeScript} A SafeScript object initialized to<tr><td><a id="l111"></a><a href="#l111">111</a><td> * {@code script}.<tr><td><a id="l112"></a><a href="#l112">112</a><td> */<tr><td><a id="l113"></a><a href="#l113">113</a><td>goog.html.SafeScript.fromConstant = function(script) {<tr><td><a id="l114"></a><a href="#l114">114</a><td> var scriptString = goog.string.Const.unwrap(script);<tr><td><a id="l115"></a><a href="#l115">115</a><td> if (scriptString.length === 0) {<tr><td><a id="l116"></a><a href="#l116">116</a><td> return goog.html.SafeScript.EMPTY;<tr><td><a id="l117"></a><a href="#l117">117</a><td> }<tr><td><a id="l118"></a><a href="#l118">118</a><td> return goog.html.SafeScript.createSafeScriptSecurityPrivateDoNotAccessOrElse(<tr><td><a id="l119"></a><a href="#l119">119</a><td> scriptString);<tr><td><a id="l120"></a><a href="#l120">120</a><td>};<tr><td><a id="l121"></a><a href="#l121">121</a><td><tr><td><a id="l122"></a><a href="#l122">122</a><td><tr><td><a id="l123"></a><a href="#l123">123</a><td>/**<tr><td><a id="l124"></a><a href="#l124">124</a><td> * Returns this SafeScript&#39;s value as a string.<tr><td><a id="l125"></a><a href="#l125">125</a><td> *<tr><td><a id="l126"></a><a href="#l126">126</a><td> * IMPORTANT: In code where it is security relevant that an object&#39;s type is<tr><td><a id="l127"></a><a href="#l127">127</a><td> * indeed {@code SafeScript}, use {@code goog.html.SafeScript.unwrap} instead of<tr><td><a id="l128"></a><a href="#l128">128</a><td> * this method. If in doubt, assume that it&#39;s security relevant. In particular,<tr><td><a id="l129"></a><a href="#l129">129</a><td> * note that goog.html functions which return a goog.html type do not guarantee<tr><td><a id="l130"></a><a href="#l130">130</a><td> * the returned instance is of the right type. For example:<tr><td><a id="l131"></a><a href="#l131">131</a><td> *<tr><td><a id="l132"></a><a href="#l132">132</a><td> * &lt;pre&gt;<tr><td><a id="l133"></a><a href="#l133">133</a><td> * var fakeSafeHtml = new String(&#39;fake&#39;);<tr><td><a id="l134"></a><a href="#l134">134</a><td> * fakeSafeHtml.__proto__ = goog.html.SafeHtml.prototype;<tr><td><a id="l135"></a><a href="#l135">135</a><td> * var newSafeHtml = goog.html.SafeHtml.htmlEscape(fakeSafeHtml);<tr><td><a id="l136"></a><a href="#l136">136</a><td> * // newSafeHtml is just an alias for fakeSafeHtml, it&#39;s passed through by<tr><td><a id="l137"></a><a href="#l137">137</a><td> * // goog.html.SafeHtml.htmlEscape() as fakeSafeHtml<tr><td><a id="l138"></a><a href="#l138">138</a><td> * // instanceof goog.html.SafeHtml.<tr><td><a id="l139"></a><a href="#l139">139</a><td> * &lt;/pre&gt;<tr><td><a id="l140"></a><a href="#l140">140</a><td> *<tr><td><a id="l141"></a><a href="#l141">141</a><td> * @see goog.html.SafeScript#unwrap<tr><td><a id="l142"></a><a href="#l142">142</a><td> * @override<tr><td><a id="l143"></a><a href="#l143">143</a><td> */<tr><td><a id="l144"></a><a href="#l144">144</a><td>goog.html.SafeScript.prototype.getTypedStringValue = function() {<tr><td><a id="l145"></a><a href="#l145">145</a><td> return this.privateDoNotAccessOrElseSafeScriptWrappedValue_;<tr><td><a id="l146"></a><a href="#l146">146</a><td>};<tr><td><a id="l147"></a><a href="#l147">147</a><td><tr><td><a id="l148"></a><a href="#l148">148</a><td><tr><td><a id="l149"></a><a href="#l149">149</a><td>if (goog.DEBUG) {<tr><td><a id="l150"></a><a href="#l150">150</a><td> /**<tr><td><a id="l151"></a><a href="#l151">151</a><td> * Returns a debug string-representation of this value.<tr><td><a id="l152"></a><a href="#l152">152</a><td> *<tr><td><a id="l153"></a><a href="#l153">153</a><td> * To obtain the actual string value wrapped in a SafeScript, use<tr><td><a id="l154"></a><a href="#l154">154</a><td> * {@code goog.html.SafeScript.unwrap}.<tr><td><a id="l155"></a><a href="#l155">155</a><td> *<tr><td><a id="l156"></a><a href="#l156">156</a><td> * @see goog.html.SafeScript#unwrap<tr><td><a id="l157"></a><a href="#l157">157</a><td> * @override<tr><td><a id="l158"></a><a href="#l158">158</a><td> */<tr><td><a id="l159"></a><a href="#l159">159</a><td> goog.html.SafeScript.prototype.toString = function() {<tr><td><a id="l160"></a><a href="#l160">160</a><td> return &#39;SafeScript{&#39; +<tr><td><a id="l161"></a><a href="#l161">161</a><td> this.privateDoNotAccessOrElseSafeScriptWrappedValue_ + &#39;}&#39;;<tr><td><a id="l162"></a><a href="#l162">162</a><td> };<tr><td><a id="l163"></a><a href="#l163">163</a><td>}<tr><td><a id="l164"></a><a href="#l164">164</a><td><tr><td><a id="l165"></a><a href="#l165">165</a><td><tr><td><a id="l166"></a><a href="#l166">166</a><td>/**<tr><td><a id="l167"></a><a href="#l167">167</a><td> * Performs a runtime check that the provided object is indeed a<tr><td><a id="l168"></a><a href="#l168">168</a><td> * SafeScript object, and returns its value.<tr><td><a id="l169"></a><a href="#l169">169</a><td> *<tr><td><a id="l170"></a><a href="#l170">170</a><td> * @param {!goog.html.SafeScript} safeScript The object to extract from.<tr><td><a id="l171"></a><a href="#l171">171</a><td> * @return {string} The safeScript object&#39;s contained string, unless<tr><td><a id="l172"></a><a href="#l172">172</a><td> * the run-time type check fails. In that case, {@code unwrap} returns an<tr><td><a id="l173"></a><a href="#l173">173</a><td> * innocuous string, or, if assertions are enabled, throws<tr><td><a id="l174"></a><a href="#l174">174</a><td> * {@code goog.asserts.AssertionError}.<tr><td><a id="l175"></a><a href="#l175">175</a><td> */<tr><td><a id="l176"></a><a href="#l176">176</a><td>goog.html.SafeScript.unwrap = function(safeScript) {<tr><td><a id="l177"></a><a href="#l177">177</a><td> // Perform additional Run-time type-checking to ensure that<tr><td><a id="l178"></a><a href="#l178">178</a><td> // safeScript is indeed an instance of the expected type. This<tr><td><a id="l179"></a><a href="#l179">179</a><td> // provides some additional protection against security bugs due to<tr><td><a id="l180"></a><a href="#l180">180</a><td> // application code that disables type checks.<tr><td><a id="l181"></a><a href="#l181">181</a><td> // Specifically, the following checks are performed:<tr><td><a id="l182"></a><a href="#l182">182</a><td> // 1. The object is an instance of the expected type.<tr><td><a id="l183"></a><a href="#l183">183</a><td> // 2. The object is not an instance of a subclass.<tr><td><a id="l184"></a><a href="#l184">184</a><td> // 3. The object carries a type marker for the expected type. &quot;Faking&quot; an<tr><td><a id="l185"></a><a href="#l185">185</a><td> // object requires a reference to the type marker, which has names intended<tr><td><a id="l186"></a><a href="#l186">186</a><td> // to stand out in code reviews.<tr><td><a id="l187"></a><a href="#l187">187</a><td> if (safeScript instanceof goog.html.SafeScript &amp;&amp;<tr><td><a id="l188"></a><a href="#l188">188</a><td> safeScript.constructor === goog.html.SafeScript &amp;&amp;<tr><td><a id="l189"></a><a href="#l189">189</a><td> safeScript.SAFE_SCRIPT_TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_ ===<tr><td><a id="l190"></a><a href="#l190">190</a><td> goog.html.SafeScript.TYPE_MARKER_GOOG_HTML_SECURITY_PRIVATE_) {<tr><td><a id="l191"></a><a href="#l191">191</a><td> return safeScript.privateDoNotAccessOrElseSafeScriptWrappedValue_;<tr><td><a id="l192"></a><a href="#l192">192</a><td> } else {<tr><td><a id="l193"></a><a href="#l193">193</a><td> goog.asserts.fail(<tr><td><a id="l194"></a><a href="#l194">194</a><td> &#39;expected object of type SafeScript, got \&#39;&#39; + safeScript + &#39;\&#39;&#39;);<tr><td><a id="l195"></a><a href="#l195">195</a><td> return &#39;type_error:SafeScript&#39;;<tr><td><a id="l196"></a><a href="#l196">196</a><td> }<tr><td><a id="l197"></a><a href="#l197">197</a><td>};<tr><td><a id="l198"></a><a href="#l198">198</a><td><tr><td><a id="l199"></a><a href="#l199">199</a><td><tr><td><a id="l200"></a><a href="#l200">200</a><td>/**<tr><td><a id="l201"></a><a href="#l201">201</a><td> * Package-internal utility method to create SafeScript instances.<tr><td><a id="l202"></a><a href="#l202">202</a><td> *<tr><td><a id="l203"></a><a href="#l203">203</a><td> * @param {string} script The string to initialize the SafeScript object with.<tr><td><a id="l204"></a><a href="#l204">204</a><td> * @return {!goog.html.SafeScript} The initialized SafeScript object.<tr><td><a id="l205"></a><a href="#l205">205</a><td> * @package<tr><td><a id="l206"></a><a href="#l206">206</a><td> */<tr><td><a id="l207"></a><a href="#l207">207</a><td>goog.html.SafeScript.createSafeScriptSecurityPrivateDoNotAccessOrElse =<tr><td><a id="l208"></a><a href="#l208">208</a><td> function(script) {<tr><td><a id="l209"></a><a href="#l209">209</a><td> return new goog.html.SafeScript().initSecurityPrivateDoNotAccessOrElse_(<tr><td><a id="l210"></a><a href="#l210">210</a><td> script);<tr><td><a id="l211"></a><a href="#l211">211</a><td>};<tr><td><a id="l212"></a><a href="#l212">212</a><td><tr><td><a id="l213"></a><a href="#l213">213</a><td><tr><td><a id="l214"></a><a href="#l214">214</a><td>/**<tr><td><a id="l215"></a><a href="#l215">215</a><td> * Called from createSafeScriptSecurityPrivateDoNotAccessOrElse(). This<tr><td><a id="l216"></a><a href="#l216">216</a><td> * method exists only so that the compiler can dead code eliminate static<tr><td><a id="l217"></a><a href="#l217">217</a><td> * fields (like EMPTY) when they&#39;re not accessed.<tr><td><a id="l218"></a><a href="#l218">218</a><td> * @param {string} script<tr><td><a id="l219"></a><a href="#l219">219</a><td> * @return {!goog.html.SafeScript}<tr><td><a id="l220"></a><a href="#l220">220</a><td> * @private<tr><td><a id="l221"></a><a href="#l221">221</a><td> */<tr><td><a id="l222"></a><a href="#l222">222</a><td>goog.html.SafeScript.prototype.initSecurityPrivateDoNotAccessOrElse_ = function(<tr><td><a id="l223"></a><a href="#l223">223</a><td> script) {<tr><td><a id="l224"></a><a href="#l224">224</a><td> this.privateDoNotAccessOrElseSafeScriptWrappedValue_ = script;<tr><td><a id="l225"></a><a href="#l225">225</a><td> return this;<tr><td><a id="l226"></a><a href="#l226">226</a><td>};<tr><td><a id="l227"></a><a href="#l227">227</a><td><tr><td><a id="l228"></a><a href="#l228">228</a><td><tr><td><a id="l229"></a><a href="#l229">229</a><td>/**<tr><td><a id="l230"></a><a href="#l230">230</a><td> * A SafeScript instance corresponding to the empty string.<tr><td><a id="l231"></a><a href="#l231">231</a><td> * @const {!goog.html.SafeScript}<tr><td><a id="l232"></a><a href="#l232">232</a><td> */<tr><td><a id="l233"></a><a href="#l233">233</a><td>goog.html.SafeScript.EMPTY =<tr><td><a id="l234"></a><a href="#l234">234</a><td> goog.html.SafeScript.createSafeScriptSecurityPrivateDoNotAccessOrElse(&#39;&#39;);</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>