Using Profiler/ProfilerViewer to Inspect Non-YUI Code
<!--
Software License Agreement (BSD License)
Copyright (c) 2009, Yahoo! Inc.
All rights reserved.
Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the
following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Sources of Intellectual Property Included in the YUI Library
YUI is issued by Yahoo! under the BSD license above. Below is a list of certain publicly available software that is the source of intellectual property in YUI, along with the licensing terms that pertain to thosesources of IP. This list is for informational purposes only and is not intended to represent an exhaustive list of third party contributions to the YUI.
* Douglas Crockford's JSON parsing and stringifying methods: In the JSON Utility, Douglas Crockford's JSON parsing and stringifying methods are adapted from work published at JSON.org. The adapted work is in the public domain.
* Robert Penner's animation-easing algorithms: In the Animation Utility, YUI makes use of Robert Penner's algorithms for easing.
* Geoff Stearns's SWFObject: In the Charts Control and the Uploader versions through 2.7.0, YUI makes use of Geoff Stearns's SWFObject v1.5 for Flash Player detection and embedding. More information on SWFObject can be found here (http://blog.deconcept.com/swfobject/). SWFObject is (c) 2007 Geoff Stearns and is released under the MIT License (http://www.opensource.org/licenses/mit-license.php).
* Diego Perini's IEContentLoaded technique: The Event Utility employs a technique developed by Diego Perini and licensed under GPL. YUI's use of this technique is included under our BSD license with the author's permission.
-->
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ProfileViewer: Profiling Calendar</title>
<link rel="stylesheet" type="text/css" href="yui_2.7.0b-lib/fonts/fonts.css">
<link rel="stylesheet" type="text/css" href="assets/dpSyntaxHighlighter.css">
<script type="text/javascript" src="yui_2.7.0b-lib/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="yui_2.7.0b-lib/profiler/profiler-min.js"></script>
<script type="text/javascript" src="assets/dpSyntaxHighlighter.js"></script>
<style type="text/css">
body {
margin:1em;
}
a.button {
background:#3f6bc3;
font:bold 11px arial;
color:#fff;
padding:4px;
margin:0 0 0 10px;
border:1px solid #3f567d;
cursor:pointer;
display:-moz-inline-stack;
display:inline-block;
}
a.disabled {background:#666;}
</style>
</head>
<body class="yui-skin-sam">
<h1>Using Profiler/ProfilerViewer to Inspect Non-YUI Code</h1>
<p>The <a href="http://developer.yahoo.com/yui/profilerviewer/">ProfilerViewer Control</a> (and the <a href="http://developer.yahoo.com/yui/profiler/">Profiler</a> that drives it) is code-agnostic: It can be used as easily to profile your own code or third-party code as it can to profile YUI modules. In this example, we use Profiler and ProfilerViewer to profile the <a href="http://code.google.com/p/syntaxhighlighter/">DP Syntax Highlighter</a> script that the YUI Project uses for code highlighting on our website.</p>
<p>To lighten the initial YUI footprint on the page (and minimize the impact of YUI on the script being profiled), this example takes the following steps:</p>
<ol><li><a href="http://developer.yahoo.com/yui/yuiloader/">YUI Loader</a> and Profiler are loaded first, along with the script being profiled. By putting only a tiny amount of YUI code on the page, we should be able to run DP Syntax Highlighter without its performance being impacted much by YUI.</li>
<li>Once DP Syntax Highlighter has run, highlighting the codeblocks in the tutorial below, click on the link below reading "Show Code Profile." This will trigger YUI Loader to load ProfilerViewer and its dependencies, rendering the display and allowing you to explore the performance profile of the Syntax Highlighter.</li>
</ol>
<p><a class="button" id="showProfile" onClick="YAHOO.example.pv.showProfilerViewer()">Show Code Profile</a></p>
<hr>
<p>Here's how we accomplish the steps outlined above. (Note: It's the script-based code-highlighting used below that's being profiled in this example.)</p>
<p>First, we load the minimal dependencies for profiling code with YUI Profiler. To that, we add the DP Syntax Highlighter code (ie, the code that we'll be profiling).</p>
<textarea name="code" class="HTML" cols="60" rows="1"><script type="text/javascript" src="http://yui.yahooapis.com//build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="http://yui.yahooapis.com//build/profiler/profiler-min.js"></script>
<script type="text/javascript" src="http://developer.yahoo.com/yui/examples/profilerviewer/assets/dpSyntaxHighlighter.js"></script></textarea>
<p>Next, we set up a simple initialization function that (a) sets up the code we want to profile then (b) executes the code:</p>
<textarea name="code" class="CSS" cols="60" rows="1">YAHOO.example.pv.init = function() {
//profile the Syntax Highlighter; note: we want to register the
//object for profiling before we execute the highlighting code:
YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter");
YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true);
//Highlight code:
dp.SyntaxHighlighter.HighlightAll('code');
};
YAHOO.example.pv.init();</textarea>
<p>At this point, we've told Profiler what parts of Syntax Highlighter we want profiled and we've then run Syntax Highlighter, capturing data about its performance. And we've done all this with the smallest possible amount of YUI code on the page. <em>Note that Profiler is loaded now, but ProfilerViewer and all of the YUI infrastructure it leverages — like Element, DataTable and Charts — is still absent.</em></p>
<p>Now it's time to set up a button that brings in the YUI ProfilerViewer and all of its dependencies. That button executes the following code:</p>
<textarea name="code" class="JScript" cols="60" rows="1">//When the showProfile button is clicked, use YUI Loader to get all required
//dependencies and then show the profile:
YAHOO.example.pv.showProfilerViewer = function() {
//disable the button once it's clicked:
document.getElementById("showProfile").onclick = "";
document.getElementById("showProfile").className += " disabled";
//private function renders the viewer once dependencies are loaded:
var showViewer = function() {
//instantiate ProfilerViewer with desired options:
var pv = new YAHOO.widget.ProfilerViewer("", {
visible: true, //expand the viewer mmediately after instantiation
showChart: true,
base:"yui_2.7.0b-lib/",
swfUrl: "yui_2.7.0b-lib/charts/assets/charts.swf"
});
};
//private function gets dependencies for ProfilerViewer:
var getProfilerViewer = function() {
var loader = new YAHOO.util.YUILoader({
base: "yui_2.7.0b-lib/",
require: ["profilerviewer"], //YUI Loader will handle all dependencies
//for us. Nice!
onSuccess: showViewer
});
loader.insert();
};
//fire getProfilerViewer to trigger the loading and display of the viewer
//console:
getProfilerViewer();
};</textarea>
<p>You can use similar strategies to leverage YUI's Profiler and ProfilerViewer on your projects — even those that aren't based on YUI.</p>
<p>The full script souce for this example follows:</p>
<textarea name="code" class="JScript" cols="60" rows="1">YAHOO.namespace("example.pv");
YAHOO.example.pv.init = function() {
//profile the Syntax Highlighter; note: we want to register the
//object for profiling before we execute the highlighting code:
YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter");
YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true);
//Highlight code:
dp.SyntaxHighlighter.HighlightAll('code');
};
//When the showProfile button is clicked, use YUI Loader to get all required
//dependencies and then show the profile:
YAHOO.example.pv.showProfilerViewer = function() {
//disable button:
document.getElementById("showProfile").onclick = "";
document.getElementById("showProfile").className += " disabled";
//private function renders the viewer once dependencies are loaded:
var showViewer = function() {
//instantiate ProfilerViewer with desired options:
var pv = new YAHOO.widget.ProfilerViewer("", {
visible: true, //expand the viewer mmediately after instantiation
showChart: true,
base:"yui_2.7.0b-lib/",
swfUrl: "yui_2.7.0b-lib/charts/assets/charts.swf"
});
};
//private function gets dependencies for ProfilerViewer:
var getProfilerViewer = function() {
var loader = new YAHOO.util.YUILoader({
base: "yui_2.7.0b-lib/",
require: ["profilerviewer"], //YUI Loader will handle all dependencies
//for us. Nice!
onSuccess: showViewer
});
loader.insert();
};
//fire getProfilerViewer to trigger the loading and display of the viewer
//console:
getProfilerViewer();
};
YAHOO.example.pv.init();</textarea>
<script type="text/javascript">
YAHOO.namespace("example.pv");
YAHOO.example.pv.init = function() {
//profile the Syntax Highlighter; note: we want to register the
//object for profiling before we execute the highlighting code:
YAHOO.tool.Profiler.registerConstructor("dp.sh.Highlighter");
YAHOO.tool.Profiler.registerObject("dpSyntaxHighlighter", dp, true);
//Highlight code:
dp.SyntaxHighlighter.HighlightAll('code');
};
//When the showProfile button is clicked, use YUI Loader to get all required
//dependencies and then show the profile:
YAHOO.example.pv.showProfilerViewer = function() {
//disable button:
document.getElementById("showProfile").onclick = "";
document.getElementById("showProfile").className += " disabled";
//private function renders the viewer once dependencies are loaded:
var showViewer = function() {
//instantiate ProfilerViewer with desired options:
var pv = new YAHOO.widget.ProfilerViewer("", {
visible: true, //expand the viewer mmediately after instantiation
showChart: true,
base:"yui_2.7.0b-lib/",
swfUrl: "yui_2.7.0b-lib/charts/assets/charts.swf"
});
//Just to make the instance publicly accessible via the console:
YAHOO.example.pv.instance = pv;
};
//private function gets dependencies for ProfilerViewer:
var getProfilerViewer = function() {
var loader = new YAHOO.util.YUILoader({
base: "yui_2.7.0b-lib/",
require: ["profilerviewer"], //YUI Loader will handle all dependencies
//for us. Nice!
onSuccess: showViewer
});
loader.insert();
};
//fire getProfilerViewer to trigger the loading and display of the viewer
//console:
getProfilerViewer();
};
YAHOO.example.pv.init();
</script>
</body>
</html>
<!-- presentbright.corp.yahoo.com uncompressed/chunked Thu Feb 19 10:53:18 PST 2009 -->
yui_2.7.0b.zip( 4,431 k)Related examples in the same category