← Back to branch summary

~ubuntu-branches/ubuntu/saucy/ruby-erubis/saucy

« back to all changes in this revision

Viewing changes to doc-api/classes/Erubis/RubyGenerator.html

  • Committer: Package Import Robot
  • Author(s): Laurent Bigonville
  • Date: 2012-01-26 15:15:58 UTC
  • Revision ID: package-import@ubuntu.com-20120126151558-9u7mnf9ooqnw3bwz
Tags: upstream-2.7.0
Import upstream version 2.7.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc-api/classes/Erubis/RubyGenerator.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html 
 
3
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
4
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
5
 
 
6
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
7
<head>
 
8
  <title>Module: Erubis::RubyGenerator</title>
 
9
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
 
10
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
 
11
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 
12
  <script type="text/javascript">
 
13
  // <![CDATA[
 
14
 
 
15
  function popupCode( url ) {
 
16
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
 
17
  }
 
18
 
 
19
  function toggleCode( id ) {
 
20
    if ( document.getElementById )
 
21
      elem = document.getElementById( id );
 
22
    else if ( document.all )
 
23
      elem = eval( "document.all." + id );
 
24
    else
 
25
      return false;
 
26
 
 
27
    elemStyle = elem.style;
 
28
    
 
29
    if ( elemStyle.display != "block" ) {
 
30
      elemStyle.display = "block"
 
31
    } else {
 
32
      elemStyle.display = "none"
 
33
    }
 
34
 
 
35
    return true;
 
36
  }
 
37
  
 
38
  // Make codeblocks hidden by default
 
39
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
 
40
  
 
41
  // ]]>
 
42
  </script>
 
43
 
 
44
</head>
 
45
<body>
 
46
 
 
47
 
 
48
 
 
49
    <div id="classHeader">
 
50
        <table class="header-table">
 
51
        <tr class="top-aligned-row">
 
52
          <td><strong>Module</strong></td>
 
53
          <td class="class-name-in-header">Erubis::RubyGenerator</td>
 
54
        </tr>
 
55
        <tr class="top-aligned-row">
 
56
            <td><strong>In:</strong></td>
 
57
            <td>
 
58
                <a href="../../files/erubis/engine/eruby_rb.html">
 
59
                erubis/engine/eruby.rb
 
60
                </a>
 
61
        <br />
 
62
            </td>
 
63
        </tr>
 
64
 
 
65
        </table>
 
66
    </div>
 
67
  <!-- banner header -->
 
68
 
 
69
  <div id="bodyContent">
 
70
 
 
71
 
 
72
 
 
73
  <div id="contextContent">
 
74
 
 
75
    <div id="description">
 
76
      <p>
 
77
code generator for Ruby
 
78
</p>
 
79
 
 
80
    </div>
 
81
 
 
82
 
 
83
   </div>
 
84
 
 
85
    <div id="method-list">
 
86
      <h3 class="section-bar">Methods</h3>
 
87
 
 
88
      <div class="name-list">
 
89
      <a href="#M000121">add_expr_debug</a>&nbsp;&nbsp;
 
90
      <a href="#M000120">add_expr_escaped</a>&nbsp;&nbsp;
 
91
      <a href="#M000119">add_expr_literal</a>&nbsp;&nbsp;
 
92
      <a href="#M000118">add_stmt</a>&nbsp;&nbsp;
 
93
      <a href="#M000117">add_text</a>&nbsp;&nbsp;
 
94
      <a href="#M000115">escape_text</a>&nbsp;&nbsp;
 
95
      <a href="#M000116">escaped_expr</a>&nbsp;&nbsp;
 
96
      <a href="#M000114">init_generator</a>&nbsp;&nbsp;
 
97
      </div>
 
98
    </div>
 
99
 
 
100
  </div>
 
101
 
 
102
 
 
103
    <!-- if includes -->
 
104
    <div id="includes">
 
105
      <h3 class="section-bar">Included Modules</h3>
 
106
 
 
107
      <div id="includes-list">
 
108
        <span class="include-name"><a href="Generator.html">Generator</a></span>
 
109
        <span class="include-name"><a href="StringBufferEnhancer.html">StringBufferEnhancer</a></span>
 
110
      </div>
 
111
    </div>
 
112
 
 
113
    <div id="section">
 
114
 
 
115
 
 
116
 
 
117
 
 
118
 
 
119
      
 
120
 
 
121
 
 
122
    <!-- if method_list -->
 
123
    <div id="methods">
 
124
      <h3 class="section-bar">Public Instance methods</h3>
 
125
 
 
126
      <div id="method-M000121" class="method-detail">
 
127
        <a name="M000121"></a>
 
128
 
 
129
        <div class="method-heading">
 
130
          <a href="#M000121" class="method-signature">
 
131
          <span class="method-name">add_expr_debug</span><span class="method-args">(src, code)</span>
 
132
          </a>
 
133
        </div>
 
134
      
 
135
        <div class="method-description">
 
136
          <p><a class="source-toggle" href="#"
 
137
            onclick="toggleCode('M000121-source');return false;">[Source]</a></p>
 
138
          <div class="method-source-code" id="M000121-source">
 
139
<pre>
 
140
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 63</span>
 
141
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_expr_debug</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">code</span>)
 
142
      <span class="ruby-identifier">code</span>.<span class="ruby-identifier">strip!</span>
 
143
      <span class="ruby-identifier">s</span> = (<span class="ruby-identifier">code</span>.<span class="ruby-identifier">dump</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\A&quot;(.*)&quot;\z/</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">$1</span>
 
144
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">' $stderr.puts(&quot;*** debug: '</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'=#{('</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">').inspect}&quot;);'</span>
 
145
    <span class="ruby-keyword kw">end</span>
 
146
</pre>
 
147
          </div>
 
148
        </div>
 
149
      </div>
 
150
 
 
151
      <div id="method-M000120" class="method-detail">
 
152
        <a name="M000120"></a>
 
153
 
 
154
        <div class="method-heading">
 
155
          <a href="#M000120" class="method-signature">
 
156
          <span class="method-name">add_expr_escaped</span><span class="method-args">(src, code)</span>
 
157
          </a>
 
158
        </div>
 
159
      
 
160
        <div class="method-description">
 
161
          <p><a class="source-toggle" href="#"
 
162
            onclick="toggleCode('M000120-source');return false;">[Source]</a></p>
 
163
          <div class="method-source-code" id="M000120-source">
 
164
<pre>
 
165
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 59</span>
 
166
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_expr_escaped</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">code</span>)
 
167
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; #{@bufvar} &lt;&lt; &quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">escaped_expr</span>(<span class="ruby-identifier">code</span>) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">';'</span>
 
168
    <span class="ruby-keyword kw">end</span>
 
169
</pre>
 
170
          </div>
 
171
        </div>
 
172
      </div>
 
173
 
 
174
      <div id="method-M000119" class="method-detail">
 
175
        <a name="M000119"></a>
 
176
 
 
177
        <div class="method-heading">
 
178
          <a href="#M000119" class="method-signature">
 
179
          <span class="method-name">add_expr_literal</span><span class="method-args">(src, code)</span>
 
180
          </a>
 
181
        </div>
 
182
      
 
183
        <div class="method-description">
 
184
          <p><a class="source-toggle" href="#"
 
185
            onclick="toggleCode('M000119-source');return false;">[Source]</a></p>
 
186
          <div class="method-source-code" id="M000119-source">
 
187
<pre>
 
188
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 55</span>
 
189
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_expr_literal</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">code</span>)
 
190
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; #{@bufvar} &lt;&lt; (&quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">code</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">').to_s;'</span>
 
191
    <span class="ruby-keyword kw">end</span>
 
192
</pre>
 
193
          </div>
 
194
        </div>
 
195
      </div>
 
196
 
 
197
      <div id="method-M000118" class="method-detail">
 
198
        <a name="M000118"></a>
 
199
 
 
200
        <div class="method-heading">
 
201
          <a href="#M000118" class="method-signature">
 
202
          <span class="method-name">add_stmt</span><span class="method-args">(src, code)</span>
 
203
          </a>
 
204
        </div>
 
205
      
 
206
        <div class="method-description">
 
207
          <p><a class="source-toggle" href="#"
 
208
            onclick="toggleCode('M000118-source');return false;">[Source]</a></p>
 
209
          <div class="method-source-code" id="M000118-source">
 
210
<pre>
 
211
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 49</span>
 
212
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_stmt</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">code</span>)
 
213
      <span class="ruby-comment cmt">#src &lt;&lt; code &lt;&lt; ';'</span>
 
214
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">code</span>
 
215
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">';'</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">code</span>[<span class="ruby-value">-1</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?\n</span>
 
216
    <span class="ruby-keyword kw">end</span>
 
217
</pre>
 
218
          </div>
 
219
        </div>
 
220
      </div>
 
221
 
 
222
      <div id="method-M000117" class="method-detail">
 
223
        <a name="M000117"></a>
 
224
 
 
225
        <div class="method-heading">
 
226
          <a href="#M000117" class="method-signature">
 
227
          <span class="method-name">add_text</span><span class="method-args">(src, text)</span>
 
228
          </a>
 
229
        </div>
 
230
      
 
231
        <div class="method-description">
 
232
          <p><a class="source-toggle" href="#"
 
233
            onclick="toggleCode('M000117-source');return false;">[Source]</a></p>
 
234
          <div class="method-source-code" id="M000117-source">
 
235
<pre>
 
236
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 45</span>
 
237
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_text</span>(<span class="ruby-identifier">src</span>, <span class="ruby-identifier">text</span>)
 
238
      <span class="ruby-identifier">src</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; #{@bufvar} &lt;&lt; '&quot;</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">escape_text</span>(<span class="ruby-identifier">text</span>) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;';&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">text</span>.<span class="ruby-identifier">empty?</span>
 
239
    <span class="ruby-keyword kw">end</span>
 
240
</pre>
 
241
          </div>
 
242
        </div>
 
243
      </div>
 
244
 
 
245
      <div id="method-M000115" class="method-detail">
 
246
        <a name="M000115"></a>
 
247
 
 
248
        <div class="method-heading">
 
249
          <a href="#M000115" class="method-signature">
 
250
          <span class="method-name">escape_text</span><span class="method-args">(text)</span>
 
251
          </a>
 
252
        </div>
 
253
      
 
254
        <div class="method-description">
 
255
          <p><a class="source-toggle" href="#"
 
256
            onclick="toggleCode('M000115-source');return false;">[Source]</a></p>
 
257
          <div class="method-source-code" id="M000115-source">
 
258
<pre>
 
259
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 31</span>
 
260
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">escape_text</span>(<span class="ruby-identifier">text</span>)
 
261
      <span class="ruby-identifier">text</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/['\\]/</span>, <span class="ruby-value str">'\\\\\&amp;'</span>)   <span class="ruby-comment cmt"># &quot;'&quot; =&gt; &quot;\\'&quot;,  '\\' =&gt; '\\\\'</span>
 
262
    <span class="ruby-keyword kw">end</span>
 
263
</pre>
 
264
          </div>
 
265
        </div>
 
266
      </div>
 
267
 
 
268
      <div id="method-M000116" class="method-detail">
 
269
        <a name="M000116"></a>
 
270
 
 
271
        <div class="method-heading">
 
272
          <a href="#M000116" class="method-signature">
 
273
          <span class="method-name">escaped_expr</span><span class="method-args">(code)</span>
 
274
          </a>
 
275
        </div>
 
276
      
 
277
        <div class="method-description">
 
278
          <p><a class="source-toggle" href="#"
 
279
            onclick="toggleCode('M000116-source');return false;">[Source]</a></p>
 
280
          <div class="method-source-code" id="M000116-source">
 
281
<pre>
 
282
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 35</span>
 
283
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">escaped_expr</span>(<span class="ruby-identifier">code</span>)
 
284
      <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;#{@escapefunc}(#{code})&quot;</span>
 
285
    <span class="ruby-keyword kw">end</span>
 
286
</pre>
 
287
          </div>
 
288
        </div>
 
289
      </div>
 
290
 
 
291
      <div id="method-M000114" class="method-detail">
 
292
        <a name="M000114"></a>
 
293
 
 
294
        <div class="method-heading">
 
295
          <a href="#M000114" class="method-signature">
 
296
          <span class="method-name">init_generator</span><span class="method-args">(properties={})</span>
 
297
          </a>
 
298
        </div>
 
299
      
 
300
        <div class="method-description">
 
301
          <p><a class="source-toggle" href="#"
 
302
            onclick="toggleCode('M000114-source');return false;">[Source]</a></p>
 
303
          <div class="method-source-code" id="M000114-source">
 
304
<pre>
 
305
<span class="ruby-comment cmt"># File erubis/engine/eruby.rb, line 21</span>
 
306
    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">init_generator</span>(<span class="ruby-identifier">properties</span>={})
 
307
      <span class="ruby-keyword kw">super</span>
 
308
      <span class="ruby-ivar">@escapefunc</span> <span class="ruby-operator">||=</span> <span class="ruby-value str">&quot;Erubis::XmlHelper.escape_xml&quot;</span>
 
309
      <span class="ruby-ivar">@bufvar</span>     = <span class="ruby-identifier">properties</span>[<span class="ruby-identifier">:bufvar</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">&quot;_buf&quot;</span>
 
310
    <span class="ruby-keyword kw">end</span>
 
311
</pre>
 
312
          </div>
 
313
        </div>
 
314
      </div>
 
315
 
 
316
 
 
317
    </div>
 
318
 
 
319
 
 
320
  </div>
 
321
 
 
322
 
 
323
<div id="validator-badges">
 
324
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 
325
</div>
 
326
 
 
327
</body>
 
328
</html>
 
 
b'\\ No newline at end of file'