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

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">
<title>cascadia - The Go Programming Language</title>
<link type="text/css" rel="stylesheet" href="../../../../lib/godoc/style.css">
<link rel="stylesheet" href="../../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>
<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->
<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>
<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>
</div></div>
<div id="page" class="wide">
<div class="container">
<h1>Package cascadia</h1>
<div id="nav"></div>
<!--
Copyright 2009 The Go Authors. All rights reserved.
Use of this source code is governed by a BSD-style
license that can be found in the LICENSE file.
-->
<!--
Note: Static (i.e., not template-generated) href and id
attributes start with "pkg-" to make it impossible for
them to conflict with generated attributes (some of which
correspond to Go identifiers).
-->
<script type='text/javascript'>
document.ANALYSIS_DATA = null;
document.CALLGRAPH = null;
</script>
<div id="short-nav">
<dl>
<dd><code>import "github.com/andybalholm/cascadia"</code></dd>
</dl>
<dl>
<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
<dd><a href="index.html#pkg-subdirectories">Subdirectories</a></dd>
</dl>
</div>
<!-- The package's Name is printed as title by the top-level template -->
<div id="pkg-overview" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
<p>
The cascadia package is an implementation of CSS selectors.
</p>
</div>
</div>
<div id="pkg-index" class="toggleVisible">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
</div>
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
<div id="manual-nav">
<dl>
<dd><a href="index.html#Selector">type Selector</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Compile">func Compile(sel string) (Selector, error)</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#MustCompile">func MustCompile(sel string) Selector</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Selector.Filter">func (s Selector) Filter(nodes []*html.Node) (result []*html.Node)</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Selector.Match">func (s Selector) Match(n *html.Node) bool</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Selector.MatchAll">func (s Selector) MatchAll(n *html.Node) []*html.Node</a></dd>
<dd>&nbsp; &nbsp; <a href="index.html#Selector.MatchFirst">func (s Selector) MatchFirst(n *html.Node) *html.Node</a></dd>
</dl>
</div><!-- #manual-nav -->
<h4>Package files</h4>
<p>
<span style="font-size:90%">
<a href="http://localhost:6060/src/github.com/andybalholm/cascadia/parser.go">parser.go</a>
<a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go">selector.go</a>
</span>
</p>
</div><!-- .expanded -->
</div><!-- #pkg-index -->
<div id="pkg-callgraph" class="toggle" style="display: none">
<div class="collapsed">
<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
</div> <!-- .expanded -->
<div class="expanded">
<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
<p>
In the call graph viewer below, each node
is a function belonging to this package
and its children are the functions it
calls&mdash;perhaps dynamically.
</p>
<p>
The root nodes are the entry points of the
package: functions that may be called from
outside the package.
There may be non-exported or anonymous
functions among them if they are called
dynamically from another package.
</p>
<p>
Click a node to visit that function's source code.
From there you can visit its callers by
clicking its declaring <code>func</code>
token.
</p>
<p>
Functions may be omitted if they were
determined to be unreachable in the
particular programs or tests that were
analyzed.
</p>
<!-- Zero means show all package entry points. -->
<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
</div>
</div> <!-- #pkg-callgraph -->
<h2 id="Selector">type <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=219:254#L5">Selector</a></h2>
<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>
<p>
A Selector is a function which tells whether a node matches or not.
</p>
<h3 id="Compile">func <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1022:1064#L31">Compile</a></h3>
<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>
<p>
Compile parses a selector and returns, if successful, a Selector object
that can be used to match against html.Node objects.
</p>
<h3 id="MustCompile">func <a href="http://localhost:6060/src/github.com/andybalholm/cascadia/selector.go?s=1371:1408#L46">MustCompile</a></h3>
<pre>func MustCompile(sel <a href="../../../builtin/index.html#string">string</a>) <a href="index.html#Selector">Selector</a></pre>
<p>
MustCompile is like Compile, but panics instead of returning an error.
</p>
<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>
<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>
<p>
Filter returns the nodes in nodes that match the selector.
</p>
<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>
<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>
<p>
Match returns true if the node matches the selector.
</p>
<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>
<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>
<p>
MatchAll returns a slice of the nodes that match the selector,
from n and its children.
</p>
<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>
<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>
<p>
MatchFirst returns the first node that matches s, from n and its children.
</p>
<h2 id="pkg-subdirectories">Subdirectories</h2>
<div class="pkg-dir">
<table>
<tr>
<th class="pkg-name">Name</th>
<th class="pkg-synopsis">Synopsis</th>
</tr>
<tr>
<td colspan="2"><a href="../index.html">..</a></td>
</tr>
<tr>
<td class="pkg-name" style="padding-left: 0px;">
<a href="fuzz/index.html">fuzz</a>
</td>
<td class="pkg-synopsis">
</td>
</tr>
</table>
</div>
<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>
</div><!-- .container -->
</div><!-- #page -->
<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>
<script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>
</body>
</html>