You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

357 lines
11 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>cascadia - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package cascadia</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "github.com/andybalholm/cascadia"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. <dd><a href="index.html#pkg-subdirectories">Subdirectories</a></dd>
  58. </dl>
  59. </div>
  60. <!-- The package's Name is printed as title by the top-level template -->
  61. <div id="pkg-overview" class="toggleVisible">
  62. <div class="collapsed">
  63. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  64. </div>
  65. <div class="expanded">
  66. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  67. <p>
  68. The cascadia package is an implementation of CSS selectors.
  69. </p>
  70. </div>
  71. </div>
  72. <div id="pkg-index" class="toggleVisible">
  73. <div class="collapsed">
  74. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  75. </div>
  76. <div class="expanded">
  77. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  78. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  79. <div id="manual-nav">
  80. <dl>
  81. <dd><a href="index.html#Selector">type Selector</a></dd>
  82. <dd>&nbsp; &nbsp; <a href="index.html#Compile">func Compile(sel string) (Selector, error)</a></dd>
  83. <dd>&nbsp; &nbsp; <a href="index.html#MustCompile">func MustCompile(sel string) Selector</a></dd>
  84. <dd>&nbsp; &nbsp; <a href="index.html#Selector.Filter">func (s Selector) Filter(nodes []*html.Node) (result []*html.Node)</a></dd>
  85. <dd>&nbsp; &nbsp; <a href="index.html#Selector.Match">func (s Selector) Match(n *html.Node) bool</a></dd>
  86. <dd>&nbsp; &nbsp; <a href="index.html#Selector.MatchAll">func (s Selector) MatchAll(n *html.Node) []*html.Node</a></dd>
  87. <dd>&nbsp; &nbsp; <a href="index.html#Selector.MatchFirst">func (s Selector) MatchFirst(n *html.Node) *html.Node</a></dd>
  88. </dl>
  89. </div><!-- #manual-nav -->
  90. <h4>Package files</h4>
  91. <p>
  92. <span style="font-size:90%">
  93. <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/parser.go">parser.go</a>
  94. <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go">selector.go</a>
  95. </span>
  96. </p>
  97. </div><!-- .expanded -->
  98. </div><!-- #pkg-index -->
  99. <div id="pkg-callgraph" class="toggle" style="display: none">
  100. <div class="collapsed">
  101. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  102. </div> <!-- .expanded -->
  103. <div class="expanded">
  104. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  105. <p>
  106. In the call graph viewer below, each node
  107. is a function belonging to this package
  108. and its children are the functions it
  109. calls&mdash;perhaps dynamically.
  110. </p>
  111. <p>
  112. The root nodes are the entry points of the
  113. package: functions that may be called from
  114. outside the package.
  115. There may be non-exported or anonymous
  116. functions among them if they are called
  117. dynamically from another package.
  118. </p>
  119. <p>
  120. Click a node to visit that function's source code.
  121. From there you can visit its callers by
  122. clicking its declaring <code>func</code>
  123. token.
  124. </p>
  125. <p>
  126. Functions may be omitted if they were
  127. determined to be unreachable in the
  128. particular programs or tests that were
  129. analyzed.
  130. </p>
  131. <!-- Zero means show all package entry points. -->
  132. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  133. </div>
  134. </div> <!-- #pkg-callgraph -->
  135. <h2 id="Selector">type <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=219:254#L5">Selector</a></h2>
  136. <pre>type Selector func(*<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>) <a href="../../../builtin/index.html#bool">bool</a></pre>
  137. <p>
  138. A Selector is a function which tells whether a node matches or not.
  139. </p>
  140. <h3 id="Compile">func <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1022:1064#L31">Compile</a></h3>
  141. <pre>func Compile(sel <a href="../../../builtin/index.html#string">string</a>) (<a href="index.html#Selector">Selector</a>, <a href="../../../builtin/index.html#error">error</a>)</pre>
  142. <p>
  143. Compile parses a selector and returns, if successful, a Selector object
  144. that can be used to match against html.Node objects.
  145. </p>
  146. <h3 id="MustCompile">func <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1371:1408#L46">MustCompile</a></h3>
  147. <pre>func MustCompile(sel <a href="../../../builtin/index.html#string">string</a>) <a href="index.html#Selector">Selector</a></pre>
  148. <p>
  149. MustCompile is like Compile, but panics instead of returning an error.
  150. </p>
  151. <h3 id="Selector.Filter">func (Selector) <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=2415:2481#L93">Filter</a></h3>
  152. <pre>func (s <a href="index.html#Selector">Selector</a>) Filter(nodes []*<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>) (result []*<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>)</pre>
  153. <p>
  154. Filter returns the nodes in nodes that match the selector.
  155. </p>
  156. <h3 id="Selector.Match">func (Selector) <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1999:2041#L73">Match</a></h3>
  157. <pre>func (s <a href="index.html#Selector">Selector</a>) Match(n *<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>) <a href="../../../builtin/index.html#bool">bool</a></pre>
  158. <p>
  159. Match returns true if the node matches the selector.
  160. </p>
  161. <h3 id="Selector.MatchAll">func (Selector) <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1589:1642#L56">MatchAll</a></h3>
  162. <pre>func (s <a href="index.html#Selector">Selector</a>) MatchAll(n *<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>) []*<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a></pre>
  163. <p>
  164. MatchAll returns a slice of the nodes that match the selector,
  165. from n and its children.
  166. </p>
  167. <h3 id="Selector.MatchFirst">func (Selector) <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=2138:2191#L78">MatchFirst</a></h3>
  168. <pre>func (s <a href="index.html#Selector">Selector</a>) MatchFirst(n *<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a>) *<a href="../../../golang.org/x/net/html/index.html">html</a>.<a href="../../../golang.org/x/net/html/index.html#Node">Node</a></pre>
  169. <p>
  170. MatchFirst returns the first node that matches s, from n and its children.
  171. </p>
  172. <h2 id="pkg-subdirectories">Subdirectories</h2>
  173. <div class="pkg-dir">
  174. <table>
  175. <tr>
  176. <th class="pkg-name">Name</th>
  177. <th class="pkg-synopsis">Synopsis</th>
  178. </tr>
  179. <tr>
  180. <td colspan="2"><a href="../index.html">..</a></td>
  181. </tr>
  182. <tr>
  183. <td class="pkg-name" style="padding-left: 0px;">
  184. <a href="fuzz/index.html">fuzz</a>
  185. </td>
  186. <td class="pkg-synopsis">
  187. </td>
  188. </tr>
  189. </table>
  190. </div>
  191. <div id="footer">
  192. Build version go1.6.<br>
  193. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  194. the content of this page is licensed under the
  195. Creative Commons Attribution 3.0 License,
  196. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  197. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  198. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  199. </div>
  200. </div><!-- .container -->
  201. </div><!-- #page -->
  202. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  203. <script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
  204. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
  205. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>
  206. <script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>
  207. </body>
  208. </html>