Commit 42094eee7cfe93d587421c02d7ff7f512f8e5e38
2015-09-10T09:09:03
Autoloader Plugin
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
diff --git a/components.js b/components.js
index 3746a5d..14eff77 100644
--- a/components.js
+++ b/components.js
@@ -474,6 +474,11 @@ var components = {
"title": "Remove initial line feed",
"owner": "Golmote",
"noCSS": true
+ },
+ "autoloader": {
+ "title": "Autoloader",
+ "owner": "Golmote",
+ "noCSS": true
}
}
};
diff --git a/gulpfile.js b/gulpfile.js
index 51af93c..25757db 100644
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -18,7 +18,8 @@ var gulp = require('gulp'),
'plugins/file-highlight/prism-file-highlight.js'
],
plugins: ['plugins/**/*.js', '!plugins/**/*.min.js'],
- showLanguagePlugin: 'plugins/show-language/prism-show-language.js'
+ showLanguagePlugin: 'plugins/show-language/prism-show-language.js',
+ autoloaderPlugin: 'plugins/autoloader/prism-autoloader.js'
};
gulp.task('components', function() {
@@ -37,7 +38,7 @@ gulp.task('build', function() {
.pipe(gulp.dest('./'));
});
-gulp.task('plugins', ['show-language-plugin'], function() {
+gulp.task('plugins', ['languages-plugins'], function() {
return gulp.src(paths.plugins)
.pipe(uglify())
.pipe(rename({ suffix: '.min' }))
@@ -49,7 +50,7 @@ gulp.task('watch', function() {
gulp.watch(paths.plugins, ['plugins', 'build']);
});
-gulp.task('show-language-plugin', function (cb) {
+gulp.task('languages-plugins', function (cb) {
fs.readFile(paths.componentsFile, {
encoding: 'utf-8'
}, function (err, data) {
@@ -59,6 +60,7 @@ gulp.task('show-language-plugin', function (cb) {
data = JSON.parse(data);
var languagesMap = {};
+ var dependenciesMap = {};
for (var p in data.languages) {
if (p !== 'meta') {
var title = data.languages[p].displayTitle || data.languages[p].title;
@@ -66,18 +68,41 @@ gulp.task('show-language-plugin', function (cb) {
if (title !== ucfirst) {
languagesMap[p] = title;
}
+
+ if(data.languages[p].require) {
+ dependenciesMap[p] = data.languages[p].require;
+ }
}
}
- var jsonLanguages = JSON.stringify(languagesMap);
- var stream = gulp.src(paths.showLanguagePlugin)
- .pipe(replace(
- /\/\*languages_placeholder\[\*\/[\s\S]*?\/\*\]\*\//,
- '/*languages_placeholder[*/' + jsonLanguages + '/*]*/'
- ))
- .pipe(gulp.dest(paths.showLanguagePlugin.substring(0, paths.showLanguagePlugin.lastIndexOf('/'))));
- stream.on('error', cb);
- stream.on('end', cb);
+ var jsonLanguagesMap = JSON.stringify(languagesMap);
+ var jsonDependenciesMap = JSON.stringify(dependenciesMap);
+
+ var tasks = [
+ {plugin: paths.showLanguagePlugin, map: jsonLanguagesMap},
+ {plugin: paths.autoloaderPlugin, map: jsonDependenciesMap}
+ ];
+
+ var cpt = 0;
+ var l = tasks.length;
+ var done = function() {
+ cpt++;
+ if(cpt === l) {
+ cb && cb();
+ }
+ };
+
+ tasks.forEach(function(task) {
+ var stream = gulp.src(task.plugin)
+ .pipe(replace(
+ /\/\*languages_placeholder\[\*\/[\s\S]*?\/\*\]\*\//,
+ '/*languages_placeholder[*/' + task.map + '/*]*/'
+ ))
+ .pipe(gulp.dest(task.plugin.substring(0, task.plugin.lastIndexOf('/'))));
+
+ stream.on('error', done);
+ stream.on('end', done);
+ });
} catch (e) {
cb(e);
diff --git a/plugins/autoloader/index.html b/plugins/autoloader/index.html
new file mode 100644
index 0000000..11fb8ec
--- /dev/null
+++ b/plugins/autoloader/index.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+
+<meta charset="utf-8" />
+<link rel="shortcut icon" href="favicon.png" />
+<title>Autoloader ▲ Prism plugins</title>
+<base href="../.." />
+<link rel="stylesheet" href="style.css" />
+<link rel="stylesheet" href="themes/prism.css" data-noprefix />
+<script src="prefixfree.min.js"></script>
+
+<script>var _gaq = [['_setAccount', 'UA-33746269-1'], ['_trackPageview']];</script>
+<script src="http://www.google-analytics.com/ga.js" async></script>
+</head>
+<body>
+
+<header>
+ <div class="intro" data-src="templates/header-plugins.html" data-type="text/html"></div>
+
+ <h2>Autoloader</h2>
+ <p>Automatically loads the needed languages to highlight the code blocks.</p>
+</header>
+
+<section class="language-javascript">
+ <h1>How to use</h1>
+
+ <p>
+ The default usage does not require anything to be done. The plugin will automatically handle missing grammars and load them for you.
+ However, a couple of options are available through the configuration object <code>Prism.plugins.autoloader</code>.
+ </p>
+
+ <h2>Specifying the grammars path</h2>
+
+ <p>
+ By default, the plugin will look for the missing grammars in the <code>components</code> folder.
+ If your files are in a different location, you can specify it using the <code>languages_path</code> option:
+ </p>
+
+ <pre><code>Prism.plugins.autoloader.languages_path = 'path/to/grammars/';</code></pre>
+
+ <h2>Using development versions</h2>
+
+ <p>
+ By default, the plugin uses the minified versions of the grammars.
+ If you wish to use the development versions instead, you can set the <code>use_minified</code> option to false:
+ </p>
+
+ <pre><code>Prism.plugins.autoloader.use_minified = false;</code></pre>
+
+ <h2>Specifying additional dependencies</h2>
+
+ <p>
+ All default dependencies are already included in the plugin.
+ However, there are some cases where you might want to load an additional dependency for a specific code block.
+ To do so, just add a <code>data-dependencies</code> attribute on you <code><code></code> or <code><pre></code> tags,
+ containing a list of comma-separated language aliases.
+ </p>
+
+ <pre><code class="language-markup"><pre><code class="language-jade" data-dependencies="less">
+:less
+ foo {
+ color: @red;
+ }
+</code><pre></code></pre>
+
+ <h2>Force to reload a grammar</h2>
+
+ <p>
+ The plugin usually don't reload a grammar if it already exists.
+ In some very specific cases, you might however want to do so.
+ If you add an exclamation mark after an alias in the <code>data-dependencies</code> attribute,
+ this language will be reloaded.
+ </p>
+
+ <pre><code class="language-markup"><pre class="language-markup" data-dependencies="markup,css!"><code></code></pre>
+
+</section>
+
+<section>
+ <h1>Examples</h1>
+
+ <p>Note that no languages are loaded on this page by default.</p>
+
+ <p>Basic usage with some Perl code:</p>
+ <pre><code class="language-perl">my ($class, $filename) = @_;</code></pre>
+
+ <p>The Less filter used in Jade:</p>
+ <pre><code class="language-jade" data-dependencies="less">:less
+ foo {
+ color: @red;
+ }</code></pre>
+
+</section>
+
+<footer data-src="templates/footer.html" data-type="text/html"></footer>
+
+<script src="components/prism-core.js"></script>
+<script src="plugins/autoloader/prism-autoloader.js"></script>
+<script src="utopia.js"></script>
+<script src="components.js"></script>
+<script src="code.js"></script>
+
+
+</body>
+</html>
\ No newline at end of file
diff --git a/plugins/autoloader/prism-autoloader.js b/plugins/autoloader/prism-autoloader.js
new file mode 100644
index 0000000..9065c11
--- /dev/null
+++ b/plugins/autoloader/prism-autoloader.js
@@ -0,0 +1,194 @@
+(function () {
+ if (typeof self === 'undefined' || !self.Prism || !self.document || !document.createElement) {
+ return;
+ }
+
+ // The dependencies map is built automatically with gulp
+ var lang_dependencies = /*languages_placeholder[*/{"javascript":"clike","actionscript":"javascript","aspnet":"markup","bash":"clike","c":"clike","csharp":"clike","cpp":"c","coffeescript":"javascript","css-extras":"css","d":"clike","dart":"clike","fsharp":"clike","glsl":"clike","go":"clike","groovy":"clike","haml":"ruby","handlebars":"markup","jade":"javascript","java":"clike","less":"css","markdown":"markup","objectivec":"c","php":"clike","php-extras":"php","processing":"clike","qore":["clike"],"jsx":["markup","javascript"],"ruby":"clike","sass":"css","scss":"css","scala":"java","smarty":"markup","swift":"clike","textile":"markup","twig":"markup","typescript":"javascript","wiki":"markup"}/*]*/;
+
+ var lang_data = {};
+
+ var config = Prism.plugins.autoloader = {
+ languages_path: 'components/',
+ use_minified: true
+ };
+
+ /**
+ * Lazy loads an external script
+ * @param {string} src
+ * @param {function=} success
+ * @param {function=} error
+ */
+ var script = function(src, success, error) {
+ var s = document.createElement('script');
+ s.src = src;
+ s.async = true;
+ s.onload = function() {
+ document.body.removeChild(s);
+ success && success();
+ };
+ s.onerror = function() {
+ document.body.removeChild(s);
+ error && error();
+ };
+ document.body.appendChild(s);
+ };
+
+ /**
+ *
+ * @param {string} lang
+ * @returns {string}
+ */
+ var getLanguagePath = function(lang) {
+ return config.languages_path +
+ 'prism-' + lang
+ + (config.use_minified ? '.min' : '') + '.js'
+ };
+
+ /**
+ * Tries to load a grammar and
+ * highlight again the given element once loaded.
+ * @param {string} lang
+ * @param {HTMLElement} elt
+ */
+ var registerElement = function(lang, elt) {
+ var data = lang_data[lang];
+ if(!data) {
+ data = lang_data[lang] = {};
+ }
+
+ // Look for additional dependencies defined on the <code> or <pre> tags
+ var deps = elt.getAttribute('data-dependencies');
+ if(!deps && elt.parentNode && elt.parentNode.tagName.toLowerCase() === 'pre') {
+ deps = elt.parentNode.getAttribute('data-dependencies');
+ }
+
+ if(deps) {
+ deps = deps.split(/\s*,\s*/g);
+ } else {
+ deps = [];
+ }
+
+ loadLanguages(deps, function() {
+ loadLanguage(lang, function() {
+ Prism.highlightElement(elt);
+ });
+ });
+ };
+
+ /**
+ * Sequentially loads an array of grammars.
+ * @param {string[]|string} langs
+ * @param {function=} success
+ * @param {function=} error
+ */
+ var loadLanguages = function(langs, success, error) {
+ if(typeof langs === 'string') {
+ langs = [langs];
+ }
+ var i = 0;
+ var l = langs.length;
+ var f = function() {
+ if(i<l) {
+ loadLanguage(langs[i], function() {
+ i++;
+ f();
+ }, function() {
+ error && error(langs[i]);
+ });
+ } else if(i === l) {
+ success && success(langs);
+ }
+ };
+ f();
+ };
+
+ /**
+ * Load a grammar with its dependencies
+ * @param {string} lang
+ * @param {function=} success
+ * @param {function=} error
+ */
+ var loadLanguage = function(lang, success, error) {
+ var load = function() {
+ var force = false;
+ // Do we want to force reload the grammar?
+ if(lang.indexOf('!') > 0) {
+ force = true;
+ lang = lang.replace('!', '');
+ }
+
+ var data = lang_data[lang];
+ if(!data) {
+ data = lang_data[lang] = {};
+ }
+ if(success) {
+ if (!data.success_callbacks) {
+ data.success_callbacks = [];
+ }
+ data.success_callbacks.push(success);
+ }
+ if(error) {
+ if (!data.error_callbacks) {
+ data.error_callbacks = [];
+ }
+ data.error_callbacks.push(error);
+ }
+
+ if(!force && Prism.languages[lang]) {
+ languageSuccess(lang);
+ } else if(!force && data.error) {
+ languageError(lang);
+ } else if(force || !data.loading) {
+ data.loading = true;
+ var src = getLanguagePath(lang);
+ script(src, function () {
+ data.loading = false;
+ languageSuccess(lang);
+
+ }, function () {
+ data.loading = false;
+ data.error = true;
+ languageError(lang);
+ });
+ }
+ };
+ var dependencies = lang_dependencies[lang];
+ if(dependencies && dependencies.length) {
+ loadLanguages(dependencies, load);
+ } else {
+ load();
+ }
+ };
+
+ /**
+ * Runs all success callbacks for this language.
+ * @param {string} lang
+ */
+ var languageSuccess = function(lang) {
+ if(lang_data[lang] && lang_data[lang].success_callbacks && lang_data[lang].success_callbacks.length) {
+ lang_data[lang].success_callbacks.forEach(function(f) {
+ f(lang);
+ });
+ }
+ };
+
+ /**
+ * Runs all error callbacks for this language.
+ * @param {string} lang
+ */
+ var languageError = function(lang) {
+ if(lang_data[lang] && lang_data[lang].error_callbacks && lang_data[lang].error_callbacks.length) {
+ lang_data[lang].error_callbacks.forEach(function(f) {
+ f(lang);
+ });
+ }
+ };
+
+ Prism.hooks.add('complete', function(env) {
+ if(env.element && env.language && !env.grammar) {
+ registerElement(env.language, env.element);
+ }
+ });
+
+}());
\ No newline at end of file
diff --git a/plugins/autoloader/prism-autoloader.min.js b/plugins/autoloader/prism-autoloader.min.js
new file mode 100644
index 0000000..356dbbb
--- /dev/null
+++ b/plugins/autoloader/prism-autoloader.min.js
@@ -0,0 +1 @@
+!function(){if("undefined"!=typeof self&&self.Prism&&self.document&&document.createElement){var e={javascript:"clike",actionscript:"javascript",aspnet:"markup",bash:"clike",c:"clike",csharp:"clike",cpp:"c",coffeescript:"javascript","css-extras":"css",d:"clike",dart:"clike",fsharp:"clike",glsl:"clike",go:"clike",groovy:"clike",haml:"ruby",handlebars:"markup",jade:"javascript",java:"clike",less:"css",markdown:"markup",objectivec:"c",php:"clike","php-extras":"php",processing:"clike",qore:["clike"],jsx:["markup","javascript"],ruby:"clike",sass:"css",scss:"css",scala:"java",smarty:"markup",swift:"clike",textile:"markup",twig:"markup",typescript:"javascript",wiki:"markup"},c={},a=Prism.plugins.autoloader={languages_path:"components/",use_minified:!0},s=function(e,c,a){var s=document.createElement("script");s.src=e,s.async=!0,s.onload=function(){document.body.removeChild(s),c&&c()},s.onerror=function(){document.body.removeChild(s),a&&a()},document.body.appendChild(s)},r=function(e){return a.languages_path+"prism-"+e+(a.use_minified?".min":"")+".js"},n=function(e,a){var s=c[e];s||(s=c[e]={});var r=a.getAttribute("data-dependencies");!r&&a.parentNode&&"pre"===a.parentNode.tagName.toLowerCase()&&(r=a.parentNode.getAttribute("data-dependencies")),r=r?r.split(/\s*,\s*/g):[],i(r,function(){t(e,function(){Prism.highlightElement(a)})})},i=function(e,c,a){"string"==typeof e&&(e=[e]);var s=0,r=e.length,n=function(){r>s?t(e[s],function(){s++,n()},function(){a&&a(e[s])}):s===r&&c&&c(e)};n()},t=function(a,n,t){var u=function(){var e=!1;a.indexOf("!")>0&&(e=!0,a=a.replace("!",""));var i=c[a];if(i||(i=c[a]={}),n&&(i.success_callbacks||(i.success_callbacks=[]),i.success_callbacks.push(n)),t&&(i.error_callbacks||(i.error_callbacks=[]),i.error_callbacks.push(t)),!e&&Prism.languages[a])l(a);else if(!e&&i.error)o(a);else if(e||!i.loading){i.loading=!0;var u=r(a);s(u,function(){i.loading=!1,l(a)},function(){i.loading=!1,i.error=!0,o(a)})}},p=e[a];p&&p.length?i(p,u):u()},l=function(e){c[e]&&c[e].success_callbacks&&c[e].success_callbacks.length&&c[e].success_callbacks.forEach(function(c){c(e)})},o=function(e){c[e]&&c[e].error_callbacks&&c[e].error_callbacks.length&&c[e].error_callbacks.forEach(function(c){c(e)})};Prism.hooks.add("complete",function(e){e.element&&e.language&&!e.grammar&&n(e.language,e.element)})}}();
\ No newline at end of file