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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
|
<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
1) The <head> information in this page is significant, should be uniform
across api docs and should be edited only with knowledge of the
templating mechanism.
3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
browser, it will be re-generated from the template, json schema and
authored overview content.
4) The <body>.innerHTML is also generated by an offline step so that this
page may easily be indexed by search engines.
--><html xmlns="http://www.w3.org/1999/xhtml"><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
<link href="css/print.css" rel="stylesheet" type="text/css" media="print">
<script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
</script>
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<title>Tutorial: Debugging - Google Chrome Extensions - Google Code</title></head><body> <div id="gc-container" class="labs">
<!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
<!-- In particular, sub-templates that recurse, must be used by allowing
jstemplate to make a copy of the template in this section which
are not operated on by way of the jsskip="true" -->
<div style="display:none">
<!-- VALUE -->
<div id="valueTemplate">
<dt>
<var>paramName</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
<span id="typeTemplate">
<span>
<a> Type</a>
</span>
<span>
<span>
array of <span><span></span></span>
</span>
<span>paramType</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo">
Undocumented.
</dd>
<dd>
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
<div>
<div>
</div>
</div>
</dl>
</dd>
</div> <!-- /VALUE -->
</div> <!-- /SUBTEMPLATES -->
<a id="top"></a>
<div id="skipto">
<a href="#gc-pagecontent">Skip to page content</a>
<a href="#gc-toc">Skip to main navigation</a>
</div>
<!-- API HEADER -->
<table id="header" width="100%" cellspacing="0" border="0">
<tbody><tr>
<td valign="middle"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></td>
<td valign="middle" width="100%" style="padding-left:0.6em;">
<form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
<div id="gsc-search-box">
<input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" size="55">
<input class="gsc-search-button" type="submit" name="sa" value="Search">
<br>
<span class="greytext">e.g. "ajax apis" or "open source"</span>
</div>
</form>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script>
</td>
</tr>
</tbody></table>
<div id="codesiteContent">
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions (<a href="/labs/">Labs</a>)</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" class="selected" title="Google Chrome Extensions documentation home page">Home</a>
</li>
<li id="group_link">
<a href="http://groups.google.com/group/chromium-extensions" title="Google Chrome Extensions mailing list">Group</a>
</li>
<li id="samples_link">
<a href="samples.html" title="Google Chrome Extensions samples">Samples</a>
</li>
<!--
<li id="terms_link">
Terms
</li>
-->
</ul>
</div> <!-- end gc-topnav -->
<div class="g-section g-tpl-170">
<!-- SIDENAV -->
<div class="g-unit g-first" id="gc-toc">
<ul>
<li><a href="index.html">Home</a></li>
<li><a href="getstarted.html">Getting Started</a></li>
<li><a href="overview.html">Overview</a></li>
<li><h2><a href="devguide.html">Developer's Guide</a></h2>
<ul>
<li>Browser UI
<ul>
<li><a href="browserAction.html">Browser Actions</a></li>
<li><a href="options.html">Options Pages</a></li>
<li><a href="override.html">Override Pages</a></li>
<li><a href="pageAction.html">Page Actions</a></li>
<li><a href="themes.html">Themes</a></li>
</ul>
</li>
<li>Browser Interaction
<ul>
<li><a href="bookmarks.html">Bookmarks</a></li>
<li><a href="events.html">Events</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li><a href="windows.html">Windows</a></li>
</ul>
</li>
<li>Implementation
<ul>
<li><a href="background_pages.html">Background Pages</a></li>
<li><a href="content_scripts.html">Content Scripts</a></li>
<li><a href="xhr.html">Cross-Origin XHR</a></li>
<li><a href="messaging.html">Message Passing</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
</ul>
</li>
<li>Finishing
<ul>
<li><a href="autoupdate.html">Autoupdating</a></li>
<li><a href="packaging.html">Packaging</a></li>
</ul>
</li>
</ul>
</li>
<li><h2><a href="tutorials.html">Tutorials</a></h2>
<ul>
<li class="leftNavSelected">Debugging</li>
</ul>
</li>
<li><h2>Reference</h2>
<ul>
<li>Formats
<ul>
<li><a href="manifest.html">Manifest Files</a></li>
<li><a href="match_patterns.html">Match Patterns</a></li>
<!-- <li>Packages (.crx)</li> -->
</ul>
</li>
<li><a href="api_index.html">chrome.* APIs</a></li>
<li><a href="api_other.html">Other APIs</a></li>
</ul>
</li>
<li><h2><a href="samples.html">Samples</a></h2></li>
</ul>
</div>
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
<h1 class="page_title">Tutorial: Debugging</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href="#extension-info"> View extension information </a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li>
<a href="#inspect-popup"> Inspect the popup </a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li>
<a href="#debug"> Use the debugger </a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li>
<a href="#summary">Summary</a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li><li>
<a href="#next">Now what?</a>
<ol>
<li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li>
<div style="display: none; ">
<li>
<a href="#apiReference">API reference</a>
<ol>
<li>
<a href="#properties">Properties</a>
<ol>
<li>
<a href="#property-anchor">propertyName</a>
</li>
</ol>
</li>
<li>
<a href="#methods">Methods</a>
<ol>
<li>
<a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
<li>
<a href="#events">Events</a>
<ol>
<li>
<a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
<li>
<a href="#types">Types</a>
<ol>
<li>
<a href="#id-anchor">id</a>
</li>
</ol>
</li>
</ol>
</li>
</div>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-title" class="pageData">Tutorial: Debugging</div>
<div id="pageData-showTOC" class="pageData">true</div>
<p>
This tutorial introduces you to using
Google Chrome's built-in Developer Tools
to interactively debug an extension.
</p>
<h2 id="extension-info"> View extension information </h2>
<p>
To follow this tutorial, you need
the Hello World extension that was featured in
<a href="getstarted.html">Getting Started</a>.
In this section,
you'll load the extension
and take a look at its information
in the Extensions page.
</p>
<ol>
<li>
<p>
Load the Hello World extension if it isn't already running.
If the extension is running,
you'll see the Hello World icon
<img src="examples/tutorials/getstarted/icon.png" width="19" height="19" alt="" style="margin:0">
to the right of
your browser's address bar.
</p>
<p>
If the Hello World extension isn't already running,
find the extension files and load them.
If you don't have a handy copy of the files,
extract them from this
<a href="examples/tutorials/getstarted/getstarted.zip">ZIP file</a>.
See Getting Started if you need
<a href="getstarted.html#load-ext">instructions
for loading the extension</a>.
</p>
</li>
<li>
Go to the Extensions page
(<b>chrome://extensions</b>),
and make sure the page is in Developer mode.
</li>
<li>
Look at the Hello World extension's information on that page.
You can see details such as the extension's
name, description, and ID.
<p class="comment">
[PENDING: screenshot here?]
</p>
</li>
<li>
Keeping an eye on the Extensions page,
click the Hello World extension's icon
<img src="examples/tutorials/getstarted/icon.png" width="19" height="19" alt="" style="margin:0">.
A popup appears,
and a link named <b>popup.html</b> appears in extension's information,
under a new "Inspect active views:" heading.
<p>
<img src="images/debug-popup.gif" width="500" height="377" alt="">
</p></li>
</ol>
<p>
Normally, you can inspect a page
by clicking its link in the Extensions page.
However, clicking the link for a popup just
makes the popup disappear.
(This happens because a popup goes away as soon as it loses the keyboard focus.)
The next section shows how you can inspect popup pages.
</p>
<h2 id="inspect-popup"> Inspect the popup </h2>
<p>
Using the <b>chrome-extension</b> protocol,
you can view any file in your extension.
<span class="comment">
[PENDING: check]
</span>
This feature is especially handy for debugging popups.
</p>
<ol>
<li>
Get the ID for the Hello World extension
from the Extensions page.
Example: <b>opnnhifacfpohionnikhlecfgheooenk</b>
</li>
<li>
Open a new tab or window,
and enter the following in the address box:
<blockquote>
<b>chrome-extension://</b><em>extensionId</em><b>/popup.html</b>
</blockquote>
<p>
You should see a full-page version of the popup's contents,
like the following:
</p>
<p>
<img src="images/debug-popup-tab.gif" width="500" height="245" alt="">
</p>
</li><li>
Back in the Extensions page,
press <b>F5</b> or click the browser's Reload button
to update the Hello World extension's information.
<span class="comment">[PENDING: this seems like it should be unnecessary --
like the page should update itself]</span>
</li>
<li>
Click the link to <b>popup.html</b>.
A Developer Tools window like the following should appear,
displaying the code for <b>popup.html</b>.
<p>
<img src="images/devtools-1.gif" alt="" width="500" height="294">
</p>
</li>
<li>
If the <strong>Scripts</strong> button isn't already selected,
click it.
<span class="comment">[PENDING: can we omit this step?]</span>
</li>
<li>
Click the console button
<img src="images/console-button.gif" style="margin:0; padding:0" align="absmiddle" width="26" height="22" alt="">(second
from left,
at the bottom of the Developer Tools window)
so that you can see both the code and the console.
</li>
</ol>
<h2 id="debug"> Use the debugger </h2>
<p>
In this section,
you'll follow the execution of the popup page
as it adds images to itself.
</p>
<ol>
<li>
Set a breakpoint inside the image-adding loop
by searching for the string <b>img.src</b>
and clicking the number of the line where it occurs
(for example, <strong>37</strong>):
<p>
<img src="images/devtools-2.gif" alt="" width="500" height="294">
</p>
</li>
<li>
Make sure you can see the <b>popup.html</b> tab.
It should show 20 "hello world" images.
</li>
<li>
At the console prompt, reload the popup page
by entering <b>location.reload()</b>:
<pre>> <b>location.reload()</b>
</pre>
<p>
The popup page goes blank as it begins to reload,
and its execution stops at line 37.
</p>
</li>
<li>
In the upper right part of the tools window,
you should see the local scope variables.
This section shows the current values of all variables in the current scope.
For example, in the following screenshot
the value of <code>i</code> is 0, and
<code>photos</code> is a node list
that contains at least a few elements.
(In fact, it contains 20 elements at indexes 0 through 19,
each one representing a photo.)
<p>
<img src="images/devtools-localvars.gif" alt="" width="225" height="215">
</p>
</li>
<li>
Click the play/pause button
<img src="images/play-button.gif" style="margin:0; padding:0" align="absmiddle" width="22" height="20" alt="">(near
the top right of the Developer Tools window)
to go through the image-processing loop a single time.
Each time you click that button,
the value of <code>i</code> increments and
another icon appears in the popup page.
For example, when <code>i</code> is 10,
the popup page looks something like this:
</li>
<p>
<img src="images/devtools-3.gif" width="500" height="245" alt="the popup page with 10 images">
</p>
<li>
Use the buttons next to the play/pause button
to step over, into, and out of function calls.
To let the page finish loading,
click line <b>37</b> to disable the breakpoint,
and then press play/pause
<img src="images/play-button.gif" style="margin:0; padding:0" align="absmiddle" width="22" height="20" alt="">to
continue execution.
</li>
</ol>
<h2 id="summary">Summary</h2>
<p>
This tutorial demonstrated some techniques you can use
to debug your extensions:
</p>
<ul>
<li>
Find your extension's ID and links to its pages in
the <b>Extensions</b> page
(<b>chrome://extensions</b>).
</li>
<li>
View hard-to-reach pages
(and any other file in your extension) using
<b>chrome-extension://</b><em>extensionId</em><b>/</b><em>filename</em>.
</li>
<li>
Use Developer Tools to inspect
and step through a page's JavaScript code.
</li>
<li>
Reload the currently inspected page from the console
using <b>location.reload()</b>.
</li>
</ul>
<h2 id="next">Now what?</h2>
<p>
Now that you've been introduced to debugging,
here are suggestions for what to do next:
</p>
<ul>
<li>
Try installing and inspecting other extensions,
such as the
<a href="samples.html">samples</a>.
</li>
<li>
Try using widely available debugging APIs such as
<code>console.log()</code> and <code>console.error()</code>
in your extension's JavaScript code.
Example: <code>console.log("Hello, world!")</code>
</li>
<li>
Explore the
<a href="http://www.chromium.org/devtools">Developer Tools site</a>,
and watch some video tutorials.
</li>
</ul>
<p class="comment">
[PENDING: do something to help people debug
content scripts, which show up in blue]
</p>
<p>
For more ideas,
see the <a href="getstarted.html#summary">Now what?</a> section
of Getting Started.
</p>
</div>
<!-- API PAGE -->
<div class="apiPage" style="display: none; ">
<a name="apiReference"></a>
<h2>API reference: chrome.apiname </h2>
<!-- PROPERTIES -->
<div class="apiGroup">
<a name="properties"></a>
<h3 id="properties">Properties</h3>
<div>
<a></a>
<h4>getLastError</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span>chrome.extension</span><span>lastError</span>
</div>
<div>
</div>
</div>
</div> <!-- /apiGroup -->
<!-- METHODS -->
<div class="apiGroup" id="methods">
<a name="methods"></a>
<h3>Methods</h3>
<!-- iterates over all functions -->
<div class="apiItem">
<a></a> <!-- method-anchor -->
<h4>method name</h4>
<div class="summary"><span>void</span>
<!-- Note: intentionally longer 80 columns -->
<span>chrome.module.methodName</span>(<span><span>, </span><span></span>
<var><span></span></var></span>)</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- RETURNS -->
<h4>Returns</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
<!-- CALLBACK -->
<div>
<div>
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter,
it should specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div>
</div>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div class="apiGroup">
<a name="events"></a>
<h3 id="events">Events</h3>
<!-- iterates over all events -->
<div class="apiItem">
<a></a>
<h4>event name</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);
</div>
<div class="description">
<p class="todo">Undocumented.</p>
<p>
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div>
<div>
</div>
</div>
</dl>
</div> <!-- /decription -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<div class="apiGroup">
<a name="types.sort(sortByName)"></a>
<h3 id="types">Types</h3>
<!-- iterates over all types -->
<div class="apiItem">
<a></a>
<h4>type name</h4>
<div>
</div>
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /gc-pagecontent -->
</div> <!-- /g-section -->
</div> <!-- /codesiteContent -->
<div id="gc-footer" --="">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2009 Google
</p>
<!-- begin analytics -->
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
<script type="text/javascript">
// chrome doc tracking
try {
var engdocs = _gat._getTracker("YT-10763712-2");
engdocs._trackPageview();
} catch(err) {}
// code.google.com site-wide tracking
try {
_uacct="UA-18071-1";
_uanchor=1;
_uff=0;
urchinTracker();
}
catch(e) {/* urchinTracker not available. */}
</script>
<!-- end analytics -->
</div>
</div> <!-- /gc-footer -->
</div> <!-- /gc-container -->
</body></html>
|
