File: HTMLTokenizer.html

package info (click to toggle)
libopenid-ruby 2.1.2debian-1
  • links: PTS, VCS
  • area: main
  • in suites: lenny
  • size: 5,140 kB
  • ctags: 3,251
  • sloc: ruby: 17,165; xml: 219; sh: 54; python: 30; makefile: 12
file content (337 lines) | stat: -rw-r--r-- 9,805 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: HTMLTokenizer</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">HTMLTokenizer</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/lib/openid/yadis/htmltokenizer_rb.html">
                lib/openid/yadis/htmltokenizer.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                Object
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
A class to tokenize HTML.
</p>
<p>
Example:
</p>
<pre>
  page = &quot;&lt;HTML&gt;
  &lt;HEAD&gt;
  &lt;TITLE&gt;This is the title&lt;/TITLE&gt;
  &lt;/HEAD&gt;
   &lt;!-- Here comes the &lt;a href=\&quot;missing.link\&quot;&gt;blah&lt;/a&gt;
   comment body
    --&gt;
   &lt;BODY&gt;
     &lt;H1&gt;This is the header&lt;/H1&gt;
     &lt;P&gt;
       This is the paragraph, it contains
       &lt;a href=\&quot;link.html\&quot;&gt;links&lt;/a&gt;,
       &lt;img src=\&quot;blah.gif\&quot; optional alt='images
       are
       really cool'&gt;.  Ok, here is some more text and
       &lt;A href=\&quot;http://another.link.com/\&quot; target=\&quot;_blank\&quot;&gt;another link&lt;/A&gt;.
     &lt;/P&gt;
   &lt;/body&gt;
   &lt;/HTML&gt;
   &quot;
   toke = HTMLTokenizer.new(page)

   assert(&quot;&lt;h1&gt;&quot; == toke.getTag(&quot;h1&quot;, &quot;h2&quot;, &quot;h3&quot;).to_s.downcase)
   assert(HTMLTag.new(&quot;&lt;a href=\&quot;link.html\&quot;&gt;&quot;) == toke.getTag(&quot;IMG&quot;, &quot;A&quot;))
   assert(&quot;links&quot; == toke.getTrimmedText)
   assert(toke.getTag(&quot;IMG&quot;, &quot;A&quot;).attr_hash['optional'])
   assert(&quot;_blank&quot; == toke.getTag(&quot;IMG&quot;, &quot;A&quot;).attr_hash['target'])
</pre>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000005">getNextToken</a>&nbsp;&nbsp;
      <a href="#M000006">getTag</a>&nbsp;&nbsp;
      <a href="#M000007">getText</a>&nbsp;&nbsp;
      <a href="#M000008">getTrimmedText</a>&nbsp;&nbsp;
      <a href="#M000002">new</a>&nbsp;&nbsp;
      <a href="#M000004">peekNextToken</a>&nbsp;&nbsp;
      <a href="#M000003">reset</a>&nbsp;&nbsp;
      <a href="#M000001">version</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->

    <div id="section">





    <div id="attribute-list">
      <h3 class="section-bar">Attributes</h3>

      <div class="name-list">
        <table>
        <tr class="top-aligned-row context-row">
          <td class="context-item-name">page</td>
          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
          <td class="context-item-desc"></td>
        </tr>
        </table>
      </div>
    </div>
      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000002" class="method-detail">
        <a name="M000002"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000002.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000002.html');return false;">
          <span class="method-name">new</span><span class="method-args">(content)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Create a <a href="HTMLTokenizer.html#M000002">new</a> tokenizer, based on
the content, used as a string.
</p>
        </div>
      </div>

      <div id="method-M000001" class="method-detail">
        <a name="M000001"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000001.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000001.html');return false;">
          <span class="method-name">version</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get <a href="HTMLTokenizer.html#M000001">version</a> of <a
href="HTMLTokenizer.html">HTMLTokenizer</a> lib
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000005" class="method-detail">
        <a name="M000005"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000005.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000005.html');return false;">
          <span class="method-name">getNextToken</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get the next token, returns an instance of
</p>
<ul>
<li><a href="HTMLText.html">HTMLText</a>

</li>
<li><a href="HTMLToken.html">HTMLToken</a>

</li>
<li><a href="HTMLTag.html">HTMLTag</a>

</li>
</ul>
        </div>
      </div>

      <div id="method-M000006" class="method-detail">
        <a name="M000006"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000006.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000006.html');return false;">
          <span class="method-name">getTag</span><span class="method-args">(*sought_tags)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get a tag from the specified set of desired tags. For example: <tt>foo =
toke.getTag(&quot;h1&quot;, &quot;h2&quot;, &quot;h3&quot;)</tt> Will
return the next header tag encountered.
</p>
        </div>
      </div>

      <div id="method-M000007" class="method-detail">
        <a name="M000007"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000007.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000007.html');return false;">
          <span class="method-name">getText</span><span class="method-args">(until_tag = nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Get all the text between the current position and the next tag (if
specified) or a specific later tag
</p>
        </div>
      </div>

      <div id="method-M000008" class="method-detail">
        <a name="M000008"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000008.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000008.html');return false;">
          <span class="method-name">getTrimmedText</span><span class="method-args">(until_tag = nil)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Like <a href="HTMLTokenizer.html#M000007">getText</a>, but squeeze all
whitespace, getting rid of leading and trailing whitespace, and squeezing
multiple spaces into a single space.
</p>
        </div>
      </div>

      <div id="method-M000004" class="method-detail">
        <a name="M000004"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000004.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000004.html');return false;">
          <span class="method-name">peekNextToken</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Look at the next token, but don&#8216;t actually grab it
</p>
        </div>
      </div>

      <div id="method-M000003" class="method-detail">
        <a name="M000003"></a>

        <div class="method-heading">
          <a href="HTMLTokenizer.src/M000003.html" target="Code" class="method-signature"
            onclick="popupCode('HTMLTokenizer.src/M000003.html');return false;">
          <span class="method-name">reset</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Reset the parser, setting the current position back at the stop
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>