76 Commits

Author SHA1 Message Date
Arnavion 0c0f250473 Link to archived-repos-issues repo. 2022-02-06 01:36:44 -08:00
Arnavion 7287f286d7 RIP o7 part 2
Remove IRC channel, contribution request and Travis CI badge,
and minor http->https cleanup.
2020-03-26 00:04:58 -07:00
Arnavion ee97d1d0f3 RIP o7 2019-01-08 01:11:42 -08:00
DoomTay 6b405e65c1 Don't generate overlapping keyframes if \fad has 0ms start or 0ms end
Fixes #111
Closes #112
2018-07-23 02:23:48 -07:00
Nick Fujita 436fa10544 Added support for \n
Fixes #103
Closes #104
2017-10-16 18:43:47 -07:00
Arnavion 8098b70c70 Added tslint file and suppressions. 2017-04-12 01:22:40 -07:00
Arnavion d1593e7f1f Updated IE bug URLs. 2017-04-11 19:56:29 -07:00
Arnavion 8259a5a3d1 Fixed issues detected by tslint. 2017-04-11 19:30:43 -07:00
Arnavion e0c630038b Updated node versions in .travis.yml 2017-04-08 23:24:38 -07:00
Arnavion a39140db8e Updated npm to v4.x 2017-04-08 23:24:38 -07:00
Arnavion 9bfac13171 Updated TypeScript to v2.0.10 2017-04-08 23:24:06 -07:00
Arnavion 21cf48a44c Fixed return type annotation on calculateFontMetrics 2016-09-22 09:52:26 -07:00
Arnavion 41d8516449 Fixed uglify script to not remove the wrong nodes when shuffling around the TS built-ins. 2016-09-10 12:48:38 -07:00
Arnavion 8b7ef6201e Updated pngjs to v2.3.1 2016-05-28 15:27:54 -07:00
Arnavion 5fb5a4d73d Added note to readme that margins and line height aren't identical to desktop renderers. 2016-05-18 00:04:41 -07:00
Arnavion 86971d1902 Minor functional test updates due to latest IE 11. 2016-05-18 00:00:32 -07:00
Arnavion 9071332e1e Updated intern to v3.x >= v3.2.0 2016-05-17 23:12:05 -07:00
Arnavion ae62c0c89f Log errors from pre-render and draw, and continue rendering other dialogues in the same tick even if one errors.
Only enabled in debugMode to avoid flooding console with one new message every tick while the bad dialogue is visible.

Fixes #76
2016-05-04 00:09:43 -07:00
Arnavion 027a8d69f5 SVG 1.2 implementations have null viewBox properties if "viewBox" attribute is not explicitly set on the DOM element.
Fixes #77
2016-04-29 12:30:36 -07:00
Arnavion 4c4ef34e8b Fixed rotation for the special case of only one rotation on the whole dialogue, by applying the rotation transform on the sub div instead of the individual spans.
The implementation is still broken for the general case of multiple rotations (see #14), but one rotation is the much more common case.

Fixes #75
2016-04-29 00:34:54 -07:00
Arnavion 4d519fd6c9 Made functional test screenshots bigger. 2016-04-27 22:40:57 -07:00
Arnavion 4ffa5499a4 Removed firefox tests.
Will regenerate them when firefox works with functional tests again.
2016-04-27 22:38:27 -07:00
Arnavion 6e7e7a005e Aggregate all the failures of a functional test instead of failing at the first mismatching screenshot. 2016-04-27 20:46:13 -07:00
Arnavion 20a0d8ee64 Also test on node v6 2016-04-27 20:45:05 -07:00
Arnavion 56fbd7a9b2 Updated TypeScript to v1.8.10 2016-04-27 13:06:09 -07:00
Arnavion 293617aa22 Updated async-build to v0.3.0 2016-04-27 13:05:46 -07:00
Arnavion 7ae40e7164 Seek to external time when auto-pausing.
Otherwise the current time remains larger than the external time by the auto-pause-after interval, and thus keeps triggering clock ticks despite being paused.
2016-04-08 02:09:05 -07:00
Arnavion 361bc707d3 Restrict intern to v3.0.x
v3.1.x updated istanbul dependency to v0.4.1 which has bug https://github.com/gotwarlost/istanbul/issues/591
2016-04-06 14:58:03 -07:00
Arnavion 04dc60f128 Fixed some issues found by tslint. 2016-04-06 03:16:40 -07:00
Arnavion 70537168a0 Removed unused code. 2016-03-26 22:57:16 -07:00
Arnavion 6e33697c5c Added a comment about the getters for the dynamic properties on the export object. 2016-03-26 18:47:00 -07:00
Arnavion 8680e884a1 Fixed behavior of tags with default values inside \t
The progression is ignored and the default value of the tag is applied as if it was before the \t
2016-03-22 04:31:32 -07:00
Arnavion ec693190b5 Fixed interpretation of \fs+ and \fs-
\fs+1 is a 10% increase, not a 1px increase.

Ref https://github.com/libass/libass/commit/9f2ffc03574ae323867fba00f8aaacc637bb0aa1
2016-03-22 04:29:17 -07:00
Arnavion 4dfdaf6010 Some tiny fixes found by TS's upcoming strictNullChecks feature. 2016-03-21 23:30:37 -07:00
Arnavion 9540b2c00a Updated TypeScript to v1.8.9 2016-03-21 03:16:34 -07:00
Arnavion 9445d04efa Insert new subs above existing subs in alignments 1-3
Fixes #49
2016-03-11 23:23:45 -08:00
Arnavion 7a7ee02905 Added top-level version property.
`libjass.version` is `["0.12.0", 0, 12, 0]`

Fixes #57
2016-03-11 12:15:21 -08:00
Arnavion a6605064c1 Exported variables are not setters, and the few that were (debugMode, etc.) now have an alternative (libjass.configure). 2016-03-11 12:14:50 -08:00
Arnavion 4438caae92 Made paths in .gitignore absolute. 2016-03-11 12:13:51 -08:00
Arnavion 212f376b77 Changed <>-style type assertions to as.
Easier to grep for and remove as newer versions of TS make them unnecessary.
2016-03-10 13:06:57 -08:00
Arnavion 35310a5980 Changed libjass.parts.Bold.value to boolean | number type. 2016-03-10 00:44:34 -08:00
Arnavion 4ccb76f53c Set line-height correctly for scaled text. 2016-03-09 22:28:03 -08:00
Arnavion 1ac4fb24aa Handle negative positions in SVG drawings. 2016-03-09 22:06:10 -08:00
Arnavion 1aef4ef1c9 Fixed shadows to include outlines.
Reported in #70
2016-03-09 12:40:16 -08:00
Arnavion c421cb10b6 Check whether to skip pre-rendering a sub before looking up any existing pre-rendered sub. 2016-03-09 12:39:55 -08:00
Arnavion 739ae86ffe Removed document.createElementNS overloads since they're in lib.d.ts now. 2016-03-07 23:51:55 -08:00
Arnavion 3dc4a78812 Render fractional outlines.
The SVG renderer uses feMorphology, but atleast on some browsers the filter's radius property doesn't support fractional radii. The renderer now adds four corner outlines using feOffset; feOffset doesn't appear to support fractional offsets either on the same browsers, but it does get rounded up or down automatically to give a close approximation.

The text shadow renderer now adds four corner shadows at the fractional distances.

Reported in #70
2016-03-07 23:11:39 -08:00
Arnavion 97c0691994 Updated TypeScript to v1.8.7 2016-03-04 01:41:10 -08:00
Arnavion 79c9b73e0d Stop passing in enableSvg explicitly to functional tests. 2016-03-02 11:44:07 -08:00
Arnavion 1e20e498c4 Removed unnecessary parameter. 2016-03-02 11:03:34 -08:00
Arnavion 5e6f3c8ba4 Some small optimizations for SVG filter effects. 2016-03-02 10:57:07 -08:00
Arnavion c15bd7391d Do some basic tests for SVG filter effects support if RendererSettings object does not specify a value for enableSvg, and default to that.
Technically this checks for whether the browser interprets the readonly WebIDL property correctly, which is arguably completely unrelated. However FF and Chrome support both, IE supports neither, and there's no other non-manual check for this feature, so it seems to be a reasonable way.
2016-03-01 23:50:18 -08:00
Arnavion 66f8ffc4c2 Added proper typed overload of Node.cloneNode() 2016-03-01 23:49:23 -08:00
Arnavion 93c2428626 Deprecated pathSegList API has been removed from some browsers. Switch back to setting d attribute. 2016-03-01 23:48:52 -08:00
Arnavion c04d0b6631 Minor typo. 2016-02-24 00:17:15 -08:00
Arnavion 05fc742588 Stronger type for stringly-typed parameters. 2016-02-22 23:20:35 -08:00
Arnavion d590984eb6 Updated TypeScript to v1.8.0 2016-02-22 23:20:33 -08:00
Arnavion a67ec2948f Exposed serialization API as libjass.serialize and libjass.deserialize. 2016-02-19 21:18:33 -08:00
Arnavion c432f33149 Implemented support for serializing ASS objects. 2016-02-19 21:18:03 -08:00
Arnavion 1bc6e63d18 Moved serialize, deserialize and registerClassPrototype to their own module with minor tweaks. 2016-02-19 21:16:19 -08:00
Arnavion d5831e65a1 Added note that RendererSettings.makeFontMapFromStyleElement doesn't support complicated @font-face declarations. 2016-02-18 03:02:04 -08:00
Arnavion 15d13e2fa2 Minor formatting. 2016-02-18 00:51:57 -08:00
Arnavion 5e100e88fb Name SVG filter IDs starting with "libjass-" 2016-02-18 00:50:15 -08:00
Arnavion 18b5d88f07 Switch to single-file AMD output similar to TS 1.8's concatenated output. 2016-02-14 02:53:03 -08:00
Arnavion 201fc044ee Use inlineSources compiler option instead of re-reading the files explicitly. 2016-02-13 22:59:28 -08:00
Arnavion bb28a85d97 Added @license to license header so minification tools preserve it. 2016-02-13 20:29:47 -08:00
Arnavion 414e48c022 Moved UMD wrapper to its own file. 2016-02-13 20:28:56 -08:00
Arnavion 7a5957cb27 Fixed JSDoc on libjass.configure() 2016-02-13 20:27:23 -08:00
Arnavion 2ae4ba0a09 Convert UJS parser errors to real Errors so that the async-build pipeline detects them. 2016-02-13 19:26:15 -08:00
Arnavion 40ac799134 tsconfig JSON schema specifies lower-case values. 2016-02-13 18:30:06 -08:00
Arnavion 990ca04065 Added libjass.configure() and deprecated libjass.{debugMode, verboseMode, Set, Map, Promise} setters. 2016-02-13 17:39:04 -08:00
Arnavion efa2fa7ade Support "ass" and "srt" strings as the type parameter of the ASS.from* functions in addition to the libjass.Format constants. 2016-02-06 01:19:38 -08:00
Arnavion 1de86c435a Change "fetch() failed" warning to a debug-mode log message, since it's not really a bad thing. 2016-02-06 01:19:36 -08:00
Arnavion df3ddb214e Whitespace. 2016-01-29 15:04:12 -08:00
Arnavion fa3467c649 Exported some interfaces that should've been because another exported interface references them. 2016-01-29 15:04:10 -08:00
Arnavion bba93dad9f Don't replace unicode escapes with the actual UTF-8 character.
Caters for servers that don't set a charset for libjass.js in the Content-Type header or HTML tag, and clients that end up interpreting libjass.js as system encoding and showing mojibake.

Fixes #65
2016-01-26 23:54:54 -08:00
157 changed files with 3283 additions and 2597 deletions
+10 -8
View File
@@ -1,12 +1,14 @@
build/doc.js
build/typescript/typescript.d.ts
build/typescript/*.js
/build/doc.js
/build/typescript/typescript.d.ts
/build/typescript/*.js
dist/
/dist/
lib/
!lib/libjass.css
/lib/
!/lib/libjass.css
node_modules/
/node_modules/
npm-debug.log
/npm-debug.log
/src/version.ts
+2 -4
View File
@@ -1,9 +1,7 @@
language: node_js
node_js:
- "0.10"
- "0.12"
- "4"
- "5"
- "6"
- "7"
before_script:
- "node ./build.js doc"
sudo: false
+35 -24
View File
@@ -1,6 +1,24 @@
[![Build Status](https://travis-ci.org/Arnavion/libjass.png?branch=master)](https://travis-ci.org/Arnavion/libjass)
This project is no longer being worked on.
libjass is a JavaScript library written in TypeScript to render ASS subs in the browser. [Check out the demo.](http://arnavion.github.io/libjass/demo/index.xhtml)
You should probably use something else, like https://github.com/Dador/JavascriptSubtitlesOctopus
When I started libjass in 2011, I made a bet that offloading rendering to the DOM would eventually be the way to get fast and accurate rendering. CSS filter effects were about to be standardized. Regular JavaScript would've been too slow to do the fancy rendering that ASS requires. Surely letting the browser render text would be faster than parsing fonts in JS, computing the dimensions and margins for every rendered character, and blitting individual outline and shadow pixels to a canvas.
However CSS filter effects by themselves turned out to be inadequate to accurately render even the basics of ASS. SVG filters are more accurate, but are unoptimized or unsupported in all browsers since nobody really uses them (a vicious cycle). As such, both of them are unable to efficiently render the simplest and most common ASS feature - the elliptical border. The `feMorphology` SVG filter can only dilate to rectangles, so libjass has to stack many such rectangles of different sizes to approximate an ellipse. Big borders end up needing tens of such rectangles and a large gaussian blur, which brings even the mightiest browser's renderer to its single-threaded knees.
Layout also has problems. CSS doesn't provide an easy to way for a subtitle to push another subtitle away so that they don't overlap. It doesn't provide a line-breaking strategy that tries to equalize the lengths of the broken lines (what ASS calls smart line wrapping). Vertically centering things is still a nightmare - flexbox and CSS grid don't help because subtitles don't follow grids - so `\an4-6` were never properly implemented. These things *could* be solved by positioning the text manually, but this would've brought us back to the problem of parsing fonts and measuring text dimensions in JavaScript instead of letting the DOM handle it.
In 2013, asm.js became a way to use the original C renderers like libass, compiled to something that's not as fast as native C but still faster than regular JavaScript rendering. More recently, WASM has emerged as a more cross-platform and strongly-guaranteed way of doing this. Parsing fonts and computing dimensions is now a feasible prospect.
Because of this, I believe libjass's strategy of relying on the browser DOM is a dead end.
I'm happy to continue providing support and answering questions about the code on Github. Since this repository is archived, please ask by opening an issue at https://github.com/Arnavion/archived-repos-issues instead. The code in this repository is still available under APL-2.0. The ASS parser is functional regardless of the browser renderer. Feel free to fork this project, or incorporate its code into your own projects, under the terms of the license.
Thank you, the users who used libjass on your websites, opened issues, and contributed fixes. libjass was my first OSS project that I intended to be used by more people than me. I had fun working on it and learning about web dev.
----
libjass is a JavaScript library written in TypeScript to render ASS subs in the browser. [Check out the demo.](https://arnavion.github.io/libjass/demo/index.xhtml)
### What's special about libjass?
@@ -42,37 +60,37 @@ Only libjass.js and libjass.css are needed to use libjass on your website. The o
The API documentation is linked in the Links section below. Here's an overview:
* The [ASS.fromUrl()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromUrl) function takes in a URL to an ASS script and returns a promise that resolves to an [ASS](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS) object. This ASS object represents the script properties, the line styles and dialogue lines in it. Alternatively, you can use [ASS.fromString()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString) to convert a string of the script contents into an ASS object.
* The [ASS.fromUrl()](https://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromUrl) function takes in a URL to an ASS script and returns a promise that resolves to an [ASS](https://arnavion.github.io/libjass/api.xhtml#libjass.ASS) object. This ASS object represents the script properties, the line styles and dialogue lines in it. Alternatively, you can use [ASS.fromString()](https://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString) to convert a string of the script contents into an ASS object.
* Next, you initialize a renderer to render the subtitles. libjass ships with an easy-to-use renderer, the [DefaultRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer). It uses information from the ASS object to build up a series of div elements around the video tag. There is a wrapper (.libjass-subs) containing div's corresponding to the layers in the ASS script, and each layer has div's corresponding to the 9 alignment directions. libjass.css contains styles for these div's to render them at the correct location.
* Next, you initialize a renderer to render the subtitles. libjass ships with an easy-to-use renderer, the [DefaultRenderer](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer). It uses information from the ASS object to build up a series of div elements around the video tag. There is a wrapper (.libjass-subs) containing div's corresponding to the layers in the ASS script, and each layer has div's corresponding to the 9 alignment directions. libjass.css contains styles for these div's to render them at the correct location.
* The renderer uses [window.requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/window.requestAnimationFrame) as a source of timer ticks. In each tick, it determines the set of dialogues to be shown at the current video time, renders each of them as a div, and appendChild's the div into the appropriate layer+alignment div.
* The renderer can be told to dynamically change the size of the subtitles based on user input by calling [WebRenderer.resize()](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer.resize)
* The renderer can be told to dynamically change the size of the subtitles based on user input by calling [WebRenderer.resize()](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer.resize)
* Lastly, the renderer contains an implementation of preloading fonts before playing the video. It uses a map of font names to URLs - this map can be conveniently created from a CSS file containing @font-face rules using [RendererSettings.makeFontMapFromStyleElement()](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.makeFontMapFromStyleElement)
* Lastly, the renderer contains an implementation of preloading fonts before playing the video. It uses a map of font names to URLs - this map can be conveniently created from a CSS file containing @font-face rules using [RendererSettings.makeFontMapFromStyleElement()](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.makeFontMapFromStyleElement)
* For an example of using libjass, check out [the demo.](http://arnavion.github.io/libjass/demo/index.xhtml) It has comments explaining basic usage and pointers to some advanced usage.
* For an example of using libjass, check out [the demo.](https://arnavion.github.io/libjass/demo/index.xhtml) It has comments explaining basic usage and pointers to some advanced usage.
### What browser and JavaScript features does libjass need?
* libjass uses some ES5 features like getters and setters (via Object.defineProperty), and assumptions like the behavior of parseInt with leading zeros. It cannot be used with an ES3 environment.
* libjass will use ES6 Set, Map and Promise if they're available on the global object. If they're not present, it will use its own minimal internal implementations. If you have implementations of these that you would like libjass to use but don't want to register them on the global object, you can provide them to libjass specifically by setting the [libjass.Set](http://arnavion.github.io/libjass/api.xhtml#libjass.Set), [libjass.Map](http://arnavion.github.io/libjass/api.xhtml#libjass.Map) and [libjass.Promise](http://arnavion.github.io/libjass/api.xhtml#libjass.Promise) properties.
* libjass will use ES6 Set, Map and Promise if they're available on the global object. If they're not present, it will use its own minimal internal implementations. If you have implementations of these that you would like libjass to use but don't want to register them on the global object, you can provide them to libjass specifically by setting the [libjass.Set](https://arnavion.github.io/libjass/api.xhtml#libjass.Set), [libjass.Map](https://arnavion.github.io/libjass/api.xhtml#libjass.Map) and [libjass.Promise](https://arnavion.github.io/libjass/api.xhtml#libjass.Promise) properties.
* [AutoClock](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.AutoClock) and [VideoClock](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.VideoClock) use [window.requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) to generate clock ticks.
* [AutoClock](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.AutoClock) and [VideoClock](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.VideoClock) use [window.requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame) to generate clock ticks.
* [WebRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer) and [DefaultRenderer](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer) use [SVG filter effects for HTML](http://caniuse.com/#feat=svg-html) to render outlines and blur. This feature is not available on all browsers, so you can tell them to fall back to more widely available CSS methods by setting the [RendererSettings.enableSvg](http://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.enableSvg) property to false.
* [WebRenderer](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.WebRenderer) and [DefaultRenderer](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.DefaultRenderer) use [SVG filter effects for HTML](https://caniuse.com/#feat=svg-html) to render outlines and blur. This feature is not available on all browsers, so you can tell them to fall back to more widely available CSS methods by setting the [RendererSettings.enableSvg](https://arnavion.github.io/libjass/api.xhtml#libjass.renderers.RendererSettings.enableSvg) property to false.
* WebRenderer and DefaultRenderer use [CSS3 animations](http://caniuse.com/#feat=css-animation) for effects like \mov and \fad.
* WebRenderer and DefaultRenderer use [CSS3 animations](https://caniuse.com/#feat=css-animation) for effects like \mov and \fad.
* Using fonts attached to the script requires [ES6 typed arrays](http://caniuse.com/#feat=typedarrays) (ArrayBuffer, DataView, Uint8Array, etc).
* Using fonts attached to the script requires [ES6 typed arrays](https://caniuse.com/#feat=typedarrays) (ArrayBuffer, DataView, Uint8Array, etc).
### Can I use libjass in node?
libjass's parser works in node. Entire scripts can be parsed via [ASS.fromString()](http://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString)
libjass's parser works in node. Entire scripts can be parsed via [ASS.fromString()](https://arnavion.github.io/libjass/api.xhtml#libjass.ASS.fromString)
```javascript
> var libjass = require("libjass")
@@ -95,7 +113,7 @@ true
'Fade { start: 0.2, end: 0 }'
```
[libjass.parser.parse](http://arnavion.github.io/libjass/api.xhtml#libjass.parser.parse) parses the first parameter using the second parameter as the rule name. For example, the [dialogueParts](http://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun.parse_dialogueParts) rule can be used to get an array of [libjass.parts](http://arnavion.github.io/libjass/api.xhtml#libjass.parts) objects that represent the parts of an ASS dialogue line.
[libjass.parser.parse](https://arnavion.github.io/libjass/api.xhtml#libjass.parser.parse) parses the first parameter using the second parameter as the rule name. For example, the [dialogueParts](https://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun.parse_dialogueParts) rule can be used to get an array of [libjass.parts](https://arnavion.github.io/libjass/api.xhtml#libjass.parts) objects that represent the parts of an ASS dialogue line.
```javascript
> var parts = libjass.parser.parse("{\\an8}Are {\\i1}you{\\i0} the one who stole the clock?!", "dialogueParts")
@@ -112,18 +130,11 @@ true
8
```
The rule names are derived from the methods on the [ParserRun class](http://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun).
The rule names are derived from the methods on the [ParserRun class](https://arnavion.github.io/libjass/api.xhtml#./parser/parse.ParserRun).
See the tests, particularly the ones in tests/unit/miscellaneous.js, for examples.
### Can I contribute?
Yes! Feature requests, suggestions, bug reports and pull requests are welcome! I'm especially looking for details and edge-cases of the ASS syntax that libjass doesn't support.
You can also join the IRC channel in the links section below and ask any questions.
### Supported features
* Styles: Italic, Bold, Underline, StrikeOut, FontName, FontSize, ScaleX, ScaleY, Spacing, PrimaryColor, OutlineColor, BackColor, Outline, Shadow, Alignment, MarginL, MarginR, MarginV
@@ -137,13 +148,13 @@ You can also join the IRC channel in the links section below and ask any questio
* \an4, \an5, \an6 aren't positioned correctly.
* Smart line wrapping is not supported. Such lines are rendered as [wrapping style 1 (end-of-line wrapping).](http://docs.aegisub.org/3.0/ASS_Tags/#wrapstyle)
* Lines with multiple rotations aren't rotated the same as VSFilter or libass. See [#14](https://github.com/Arnavion/libjass/issues/14)
- Desktop renderers include borders when calculating space between adjacent lines. libjass doesn't.
### Links
* [GitHub](https://github.com/Arnavion/libjass/)
* IRC channel - #libjass on irc.rizon.net
* [API documentation](http://arnavion.github.io/libjass/api.xhtml)
* [API documentation](https://arnavion.github.io/libjass/api.xhtml)
* [Aegisub's documentation on ASS](http://docs.aegisub.org/3.0/ASS_Tags/)
+44 -6
View File
@@ -67,7 +67,45 @@ task("build-tools", function (callback) {
task("default", ["libjass.js", "libjass.min.js"]);
task("libjass.js", ["build-tools"], function (callback) {
task("version.ts", function (callback) {
fs.exists("./src/version.ts", function (exists) {
if (exists) {
callback();
return;
}
async.waterfall([
fs.readFile.bind(fs, "./package.json"),
function (buffer, callback) {
try {
var packageJson = JSON.parse(buffer);
var versionString = packageJson.version;
var versionParts = versionString.split(".").map(function (num) { return parseInt(num); });
var versionFileContents =
"/* tslint:disable */\n" +
"\n" +
"/**\n" +
" * The version of libjass. An array like\n" +
" *\n" +
" * [\"0.12.0\", 0, 12, 0]\n" +
" *\n" +
" * @type {!Array.<string|number>}\n" +
" */\n" +
"export const version = " + JSON.stringify([versionString].concat(versionParts)) + ";\n";
callback(null, versionFileContents);
}
catch (ex) {
callback(ex);
}
},
function (contents, callback) {
fs.writeFile("./src/version.ts", contents, "utf8", callback);
}
], callback);
});
});
task("libjass.js", ["build-tools", "version.ts"], function (callback) {
fs.exists("./lib/libjass.js", function (exists) {
if (exists) {
callback();
@@ -76,7 +114,7 @@ task("libjass.js", ["build-tools"], function (callback) {
callback(null, task.src("./src/tsconfig.json")
.pipe(TypeScript.build("./src/index.ts", "libjass"))
.pipe(UglifyJS.build("./src/index", "libjass", ["AttachmentType", "BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(UglifyJS.build("libjass", ["AttachmentType", "BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(task.dest("./lib")));
});
});
@@ -94,9 +132,9 @@ task("libjass.min.js", ["libjass.js"], function (callback) {
});
});
task("clean", task.clean(["./lib/libjass.js", "./lib/libjass.js.map", "./lib/libjass.min.js", "./lib/libjass.min.js.map"]));
task("clean", task.clean(["./src/version.ts", "./lib/libjass.js", "./lib/libjass.js.map", "./lib/libjass.min.js", "./lib/libjass.min.js.map"]));
task("watch", ["build-tools"], function (callback) {
task("watch", ["build-tools", "version.ts"], function (callback) {
npm.load(function () {
var testRunning = false;
var rerunTest = false;
@@ -125,7 +163,7 @@ task("watch", ["build-tools"], function (callback) {
task.src("./src/tsconfig.json")
.pipe(TypeScript.watch("./src/index.ts", "libjass"))
.pipe(UglifyJS.watch("./src/index", "libjass", ["BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(UglifyJS.watch("libjass", ["BorderStyle", "ClockEvent", "Format", "WorkerCommands", "WrappingStyle"]))
.pipe(task.dest("./lib"))
.pipe(new task.FileTransform(function (file) {
if (file.path === "libjass.js") {
@@ -165,7 +203,7 @@ task("demo", ["libjass.js"], function () {
task("doc", ["make-doc", "test-doc"]);
task("make-doc", ["build-tools"], function () {
task("make-doc", ["build-tools", "version.ts"], function () {
var Doc = require("./build/doc.js");
return task.src("./src/tsconfig.json")
+60 -69
View File
@@ -18,18 +18,14 @@
* limitations under the License.
*/
import * as fs from "fs";
import * as path from "path";
import { Transform } from "stream";
import { File, FileTransform } from "async-build";
import { FileTransform } from "async-build";
import * as AST from "./typescript/ast";
import { Compiler } from "./typescript/compiler";
import { walk } from "./typescript/walker";
function flatten<T>(arr: T[][]): T[] {
var result: T[] = [];
let result: T[] = [];
for (const a of arr) {
result = result.concat(a);
@@ -38,7 +34,7 @@ function flatten<T>(arr: T[][]): T[] {
return result;
}
var sorter = (() => {
const sorter = (() => {
function visibilitySorter(value1: { isPrivate?: boolean; isProtected?: boolean; }, value2: { isPrivate?: boolean; isProtected?: boolean; }) {
if (value1.isPrivate === value2.isPrivate && value1.isProtected === value2.isProtected) {
return 0;
@@ -63,10 +59,10 @@ var sorter = (() => {
return 0;
}
var types = [AST.Property, AST.Function, AST.Interface, AST.Class, AST.Enum];
const types = [AST.Property, AST.Function, AST.Interface, AST.Class, AST.Enum];
function typeSorter(value1: AST.ModuleMember | AST.NamespaceMember, value2: AST.ModuleMember | AST.NamespaceMember) {
var type1Index = -1;
var type2Index = -1;
let type1Index = -1;
let type2Index = -1;
types.every((type, index) => {
if (value1 instanceof type) {
@@ -85,11 +81,11 @@ var sorter = (() => {
return value1.name.localeCompare(value2.name);
}
var sorters: ((value1: AST.ModuleMember, value2: AST.ModuleMember) => number)[] = [visibilitySorter, typeSorter, nameSorter];
const sorters: ((value1: AST.ModuleMember, value2: AST.ModuleMember) => number)[] = [visibilitySorter, typeSorter, nameSorter];
return (value1: AST.ModuleMember, value2: AST.ModuleMember) => {
for (var i = 0; i < sorters.length; i++) {
var result = sorters[i](value1, value2);
for (const sorter of sorters) {
const result = sorter(value1, value2);
if (result !== 0) {
return result;
@@ -111,10 +107,10 @@ function sanitize(str: string) {
function toVariableName(item: { name: string }) {
// TODO: Handle non-letters (are both their toLowerCase() and toUpperCase())
var name = item.name;
var result = "";
const name = item.name;
let result = "";
for (var i = 0; i < name.length; i++) {
for (let i = 0; i < name.length; i++) {
if (name[i] === name[i].toLowerCase()) {
// This is lower case. Write it as lower case.
result += name[i];
@@ -169,15 +165,15 @@ function toUsageName(item: AST.Class | AST.Interface | AST.Function | AST.Proper
}
if (item.parent instanceof AST.Namespace) {
if ((<AST.Class | AST.Interface | AST.Function | AST.Enum>item).isPrivate) {
if ((item as AST.CanBePrivate).isPrivate) {
return item.name;
}
return item.fullName;
}
if ((<AST.Function>item).isStatic) {
return toUsageName(<AST.Class | AST.Interface>item.parent) + '.' + item.name;
if ((item as AST.CanBeStatic).isStatic) {
return toUsageName(item.parent as AST.Class | AST.Interface) + '.' + item.name;
}
return toVariableName(item.parent) + '.' + item.name;
@@ -188,13 +184,12 @@ function toId(item: { fullName?: string; name: string; }): string {
}
function toLink(item: AST.ModuleMember | AST.EnumMember | AST.TypeReference): string {
var result = `<a href="#${ toId(item) }">${ sanitize(item.name) }`;
let result = `<a href="#${ toId(item) }">${ sanitize(item.name) }`;
var itemWithGenerics = <AST.HasGenerics>item;
if (itemWithGenerics.generics !== undefined && itemWithGenerics.generics.length > 0) {
var generics = <(string | AST.TypeReference | AST.IntrinsicTypeReference)[]>itemWithGenerics.generics;
if (AST.hasGenerics(item) && item.generics.length > 0) {
const generics = item.generics as (string | AST.TypeReference | AST.IntrinsicTypeReference)[];
result += sanitize(`.<${ generics.map(generic =>
(generic instanceof AST.TypeReference || generic instanceof AST.IntrinsicTypeReference) ? generic.name : <string>generic
(generic instanceof AST.TypeReference || generic instanceof AST.IntrinsicTypeReference) ? generic.name : generic
).join(', ') }>`);
}
@@ -204,9 +199,9 @@ function toLink(item: AST.ModuleMember | AST.EnumMember | AST.TypeReference): st
}
function writeDescription(text: string): string {
var result = sanitize(text).replace(/\{@link ([^} ]+)\}/g, (substring, linkTarget) => `<a href="#${ linkTarget }">${ linkTarget }</a>`);
let result = sanitize(text).replace(/\{@link ([^} ]+)\}/g, (substring, linkTarget) => `<a href="#${ linkTarget }">${ linkTarget }</a>`);
var inCodeBlock = false;
let inCodeBlock = false;
result = result.split("\n").map(line => {
if (line.substr(0, " ".length) === " ") {
line = line.substr(" ".length);
@@ -289,7 +284,7 @@ function functionToHtml(func: AST.Function): string[] {
}
function interfaceToHtml(interfase: AST.Interface): string[] {
var members: AST.InterfaceMember[] = [];
const members: AST.InterfaceMember[] = [];
Object.keys(interfase.members).forEach(memberName => members.push(interfase.members[memberName]));
members.sort(sorter);
@@ -311,7 +306,7 @@ function interfaceToHtml(interfase: AST.Interface): string[] {
return functionToHtml(member).map(indenter(2));
}
else {
throw new Error(`Unrecognized member type: ${ (<any>member.constructor).name }`);
throw new Error(`Unrecognized member type: ${ (member as any).constructor.name }`);
}
}))).concat([
' </dd>',
@@ -321,7 +316,7 @@ function interfaceToHtml(interfase: AST.Interface): string[] {
}
function classToHtml(clazz: AST.Class): string[] {
var members: AST.InterfaceMember[] = [];
const members: AST.InterfaceMember[] = [];
Object.keys(clazz.members).forEach(memberName => members.push(clazz.members[memberName]));
members.sort(sorter);
@@ -331,7 +326,7 @@ function classToHtml(clazz: AST.Class): string[] {
clazz.isAbstract ? ' abstract' : ''}${
clazz.isPrivate ? ' private' : ''}">`,
` <dt class="name">class ${ toLink(clazz) }${
(clazz.baseType !== null) ? ` extends ${ (clazz.baseType instanceof AST.TypeReference) ? toLink(<AST.TypeReference>clazz.baseType) : clazz.baseType.name }` : '' }${
(clazz.baseType !== null) ? ` extends ${ (clazz.baseType instanceof AST.TypeReference) ? toLink(clazz.baseType) : clazz.baseType.name }` : '' }${
(clazz.interfaces.length > 0) ? ` implements ${ clazz.interfaces.map(interfase => interfase instanceof AST.TypeReference ? toLink(interfase) : interfase.name).join(', ') }` : ''}</dt>`,
' <dd class="description">',
` ${ writeDescription(clazz.description) }`,
@@ -351,7 +346,7 @@ function classToHtml(clazz: AST.Class): string[] {
return functionToHtml(member).map(indenter(2));
}
else {
throw new Error(`Unrecognized member type: ${ (<any>member.constructor).name }`);
throw new Error(`Unrecognized member type: ${ (member as any).constructor.name }`);
}
}))).concat([
' </dd>',
@@ -407,30 +402,26 @@ function propertyToHtml(property: AST.Property): string[] {
}
export function build(outputFilePath: string, root: string, rootNamespaceName: string): FileTransform {
var compiler = new Compiler();
return new FileTransform(function (file: File): void {
var self: FileTransform = this;
const compiler = new Compiler();
return new FileTransform(function (file): void {
// Compile
compiler.compile(file);
// Walk
var walkResult = walk(compiler, root, rootNamespaceName);
var namespaces = walkResult.namespaces;
var modules = walkResult.modules;
const walkResult = walk(compiler, root, rootNamespaceName);
const namespaces = walkResult.namespaces;
const modules = walkResult.modules;
// Make HTML
var namespaceNames = Object.keys(namespaces)
const namespaceNames = Object.keys(namespaces)
.filter(namespaceName => namespaceName.substr(0, rootNamespaceName.length) === rootNamespaceName)
.sort((ns1, ns2) => ns1.localeCompare(ns2));
var moduleNames = Object.keys(modules).sort((ns1, ns2) => ns1.localeCompare(ns2));
const moduleNames = Object.keys(modules).sort((ns1, ns2) => ns1.localeCompare(ns2)).filter(moduleName => Object.keys(modules[moduleName].members).length > 0);
moduleNames = moduleNames.filter(moduleName => Object.keys(modules[moduleName].members).length > 0);
self.push({
this.push({
path: outputFilePath,
contents: Buffer.concat([new Buffer(
`<?xml version="1.0" encoding="utf-8" ?>
@@ -590,9 +581,9 @@ export function build(outputFilePath: string, root: string, rootNamespaceName: s
<label><input type="checkbox" id="show-private" />Show private</label>
`
)].concat(namespaceNames.map(namespaceName => {
var namespace = namespaces[namespaceName];
const namespace = namespaces[namespaceName];
var namespaceMembers: AST.NamespaceMember[] = [];
const namespaceMembers: AST.NamespaceMember[] = [];
for (const memberName of Object.keys(namespace.members)) {
namespaceMembers.push(namespace.members[memberName]);
}
@@ -614,13 +605,13 @@ export function build(outputFilePath: string, root: string, rootNamespaceName: s
`
)]));
})).concat(moduleNames.map(moduleName => {
var module = modules[moduleName];
const module = modules[moduleName];
var moduleMembers: AST.ModuleMemberWithoutReference[] = [];
const moduleMembers: AST.ModuleMemberWithoutReference[] = [];
for (const memberName of Object.keys(module.members)) {
var member = module.members[memberName];
if ((<AST.HasParent><any>member).parent === module) {
moduleMembers.push(<AST.ModuleMemberWithoutReference>member);
const member = module.members[memberName];
if ((member as AST.HasParent).parent === module) {
moduleMembers.push(member as AST.ModuleMemberWithoutReference);
}
}
@@ -650,22 +641,22 @@ export function build(outputFilePath: string, root: string, rootNamespaceName: s
<div class="content">
`
)]).concat(flatten(namespaceNames.map(namespaceName => {
var namespace = namespaces[namespaceName];
const namespace = namespaces[namespaceName];
var namespaceMembers: AST.NamespaceMember[] = [];
const namespaceMembers: AST.NamespaceMember[] = [];
for (const memberName of Object.keys(namespace.members)) {
namespaceMembers.push(namespace.members[memberName]);
}
namespaceMembers.sort(sorter);
var properties = <AST.Property[]>namespaceMembers.filter(member => member instanceof AST.Property);
var functions = <AST.Function[]>namespaceMembers.filter(member => member instanceof AST.Function);
var interfaces = <AST.Interface[]>namespaceMembers.filter(member => member instanceof AST.Interface);
var classes = <AST.Class[]>namespaceMembers.filter(member => member instanceof AST.Class);
var enums = <AST.Enum[]>namespaceMembers.filter(member => member instanceof AST.Enum);
const properties = namespaceMembers.filter(member => member instanceof AST.Property) as AST.Property[];
const functions = namespaceMembers.filter(member => member instanceof AST.Function) as AST.Function[];
const interfaces = namespaceMembers.filter(member => member instanceof AST.Interface) as AST.Interface[];
const classes = namespaceMembers.filter(member => member instanceof AST.Class) as AST.Class[];
const enums = namespaceMembers.filter(member => member instanceof AST.Enum) as AST.Enum[];
var result = [new Buffer(
const result = [new Buffer(
` <section class="namespace">
<h1 id="${ sanitize(namespaceName) }">Namespace ${ sanitize(namespaceName) }</h1>
`
@@ -763,13 +754,13 @@ export function build(outputFilePath: string, root: string, rootNamespaceName: s
return result;
}))).concat(flatten(moduleNames.map(moduleName => {
var module = modules[moduleName];
const module = modules[moduleName];
var moduleMembers: AST.ModuleMember[] = [];
const moduleMembers: AST.ModuleMember[] = [];
for (const memberName of Object.keys(module.members)) {
var member = module.members[memberName];
if ((<AST.HasParent><any>member).parent === module) {
moduleMembers.push(<AST.ModuleMember>member);
const member = module.members[memberName];
if ((member as AST.HasParent).parent === module) {
moduleMembers.push(member);
}
}
@@ -779,13 +770,13 @@ export function build(outputFilePath: string, root: string, rootNamespaceName: s
moduleMembers.sort(sorter);
var properties = <AST.Property[]>moduleMembers.filter(member => member instanceof AST.Property);
var functions = <AST.Function[]>moduleMembers.filter(member => member instanceof AST.Function);
var interfaces = <AST.Interface[]>moduleMembers.filter(member => member instanceof AST.Interface);
var classes = <AST.Class[]>moduleMembers.filter(member => member instanceof AST.Class);
var enums = <AST.Enum[]>moduleMembers.filter(member => member instanceof AST.Enum);
const properties = moduleMembers.filter(member => member instanceof AST.Property) as AST.Property[];
const functions = moduleMembers.filter(member => member instanceof AST.Function) as AST.Function[];
const interfaces = moduleMembers.filter(member => member instanceof AST.Interface) as AST.Interface[];
const classes = moduleMembers.filter(member => member instanceof AST.Class) as AST.Class[];
const enums = moduleMembers.filter(member => member instanceof AST.Enum) as AST.Enum[];
var result = [new Buffer(
const result = [new Buffer(
` <section class="module">
<h1 id="${ sanitize(moduleName) }">Module ${ sanitize(moduleName) }</h1>
`
+6
View File
@@ -7,6 +7,12 @@ declare var require: {
resolve(id: string): string;
};
interface BufferConstructor {
new (str: string): Buffer;
prototype: Buffer;
concat(list: Buffer[]): Buffer;
}
declare module "fs" {
export function existsSync(filename: string): boolean;
export function readFileSync(filename: string, options: { encoding: string }): string;
+26
View File
@@ -0,0 +1,26 @@
{
"compilerOptions": {
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"noUnusedParameters": false,
"strictNullChecks": false,
"target": "es5",
"module": "commonjs",
"moduleResolution": "classic",
"noImplicitUseStrict": false,
"types": []
},
"files": [
"./typescript/index.ts",
"./doc.ts",
"./node.d.ts",
"./typescript/typescript.d.ts",
"../node_modules/async-build/typings.d.ts"
]
}
+12 -2
View File
@@ -18,7 +18,7 @@
* limitations under the License.
*/
import * as ts from "typescript";
import ts = require("typescript");
export class HasParent {
public parent: HasParent = null;
@@ -30,7 +30,7 @@ export class HasParent {
return this.name;
}
var parent = this.parent;
const parent = this.parent;
if (parent instanceof Namespace) {
return parent.getMemberFullName(this);
}
@@ -188,7 +188,17 @@ export class UnresolvedType {
}
export type HasStringGenerics = Class | Interface | Function;
export function hasStringGenerics(item: NamespaceMember): item is HasStringGenerics {
return (item as HasGenerics).generics !== undefined;
}
export type HasGenerics = HasStringGenerics | TypeReference;
export function hasGenerics(item: ModuleMember | EnumMember | TypeReference): item is HasGenerics {
return (item as HasGenerics).generics !== undefined;
}
export type CanBePrivate = Class | Interface | Function | Getter | Setter | Enum | Reference;
export type CanBeProtected = Function;
export type CanBeStatic = Function;
+66 -185
View File
@@ -18,46 +18,70 @@
* limitations under the License.
*/
import * as fs from "fs";
import * as path from "path";
import { Transform } from "stream";
import * as ts from "typescript";
import path = require("path");
import ts = require("typescript");
import { File, FileTransform, FileWatcher } from "async-build";
import { File, FileTransform } from "async-build";
import * as AST from "./ast";
import { walk } from "./walker";
export interface StreamingCompilerHost extends ts.CompilerHost, ts.ParseConfigHost {
export interface StreamingCompilerHost extends ts.CompilerHost {
setOutputStream(outputStream: FileTransform): void;
}
function createCompilerHost(options: ts.CompilerOptions): StreamingCompilerHost {
const host = ts.createCompilerHost(options) as StreamingCompilerHost;
let _outputStream: FileTransform = null;
host.setOutputStream = outputStream => _outputStream = outputStream;
host.writeFile = (fileName, data, writeByteOrderMark, onError?, sourceFiles?): void => {
_outputStream.push({
path: fileName,
contents: new Buffer(data)
});
};
host.useCaseSensitiveFileNames = () => true;
host.getNewLine = () => "\n";
return host;
}
export class Compiler {
private _projectRoot: string = null;
private _host: StreamingCompilerHost;
private _program: ts.Program = null;
constructor(private _host: StreamingCompilerHost = new CompilerHost()) { }
compile(projectConfigFile: File) {
this._projectRoot = path.dirname(projectConfigFile.path);
var projectConfig = ts.parseJsonConfigFileContent(JSON.parse(projectConfigFile.contents.toString()), this._host, this._projectRoot);
const projectConfig = ts.parseJsonConfigFileContent(JSON.parse(projectConfigFile.contents.toString()), ts.sys, this._projectRoot);
this._host = createCompilerHost(projectConfig.options);
this._program = ts.createProgram(projectConfig.fileNames, projectConfig.options, this._host);
var syntacticDiagnostics = this._program.getSyntacticDiagnostics();
const syntacticDiagnostics = this._program.getSyntacticDiagnostics();
if (syntacticDiagnostics.length > 0) {
this._reportDiagnostics(syntacticDiagnostics);
throw new Error("There were one or more syntactic diagnostics.");
}
var globalDiagnostics = this._program.getGlobalDiagnostics();
const optionsDiagnostics = this._program.getOptionsDiagnostics();
if (optionsDiagnostics.length > 0) {
this._reportDiagnostics(optionsDiagnostics);
throw new Error("There were one or more options diagnostics.");
}
const globalDiagnostics = this._program.getGlobalDiagnostics();
if (globalDiagnostics.length > 0) {
this._reportDiagnostics(globalDiagnostics);
throw new Error("There were one or more global diagnostics.");
}
var semanticDiagnostics = this._program.getSemanticDiagnostics();
const semanticDiagnostics = this._program.getSemanticDiagnostics();
if (semanticDiagnostics.length > 0) {
this._reportDiagnostics(semanticDiagnostics);
throw new Error("There were one or more semantic diagnostics.");
@@ -67,7 +91,7 @@ export class Compiler {
writeFiles(outputStream: FileTransform) {
this._host.setOutputStream(outputStream);
var emitDiagnostics = this._program.emit().diagnostics;
const emitDiagnostics = this._program.emit().diagnostics;
if (emitDiagnostics.length > 0) {
this._reportDiagnostics(emitDiagnostics);
throw new Error("There were one or more emit diagnostics.");
@@ -88,10 +112,10 @@ export class Compiler {
private _reportDiagnostics(diagnostics: ts.Diagnostic[]) {
for (const diagnostic of diagnostics) {
var message = "";
let message = "";
if (diagnostic.file) {
var location = ts.getLineAndCharacterOfPosition(diagnostic.file, diagnostic.start);
const location = ts.getLineAndCharacterOfPosition(diagnostic.file, diagnostic.start);
message = `${ diagnostic.file.fileName }(${ location.line + 1 },${ location.character }): `;
}
@@ -105,168 +129,23 @@ export class Compiler {
};
}
const typeScriptModulePath = path.dirname(require.resolve("typescript"));
class CompilerHost implements StreamingCompilerHost {
protected _sourceFiles = Object.create(null);
private _outputStream: FileTransform = null;
setOutputStream(outputStream: FileTransform): void {
this._outputStream = outputStream;
}
// ts.ModuleResolutionHost members
fileExists(fileName: string): boolean {
return fs.existsSync(fileName);
}
readFile(fileName: string): string {
if (!this.fileExists(fileName)) {
return undefined;
}
return fs.readFileSync(fileName, { encoding: "utf8" });
}
// ts.CompilerHost members
getSourceFile(fileName: string, languageVersion: ts.ScriptTarget, onError: (message: string) => void): ts.SourceFile {
if (fileName in this._sourceFiles) {
return this._sourceFiles[fileName];
}
try {
var text = fs.readFileSync(fileName, { encoding: "utf8" });
var result = ts.createSourceFile(fileName, text, ts.ScriptTarget.ES5);
this._sourceFiles[fileName] = result;
}
catch (ex) {
if (onError) {
onError(ex.message);
}
}
return result;
}
getDefaultLibFileName(): string {
return path.join(typeScriptModulePath, "lib.dom.d.ts");
}
writeFile(fileName: string, data: string, writeByteOrderMark: boolean, onError: (message?: string) => void): void {
this._outputStream.push({
path: fileName,
contents: new Buffer(data)
});
}
getCurrentDirectory(): string {
return path.resolve(".");
}
getCanonicalFileName(fileName: string): string {
return ts.normalizeSlashes(path.resolve(fileName));
}
useCaseSensitiveFileNames(): boolean {
return true;
}
getNewLine(): string {
return "\n";
}
// ts.ParseConfigHost members
readDirectory(rootDir: string, extension: string, exclude: string[]): string[] {
return ts.sys.readDirectory(rootDir, extension, exclude).map(fileName => this.getCanonicalFileName(fileName));
}
}
class WatchCompilerHost extends CompilerHost {
private _fileWatcher = new FileWatcher(fileNames => this._onFilesChanged(fileNames));
private _filesChangedSinceLast: string[] = [];
constructor(private _onChangeCallback: () => void) {
super();
}
getSourceFile(fileName: string, languageVersion: ts.ScriptTarget, onError: (message: string) => void): ts.SourceFile {
var result = super.getSourceFile(fileName, languageVersion, onError);
if (result !== undefined) {
this._fileWatcher.watchFile(fileName);
}
return result;
};
private _onFilesChanged(fileNames: string[]) {
for (const fileName of fileNames) {
delete this._sourceFiles[fileName];
}
this._onChangeCallback();
}
}
export function build(root: string, rootNamespaceName: string): FileTransform {
var compiler = new Compiler();
return new FileTransform(function (projectConfigFile: File): void {
var self: FileTransform = this;
const compiler = new Compiler();
return new FileTransform(function (projectConfigFile): void {
console.log("Compiling " + projectConfigFile.path + "...");
compiler.compile(projectConfigFile);
var walkResult = walk(compiler, root, rootNamespaceName);
const walkResult = walk(compiler, root, rootNamespaceName);
addJSDocComments(walkResult.modules);
compiler.writeFiles(self);
compiler.writeFiles(this);
console.log("Compile succeeded.");
});
}
export function watch(root: string, rootNamespaceName: string): FileTransform {
return new FileTransform(function (projectConfigFile: File): void {
var self: FileTransform = this;
function compile() {
console.log("Compiling " + projectConfigFile.path + "...");
compiler.compile(projectConfigFile);
compiler.writeFiles(self);
console.log("Compile succeeded.");
self.push({
path: "END",
contents: ""
});
};
var compilerHost = new WatchCompilerHost(() => {
try {
compile();
}
catch (ex) {
console.error("Compile failed." + ex.stack);
}
});
var compiler = new Compiler(compilerHost);
compile();
console.log("Listening for changes...");
}, callback => { });
}
function addJSDocComments(modules: { [name: string]: AST.Module }): void {
function visitor(current: AST.Module | AST.ModuleMember | AST.InterfaceMember) {
if (current instanceof AST.Module) {
@@ -277,18 +156,18 @@ function addJSDocComments(modules: { [name: string]: AST.Module }): void {
return;
}
var newComments: string[] = [];
const newComments: string[] = [];
if (current instanceof AST.Class) {
newComments.push("@constructor");
if (current.baseType !== null) {
var baseType = current.baseType;
const baseType = current.baseType;
newComments.push(
"@extends {" +
baseType.fullName + (
(baseType instanceof AST.TypeReference && baseType.generics.length) > 0 ?
(".<" + (<AST.TypeReference>baseType).generics.map(generic => generic.fullName).join(", ") + ">") :
(".<" + (baseType as AST.TypeReference).generics.map(generic => generic.fullName).join(", ") + ">") :
""
) +
"}"
@@ -318,37 +197,37 @@ function addJSDocComments(modules: { [name: string]: AST.Module }): void {
return;
}
if ((<AST.HasParent><any>current).parent instanceof AST.Namespace) {
newComments.push("@memberOf " + (<AST.HasParent><any>current).parent.fullName);
if (current.parent instanceof AST.Namespace) {
newComments.push("@memberOf " + current.parent.fullName);
}
if ((<AST.HasStringGenerics>current).generics !== undefined && (<AST.HasStringGenerics>current).generics.length > 0) {
newComments.push("@template " + (<AST.HasStringGenerics>current).generics.join(", "));
if (AST.hasStringGenerics(current) && current.generics.length > 0) {
newComments.push("@template " + current.generics.join(", "));
}
if ((<AST.CanBePrivate><any>current).isPrivate) {
if ((current as AST.CanBePrivate).isPrivate) {
newComments.push("@private");
}
if ((<AST.CanBeProtected>current).isProtected) {
if ((current as AST.CanBeProtected).isProtected) {
newComments.push("@protected");
}
if ((<AST.CanBeStatic>current).isStatic) {
if ((current as AST.CanBeStatic).isStatic) {
newComments.push("@static");
}
if (newComments.length > 0) {
if (current instanceof AST.Property) {
var nodes: ts.Node[] = [];
const nodes: ts.Node[] = [];
if (current.getter !== null) { nodes.push(current.getter.astNode); }
if (current.setter !== null && nodes[0] !== current.setter.astNode) { nodes.push(current.setter.astNode); }
for (const node of nodes) {
(<any>node)["typescript-new-comment"] = newComments;
(node as any)["typescript-new-comment"] = newComments;
}
}
else {
(<any>(<AST.Class | AST.Interface | AST.Function | AST.Enum>current).astNode)["typescript-new-comment"] = newComments;
(current.astNode as any)["typescript-new-comment"] = newComments;
}
}
}
@@ -399,14 +278,14 @@ class FakeSourceFile {
var fakeSourceFiles: { [name: string]: FakeSourceFile } = Object.create(null);
export var oldGetLeadingCommentRangesOfNode: typeof ts.getLeadingCommentRangesOfNode = ts.getLeadingCommentRangesOfNode.bind(ts);
ts.getLeadingCommentRangesOfNode = (node: ts.Node, sourceFileOfNode: ts.SourceFile) => {
sourceFileOfNode = sourceFileOfNode || ts.getSourceFileOfNode(node);
export const oldGetLeadingCommentRangesOfNodeFromText: typeof ts.getLeadingCommentRangesOfNodeFromText = ts.getLeadingCommentRangesOfNodeFromText.bind(ts);
var originalComments = oldGetLeadingCommentRangesOfNode(node, sourceFileOfNode);
ts.getLeadingCommentRangesOfNodeFromText = (node: ts.Node, text: string) => {
const originalComments = oldGetLeadingCommentRangesOfNodeFromText(node, text);
if (originalComments !== undefined && (<any>node)["typescript-new-comment"] !== undefined) {
var fakeSourceFile = fakeSourceFiles[sourceFileOfNode.fileName];
const sourceFileOfNode = ts.getSourceFileOfNode(node);
let fakeSourceFile = fakeSourceFiles[sourceFileOfNode.fileName];
if (fakeSourceFile === undefined) {
fakeSourceFile = fakeSourceFiles[sourceFileOfNode.fileName] = new FakeSourceFile(sourceFileOfNode);
}
@@ -418,10 +297,12 @@ ts.getLeadingCommentRangesOfNode = (node: ts.Node, sourceFileOfNode: ts.SourceFi
};
var oldWriteCommentRange: typeof ts.writeCommentRange = ts.writeCommentRange.bind(ts);
ts.writeCommentRange = (currentSourceFile: ts.SourceFile, writer: ts.EmitTextWriter, comment: ts.CommentRange, newLine: string) => {
ts.writeCommentRange = (text: string, lineMap: number[], writer: ts.EmitTextWriter, comment: ts.CommentRange, newLine: string) => {
if ((<{ sourceFile: ts.SourceFile }><any>comment).sourceFile) {
currentSourceFile = (<{ sourceFile: ts.SourceFile }><any>comment).sourceFile;
const currentSourceFile = (<{ sourceFile: ts.SourceFile }><any>comment).sourceFile;
text = currentSourceFile.text;
lineMap = currentSourceFile.lineMap;
}
return oldWriteCommentRange(currentSourceFile, writer, comment, newLine);
return oldWriteCommentRange(text, lineMap, writer, comment, newLine);
};
+16 -12
View File
@@ -1,18 +1,22 @@
declare namespace ts {
export interface EmitTextWriter { }
interface EmitTextWriter { }
export interface IntrinsicType extends Type {
interface IntrinsicType extends Type {
intrinsicName: string;
}
export function forEachValue<T, U>(map: Map<T>, callback: (value: T) => U): U;
export function getClassExtendsHeritageClauseElement(node: ClassLikeDeclaration): ExpressionWithTypeArguments;
export function getClassImplementsHeritageClauseElements(node: ClassDeclaration): NodeArray<ExpressionWithTypeArguments>;
export function getInterfaceBaseTypeNodes(node: InterfaceDeclaration): NodeArray<ExpressionWithTypeArguments>;
export function getLeadingCommentRangesOfNode(node: Node, sourceFileOfNode: SourceFile): CommentRange[];
export function getLineStarts(sourceFile: SourceFile): number[];
export function getSourceFileOfNode(node: Node): SourceFile;
export function getTextOfNode(node: Node, includeTrivia?: boolean): string;
export function normalizeSlashes(path: string): string;
export function writeCommentRange(currentSourceFile: SourceFile, writer: EmitTextWriter, comment: CommentRange, newLine: string): void;
interface SourceFile {
lineMap: number[];
}
function forEachProperty<T, U>(map: Map<T>, callback: (value: T, key: string) => U): U;
function getClassExtendsHeritageClauseElement(node: ClassLikeDeclaration | InterfaceDeclaration): ExpressionWithTypeArguments;
function getClassImplementsHeritageClauseElements(node: ClassLikeDeclaration): ExpressionWithTypeArguments[];
function getInterfaceBaseTypeNodes(node: InterfaceDeclaration): ExpressionWithTypeArguments[];
function getLeadingCommentRangesOfNodeFromText(node: Node, text: string): CommentRange[];
function getLineStarts(sourceFile: SourceFile): number[];
function getSourceFileOfNode(node: Node): SourceFile;
function getTextOfNode(node: Node, includeTrivia?: boolean): string;
function normalizeSlashes(path: string): string;
function writeCommentRange(text: string, lineMap: number[], writer: EmitTextWriter, comment: CommentRange, newLine: string): void;
}
+1 -1
View File
@@ -18,4 +18,4 @@
* limitations under the License.
*/
export { build, watch } from "./compiler";
export { build } from "./compiler";
+196 -179
View File
@@ -18,13 +18,17 @@
* limitations under the License.
*/
import * as path from "path";
import * as ts from "typescript";
import path = require("path");
import ts = require("typescript");
import { Compiler, oldGetLeadingCommentRangesOfNode } from "./compiler";
import { Compiler, oldGetLeadingCommentRangesOfNodeFromText } from "./compiler";
import * as AST from "./ast";
function hasModifier(node: ts.Node, flags: ts.NodeFlags): boolean {
return (node.flags & flags) !== 0;
}
interface JSDoc {
description: string;
isAbstract: boolean;
@@ -68,13 +72,13 @@ class Walker {
}
walk(sourceFile: ts.SourceFile): void {
var moduleName = this._moduleNameFromFileName(sourceFile.fileName);
const moduleName = this._moduleNameFromFileName(sourceFile.fileName);
if (!(moduleName in this.modules)) {
this.modules[moduleName] = new AST.Module(moduleName);
}
var module = this._scope.enter(this.modules[moduleName]);
const module = this._scope.enter(this.modules[moduleName]);
this._currentSourceFile = sourceFile;
for (const statement of sourceFile.statements) {
@@ -87,31 +91,31 @@ class Walker {
private _walk(node: ts.Node, parent: AST.Module): void {
switch (node.kind) {
case ts.SyntaxKind.VariableStatement:
this._visitVariableStatement(<ts.VariableStatement>node, parent);
this._visitVariableStatement(node as ts.VariableStatement, parent);
break;
case ts.SyntaxKind.FunctionDeclaration:
this._visitFunctionDeclaration(<ts.FunctionDeclaration>node, parent);
this._visitFunctionDeclaration(node as ts.FunctionDeclaration, parent);
break;
case ts.SyntaxKind.ClassDeclaration:
this._visitClassDeclaration(<ts.ClassDeclaration>node, parent);
this._visitClassDeclaration(node as ts.ClassDeclaration, parent);
break;
case ts.SyntaxKind.InterfaceDeclaration:
this._visitInterfaceDeclaration(<ts.InterfaceDeclaration>node, parent);
this._visitInterfaceDeclaration(node as ts.InterfaceDeclaration, parent);
break;
case ts.SyntaxKind.EnumDeclaration:
this._visitEnumDeclaration(<ts.EnumDeclaration>node, parent);
this._visitEnumDeclaration(node as ts.EnumDeclaration, parent);
break;
case ts.SyntaxKind.ImportDeclaration:
this._visitImportDeclaration(<ts.ImportDeclaration>node, parent);
this._visitImportDeclaration(node as ts.ImportDeclaration, parent);
break;
case ts.SyntaxKind.ExportDeclaration:
this._visitExportDeclaration(<ts.ExportDeclaration>node, parent);
this._visitExportDeclaration(node as ts.ExportDeclaration, parent);
break;
case ts.SyntaxKind.ExpressionStatement:
@@ -121,7 +125,7 @@ class Walker {
break;
default:
console.error(node.kind, (<any>ts).SyntaxKind[node.kind], node);
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
@@ -130,20 +134,20 @@ class Walker {
switch (node.kind) {
case ts.SyntaxKind.PropertySignature:
case ts.SyntaxKind.PropertyDeclaration:
this._visitProperty(<ts.PropertyDeclaration>node, clazz);
this._visitProperty(node as ts.PropertyDeclaration, clazz);
break;
case ts.SyntaxKind.MethodSignature:
case ts.SyntaxKind.MethodDeclaration:
this._visitMethod(<ts.MethodDeclaration>node, clazz);
this._visitMethod(node as ts.MethodDeclaration, clazz);
break;
case ts.SyntaxKind.GetAccessor:
this._visitGetAccessor(<ts.AccessorDeclaration>node, clazz);
this._visitGetAccessor(node as ts.AccessorDeclaration, clazz);
break;
case ts.SyntaxKind.SetAccessor:
this._visitSetAccessor(<ts.AccessorDeclaration>node, clazz);
this._visitSetAccessor(node as ts.AccessorDeclaration, clazz);
break;
case ts.SyntaxKind.TypeParameter:
@@ -152,7 +156,7 @@ class Walker {
break;
default:
console.error(node.kind, (<any>ts).SyntaxKind[node.kind], node);
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
@@ -161,12 +165,12 @@ class Walker {
switch (node.kind) {
case ts.SyntaxKind.PropertySignature:
case ts.SyntaxKind.PropertyDeclaration:
this._visitProperty(<ts.PropertyDeclaration>node, interfase);
this._visitProperty(node as ts.PropertyDeclaration, interfase);
break;
case ts.SyntaxKind.MethodSignature:
case ts.SyntaxKind.MethodDeclaration:
this._visitMethod(<ts.MethodDeclaration>node, interfase);
this._visitMethod(node as ts.MethodDeclaration, interfase);
break;
case ts.SyntaxKind.TypeParameter:
@@ -176,24 +180,24 @@ class Walker {
break;
default:
console.error(node.kind, (<any>ts).SyntaxKind[node.kind], node);
console.error(node.kind, ts.SyntaxKind[node.kind], node);
throw new Error("Unrecognized node.");
}
}
private _visitProperty(node: ts.PropertyDeclaration, parent: AST.Class | AST.Interface) {
if ((node.flags & ts.NodeFlags.Private) === ts.NodeFlags.Private) {
if (hasModifier(node, ts.NodeFlags.Private)) {
return;
}
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
if (jsDoc.typeAnnotation === null) {
this._notifyIncorrectJsDoc(`Field ${ ts.getTextOfNode(node.name) } has no @type annotation.`);
jsDoc.typeAnnotation = "*";
}
var property = this._scope.enter(new AST.Property(ts.getTextOfNode(node.name)));
const property = this._scope.enter(new AST.Property(ts.getTextOfNode(node.name)));
parent.members[property.name] = property;
property.getter = new AST.Getter(node, jsDoc.description, jsDoc.typeAnnotation, false);
property.setter = new AST.Setter(node, jsDoc.description, jsDoc.typeAnnotation, false);
@@ -201,9 +205,9 @@ class Walker {
}
private _visitMethod(node: ts.MethodDeclaration, parent: AST.Class | AST.Interface) {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var parameters = this._connectParameters(node.parameters, jsDoc.parameters,
const parameters = this._connectParameters(node.parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on method ${ ts.getTextOfNode(node.name) }`
);
@@ -212,25 +216,25 @@ class Walker {
jsDoc.returnType = new AST.ReturnType("", "*");
}
var isPrivate = (node.flags & ts.NodeFlags.Private) === ts.NodeFlags.Private;
var isProtected = (node.flags & ts.NodeFlags.Protected) === ts.NodeFlags.Protected;
var isStatic = (node.flags & ts.NodeFlags.Static) === ts.NodeFlags.Static;
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
const isProtected = hasModifier(node, ts.NodeFlags.Protected);
const isStatic = hasModifier(node, ts.NodeFlags.Static);
var generics = this._getGenericsOfSignatureDeclaration(node);
const generics = this._getGenericsOfSignatureDeclaration(node);
var method = this._scope.enter(new AST.Function(ts.getTextOfNode(node.name), node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, isProtected, isStatic));
const method = this._scope.enter(new AST.Function(ts.getTextOfNode(node.name), node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, isProtected, isStatic));
parent.members[method.name] = method;
this._scope.leave();
}
private _visitGetAccessor(node: ts.AccessorDeclaration, clazz: AST.Class): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var name = ts.getTextOfNode(node.name);
const name = ts.getTextOfNode(node.name);
var isPrivate = (node.flags & ts.NodeFlags.Private) === ts.NodeFlags.Private;
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
var property = <AST.Property>clazz.members[name];
let property = clazz.members[name] as AST.Property;
if (property === undefined) {
this._scope.enter(property = new AST.Property(name));
@@ -247,13 +251,13 @@ class Walker {
}
private _visitSetAccessor(node: ts.AccessorDeclaration, clazz: AST.Class): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var name = ts.getTextOfNode(node.name);
const name = ts.getTextOfNode(node.name);
var isPrivate = (node.flags & ts.NodeFlags.Private) === ts.NodeFlags.Private;
const isPrivate = hasModifier(node, ts.NodeFlags.Private);
var property = <AST.Property>clazz.members[name];
let property = clazz.members[name] as AST.Property;
if (property === undefined) {
this._scope.enter(property = new AST.Property(name));
@@ -274,19 +278,18 @@ class Walker {
return;
}
var declaration = node.declarationList.declarations[0];
if ((declaration.flags & ts.NodeFlags.Ambient) === ts.NodeFlags.Ambient) {
const declaration = node.declarationList.declarations[0];
if (hasModifier(declaration, ts.NodeFlags.Ambient)) {
return;
}
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
if (jsDoc.typeAnnotation === null) {
return;
}
var property = this._scope.enter(new AST.Property(ts.getTextOfNode(declaration.name)));
const property = this._scope.enter(new AST.Property(ts.getTextOfNode(declaration.name)));
property.getter = new AST.Getter(node, jsDoc.description, jsDoc.typeAnnotation, false);
property.setter = new AST.Setter(node, jsDoc.description, jsDoc.typeAnnotation, false);
parent.members[property.name] = property;
@@ -294,13 +297,13 @@ class Walker {
}
private _visitFunctionDeclaration(node: ts.FunctionDeclaration, parent: AST.Module): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var isPrivate = (node.flags & ts.NodeFlags.Export) !== ts.NodeFlags.Export;
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
var generics = this._getGenericsOfSignatureDeclaration(node);
const generics = this._getGenericsOfSignatureDeclaration(node);
var parameters = this._connectParameters(node.parameters, jsDoc.parameters,
const parameters = this._connectParameters(node.parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on function ${ node.name.text }`
);
@@ -313,7 +316,7 @@ class Walker {
jsDoc.returnType = new AST.ReturnType("", "*");
}
var freeFunction = this._scope.enter(new AST.Function(node.name.text, node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, false, false));
const freeFunction = this._scope.enter(new AST.Function(node.name.text, node, jsDoc.description, generics, parameters, jsDoc.returnType, jsDoc.isAbstract, isPrivate, false, false));
parent.members[freeFunction.name] = freeFunction;
@@ -321,32 +324,32 @@ class Walker {
}
private _visitClassDeclaration(node: ts.ClassDeclaration, parent: AST.Module): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var baseTypeHeritageClauseElement = ts.getClassExtendsHeritageClauseElement(node) || null;
var baseType: AST.UnresolvedType = null;
const type = this._typeChecker.getTypeAtLocation(node) as ts.InterfaceType;
const generics = this._getGenericsOfInterfaceType(type);
const baseTypeHeritageClauseElement = ts.getClassExtendsHeritageClauseElement(node) || null;
let baseType: AST.UnresolvedType = null;
if (baseTypeHeritageClauseElement !== null) {
baseType = new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(baseTypeHeritageClauseElement).symbol,
this._getGenericsOfTypeReferenceNode(baseTypeHeritageClauseElement)
this._getGenericsOfTypeReferenceNode(baseTypeHeritageClauseElement, generics)
);
}
var interfaces = (ts.getClassImplementsHeritageClauseElements(node) || []).map(type => new AST.UnresolvedType(
const interfaces = (ts.getClassImplementsHeritageClauseElements(node) || []).map(type => new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(type).symbol,
this._getGenericsOfTypeReferenceNode(type)
this._getGenericsOfTypeReferenceNode(type, generics)
));
var isPrivate = (node.flags & ts.NodeFlags.Export) !== ts.NodeFlags.Export;
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
var type = <ts.InterfaceType>this._typeChecker.getTypeAtLocation(node);
var generics = this._getGenericsOfInterfaceType(type);
var parameters: AST.Parameter[] = [];
let parameters: AST.Parameter[] = [];
if (type.symbol.members["__constructor"] !== undefined) {
parameters = this._connectParameters((<ts.ConstructorDeclaration>type.symbol.members["__constructor"].declarations[0]).parameters, jsDoc.parameters,
parameters = this._connectParameters((type.symbol.members["__constructor"].declarations[0] as ts.ConstructorDeclaration).parameters, jsDoc.parameters,
parameterName => `Could not find @param annotation for ${ parameterName } on constructor in class ${ node.name.text }`
);
}
@@ -354,11 +357,11 @@ class Walker {
this._notifyIncorrectJsDoc("There are @param annotations on this class but it has no constructors.");
}
var clazz = this._scope.enter(new AST.Class(node.name.text, node, jsDoc.description, generics, parameters, baseType, interfaces, jsDoc.isAbstract, isPrivate));
const clazz = this._scope.enter(new AST.Class(node.name.text, node, jsDoc.description, generics, parameters, baseType, interfaces, jsDoc.isAbstract, isPrivate));
parent.members[clazz.name] = clazz;
ts.forEachValue(type.symbol.exports, symbol => {
ts.forEachProperty(type.symbol.exports, symbol => {
if (symbol.name === "prototype") {
return;
}
@@ -368,7 +371,7 @@ class Walker {
}
});
ts.forEachValue(type.symbol.members, symbol => {
ts.forEachProperty(type.symbol.members, symbol => {
for (const declaration of symbol.declarations) {
this._walkClassMember(declaration, clazz);
}
@@ -378,28 +381,28 @@ class Walker {
}
private _visitInterfaceDeclaration(node: ts.InterfaceDeclaration, parent: AST.Module): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var baseTypes = (ts.getInterfaceBaseTypeNodes(node) || []).map(type => new AST.UnresolvedType(
const type = this._typeChecker.getTypeAtLocation(node) as ts.InterfaceType;
const generics = this._getGenericsOfInterfaceType(type);
const baseTypes = (ts.getInterfaceBaseTypeNodes(node) || []).map(type => new AST.UnresolvedType(
this._typeChecker.getTypeAtLocation(type).symbol,
this._getGenericsOfTypeReferenceNode(type)
this._getGenericsOfTypeReferenceNode(type, generics)
));
var existingInterfaceType = parent.members[node.name.text];
const existingInterfaceType = parent.members[node.name.text];
if (existingInterfaceType !== undefined) {
return;
}
var isPrivate = (node.flags & ts.NodeFlags.Export) !== ts.NodeFlags.Export;
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
var type = <ts.InterfaceType>this._typeChecker.getTypeAtLocation(node);
var generics = this._getGenericsOfInterfaceType(type);
var interfase = this._scope.enter(new AST.Interface(node.name.text, node, jsDoc.description, generics, baseTypes, isPrivate));
const interfase = this._scope.enter(new AST.Interface(node.name.text, node, jsDoc.description, generics, baseTypes, isPrivate));
parent.members[interfase.name] = interfase;
ts.forEachValue(type.symbol.members, symbol => {
ts.forEachProperty(type.symbol.members, symbol => {
for (const declaration of symbol.declarations) {
this._walkInterfaceMember(declaration, interfase);
}
@@ -409,33 +412,33 @@ class Walker {
}
private _visitEnumDeclaration(node: ts.EnumDeclaration, parent: AST.Module): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var existingEnumType = parent.members[node.name.text];
const existingEnumType = parent.members[node.name.text];
if (existingEnumType !== undefined) {
return;
}
var isPrivate = (node.flags & ts.NodeFlags.Export) !== ts.NodeFlags.Export;
const isPrivate = !hasModifier(node, ts.NodeFlags.Export);
var type = this._typeChecker.getTypeAtLocation(node);
const type = this._typeChecker.getTypeAtLocation(node);
var enumType = this._scope.enter(new AST.Enum(node.name.text, node, jsDoc.description, isPrivate));
const enumType = this._scope.enter(new AST.Enum(node.name.text, node, jsDoc.description, isPrivate));
parent.members[enumType.name] = enumType;
ts.forEachValue(type.symbol.exports, symbol => {
this._visitEnumMember(<ts.EnumMember>symbol.declarations[0], enumType);
ts.forEachProperty(type.symbol.exports, symbol => {
this._visitEnumMember(symbol.declarations[0] as ts.EnumMember, enumType);
});
this._scope.leave();
}
private _visitEnumMember(node: ts.EnumMember, parent: AST.Enum): void {
var jsDoc = this._parseJSDoc(node);
const jsDoc = this._parseJSDoc(node);
var value = (node.initializer === undefined) ? null : parseInt((<ts.LiteralExpression>node.initializer).text);
const value = (node.initializer === undefined) ? null : parseInt((node.initializer as ts.LiteralExpression).text);
var enumMember = this._scope.enter(new AST.EnumMember(ts.getTextOfNode(node.name), (jsDoc === null) ? "" : jsDoc.description, value));
const enumMember = this._scope.enter(new AST.EnumMember(ts.getTextOfNode(node.name), (jsDoc === null) ? "" : jsDoc.description, value));
parent.members.push(enumMember);
@@ -452,16 +455,16 @@ class Walker {
throw new Error("Default import is not supported.");
}
var moduleName = this._resolve((<ts.LiteralExpression>node.moduleSpecifier).text, parent);
const moduleName = this._resolve((node.moduleSpecifier as ts.LiteralExpression).text, parent);
if ((<ts.NamespaceImport>node.importClause.namedBindings).name !== undefined) {
if ((node.importClause.namedBindings as ts.NamespaceImport).name !== undefined) {
// import * as foo from "baz";
parent.members[(<ts.NamespaceImport>node.importClause.namedBindings).name.text] = new AST.Reference(moduleName, "*", true);
parent.members[(node.importClause.namedBindings as ts.NamespaceImport).name.text] = new AST.Reference(moduleName, "*", true);
}
else if ((<ts.NamedImports>node.importClause.namedBindings).elements !== undefined) {
else if ((node.importClause.namedBindings as ts.NamedImports).elements !== undefined) {
// import { foo, bar } from "baz";
for (const element of (<ts.NamedImports>node.importClause.namedBindings).elements) {
var importedName = element.propertyName && element.propertyName.text || element.name.text;
for (const element of (node.importClause.namedBindings as ts.NamedImports).elements) {
const importedName = element.propertyName && element.propertyName.text || element.name.text;
parent.members[element.name.text] = new AST.Reference(moduleName, importedName, true);
}
}
@@ -473,22 +476,22 @@ class Walker {
private _visitExportDeclaration(node: ts.ExportDeclaration, parent: AST.Module): void {
if (node.moduleSpecifier !== undefined) {
// export { foo } from "bar";
var moduleName = this._resolve((<ts.LiteralExpression>node.moduleSpecifier).text, parent);
const moduleName = this._resolve((node.moduleSpecifier as ts.LiteralExpression).text, parent);
for (const element of node.exportClause.elements) {
var importedName = element.propertyName && element.propertyName.text || element.name.text;
const importedName = element.propertyName && element.propertyName.text || element.name.text;
parent.members[element.name.text] = new AST.Reference(moduleName, importedName, false);
}
}
else {
// export { foo };
for (const element of node.exportClause.elements) {
(<AST.CanBePrivate><any>parent.members[element.name.text]).isPrivate = false;
(parent.members[element.name.text] as AST.CanBePrivate).isPrivate = false;
}
}
}
private _resolve(relativeModuleName: string, currentModule: AST.Module): string {
var result = ts.normalizeSlashes(path.join(currentModule.name, `../${ relativeModuleName }`));
let result = ts.normalizeSlashes(path.join(currentModule.name, `../${ relativeModuleName }`));
if (result[0] !== ".") {
result = `./${ result }`;
@@ -498,7 +501,7 @@ class Walker {
}
private _parseJSDoc(node: ts.Node): JSDoc {
var comments = oldGetLeadingCommentRangesOfNode(node, this._currentSourceFile);
let comments = oldGetLeadingCommentRangesOfNodeFromText(node, this._currentSourceFile.text);
if (comments === undefined) {
comments = [];
@@ -508,41 +511,41 @@ class Walker {
comments = [comments[comments.length - 1]];
}
var comment =
const comment =
(comments.length === 0) ?
"" :
this._currentSourceFile.text.substring(comments[0].pos, comments[0].end);
var commentStartIndex = comment.indexOf("/**");
var commentEndIndex = comment.lastIndexOf("*/");
const commentStartIndex = comment.indexOf("/**");
const commentEndIndex = comment.lastIndexOf("*/");
var lines =
const lines =
(commentStartIndex === -1 || commentEndIndex === -1) ?
[] :
comment.substring(commentStartIndex + 2, commentEndIndex).split("\n").map(line => {
var match = line.match(/^[ \t]*\* (.*)/);
const match = line.match(/^[ \t]*\* (.*)/);
if (match === null) {
return "";
}
return match[1];
});
var rootDescription = "";
let rootDescription = "";
var parameters: { [name: string]: AST.Parameter } = Object.create(null);
const parameters: { [name: string]: AST.Parameter } = Object.create(null);
var typeAnnotation: string = null;
let typeAnnotation: string = null;
var returnType: AST.ReturnType = null;
let returnType: AST.ReturnType = null;
var isAbstract = false;
let isAbstract = false;
var lastRead: { description: string } = null;
let lastRead: { description: string } = null;
for (const line of lines) {
var firstWordMatch = line.match(/^\s*(\S+)(\s*)/);
var firstWord = (firstWordMatch !== null) ? firstWordMatch[1] : "";
var remainingLine = (firstWordMatch !== null) ? line.substring(firstWordMatch[0].length) : "";
const firstWordMatch = line.match(/^\s*(\S+)(\s*)/);
const firstWord = (firstWordMatch !== null) ? firstWordMatch[1] : "";
let remainingLine = (firstWordMatch !== null) ? line.substring(firstWordMatch[0].length) : "";
if (firstWord[0] === "@") {
lastRead = null;
@@ -553,30 +556,33 @@ class Walker {
isAbstract = true;
break;
case "@param":
var type: string;
case "@param": {
let type: string;
[type, remainingLine] = this._readType(remainingLine);
var [, name, description] = remainingLine.match(/(\S+)\s*(.*)/);
const [, name, description] = remainingLine.match(/(\S+)\s*(.*)/);
var subParameterMatch = name.match(/^(?:(.+)\.([^\.]+))|(?:(.+)\[("[^\[\]"]+")\])$/);
const subParameterMatch = name.match(/^(?:(.+)\.([^\.]+))|(?:(.+)\[("[^\[\]"]+")\])$/);
if (subParameterMatch === null) {
parameters[name] = lastRead = new AST.Parameter(name, description, type);
}
else {
var parentName = subParameterMatch[1] || subParameterMatch[3];
var childName = subParameterMatch[2] || subParameterMatch[4];
var parentParameter = parameters[parentName];
const parentName = subParameterMatch[1] || subParameterMatch[3];
const childName = subParameterMatch[2] || subParameterMatch[4];
const parentParameter = parameters[parentName];
parentParameter.subParameters.push(lastRead = new AST.Parameter(childName, description, type));
}
break;
case "@return":
var [type, description] = this._readType(remainingLine);
break;
}
case "@return": {
const [type, description] = this._readType(remainingLine);
returnType = lastRead = new AST.ReturnType(description, type);
break;
}
case "@type":
[typeAnnotation] = this._readType(remainingLine);
@@ -607,9 +613,9 @@ class Walker {
return ["*", remainingLine];
}
var index = -1;
var numberOfUnterminatedBraces = 0;
for (var i = 0; i < remainingLine.length; i++) {
let index = -1;
let numberOfUnterminatedBraces = 0;
for (let i = 0; i < remainingLine.length; i++) {
if (remainingLine[i] === "{") {
numberOfUnterminatedBraces++;
}
@@ -627,7 +633,7 @@ class Walker {
throw new Error("Unterminated type specifier.");
}
var type = remainingLine.substr(1, index - 1);
const type = remainingLine.substr(1, index - 1);
remainingLine = remainingLine.substr(index + 1).replace(/^\s+/, "");
return [type, remainingLine];
@@ -641,16 +647,24 @@ class Walker {
return signatureDeclaration.typeParameters.map(typeParameter => typeParameter.name.text);
}
private _getGenericsOfTypeReferenceNode(typeReferenceNode: ts.ExpressionWithTypeArguments): (AST.UnresolvedType | AST.IntrinsicTypeReference)[] {
private _getGenericsOfTypeReferenceNode(typeReferenceNode: ts.ExpressionWithTypeArguments, intrinsicGenerics: string[]): (AST.UnresolvedType | AST.IntrinsicTypeReference)[] {
if (typeReferenceNode.typeArguments === undefined) {
return [];
}
var typeReference = <ts.TypeReference>this._typeChecker.getTypeAtLocation(typeReferenceNode);
const typeReference = this._typeChecker.getTypeAtLocation(typeReferenceNode) as ts.TypeReference;
return typeReference.typeArguments.map(typeArgument => {
if ((<ts.IntrinsicType>typeArgument).intrinsicName !== undefined) {
return new AST.IntrinsicTypeReference((<ts.IntrinsicType>typeArgument).intrinsicName);
if ((typeArgument as ts.IntrinsicType).intrinsicName !== undefined) {
return new AST.IntrinsicTypeReference((typeArgument as ts.IntrinsicType).intrinsicName);
}
if (typeArgument.flags & ts.TypeFlags.TypeParameter) {
if (intrinsicGenerics.indexOf(typeArgument.symbol.name) !== -1) {
return new AST.IntrinsicTypeReference(typeArgument.symbol.name);
}
throw new Error(`Unbound type parameter ${ typeArgument.symbol.name }`);
}
return new AST.UnresolvedType(typeArgument.symbol, []);
@@ -669,12 +683,12 @@ class Walker {
private _connectParameters(astParameters: ts.ParameterDeclaration[], jsDocParameters: { [name: string]: AST.Parameter }, onMissingMessageCallback: (parameterName: string) => string) {
return astParameters.map(parameter => {
var parameterName = (<ts.Identifier>parameter.name).text;
let parameterName = (parameter.name as ts.Identifier).text;
if (parameterName[0] === "_") {
parameterName = parameterName.substr(1);
}
var jsDocParameter = jsDocParameters[parameterName];
let jsDocParameter = jsDocParameters[parameterName];
if (jsDocParameter === undefined) {
this._notifyIncorrectJsDoc(onMissingMessageCallback.call(this, parameterName));
@@ -686,8 +700,8 @@ class Walker {
}
private _notifyIncorrectJsDoc(message: string): void {
var fileName = path.basename(this._currentSourceFile.fileName);
if (fileName === "lib.core.d.ts" || fileName === "lib.dom.d.ts") {
const fileName = path.basename(this._currentSourceFile.fileName);
if (fileName === "lib.es5.d.ts" || fileName === "lib.dom.d.ts") {
return;
}
@@ -696,17 +710,17 @@ class Walker {
link(rootNamespaceName: string): void {
for (const moduleName of Object.keys(this.modules)) {
var module = this.modules[moduleName];
const module = this.modules[moduleName];
for (const memberName of Object.keys(module.members)) {
var member = module.members[memberName];
const member = module.members[memberName];
if (member instanceof AST.Class) {
if (member.unresolvedBaseType instanceof AST.UnresolvedType) {
member.baseType = this._resolveTypeReference(<AST.UnresolvedType>member.unresolvedBaseType);
member.baseType = this._resolveTypeReference(member.unresolvedBaseType);
}
else {
member.baseType = <AST.TypeReference | AST.IntrinsicTypeReference>member.unresolvedBaseType;
member.baseType = member.unresolvedBaseType;
}
member.interfaces = member.unresolvedInterfaces.map(interfase => {
@@ -714,7 +728,7 @@ class Walker {
return this._resolveTypeReference(interfase);
}
return <AST.TypeReference | AST.IntrinsicTypeReference>interfase;
return interfase;
});
}
@@ -724,12 +738,12 @@ class Walker {
return this._resolveTypeReference(baseType);
}
return <AST.TypeReference | AST.IntrinsicTypeReference>baseType;
return baseType;
});
}
else if (member instanceof AST.Enum) {
var value = 0;
let value = 0;
for (const enumMember of member.members) {
if (enumMember.value === null) {
enumMember.value = value;
@@ -751,17 +765,17 @@ class Walker {
private _moduleToNamespace(module: AST.Module): void {
for (const memberName of Object.keys(module.members)) {
var member = module.members[memberName];
let member = module.members[memberName];
if (member instanceof AST.Reference) {
if ((<AST.Reference>member).isPrivate) {
if (member.isPrivate) {
continue;
}
if (member.name === "*") {
var newNamespace = this._scope.enter(new AST.Namespace(memberName));
const newNamespace = this._scope.enter(new AST.Namespace(memberName));
var existingNamespace = this.namespaces[newNamespace.fullName];
const existingNamespace = this.namespaces[newNamespace.fullName];
if (existingNamespace !== undefined) {
this._scope.leave();
this._scope.enter(existingNamespace);
@@ -770,10 +784,10 @@ class Walker {
this.namespaces[newNamespace.fullName] = newNamespace;
}
var referencedModuleName = (<AST.Reference>member).moduleName;
var referencedModule = this.modules[referencedModuleName];
let referencedModuleName = member.moduleName;
let referencedModule = this.modules[referencedModuleName];
if (referencedModule === undefined && ((referencedModuleName + "/index") in this.modules)) {
(<AST.Reference>member).moduleName = referencedModuleName = referencedModuleName + "/index";
member.moduleName = referencedModuleName = referencedModuleName + "/index";
referencedModule = this.modules[referencedModuleName];
}
this._moduleToNamespace(referencedModule);
@@ -782,56 +796,61 @@ class Walker {
}
else {
while (member instanceof AST.Reference) {
member = this.modules[(<AST.Reference>member).moduleName].members[member.name];
member = this.modules[member.moduleName].members[member.name];
}
this._scope.enter(<AST.NamespaceMember><any>member);
this._scope.enter(member);
this._scope.leave();
(<AST.Namespace>this._scope.current).members[member.name] = <AST.NamespaceMember>member;
(this._scope.current as AST.Namespace).members[member.name] = member;
}
}
else if (!(<AST.CanBePrivate><any>member).isPrivate) {
this._scope.enter(<AST.NamespaceMember>member);
else if (!(member as AST.CanBePrivate).isPrivate) {
this._scope.enter(member);
this._scope.leave();
(<AST.Namespace>this._scope.current).members[member.name] = <AST.NamespaceMember>member;
(this._scope.current as AST.Namespace).members[member.name] = member;
}
}
}
private _resolveTypeReference(unresolvedType: AST.UnresolvedType): AST.TypeReference {
var node: ts.Node = unresolvedType.symbol.declarations[0];
private _resolveTypeReference(unresolvedType: AST.UnresolvedType): AST.TypeReference | AST.IntrinsicTypeReference {
let node: ts.Node = unresolvedType.symbol.declarations[0];
while (node.kind !== ts.SyntaxKind.SourceFile) {
node = node.parent;
}
var sourceFile = <ts.SourceFile>node;
const sourceFile = node as ts.SourceFile;
var moduleName = this._moduleNameFromFileName(sourceFile.fileName);
var module = this.modules[moduleName];
var result = module.members[unresolvedType.symbol.name];
if (result === undefined) {
throw new Error(`Type ${ unresolvedType.symbol.name } could not be resolved.`);
if (sourceFile.fileName.substr(-"globals.d.ts".length) === "globals.d.ts") {
return new AST.IntrinsicTypeReference(unresolvedType.symbol.name);
}
else {
const moduleName = this._moduleNameFromFileName(sourceFile.fileName);
const module = this.modules[moduleName];
while (result instanceof AST.Reference) {
result = this.modules[(<AST.Reference>result).moduleName].members[result.name];
}
let result = module.members[unresolvedType.symbol.name];
var resultGenerics = unresolvedType.generics.map(generic => {
if (generic instanceof AST.UnresolvedType) {
return this._resolveTypeReference(generic);
if (result === undefined) {
throw new Error(`Type ${unresolvedType.symbol.name} could not be resolved.`);
}
return <AST.IntrinsicTypeReference>generic;
});
while (result instanceof AST.Reference) {
result = this.modules[result.moduleName].members[result.name];
}
return new AST.TypeReference(<AST.NamespaceMember><any>result, resultGenerics);
const resultGenerics = unresolvedType.generics.map(generic => {
if (generic instanceof AST.UnresolvedType) {
return this._resolveTypeReference(generic);
}
return generic;
});
return new AST.TypeReference(result, resultGenerics);
}
}
private _moduleNameFromFileName(fileName: string): string {
var result = ts.normalizeSlashes(path.relative(this._compiler.projectRoot, fileName));
let result = ts.normalizeSlashes(path.relative(this._compiler.projectRoot, fileName));
result = result.substr(0, result.length - ".ts".length);
@@ -844,18 +863,16 @@ class Walker {
}
export function walk(compiler: Compiler, root: string, rootNamespaceName: string) {
var sourceFiles = compiler.sourceFiles;
var rootFileName = ts.normalizeSlashes(path.resolve(root));
var rootSourceFile = sourceFiles.filter(sourceFile => sourceFile.fileName === rootFileName)[0];
const sourceFiles = compiler.sourceFiles;
var walker = new Walker(compiler);
const walker = new Walker(compiler);
// Walk
for (const sourceFile of sourceFiles) {
if (
path.basename(sourceFile.fileName) === "lib.core.d.ts" ||
path.basename(sourceFile.fileName) === "lib.es5.d.ts" ||
path.basename(sourceFile.fileName) === "lib.dom.d.ts" ||
sourceFile.fileName.substr(-"references.d.ts".length) === "references.d.ts"
sourceFile.fileName.substr(-"globals.d.ts".length) === "globals.d.ts"
) {
continue;
}
+109 -210
View File
@@ -26,108 +26,52 @@ var UglifyJS = require("uglify-js");
var FileTransform = require("async-build").FileTransform;
var Run = (function () {
function Run(entry, outputLibraryName, unusedVarsToIgnore) {
this._entry = path.resolve(entry).replace(/\\/g, "/");
function Run(outputLibraryName, unusedVarsToIgnore) {
this._outputLibraryName = outputLibraryName;
this._unusedVarsToIgnore = unusedVarsToIgnore;
this._root = UglifyJS.parse(
'(function (root, factory) {\n' +
' var global = this;\n' +
'\n' +
' if (typeof define === "function" && define.amd) {\n' +
' define([], function() {\n' +
' return factory(global);\n' +
' });\n' +
' }\n' +
' else if (typeof exports === "object" && typeof module === "object") {\n' +
' module.exports = factory(global);\n' +
' }\n' +
' else if (typeof exports === "object") {\n' +
' exports.libjass = factory(global);\n' +
' }\n' +
' else {\n' +
' root.libjass = factory(global);\n' +
' }\n' +
'})(this, function (global) {\n' +
' "use strict";\n' +
' return (function (modules) {\n' +
' var installedModules = Object.create(null);\n' +
' function require(moduleId) {\n' +
' if (installedModules[moduleId]) {\n' +
' return installedModules[moduleId];\n' +
' }\n' +
'\n' +
' var exports = installedModules[moduleId] = Object.create(null);\n' +
' modules[moduleId](exports, require);\n' +
' return exports;\n' +
' }\n' +
'\n' +
' return require(0);\n' +
' })([\n' +
' ]);\n' +
'});');
this._root = UglifyJS.parse(fs.readFileSync(path.resolve(__filename, "..", "umd-wrapper.js"), "utf8"));
this._root.figure_out_scope({ screw_ie8: true });
this._licenseHeader = null;
this._toInsert = null;
this._outputModulesArray = this._root.body[0].body.args[1].body[1].value.args[0].elements;
this._modules = Object.create(null);
this._rootSourceMap = UjsSourceMap({ file: this._outputLibraryName + ".js", root: "" });
this._rootSourceMap = null;
}
Run.prototype.addFile = function (file) {
var _this = this;
var moduleName = (path.extname(file.path) === ".map") ? file.path.substr(0, file.path.length - ".js.map".length) : file.path.substr(0, file.path.length - ".js".length);
if (!(moduleName in this._modules)) {
this._modules[moduleName] = { id: null, root: null };
}
var module = this._modules[moduleName];
var filenameWithoutExtension = path.relative(path.join(this._entry, ".."), moduleName).replace(/\\/g, "/");
var tsFilename = filenameWithoutExtension + ".ts";
var jsFilename = filenameWithoutExtension + ".js";
switch (path.extname(file.path)) {
case ".js":
module.root = UglifyJS.parse(file.contents.toString(), {
filename: jsFilename,
toplevel: null,
});
try {
this._toInsert = UglifyJS.parse(file.contents.toString(), {
filename: path.basename(file.path),
toplevel: null,
}).body;
}
catch (ex) {
if (ex instanceof UglifyJS.JS_Parse_Error) {
throw new Error("UglifyJS parse error: " + ex.toString() + "\n");
}
if (this._licenseHeader === null) {
module.root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (_this._licenseHeader !== null) {
return;
}
if (node.start) {
(node.start.comments_before || []).some(function (comment, i) {
if (comment.value.indexOf("Copyright") !== -1) {
_this._licenseHeader = comment;
_this._licenseHeader.value = _this._licenseHeader.value.split("\n").map(function (line) { return line.replace(/^\t/, ""); }).join("\n");
node.start.comments_before.splice(i, 1);
return true;
}
return false;
});
}
}));
this._root.start.comments_before = [this._licenseHeader];
this._root.start.nlb = true;
throw ex;
}
break;
case ".map":
var sourceMapContents = JSON.parse(file.contents.toString());
sourceMapContents.sources[0] = tsFilename;
sourceMapContents.file = jsFilename;
this._rootSourceMap.addInput(sourceMapContents);
this._rootSourceMap.get().setSourceContent(tsFilename, fs.readFileSync(moduleName + ".ts", { encoding: "utf8" }));
var rawSourceMap = JSON.parse(file.contents.toString());
this._rootSourceMap = UglifyJS.SourceMap({
file: this._outputLibraryName + ".js",
root: "",
orig: rawSourceMap,
});
var generator = this._rootSourceMap.get();
rawSourceMap.sources.forEach(function (sourceRelativePath, index) {
generator.setSourceContent(sourceRelativePath, rawSourceMap.sourcesContent[index]);
});
break;
}
};
@@ -135,63 +79,72 @@ var Run = (function () {
Run.prototype.build = function (outputStream) {
var _this = this;
// Assign IDs to all modules
var moduleNames = Object.keys(this._modules);
moduleNames.sort(function (name1, name2) { return (name1 === name2) ? 0 : (name1 < name2 ? -1 : 1); });
moduleNames.unshift.apply(moduleNames, moduleNames.splice(moduleNames.indexOf(this._entry), 1));
moduleNames.forEach(function (moduleName, index) {
_this._modules[moduleName].id = index;
});
// Splice in the TS output into the UMD wrapper.
var insertionParent = this._root.body[0].body.args[1].body;
// Merge modules
moduleNames.forEach(function (moduleName) {
var module = _this._modules[moduleName];
module.root.body.forEach(function (statement) {
if (statement instanceof UglifyJS.AST_Var && statement.definitions.length === 1) {
if (
statement.definitions[0].value instanceof UglifyJS.AST_Call &&
statement.definitions[0].value.expression.name === "require"
) {
var importRelativePath = statement.definitions[0].value.args[0].value;
var importAbsolutePath = path.join(moduleName, "..", importRelativePath).replace(/\\/g, "/");
var stringArg = statement.definitions[0].value.args[0];
var importedModule = _this._modules[importAbsolutePath];
if (importedModule === undefined) {
importedModule = _this._modules[importAbsolutePath + "/index"];
}
statement.definitions[0].value.args[0] = new UglifyJS.AST_Number({ start: stringArg.start, end: stringArg.end, value: importedModule.id });
}
else if (statement.definitions[0].name.name === "__extends") {
var importAbsolutePath = path.join(_this._entry, "..", "utility", "ts-helpers").replace(/\\/g, "/");
statement.definitions[0].value = UglifyJS.parse('require(' + _this._modules[importAbsolutePath].id + ').__extends').body[0].body;
}
else if (statement.definitions[0].name.name === "__decorate") {
var importAbsolutePath = path.join(_this._entry, "..", "utility", "ts-helpers").replace(/\\/g, "/");
statement.definitions[0].value = UglifyJS.parse('require(' + _this._modules[importAbsolutePath].id + ').__decorate').body[0].body;
this._toInsert.reverse();
for (var i = this._toInsert.length - 1; i >= 0; i--) {
var node = this._toInsert[i];
if (node instanceof UglifyJS.AST_Var) {
for (var j = 0; j < node.definitions.length; j++) {
var definition = node.definitions[j];
if (definition.name.name === "__extends" || definition.name.name === "__decorate") {
definition.value = definition.value.right;
}
}
});
var wrapper = UglifyJS.parse('/* ' + module.id + ' ./' + path.relative(path.join(_this._entry, ".."), moduleName).replace(/\\/g, "/") + ' */ function x(exports, require) { }');
var func = wrapper.body[0];
func.body = module.root.body;
func.name = null;
_this._outputModulesArray.push(func);
});
insertionParent.splice(-1, 0, node);
this._toInsert.splice(i, 1);
}
}
this._root.figure_out_scope({ screw_ie8: true });
insertionParent.splice.apply(insertionParent, [-1, 0].concat(this._toInsert));
// Set if there are any unused variables apart from the ones in unusedVarsToIgnore
var haveUnusedVars = false;
// Fixups
for (var i = 0; i < this._toInsert.length; i++) {
var node = this._toInsert[i];
if (node instanceof UglifyJS.AST_Statement && node.body instanceof UglifyJS.AST_Call && node.body.expression.name === "define") {
var defineCall = node.body;
// Remove some things from the AST
var nodesToRemove;
defineCall.expression.name = "def";
nodesToRemove = [];
if (defineCall.args[1].elements[0].value !== "require") {
throw new Error("Expected first dep to be require");
}
defineCall.args[1].elements.shift();
defineCall.args[2].argnames.shift();
if (defineCall.args[1].elements[0].value !== "exports") {
throw new Error("Expected second dep to be exports");
}
defineCall.args[1].elements.shift();
defineCall.args[2].argnames.push(defineCall.args[2].argnames.shift());
}
}
// Remove all license headers except the one from the UMD wrapper
var firstLicenseHeader = null;
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node.start) {
(node.start.comments_before || []).some(function (comment, i) {
if (comment.value.indexOf("Copyright") !== -1) {
if (firstLicenseHeader === null) {
firstLicenseHeader = comment;
}
else if (comment !== firstLicenseHeader) {
node.start.comments_before.splice(i, 1);
}
return true;
}
return false;
});
}
}));
// Fixup anonymous functions to print a space after "function"
@@ -207,7 +160,7 @@ var Run = (function () {
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node.start && node.start.comments_before) {
node.start.comments_before.forEach(function (comment) {
if (comment === _this._licenseHeader) {
if (comment.value.indexOf("Copyright") !== -1) {
return;
}
@@ -216,7 +169,7 @@ var Run = (function () {
return;
}
var indent = " "; // 9 spaces
var indent = " "; // 5 spaces
for (var i = 0; i < comment.col; i++) {
indent += " ";
}
@@ -230,8 +183,16 @@ var Run = (function () {
this._root.figure_out_scope({ screw_ie8: true });
// Remove some things from the AST
var nodesToRemove = [];
// Set if there are any unused variables apart from the ones in unusedVarsToIgnore
var haveUnusedVars = false;
// Repeat because removing some declarations may make others unreferenced
for (;;) {
this._root.figure_out_scope({ screw_ie8: true });
// Unreferenced variable and function declarations, and unreferenced terminal function arguments
this._root.walk(new UglifyJS.TreeWalker(function (node, descend) {
if (node instanceof UglifyJS.AST_SymbolDeclaration && node.unreferenced()) {
@@ -266,8 +227,6 @@ var Run = (function () {
});
nodesToRemove = [];
this._root.figure_out_scope({ screw_ie8: true });
}
@@ -315,39 +274,25 @@ var Run = (function () {
// Output
var output = {
source_map: _this._rootSourceMap,
source_map: this._rootSourceMap,
ascii_only: true,
beautify: true,
comments: function (node, comment) {
// If this is the first license header, keep it.
if (comment === _this._licenseHeader) {
return true;
}
// If this is a license header, remove it.
if (comment.value.indexOf("Copyright") !== -1) {
return false;
}
// If this is a TypeScript reference comment, strip it.
if (comment.value.substr(0, "/<reference path=".length) === "/<reference path=") {
return false;
}
return true;
}
return comment.value.indexOf("tslint") === -1;
},
};
var stream = UglifyJS.OutputStream(output);
this._root.print(stream);
outputStream.push({
path: _this._outputLibraryName + ".js",
contents: Buffer.concat([new Buffer(stream.toString()), new Buffer("\n//# sourceMappingURL=" + _this._outputLibraryName + ".js.map")])
path: this._outputLibraryName + ".js",
contents: Buffer.concat([new Buffer(stream.toString()), new Buffer("\n//# sourceMappingURL=" + this._outputLibraryName + ".js.map")])
});
outputStream.push({
path: _this._outputLibraryName + ".js.map",
contents: new Buffer(_this._rootSourceMap.get().toString())
path: this._outputLibraryName + ".js.map",
contents: new Buffer(this._rootSourceMap.get().toString())
});
// Print unused variables
@@ -366,8 +311,8 @@ var Run = (function () {
})();
module.exports = {
build: function (entry, outputLibraryName, unusedVarsToIgnore) {
var run = new Run(entry, outputLibraryName, unusedVarsToIgnore);
build: function (outputLibraryName, unusedVarsToIgnore) {
var run = new Run(outputLibraryName, unusedVarsToIgnore);
return new FileTransform(function (file) {
run.addFile(file);
@@ -376,7 +321,7 @@ module.exports = {
});
},
watch: function (entry, outputLibraryName, unusedVarsToIgnore) {
watch: function (outputLibraryName, unusedVarsToIgnore) {
var files = Object.create(null);
return new FileTransform(function (file) {
@@ -384,7 +329,7 @@ module.exports = {
files[file.path] = file;
}
else {
var run = new Run(entry, outputLibraryName, unusedVarsToIgnore);
var run = new Run(outputLibraryName, unusedVarsToIgnore);
Object.keys(files).forEach(function (filename) {
run.addFile(files[filename]);
});
@@ -452,6 +397,7 @@ module.exports = {
file: path.basename(sourceMapFile.path),
orig: sourceMapFile.contents.toString()
}),
ascii_only: true,
comments: function (node, comment) {
if (!firstLicenseHeaderFound && comment.value.indexOf("Copyright") !== -1) {
firstLicenseHeaderFound = true;
@@ -489,53 +435,6 @@ module.exports = {
}
};
var SourceMap = require.cache[require.resolve("uglify-js")].require("source-map");
function UjsSourceMap(options) {
var orig_maps = Object.create(null);
var generator = new SourceMap.SourceMapGenerator({
file: options.file,
sourceRoot: options.root,
});
return {
addInput: function (rawSourceMap) {
var consumer = new SourceMap.SourceMapConsumer(rawSourceMap);
orig_maps[consumer.file] = consumer;
},
add: function (source, gen_line, gen_col, orig_line, orig_col, name) {
var originalMap = orig_maps[source];
if (originalMap === undefined) {
return;
}
var info = originalMap.originalPositionFor({
line: orig_line,
column: orig_col
});
if (info.source === null) {
return;
}
source = info.source;
orig_line = info.line;
orig_col = info.column;
name = info.name || name;
generator.addMapping({
generated : { line: gen_line, column: gen_col },
original : { line: orig_line, column: orig_col },
source : source,
name : name
});
},
get: function () { return generator; },
toString: function () { return generator.toString(); },
};
}
var originalSymbolUnreferenced = UglifyJS.AST_Symbol.prototype.unreferenced;
// Workaround for https://github.com/mishoo/UglifyJS2/issues/789 - Nodes explicitly marked with ujs:unreferenced will not be warned for.
+65
View File
@@ -0,0 +1,65 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* @license
*/
(function (root, factory) {
var global = this;
if (typeof define === "function" && define.amd) {
define([], function() {
return factory(global);
});
}
else if (typeof exports === "object" && typeof module === "object") {
module.exports = factory(global);
}
else if (typeof exports === "object") {
exports.libjass = factory(global);
}
else {
root.libjass = factory(global);
}
})(this, function (global) {
"use strict";
var registeredModules = Object.create(null);
var installedModules = Object.create(null);
function def(moduleId, deps, body) {
installedModules[moduleId] = { deps: deps, body: body, };
}
function req(moduleId) {
if (moduleId in registeredModules) {
return registeredModules[moduleId];
}
var exports = registeredModules[moduleId] = Object.create(null);
var deps = installedModules[moduleId].deps.map(req);
deps.push(exports);
installedModules[moduleId].body.apply(null, deps);
return exports;
}
return req("index");
});
+4
View File
@@ -98,3 +98,7 @@
.libjass-filters {
display: block;
}
.libjass-filters * {
color-interpolation-filters: sRGB;
}
+6 -7
View File
@@ -17,7 +17,7 @@
"main": "lib/libjass.js",
"scripts": {
"prepublish": "node ./build.js clean default",
"build": "tsc ./build/typescript/index.ts ./build/doc.ts ./build/node.d.ts ./build/typescript/typescript.d.ts ./node_modules/async-build/typings.d.ts -m commonjs -t es5 -noImplicitAny --moduleResolution classic",
"build": "tsc -p ./build/tsconfig.json",
"test": "node ./build.js test",
"test-lib": "intern-client config=tests/intern reporters=Pretty",
"test-minified": "intern-client config=tests/intern reporters=Pretty minified=true",
@@ -26,13 +26,12 @@
},
"devDependencies": {
"async": "1.x >=1.4",
"async-build": "0.2.0",
"firefox-profile": "0.3.x",
"intern": "3.x >=3.0.1",
"npm": "3.x",
"pngjs": "2.2.0",
"async-build": "0.3.1",
"intern": "3.x >=3.2.0",
"npm": "4.x",
"pngjs": "3.x",
"sax": "1.x",
"typescript": "1.7.5",
"typescript": "2.0.10",
"uglify-js": "2.x >=2.4.24"
},
"private": true
+163
View File
@@ -0,0 +1,163 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
interface Array<T> {
filter<S extends T>(callbackfn: (value: T, index: number, array: T[]) => value is S, thisArg?: any): S[];
}
interface WorkerGlobalScope {
postMessage(message: any): void;
addEventListener(type: string, listener: (message: any) => void, useCapture: boolean): void;
}
interface FontFace {
family: string;
load(): Promise<FontFace>;
}
interface FontFaceSet {
add(fontFace: FontFace): FontFaceSet;
forEach(callbackfn: (fontFace: FontFace, index: FontFace, set: FontFaceSet) => void, thisArg?: any): void;
}
interface Map<K, V> {
size: number;
get(key: K): V | undefined;
has(key: K): boolean;
set(key: K, value: V): this;
delete(key: K): boolean;
clear(): void;
forEach(callbackfn: (value: V, index: K, map: this) => void, thisArg?: any): void;
}
interface Node {
cloneNode(deep?: boolean): this;
}
interface Promise<T> extends Thenable<T> {
then<U>(onFulfilled: (value: T) => Thenable<U>, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
/* tslint:disable-next-line:unified-signatures */
then<U>(onFulfilled: (value: T) => U, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
catch(onRejected: (reason: any) => T | Thenable<T>): Promise<T>;
}
interface ReadableStream {
getReader(): ReadableStreamReader;
}
interface ReadableStreamReader {
read(): Promise<{ value: Uint8Array; done: boolean; }>;
}
interface Set<T> {
size: number;
add(value: T): this;
clear(): void;
has(value: T): boolean;
forEach(callbackfn: (value: T, index: T, set: this) => void, thisArg?: any): void;
}
interface SVGFEComponentTransferElement {
appendChild(newChild: SVGFEFuncAElement): SVGFEFuncAElement;
appendChild(newChild: SVGFEFuncBElement): SVGFEFuncBElement;
appendChild(newChild: SVGFEFuncGElement): SVGFEFuncGElement;
appendChild(newChild: SVGFEFuncRElement): SVGFEFuncRElement;
}
interface SVGFEMergeElement {
appendChild(newChild: SVGFEMergeNodeElement): SVGFEMergeNodeElement;
}
interface TextDecoder {
decode(input: ArrayBuffer | ArrayBufferView, options: { stream: boolean }): string;
}
interface Thenable<T> {
then: ThenableThen<T>;
}
type ThenableThen<T> = (this: Thenable<T>, resolve: ((resolution: T | Thenable<T>) => void) | undefined, reject: ((reason: any) => void) | undefined) => void;
/**
* The interface implemented by a communication channel to the other side.
*/
interface WorkerCommunication {
addEventListener(type: "message", listener: (ev: MessageEvent) => any, useCapture?: boolean): void;
addEventListener(type: string, listener: EventListener, useCapture?: boolean): void;
postMessage(message: any): void;
}
declare const exports: any;
declare const global: (WorkerGlobalScope) & {
FontFace?: {
new (family: string, source: string): FontFace;
};
Map?: {
new <K, V>(iterable?: [K, V][]): Map<K, V>;
/* tslint:disable-next-line:member-ordering */
prototype: Map<any, any> | { forEach: undefined };
};
MutationObserver?: typeof MutationObserver;
Promise?: {
new <T>(init: (resolve: (value: T | Thenable<T>) => void, reject: (reason: any) => void) => void): Promise<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Promise<any>;
resolve<T>(value: T | Thenable<T>): Promise<T>;
reject<T>(reason: any): Promise<T>;
all<T>(values: (T | Thenable<T>)[]): Promise<T[]>;
race<T>(values: (T | Thenable<T>)[]): Promise<T>;
};
ReadableStream?: {
prototype: ReadableStream | { getReader: undefined; };
};
Set?: {
new <T>(iterable?: T[]): Set<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Set<any> | { forEach: undefined };
};
TextDecoder?: { new (encoding: string, options: { ignoreBOM: boolean }): TextDecoder };
WebkitMutationObserver?: typeof MutationObserver;
Worker?: typeof Worker,
WorkerGlobalScope?: {
prototype: WorkerGlobalScope;
new (): WorkerGlobalScope;
};
document?: {
currentScript?: HTMLScriptElement;
fonts?: FontFaceSet;
};
fetch?(url: string): Promise<{ body: ReadableStream; ok?: boolean; status?: number; }>;
process?: {
nextTick?(callback: () => void): void;
}
};
+66 -6
View File
@@ -42,6 +42,8 @@ export { parser };
import * as renderers from "./renderers";
export { renderers };
export { serialize, deserialize } from "./serialization";
export { ASS } from "./types/ass";
export { Attachment, AttachmentType } from "./types/attachment";
export { Dialogue } from "./types/dialogue";
@@ -50,28 +52,86 @@ export { Style } from "./types/style";
export { BorderStyle, Format, WrappingStyle } from "./types/misc";
declare const exports: any;
export { version } from "./version";
/**
* Configures libjass with the given properties.
*
* @param {!*} newConfig
* @param {?boolean} newConfig["debugMode"] When true, libjass logs some debug messages.
* @param {?boolean} newConfig["verboseMode"] When true, libjass logs some more debug messages. This setting is independent of {@link libjass.debugMode}
* @param {?function(new:Set, !Array.<T>=)} newConfig["Set"] Sets the Set implementation used by libjass to the provided one. If null, {@link ./utility/set.SimpleSet} is used.
* @param {?function(new:Map, !Array.<!Array.<*>>=)} newConfig["Map"] Sets the Map implementation used by libjass to the provided one. If null, {@link ./utility/map.SimpleMap} is used.
* @param {?function(new:Promise)} newConfig["Promise"] Sets the Promise implementation used by libjass to the provided one. If null, {@link ./utility/promise.SimplePromise} is used.
*/
export function configure(newConfig: {
debugMode?: boolean,
verboseMode?: boolean,
Set?: typeof set.Set | null,
Map?: typeof map.Map | null,
Promise?: typeof promise.Promise | null,
}): void {
if (typeof newConfig.debugMode === "boolean") {
settings.setDebugMode(newConfig.debugMode);
}
if (typeof newConfig.verboseMode === "boolean") {
settings.setVerboseMode(newConfig.verboseMode);
}
if (typeof newConfig.Set === "function" || newConfig.Set === null) {
set.setImplementation(newConfig.Set);
}
if (typeof newConfig.Map === "function" || newConfig.Map === null) {
map.setImplementation(newConfig.Map);
}
if (typeof newConfig.Promise === "function" || newConfig.Promise === null) {
promise.setImplementation(newConfig.Promise);
}
}
// Getters below are to work around https://github.com/Microsoft/TypeScript/issues/6366
Object.defineProperties(exports, {
debugMode: {
get: () => settings.debugMode,
set: settings.setDebugMode,
set: value => {
console.warn("Setter `libjass.debugMode = value` has been deprecated. Use `libjass.configure({ debugMode: value })` instead.");
settings.setDebugMode(value);
},
},
verboseMode: {
get: () => settings.verboseMode,
set: settings.setVerboseMode,
set: value => {
console.warn("Setter `libjass.verboseMode = value` has been deprecated. Use `libjass.configure({ verboseMode: value })` instead.");
settings.setVerboseMode(value);
},
},
Set: {
get: () => set.Set,
set: set.setImplementation,
set: value => {
console.warn("Setter `libjass.Set = value` has been deprecated. Use `libjass.configure({ Set: value })` instead.");
set.setImplementation(value);
},
},
Map: {
get: () => map.Map,
set: map.setImplementation,
set: value => {
console.warn("Setter `libjass.Map = value` has been deprecated. Use `libjass.configure({ Map: value })` instead.");
map.setImplementation(value);
},
},
Promise: {
get: () => promise.Promise,
set: promise.setImplementation,
set: value => {
console.warn("Setter `libjass.Promise = value` has been deprecated. Use `libjass.configure({ Promise: value })` instead.");
promise.setImplementation(value);
},
},
});
+4 -4
View File
@@ -26,9 +26,9 @@ import { Map } from "../utility/map";
* Parses a line into a {@link ./types/misc.Property}.
*
* @param {string} line
* @return {!Property}
* @return {Property}
*/
export function parseLineIntoProperty(line: string): Property {
export function parseLineIntoProperty(line: string): Property | null {
const colonPos = line.indexOf(":");
if (colonPos === -1) {
return null;
@@ -45,9 +45,9 @@ export function parseLineIntoProperty(line: string): Property {
*
* @param {string} line
* @param {!Array.<string>} formatSpecifier
* @return {!TypedTemplate}
* @return {TypedTemplate}
*/
export function parseLineIntoTypedTemplate(line: string, formatSpecifier: string[]): TypedTemplate {
export function parseLineIntoTypedTemplate(line: string, formatSpecifier: string[]): TypedTemplate | null {
const property = parseLineIntoProperty(line);
if (property === null) {
return null;
+310 -292
View File
File diff suppressed because it is too large Load Diff
+16 -12
View File
@@ -21,14 +21,13 @@
import { debugMode } from "../settings";
import { ASS } from "../types/ass";
import { Style } from "../types/style";
import { Dialogue } from "../types/dialogue";
import { Attachment, AttachmentType } from "../types/attachment";
import { Property, TypedTemplate } from "../types/misc";
import { Dialogue } from "../types/dialogue";
import { Style } from "../types/style";
import { Map } from "../utility/map";
import { Promise, DeferredPromise } from "../utility/promise";
import { DeferredPromise } from "../utility/promise";
import { parseLineIntoProperty } from "./misc";
import { Stream } from "./streams";
@@ -55,9 +54,10 @@ export class StreamParser {
private _shouldSwallowBom: boolean = true;
private _currentSection: Section = Section.ScriptInfo;
private _currentAttachment: Attachment = null;
private _currentAttachment: Attachment | null = null;
constructor(private _stream: Stream) {
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._minimalDeferred.reject(reason);
this._deferred.reject(reason);
@@ -102,6 +102,7 @@ export class StreamParser {
if (value === Section.EOF) {
const scriptProperties = this._ass.properties;
/* tslint:disable-next-line:strict-type-predicates */
if (scriptProperties.resolutionX === undefined || scriptProperties.resolutionY === undefined) {
// Malformed script.
this._minimalDeferred.reject("Malformed ASS script.");
@@ -119,7 +120,7 @@ export class StreamParser {
/**
* @param {string} line
*/
private _onNextLine(line: string): void {
private _onNextLine(line: string | null): void {
if (line === null) {
this.currentSection = Section.EOF;
return;
@@ -273,6 +274,7 @@ export class StreamParser {
}
}
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._minimalDeferred.reject(reason);
this._deferred.reject(reason);
@@ -291,12 +293,13 @@ export class SrtStreamParser {
private _shouldSwallowBom: boolean = true;
private _currentDialogueNumber: string = null;
private _currentDialogueStart: string = null;
private _currentDialogueEnd: string = null;
private _currentDialogueText: string = null;
private _currentDialogueNumber: string | null = null;
private _currentDialogueStart: string | null = null;
private _currentDialogueEnd: string | null = null;
private _currentDialogueText: string | null = null;
constructor(private _stream: Stream) {
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._deferred.reject(reason);
});
@@ -320,7 +323,7 @@ export class SrtStreamParser {
/**
* @param {string} line
*/
private _onNextLine(line: string): void {
private _onNextLine(line: string | null): void {
if (line === null) {
if (this._currentDialogueNumber !== null && this._currentDialogueStart !== null && this._currentDialogueEnd !== null && this._currentDialogueText !== null) {
this._ass.dialogues.push(new Dialogue(new Map([
@@ -380,7 +383,7 @@ export class SrtStreamParser {
.replace(/<\/u>/g, "{\\u0}").replace(/\{\/u\}/g, "{\\u0}")
.replace(
/<font color="#([0-9a-fA-F]{2})([0-9a-fA-F]{2})([0-9a-fA-F]{2})">/g,
(/* ujs:unreferenced */ substring: string, red: string, green: string, blue: string) => `{\c&H${ blue }${ green }${ red }&}`
(/* ujs:unreferenced */ _substring: string, red: string, green: string, blue: string) => `{\c&H${ blue }${ green }${ red }&}`,
).replace(/<\/font>/g, "{\\c}");
if (this._currentDialogueText !== null) {
@@ -392,6 +395,7 @@ export class SrtStreamParser {
}
}
/* tslint:disable-next-line:no-floating-promises */
this._stream.nextLine().then(line => this._onNextLine(line), reason => {
this._deferred.reject(reason);
});
+29 -59
View File
@@ -18,45 +18,7 @@
* limitations under the License.
*/
import { Promise, DeferredPromise } from "../utility/promise";
export interface ReadableStream {
/**
* @return {!ReadableStreamReader}
*/
getReader(): ReadableStreamReader;
}
interface ReadableStreamReader {
/**
* @return {!Promise.<{ value?: Uint8Array, done: boolean }>}
*/
read(): Promise<{ value: Uint8Array; done: boolean; }>;
}
export interface TextDecoder {
/**
* @param {!ArrayBuffer|!ArrayBufferView} input
* @param {{ stream: boolean }} options
* @return {string}
*/
decode(input: ArrayBuffer | ArrayBufferView, options: { stream: boolean }): string;
}
export interface TextDecoderConstructor {
new (encoding: string, options: { ignoreBOM: boolean }): TextDecoder;
/**
* @type {!TextDecoder}
*/
prototype: TextDecoder;
}
declare const global: {
/**
* @type {!TextDecoderConstructor}
*/
TextDecoder?: TextDecoderConstructor;
};
import { DeferredPromise, Promise } from "../utility/promise";
/**
* An interface for a stream.
@@ -65,7 +27,7 @@ export interface Stream {
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the stream is exhausted.
*/
nextLine(): Promise<string>;
nextLine(): Promise<string | null>;
}
/**
@@ -81,8 +43,8 @@ export class StringStream implements Stream {
/**
* @return {!Promise.<?string>} A promise that will be resolved with the next line, or null if the string has been completely read.
*/
nextLine(): Promise<string> {
let result: Promise<string> = null;
nextLine(): Promise<string | null> {
let result: Promise<string | null>;
if (this._readTill < this._str.length) {
const nextNewLinePos = this._str.indexOf("\n", this._readTill);
@@ -96,7 +58,7 @@ export class StringStream implements Stream {
}
}
else {
result = Promise.resolve<string>(null);
result = Promise.resolve<string | null>(null);
}
return result;
@@ -111,8 +73,8 @@ export class StringStream implements Stream {
*/
export class XhrStream implements Stream {
private _readTill: number = 0;
private _pendingDeferred: DeferredPromise<string> = null;
private _failedError: ErrorEvent = null;
private _pendingDeferred: DeferredPromise<string | null> | null = null;
private _failedError: ErrorEvent | null = null;
constructor(private _xhr: XMLHttpRequest) {
_xhr.addEventListener("progress", () => this._onXhrProgress(), false);
@@ -181,7 +143,7 @@ export class XhrStream implements Stream {
*/
private _tryResolveNextLine(): void {
if (this._failedError !== null) {
this._pendingDeferred.reject(this._failedError);
this._pendingDeferred!.reject(this._failedError);
return;
}
@@ -189,23 +151,19 @@ export class XhrStream implements Stream {
const nextNewLinePos = response.indexOf("\n", this._readTill);
if (nextNewLinePos !== -1) {
this._pendingDeferred.resolve(response.substring(this._readTill, nextNewLinePos));
this._pendingDeferred!.resolve(response.substring(this._readTill, nextNewLinePos));
this._readTill = nextNewLinePos + 1;
this._pendingDeferred = null;
}
else if (this._xhr.readyState === XMLHttpRequest.DONE) {
if (this._failedError !== null) {
this._pendingDeferred.reject(this._failedError);
}
// No more data. This is the last line.
else if (this._readTill < response.length) {
this._pendingDeferred.resolve(response.substr(this._readTill));
if (this._readTill < response.length) {
this._pendingDeferred!.resolve(response.substr(this._readTill));
this._readTill = response.length;
}
else {
this._pendingDeferred.resolve(null);
this._pendingDeferred!.resolve(null);
}
this._pendingDeferred = null;
@@ -220,14 +178,25 @@ export class XhrStream implements Stream {
* @param {string} encoding
*/
export class BrowserReadableStream implements Stream {
/**
* @return {boolean} Whether BrowserReadableStream is supported in this environment.
*/
static isSupported(): boolean {
return (
global.ReadableStream !== undefined &&
typeof global.ReadableStream.prototype.getReader === "function" &&
typeof global.TextDecoder === "function"
);
}
private _reader: ReadableStreamReader;
private _decoder: TextDecoder;
private _buffer: string = "";
private _pendingDeferred: DeferredPromise<string> = null;
private _pendingDeferred: DeferredPromise<string | null> | null = null;
constructor(stream: ReadableStream, encoding: string) {
this._reader = stream.getReader();
this._decoder = new global.TextDecoder(encoding, { ignoreBOM: true });
this._decoder = new global.TextDecoder!(encoding, { ignoreBOM: true });
}
/**
@@ -250,12 +219,13 @@ export class BrowserReadableStream implements Stream {
private _tryResolveNextLine(): void {
const nextNewLinePos = this._buffer.indexOf("\n");
if (nextNewLinePos !== -1) {
this._pendingDeferred.resolve(this._buffer.substr(0, nextNewLinePos));
this._pendingDeferred!.resolve(this._buffer.substr(0, nextNewLinePos));
this._buffer = this._buffer.substr(nextNewLinePos + 1);
this._pendingDeferred = null;
}
else {
/* tslint:disable-next-line:no-floating-promises */
this._reader.read().then(next => {
const { value, done } = next;
@@ -266,10 +236,10 @@ export class BrowserReadableStream implements Stream {
else {
// No more data.
if (this._buffer.length === 0) {
this._pendingDeferred.resolve(null);
this._pendingDeferred!.resolve(null);
}
else {
this._pendingDeferred.resolve(this._buffer);
this._pendingDeferred!.resolve(this._buffer);
this._buffer = "";
}
+25 -18
View File
@@ -31,25 +31,28 @@ enum DataType {
Uint32,
}
type StructMemberDefinition = { type: DataType; field?: string; };
type StructMemberDefinition = { type: DataType; field: string; };
const fieldDecorators = new Map<DataType, (proto: any, field: string) => void>();
@struct
class OffsetTable {
/** @type {function(!{ dataView: DataView, position: number }): OffsetTable} */
static read: (reader: DataReader) => OffsetTable;
/** @type {number} */ @field(DataType.Uint16) majorVersion: number;
/** @type {number} */ @field(DataType.Uint16) minorVersion: number;
/** @type {number} */ @field(DataType.Uint16) numTables: number;
/** @type {number} */ @field(DataType.Uint16) searchRange: number;
/** @type {number} */ @field(DataType.Uint16) entrySelector: number;
/** @type {number} */ @field(DataType.Uint16) rangeShift: number;
/** @type {function(!{ dataView: DataView, position: number }): OffsetTable} */
static read: (reader: DataReader) => OffsetTable;
}
@struct
class TableRecord {
/** @type {function(!{ dataView: DataView, position: number }): TableRecord} */
static read: (reader: DataReader) => TableRecord;
/** @type {string} */ @field(DataType.Char) c1: string;
/** @type {string} */ @field(DataType.Char) c2: string;
/** @type {string} */ @field(DataType.Char) c3: string;
@@ -57,32 +60,29 @@ class TableRecord {
/** @type {number} */ @field(DataType.Uint32) checksum: number;
/** @type {number} */ @field(DataType.Uint32) offset: number;
/** @type {number} */ @field(DataType.Uint32) length: number;
/** @type {function(!{ dataView: DataView, position: number }): TableRecord} */
static read: (reader: DataReader) => TableRecord;
}
@struct
class NameTableHeader {
/** @type {function(!{ dataView: DataView, position: number }): NameTableHeader} */
static read: (reader: DataReader) => NameTableHeader;
/** @type {number} */ @field(DataType.Uint16) formatSelector: number;
/** @type {number} */ @field(DataType.Uint16) count: number;
/** @type {number} */ @field(DataType.Uint16) stringOffset: number;
/** @type {function(!{ dataView: DataView, position: number }): NameTableHeader} */
static read: (reader: DataReader) => NameTableHeader;
}
@struct
class NameRecord {
/** @type {function(!{ dataView: DataView, position: number }): NameRecord} */
static read: (reader: DataReader) => NameRecord;
/** @type {number} */ @field(DataType.Uint16) platformId: number;
/** @type {number} */ @field(DataType.Uint16) encodingId: number;
/** @type {number} */ @field(DataType.Uint16) languageId: number;
/** @type {number} */ @field(DataType.Uint16) nameId: number;
/** @type {number} */ @field(DataType.Uint16) length: number;
/** @type {number} */ @field(DataType.Uint16) offset: number;
/** @type {function(!{ dataView: DataView, position: number }): NameRecord} */
static read: (reader: DataReader) => NameRecord;
}
/**
@@ -103,7 +103,7 @@ export function getTtfNames(attachment: Attachment): Set<string> {
const reader = { dataView: new DataView(bytes.buffer), position: 0 };
const offsetTable = OffsetTable.read(reader);
let nameTableRecord: TableRecord = null;
let nameTableRecord: TableRecord | null = null;
for (let i = 0; i < offsetTable.numTables; i++) {
const tableRecord = TableRecord.read(reader);
if (tableRecord.c1 + tableRecord.c2 + tableRecord.c3 + tableRecord.c4 === "name") {
@@ -111,6 +111,9 @@ export function getTtfNames(attachment: Attachment): Set<string> {
break;
}
}
if (nameTableRecord === null) {
throw new Error('Could not find "name" table record.');
}
reader.position = nameTableRecord.offset;
const nameTableHeader = NameTableHeader.read(reader);
@@ -130,24 +133,28 @@ export function getTtfNames(attachment: Attachment): Set<string> {
case 1: {
let name = "";
/* tslint:disable-next-line:prefer-for-of */
for (let j = 0; j < nameBytes.length; j++) {
name += String.fromCharCode(nameBytes[j]);
}
result.add(name);
}
break;
}
case 3: {
let name = "";
for (let j = 0; j < nameBytes.length; j += 2) {
/* tslint:disable-next-line:no-bitwise */
name += String.fromCharCode((nameBytes[j] << 8) + nameBytes[j + 1]);
}
result.add(name);
}
break;
}
}
break;
@@ -165,7 +172,7 @@ export function getTtfNames(attachment: Attachment): Set<string> {
* @return {!function(new(): T)}
*/
function struct<T>(clazz: { new (): T; read(reader: DataReader): T; }): { new (): T; read(reader: DataReader): T; } {
const fields: StructMemberDefinition[] = (<any>clazz).__fields;
const fields: StructMemberDefinition[] = (clazz as any).__fields;
clazz.read = (reader: DataReader) => {
const result: any = new clazz();
@@ -205,7 +212,7 @@ function struct<T>(clazz: { new (): T; read(reader: DataReader): T; }): { new ()
function field<T>(type: DataType): (proto: T, field: string) => void {
let existingDecorator = fieldDecorators.get(type);
if (existingDecorator === undefined) {
existingDecorator =(proto: T, field: string) => {
existingDecorator = (proto: T, field: string) => {
const ctor: { __fields?: StructMemberDefinition[] } = proto.constructor;
if (ctor.__fields === undefined) {
ctor.__fields = [];
+99 -104
View File
@@ -77,11 +77,7 @@ export class Color {
* @return {!libjass.parts.Color} Returns a new Color instance with the same color but the provided alpha.
*/
withAlpha(value: number): Color {
if (value !== null) {
return new Color(this._red, this._green, this._blue, value);
}
return this;
return new Color(this._red, this._green, this._blue, value);
}
/**
@@ -103,7 +99,7 @@ export class Color {
this._red + progression * (final.red - this._red),
this._green + progression * (final.green - this._green),
this._blue + progression * (final.blue - this._blue),
this._alpha + progression * (final.alpha - this._alpha)
this._alpha + progression * (final.alpha - this._alpha),
);
}
}
@@ -162,20 +158,26 @@ export class Text {
export class NewLine {
}
/**
* A soft newline character \n.
*/
export class SoftNewLine {
}
/**
* An italic tag {\i}
*
* @param {?boolean} value {\i1} -> true, {\i0} -> false, {\i} -> null
*/
export class Italic {
constructor(private _value: boolean) { }
constructor(private _value: boolean | null) { }
/**
* The value of this italic tag.
*
* @type {?boolean}
*/
get value(): boolean {
get value(): boolean | null {
return this._value;
}
}
@@ -183,17 +185,17 @@ export class Italic {
/**
* A bold tag {\b}
*
* @param {*} value {\b1} -> true, {\b0} -> false, {\b###} -> weight of the bold (number), {\b} -> null
* @param {?boolean|?number} value {\b1} -> true, {\b0} -> false, {\b###} -> weight of the bold (number), {\b} -> null
*/
export class Bold {
constructor(private _value: Object) { }
constructor(private _value: boolean | number | null) { }
/**
* The value of this bold tag.
*
* @type {?boolean|?number}
*/
get value(): Object {
get value(): boolean | number | null {
return this._value;
}
}
@@ -204,14 +206,14 @@ export class Bold {
* @param {?boolean} value {\u1} -> true, {\u0} -> false, {\u} -> null
*/
export class Underline {
constructor(private _value: boolean) { }
constructor(private _value: boolean | null) { }
/**
* The value of this underline tag.
*
* @type {?boolean}
*/
get value(): boolean {
get value(): boolean | null {
return this._value;
}
}
@@ -222,14 +224,14 @@ export class Underline {
* @param {?boolean} value {\s1} -> true, {\s0} -> false, {\s} -> null
*/
export class StrikeThrough {
constructor(private _value: boolean) { }
constructor(private _value: boolean | null) { }
/**
* The value of this strike-through tag.
*
* @type {?boolean}
*/
get value(): boolean {
get value(): boolean | null {
return this._value;
}
}
@@ -240,14 +242,14 @@ export class StrikeThrough {
* @param {?number} value {\bord###} -> width (number), {\bord} -> null
*/
export class Border {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this border tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -258,14 +260,14 @@ export class Border {
* @param {?number} value {\xbord###} -> width (number), {\xbord} -> null
*/
export class BorderX {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this horizontal border tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -276,14 +278,14 @@ export class BorderX {
* @param {?number} value {\ybord###} -> height (number), {\ybord} -> null
*/
export class BorderY {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this vertical border tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -294,14 +296,14 @@ export class BorderY {
* @param {?number} value {\shad###} -> depth (number), {\shad} -> null
*/
export class Shadow {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this shadow tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -312,14 +314,14 @@ export class Shadow {
* @param {?number} value {\xshad###} -> depth (number), {\xshad} -> null
*/
export class ShadowX {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this horizontal shadow tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -330,14 +332,14 @@ export class ShadowX {
* @param {?number} value {\yshad###} -> depth (number), {\yshad} -> null
*/
export class ShadowY {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this vertical shadow tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -348,14 +350,14 @@ export class ShadowY {
* @param {?number} value {\be###} -> strength (number), {\be} -> null
*/
export class Blur {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this blur tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -366,14 +368,14 @@ export class Blur {
* @param {?number} value {\blur###} -> strength (number), {\blur} -> null
*/
export class GaussianBlur {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this Gaussian blur tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -384,14 +386,14 @@ export class GaussianBlur {
* @param {?string} value {\fn###} -> name (string), {\fn} -> null
*/
export class FontName {
constructor(private _value: string) { }
constructor(private _value: string | null) { }
/**
* The value of this font name tag.
*
* @type {?string}
*/
get value(): string {
get value(): string | null {
return this._value;
}
}
@@ -402,14 +404,14 @@ export class FontName {
* @param {?number} value {\fs###} -> size (number), {\fs} -> null
*/
export class FontSize {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this font size tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -417,7 +419,7 @@ export class FontSize {
/**
* A font size increase tag {\fs+}
*
* @param {number} value {\fs+###} -> difference (number)
* @param {number} value {\fs+###} -> relative difference (number, percentage)
*/
export class FontSizePlus {
constructor(private _value: number) { }
@@ -435,7 +437,7 @@ export class FontSizePlus {
/**
* A font size decrease tag {\fs-}
*
* @param {number} value {\fs-###} -> difference (number)
* @param {number} value {\fs-###} -> relative difference (number, percentage)
*/
export class FontSizeMinus {
constructor(private _value: number) { }
@@ -456,14 +458,14 @@ export class FontSizeMinus {
* @param {?number} value {\fscx###} -> scale (number), {\fscx} -> null
*/
export class FontScaleX {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this horizontal font scaling tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -474,14 +476,14 @@ export class FontScaleX {
* @param {?number} value {\fscy###} -> scale (number), {\fscy} -> null
*/
export class FontScaleY {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this vertical font scaling tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -492,14 +494,14 @@ export class FontScaleY {
* @param {?number} value {\fsp###} -> spacing (number), {\fsp} -> null
*/
export class LetterSpacing {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this letter-spacing tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -510,14 +512,14 @@ export class LetterSpacing {
* @param {?number} value {\frx###} -> angle (number), {\frx} -> null
*/
export class RotateX {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this X-axis rotation tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -528,14 +530,14 @@ export class RotateX {
* @param {?number} value {\fry###} -> angle (number), {\fry} -> null
*/
export class RotateY {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this Y-axis rotation tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -546,14 +548,14 @@ export class RotateY {
* @param {?number} value {\frz###} -> angle (number), {\frz} -> null
*/
export class RotateZ {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this Z-axis rotation tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -564,14 +566,14 @@ export class RotateZ {
* @param {?number} value {\fax###} -> angle (number), {\fax} -> null
*/
export class SkewX {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this X-axis shearing tag.
*
* @type {?number}
*/
get value() {
get value(): number | null {
return this._value;
}
}
@@ -582,14 +584,14 @@ export class SkewX {
* @param {?number} value {\fay###} -> angle (number), {\fay} -> null
*/
export class SkewY {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this Y-axis shearing tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -600,14 +602,14 @@ export class SkewY {
* @param {libjass.parts.Color} value {\1c###} -> color (Color), {\1c} -> null
*/
export class PrimaryColor {
constructor(private _value: Color) { }
constructor(private _value: Color | null) { }
/**
* The value of this primary color tag.
*
* @type {libjass.parts.Color}
*/
get value(): Color {
get value(): Color | null {
return this._value;
}
}
@@ -618,14 +620,14 @@ export class PrimaryColor {
* @param {libjass.parts.Color} value {\2c###} -> color (Color), {\2c} -> null
*/
export class SecondaryColor {
constructor(private _value: Color) { }
constructor(private _value: Color | null) { }
/**
* The value of this secondary color tag.
*
* @type {libjass.parts.Color}
*/
get value(): Color {
get value(): Color | null {
return this._value;
}
}
@@ -636,14 +638,14 @@ export class SecondaryColor {
* @param {libjass.parts.Color} value {\3c###} -> color (Color), {\3c} -> null
*/
export class OutlineColor {
constructor(private _value: Color) { }
constructor(private _value: Color | null) { }
/**
* The value of this outline color tag.
*
* @type {libjass.parts.Color}
*/
get value(): Color {
get value(): Color | null {
return this._value;
}
}
@@ -654,14 +656,14 @@ export class OutlineColor {
* @param {libjass.parts.Color} value {\4c###} -> color (Color), {\4c} -> null
*/
export class ShadowColor {
constructor(private _value: Color) { }
constructor(private _value: Color | null) { }
/**
* The value of this shadow color tag.
*
* @type {libjass.parts.Color}
*/
get value(): Color {
get value(): Color | null {
return this._value;
}
}
@@ -672,14 +674,14 @@ export class ShadowColor {
* @param {?number} value {\alpha###} -> alpha (number), {\alpha} -> null
*/
export class Alpha {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this alpha tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -690,14 +692,14 @@ export class Alpha {
* @param {?number} value {\1a###} -> alpha (number), {\1a} -> null
*/
export class PrimaryAlpha {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this primary alpha tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -708,14 +710,14 @@ export class PrimaryAlpha {
* @param {?number} value {\2a###} -> alpha (number), {\2a} -> null
*/
export class SecondaryAlpha {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this secondary alpha tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -726,14 +728,14 @@ export class SecondaryAlpha {
* @param {?number} value {\3a###} -> alpha (number), {\3a} -> null
*/
export class OutlineAlpha {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this outline alpha tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -744,14 +746,14 @@ export class OutlineAlpha {
* @param {?number} value {\4a###} -> alpha (number), {\4a} -> null
*/
export class ShadowAlpha {
constructor(private _value: number) { }
constructor(private _value: number | null) { }
/**
* The value of this shadow alpha tag.
*
* @type {?number}
*/
get value(): number {
get value(): number | null {
return this._value;
}
}
@@ -767,7 +769,7 @@ export class Alignment {
/**
* The value of this alignment tag.
*
* @type {?number}
* @type {number}
*/
get value(): number {
return this._value;
@@ -852,14 +854,14 @@ export class WrappingStyle {
* @param {?string} value {\r###} -> style name (string), {\r} -> null
*/
export class Reset {
constructor(private _value: string) { }
constructor(private _value: string | null) { }
/**
* The value of this style reset tag.
*
* @type {?string}
*/
get value(): string {
get value(): string | null {
return this._value;
}
}
@@ -899,11 +901,11 @@ export class Position {
* @param {number} y1
* @param {number} x2
* @param {number} y2
* @param {number} t1
* @param {number} t2
* @param {?number} t1
* @param {?number} t2
*/
export class Move {
constructor(private _x1: number, private _y1: number, private _x2: number, private _y2: number, private _t1: number, private _t2: number) { }
constructor(private _x1: number, private _y1: number, private _x2: number, private _y2: number, private _t1: number | null, private _t2: number | null) { }
/**
* The starting x value of this move tag.
@@ -944,18 +946,18 @@ export class Move {
/**
* The start time of this move tag.
*
* @type {number}
* @type {?number}
*/
get t1(): number {
get t1(): number | null {
return this._t1;
}
/**
* The end time value of this move tag.
*
* @type {number}
* @type {?number}
*/
get t2(): number {
get t2(): number | null {
return this._t2;
}
}
@@ -1030,7 +1032,7 @@ export class Fade {
export class ComplexFade {
constructor(
private _a1: number, private _a2: number, private _a3: number,
private _t1: number, private _t2: number, private _t3: number, private _t4: number
private _t1: number, private _t2: number, private _t3: number, private _t4: number,
) { }
/**
@@ -1100,20 +1102,20 @@ export class ComplexFade {
/**
* A transform tag {\t}
*
* @param {number} start
* @param {number} end
* @param {number} accel
* @param {?number} start
* @param {?number} end
* @param {?number} accel
* @param {!Array.<!libjass.parts.Tag>} tags
*/
export class Transform {
constructor(private _start: number, private _end: number, private _accel: number, private _tags: Part[]) { }
constructor(private _start: number | null, private _end: number | null, private _accel: number | null, private _tags: Part[]) { }
/**
* The starting time of this transform tag.
*
* @type {?number}
*/
get start(): number {
get start(): number | null {
return this._start;
}
@@ -1122,7 +1124,7 @@ export class Transform {
*
* @type {?number}
*/
get end(): number {
get end(): number | null {
return this._end;
}
@@ -1131,7 +1133,7 @@ export class Transform {
*
* @type {?number}
*/
get accel(): number {
get accel(): number | null {
return this._accel;
}
@@ -1295,37 +1297,30 @@ export class DrawingInstructions {
}
}
const addToString = function (ctor: Function, ctorName: string) {
const addToString = function (ctor: Function, ctorName: string): void {
if (!ctor.prototype.hasOwnProperty("toString")) {
const propertyNames = Object.getOwnPropertyNames(ctor.prototype).filter(property => property !== "constructor");
ctor.prototype.toString = function () {
return (
ctorName + " { " +
propertyNames.map(name => `${ name }: ${ (<any>this)[name] }`).join(", ") +
((propertyNames.length > 0) ? " " : "") +
"}"
);
}
ctor.prototype.toString = function (this: any): string {
return `${ ctorName } { ${ propertyNames.map(name => `${ name }: ${ this[name] }`).join(", ") }${ (propertyNames.length > 0) ? " " : "" }}`;
};
}
};
import { registerClassPrototype } from "../webworker/misc";
declare const exports: any;
import { registerClass } from "../serialization";
for (const key of Object.keys(exports)) {
const value: any = exports[key];
if (value instanceof Function) {
addToString(value, key);
registerClassPrototype(value.prototype);
registerClass(value);
}
}
for (const key of Object.keys(drawing)) {
const value: any = (<any>drawing)[key];
const value: any = (drawing as any)[key];
if (value instanceof Function) {
addToString(value, `Drawing${ key }`);
registerClassPrototype(value.prototype);
registerClass(value);
}
}
+6 -6
View File
@@ -41,10 +41,10 @@ import { ManualClock } from "./manual";
export class AutoClock implements Clock {
private _manualClock: ManualClock = new ManualClock();
private _nextAnimationFrameRequestId: number = null;
private _nextAnimationFrameRequestId: number | null = null;
private _lastKnownExternalTime: number = null;
private _lastKnownExternalTimeObtainedAt: number = null;
private _lastKnownExternalTime: number | null = null;
private _lastKnownExternalTimeObtainedAt: number = 0;
constructor(private _getCurrentTime: () => number, private _autoPauseAfter: number) { }
@@ -193,7 +193,7 @@ export class AutoClock implements Clock {
*/
addEventListener(type: ClockEvent, listener: Function): void {
this._manualClock.addEventListener(type, listener);
};
}
/**
* @param {number} timeStamp
@@ -213,8 +213,8 @@ export class AutoClock implements Clock {
if (!this._manualClock.paused) {
if (this._lastKnownExternalTime !== null && currentExternalTime === this._lastKnownExternalTime) {
if (timeStamp - this._lastKnownExternalTimeObtainedAt > this._autoPauseAfter) {
this._lastKnownExternalTimeObtainedAt = null;
this._manualClock.pause();
this._lastKnownExternalTimeObtainedAt = 0;
this._manualClock.seek(currentExternalTime);
}
else {
this._manualClock.tick((timeStamp - this._lastKnownExternalTimeObtainedAt) / 1000 * this._manualClock.rate + this._lastKnownExternalTime);
-2
View File
@@ -18,8 +18,6 @@
* limitations under the License.
*/
import { Map } from "../../utility/map";
/**
* A mixin class that represents an event source.
*/
+5 -1
View File
@@ -18,8 +18,8 @@
* limitations under the License.
*/
import { mixin } from "../../utility/mixin";
import { Map } from "../../utility/map";
import { mixin } from "../../utility/mixin";
import { Clock, ClockEvent, EventSource } from "./base";
@@ -226,6 +226,8 @@ export class ManualClock implements Clock, EventSource<ClockEvent> {
}
}
/* tslint:disable:member-ordering */
// EventSource members
/**
@@ -242,5 +244,7 @@ export class ManualClock implements Clock, EventSource<ClockEvent> {
* @type {function(number, Array.<*>)}
*/
_dispatchEvent: (type: ClockEvent, args: Object[]) => void;
/* tslint:enable:member-ordering */
}
mixin(ManualClock, [EventSource]);
+1 -1
View File
@@ -35,7 +35,7 @@ export class DefaultRenderer extends WebRenderer {
constructor(private _video: HTMLVideoElement, ass: ASS, settings?: RendererSettings) {
super(ass, new VideoClock(_video), document.createElement("div"), settings);
this._video.parentElement.replaceChild(this.libjassSubsWrapper, this._video);
this._video.parentElement!.replaceChild(this.libjassSubsWrapper, this._video);
this.libjassSubsWrapper.insertBefore(this._video, this.libjassSubsWrapper.firstElementChild);
}
+22 -15
View File
@@ -18,15 +18,15 @@
* limitations under the License.
*/
import { Clock, ClockEvent } from "./clocks/base";
import { RendererSettings } from "./settings";
import { verboseMode } from "../settings";
import { debugMode, verboseMode } from "../settings";
import { ASS } from "../types/ass";
import { Dialogue } from "../types/dialogue";
import { Clock, ClockEvent } from "./clocks/base";
import { RendererSettings } from "./settings";
/**
* A renderer implementation that doesn't output anything.
*
@@ -35,7 +35,7 @@ import { Dialogue } from "../types/dialogue";
* @param {libjass.renderers.RendererSettings} settings
*/
export class NullRenderer {
private static _lastRendererId = -1;
private static _lastRendererId: number = -1;
private _id: number;
@@ -88,14 +88,14 @@ export class NullRenderer {
*
* @param {!libjass.Dialogue} dialogue
*/
preRender(dialogue: Dialogue): void { }
preRender(_dialogue: Dialogue): void { }
/**
* Draw a dialogue. This is a no-op for this type.
*
* @param {!libjass.Dialogue} dialogue
*/
draw(dialogue: Dialogue): void { }
draw(_dialogue: Dialogue): void { }
/**
* Enable the renderer.
@@ -159,14 +159,21 @@ export class NullRenderer {
}
for (const dialogue of this._ass.dialogues) {
if (dialogue.end > currentTime) {
if (dialogue.start <= currentTime) {
// This dialogue is visible right now. Draw it.
this.draw(dialogue);
try {
if (dialogue.end > currentTime) {
if (dialogue.start <= currentTime) {
// This dialogue is visible right now. Draw it.
this.draw(dialogue);
}
else if (dialogue.start <= (currentTime + this._settings.preRenderTime)) {
// This dialogue will be visible soon. Pre-render it.
this.preRender(dialogue);
}
}
else if (dialogue.start <= (currentTime + this._settings.preRenderTime)) {
// This dialogue will be visible soon. Pre-render it.
this.preRender(dialogue);
}
catch (ex) {
if (debugMode) {
console.error(`Rendering dialogue ${ dialogue.id } failed.`, ex);
}
}
}
+135 -63
View File
@@ -18,12 +18,85 @@
* limitations under the License.
*/
import { debugMode } from "../settings";
import { Map } from "../utility/map";
/**
* Settings for the renderer.
*/
export class RendererSettings {
/**
* A convenience method to create a font map from a <style> or <link> element that contains @font-face rules. There should be one @font-face rule for each font name, mapping to a font file URL.
*
* For example:
*
* @font-face {
* font-family: "Helvetica";
* src: url("/fonts/helvetica.ttf"), local("Arial");
* }
*
* More complicated @font-face syntax like format() or multi-line src are not supported.
*
* @param {!LinkStyle} linkStyle
* @return {!Map.<string, string>}
*/
static makeFontMapFromStyleElement(linkStyle: LinkStyle): Map<string, string> {
const fontMap = new Map<string, string>();
const styleSheet = linkStyle.sheet as CSSStyleSheet;
/* tslint:disable-next-line:prefer-for-of */
for (let i = 0; i < styleSheet.cssRules.length; i++) {
const rule = styleSheet.cssRules[i];
if (isFontFaceRule(rule)) {
const name = rule.style.getPropertyValue("font-family").match(/^["']?(.*?)["']?$/)![1];
let src = rule.style.getPropertyValue("src");
if (!src) {
src = rule.cssText.split("\n")
.map(line => line.match(/src:\s*([^;]+?)\s*;/))
.filter((matches): matches is RegExpMatchArray => matches !== null)
.map(matches => matches[1])[0];
}
fontMap.set(name, src);
}
}
return fontMap;
}
/**
* Converts an arbitrary object into a {@link libjass.renderers.RendererSettings} object.
*
* @param {*} object
* @return {!libjass.renderers.RendererSettings}
*/
static from(object?: any): RendererSettings {
if (object === undefined || object === null) {
object = {};
}
const {
fontMap = null,
preRenderTime = 5,
preciseOutlines = false,
enableSvg = testSupportsSvg(),
fallbackFonts = 'Arial, Helvetica, sans-serif, "Segoe UI Symbol"',
useAttachedFonts = false,
} = object as RendererSettings;
const result = new RendererSettings();
result.fontMap = fontMap;
result.preRenderTime = preRenderTime;
result.preciseOutlines = preciseOutlines;
result.enableSvg = enableSvg;
result.fallbackFonts = fallbackFonts;
result.useAttachedFonts = useAttachedFonts;
return result;
}
/**
* A map of font name to one or more URLs of that font. If provided, the fonts in this map are pre-loaded by the WebRenderer when it's created.
*
@@ -42,9 +115,9 @@ export class RendererSettings {
*
* Defaults to null.
*
* @type {!Map.<string, (string|!Array.<string>)>}
* @type {Map.<string, (string|!Array.<string>)>}
*/
fontMap: Map<string, string | string[]>;
fontMap: Map<string, string | string[]> | null;
/**
* Subtitles will be pre-rendered for this amount of time (seconds).
@@ -96,67 +169,6 @@ export class RendererSettings {
* @type {boolean}
*/
useAttachedFonts: boolean;
/**
* A convenience method to create a font map from a <style> or <link> element that contains @font-face rules. There should be one @font-face rule for each font name, mapping to a font file URL.
*
* For example:
*
* @font-face {
* font-family: "Helvetica";
* src: url("/fonts/helvetica.ttf"), local("Arial");
* }
*
* @param {!LinkStyle} linkStyle
* @return {!Map.<string, string>}
*/
static makeFontMapFromStyleElement(linkStyle: LinkStyle): Map<string, string> {
const fontMap = new Map<string, string>();
const styleSheet = <CSSStyleSheet>linkStyle.sheet;
for (let i = 0; i < styleSheet.cssRules.length; i++) {
const rule = styleSheet.cssRules[i];
if (isFontFaceRule(rule)) {
const name = rule.style.getPropertyValue("font-family").match(/^["']?(.*?)["']?$/)[1];
let src = rule.style.getPropertyValue("src");
if (!src) {
src = rule.cssText.split("\n")
.map(line => line.match(/src:\s*([^;]+?)\s*;/))
.filter(matches => matches !== null)
.map(matches => matches[1])[0];
}
fontMap.set(name, src);
}
}
return fontMap;
}
/**
* Converts an arbitrary object into a {@link libjass.renderers.RendererSettings} object.
*
* @param {*} object
* @return {!libjass.renderers.RendererSettings}
*/
static from(object?: any): RendererSettings {
if (object === undefined || object === null) {
object = {};
}
const { fontMap = null, preRenderTime = 5, preciseOutlines = false, enableSvg = true, fallbackFonts = 'Arial, Helvetica, sans-serif, "Segoe UI Symbol"', useAttachedFonts = false } = <RendererSettings>object;
const result = new RendererSettings();
result.fontMap = fontMap;
result.preRenderTime = preRenderTime;
result.preciseOutlines = preciseOutlines;
result.enableSvg = enableSvg;
result.fallbackFonts = fallbackFonts;
result.useAttachedFonts = useAttachedFonts;
return result;
}
}
/**
@@ -166,3 +178,63 @@ export class RendererSettings {
function isFontFaceRule(rule: CSSRule): rule is CSSFontFaceRule {
return rule.type === CSSRule.FONT_FACE_RULE;
}
/**
* Returns true if this environment may support SVG filter effects. May return false positives.
*
* @return {boolean}
*/
function testSupportsSvg(): boolean {
if (debugMode) {
console.log("Testing whether SVG filter effects are supported.");
}
if (global.document === undefined) {
if (debugMode) {
console.log("This doesn't look like a browser. Assuming it doesn't support SVG filter effects.");
}
return false;
}
const morphologyFilter = document.createElementNS("http://www.w3.org/2000/svg", "feMorphology");
// https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/6618301/
try {
morphologyFilter.radiusX.baseVal = 1;
}
catch (ex) {
if (debugMode) {
if (ex instanceof DOMException) {
const domException = ex as DOMException;
if (domException.code === DOMException.NO_MODIFICATION_ALLOWED_ERR) {
console.log("Setting SVGFEMorphologyElement.radiusX.baseVal threw NoModificationAllowedError. This browser doesn't support SVG DOM correctly.");
}
else {
console.log(`Setting SVGFEMorphologyElement.radiusX.baseVal threw unexpected DOMException code ${ domException.code }. This browser doesn't support SVG DOM correctly.`);
}
}
else {
console.log(`Setting SVGFEMorphologyElement.radiusX.baseVal threw unexpected exception ${ ex }. This browser doesn't support SVG SVG DOM correctly.`);
}
}
return false;
}
// https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/6618454/
morphologyFilter.setAttribute("radius", "1");
if (morphologyFilter.cloneNode().getAttribute("radius") !== "1") {
if (debugMode) {
console.log("SVGFEMorphologyElement's radius attribute was corrupted when cloned. This browser doesn't support SVG DOM correctly.");
}
return false;
}
if (debugMode) {
console.log("This browser may support SVG filter effects.");
}
return true;
}
+6 -2
View File
@@ -71,8 +71,8 @@ export class AnimationCollection {
* @param {!Array.<!libjass.renderers.Keyframe>} keyframes
*/
add(timingFunction: string, keyframes: Keyframe[]): void {
let start: number = null;
let end: number = null;
let start: number | null = null;
let end: number | null = null;
for (const keyframe of keyframes) {
if (start === null) {
@@ -82,6 +82,10 @@ export class AnimationCollection {
end = keyframe.time;
}
if (start === null || end === null) {
throw new Error("Atleast one keyframe must be provided.");
}
let ruleCssText = "";
for (const keyframe of keyframes) {
+48 -15
View File
@@ -54,43 +54,76 @@ export class DrawingStyles {
* @return {!SVGSVGElement}
*/
toSVG(drawingInstructions: parts.DrawingInstructions, fillColor: parts.Color): SVGSVGElement {
const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svg.setAttribute("version", "1.1");
if (drawingInstructions.instructions.length === 0) {
return svg;
}
const scaleFactor = Math.pow(2, this._scale - 1);
const scaleX = this._outputScaleX / scaleFactor;
const scaleY = this._outputScaleY / scaleFactor;
const path = document.createElementNS("http://www.w3.org/2000/svg", "path");
let pathString = "";
let bboxWidth = 0;
let bboxHeight = 0;
let bboxMinX = Infinity;
let bboxMaxX = -Infinity;
let bboxMinY = Infinity;
let bboxMaxY = -Infinity;
for (const instruction of drawingInstructions.instructions) {
if (instruction instanceof parts.drawing.MoveInstruction) {
path.pathSegList.appendItem(path.createSVGPathSegMovetoAbs(instruction.x, instruction.y + this._baselineOffset));
bboxWidth = Math.max(bboxWidth, instruction.x);
bboxHeight = Math.max(bboxHeight, instruction.y + this._baselineOffset);
pathString += ` M ${ instruction.x.toFixed(3) } ${ (instruction.y + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x);
bboxMaxX = Math.max(bboxMaxX, instruction.x);
bboxMinY = Math.min(bboxMinY, instruction.y + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y + this._baselineOffset);
}
else if (instruction instanceof parts.drawing.LineInstruction) {
path.pathSegList.appendItem(path.createSVGPathSegLinetoAbs(instruction.x, instruction.y + this._baselineOffset));
bboxWidth = Math.max(bboxWidth, instruction.x);
bboxHeight = Math.max(bboxHeight, instruction.y + this._baselineOffset);
pathString += ` L ${ instruction.x.toFixed(3) } ${ (instruction.y + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x);
bboxMaxX = Math.max(bboxMaxX, instruction.x);
bboxMinY = Math.min(bboxMinY, instruction.y + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y + this._baselineOffset);
}
else if (instruction instanceof parts.drawing.CubicBezierCurveInstruction) {
path.pathSegList.appendItem(path.createSVGPathSegCurvetoCubicAbs(instruction.x3, instruction.y3 + this._baselineOffset, instruction.x1, instruction.y1 + this._baselineOffset, instruction.x2, instruction.y2 + this._baselineOffset));
bboxWidth = Math.max(bboxWidth, instruction.x1, instruction.x2, instruction.x3);
bboxHeight = Math.max(bboxHeight, instruction.y1 + this._baselineOffset, instruction.y2 + this._baselineOffset, instruction.y3 + this._baselineOffset);
pathString += ` C ${ instruction.x1.toFixed(3) } ${ (instruction.y1 + this._baselineOffset).toFixed(3) } ${ instruction.x2.toFixed(3) } ${ (instruction.y2 + this._baselineOffset).toFixed(3) } ${ instruction.x3.toFixed(3) } ${ (instruction.y3 + this._baselineOffset).toFixed(3) }`;
bboxMinX = Math.min(bboxMinX, instruction.x1, instruction.x2, instruction.x3);
bboxMaxX = Math.max(bboxMaxX, instruction.x1, instruction.x2, instruction.x3);
bboxMinY = Math.min(bboxMinY, instruction.y1 + this._baselineOffset, instruction.y2 + this._baselineOffset, instruction.y3 + this._baselineOffset);
bboxMaxY = Math.max(bboxMaxY, instruction.y1 + this._baselineOffset, instruction.y2 + this._baselineOffset, instruction.y3 + this._baselineOffset);
}
}
const svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svg.setAttribute("version", "1.1");
svg.width.baseVal.valueAsString = `${ (bboxWidth * scaleX).toFixed(3) }px`;
svg.height.baseVal.valueAsString = `${ (bboxHeight * scaleY).toFixed(3) }px`;
bboxMinX *= scaleX;
bboxMaxX *= scaleX;
bboxMinY *= scaleY;
bboxMaxY *= scaleY;
const bboxWidth = bboxMaxX - bboxMinX;
const bboxHeight = bboxMaxY - bboxMinY;
svg.width.baseVal.valueAsString = `${ bboxWidth.toFixed(3) }px`;
svg.height.baseVal.valueAsString = `${ bboxHeight.toFixed(3) }px`;
// svg.viewBox.baseVal is null in atleast FF. See https://bugzilla.mozilla.org/show_bug.cgi?id=888307 which justifies it with SVG 1.2 spec.
svg.setAttribute("viewBox", `${ bboxMinX } ${ bboxMinY } ${ bboxWidth } ${ bboxHeight }`);
svg.style.position = "relative";
svg.style.left = `${ bboxMinX.toFixed(3) }px`;
svg.style.top = `${ bboxMinY.toFixed(3) }px`;
const g = document.createElementNS("http://www.w3.org/2000/svg", "g");
svg.appendChild(g);
g.setAttribute("transform", `scale(${ scaleX.toFixed(3) } ${ scaleY.toFixed(3) })`);
g.appendChild(path);
path.setAttribute("d", pathString);
path.setAttribute("fill", fillColor.toString());
return svg;
+3 -6
View File
@@ -18,7 +18,6 @@
* limitations under the License.
*/
import { Map } from "../../utility/map";
import { Promise } from "../../utility/promise";
/**
@@ -47,7 +46,7 @@ function prepareFontSizeElement(fontFamily: string, fontSize: number, fallbackFo
function lineHeightForFontSize(fontFamily: string, fontSize: number, fallbackFonts: string, fontSizeElement: HTMLDivElement): Promise<number> {
prepareFontSizeElement(fontFamily, fontSize, fallbackFonts, fontSizeElement);
return new Promise(resolve => setTimeout(() => resolve(fontSizeElement.offsetHeight), 1000));
return new Promise<number>(resolve => setTimeout(() => resolve(fontSizeElement.offsetHeight), 1000));
}
/**
@@ -78,14 +77,12 @@ function fontMetricsFromLineHeights(lowerLineHeight: number, upperLineHeight: nu
* @param {string} fontFamily
* @param {string} fallbackFonts
* @param {!HTMLDivElement} fontSizeElement
* @return {!Promise.<number>}
* @return {!Promise.<[number, number]>}
*/
export function calculateFontMetrics(fontFamily: string, fallbackFonts: string, fontSizeElement: HTMLDivElement): Promise<[number, number]> {
return lineHeightForFontSize(fontFamily, 180, fallbackFonts, fontSizeElement).then(lowerLineHeight =>
lineHeightForFontSize(fontFamily, 360, fallbackFonts, fontSizeElement).then(upperLineHeight =>
fontMetricsFromLineHeights(lowerLineHeight, upperLineHeight)
)
);
fontMetricsFromLineHeights(lowerLineHeight, upperLineHeight)));
}
/**
-2
View File
@@ -18,8 +18,6 @@
* limitations under the License.
*/
import { Map } from "../../utility/map";
/**
* This class represents a single keyframe. It has a list of CSS properties (names and values) associated with a point in time. Multiple keyframes make up an animation.
*
File diff suppressed because it is too large Load Diff
+309 -199
View File
@@ -18,20 +18,16 @@
* limitations under the License.
*/
import { AnimationCollection } from "./animation-collection";
import { Color } from "../../parts";
import { fontSizeForLineHeight } from "./font-size";
import { WebRenderer } from "./renderer";
import { Dialogue } from "../../types/dialogue";
import { Style } from "../../types/style";
import { RendererSettings } from "../settings";
import { Color } from "../../parts";
import { Style } from "../../types/style";
import { Dialogue } from "../../types/dialogue";
import { Map } from "../../utility/map";
import { AnimationCollection } from "./animation-collection";
import { fontSizeForLineHeight } from "./font-size";
import { WebRenderer } from "./renderer";
/**
* This class represents the style attribute of a span.
@@ -51,7 +47,7 @@ export class SpanStyles {
private _defaultStyle: Style;
private _italic: boolean;
private _bold: Object;
private _bold: boolean | number;
private _underline: boolean;
private _strikeThrough: boolean;
@@ -89,7 +85,7 @@ export class SpanStyles {
private _blur: number;
private _gaussianBlur: number;
private _nextFilterId = 0;
private _nextFilterId: number = 0;
constructor(renderer: WebRenderer, dialogue: Dialogue, private _scaleX: number, private _scaleY: number, private _settings: RendererSettings, private _fontSizeElement: HTMLDivElement, private _svgDefsElement: SVGDefsElement, private _fontMetricsCache: Map<string, [number, number]>) {
this._id = `${ renderer.id }-${ dialogue.id }`;
@@ -103,7 +99,7 @@ export class SpanStyles {
*
* @param {libjass.Style} newStyle The new defaults to reset the style to. If null, the styles are reset to the default style of the Dialogue.
*/
reset(newStyle: Style): void {
reset(newStyle: Style | undefined | null): void {
if (newStyle === undefined || newStyle === null) {
newStyle = this._defaultStyle;
}
@@ -127,12 +123,12 @@ export class SpanStyles {
this.letterSpacing = newStyle.letterSpacing;
this._rotationX = null;
this._rotationY = null;
this._rotationZ = newStyle.rotationZ;
this.rotationX = 0;
this.rotationY = 0;
this.rotationZ = newStyle.rotationZ;
this._skewX = null;
this._skewY = null;
this.skewX = 0;
this.skewY = 0;
this.primaryColor = newStyle.primaryColor;
this.secondaryColor = newStyle.secondaryColor;
@@ -144,8 +140,8 @@ export class SpanStyles {
this.outlineAlpha = newStyle.outlineColor.alpha;
this.shadowAlpha = newStyle.shadowColor.alpha;
this.blur = null;
this.gaussianBlur = null;
this.blur = null as any as number;
this.gaussianBlur = null as any as number;
}
/**
@@ -166,13 +162,11 @@ export class SpanStyles {
fontStyleOrWeight += "bold ";
}
else if (this._bold !== false) {
fontStyleOrWeight += this._bold + " ";
fontStyleOrWeight += this._bold.toFixed(0) + " ";
}
const fontSize = (
this._scaleY *
fontSizeForLineHeight(this._fontName, this._fontSize * (isTextOnlySpan ? this._fontScaleX : 1), this._settings.fallbackFonts, this._fontSizeElement, this._fontMetricsCache)
).toFixed(3);
const lineHeight = (this._scaleY * this._fontSize).toFixed(3);
const lineHeight = this._scaleY * (isTextOnlySpan ? this._fontScaleX : 1) * this._fontSize;
const fontSize = fontSizeForLineHeight(this._fontName, lineHeight, this._settings.fallbackFonts, this._fontSizeElement, this._fontMetricsCache);
let fonts = this._fontName;
@@ -193,7 +187,7 @@ export class SpanStyles {
fonts += `, ${ this._settings.fallbackFonts }`;
}
span.style.font = `${ fontStyleOrWeight }${ fontSize }px/${ lineHeight }px ${ fonts }`;
span.style.font = `${ fontStyleOrWeight }${ fontSize.toFixed(3) }px/${ lineHeight.toFixed(3) }px ${ fonts }`;
let textDecoration = "";
if (this._underline) {
@@ -218,19 +212,8 @@ export class SpanStyles {
transform += `scaleY(${ this._fontScaleY }) `;
}
}
if (this._rotationY !== null) {
transform += `rotateY(${ this._rotationY }deg) `;
}
if (this._rotationX !== null) {
transform += `rotateX(${ this._rotationX }deg) `;
}
if (this._rotationZ !== 0) {
transform += `rotateZ(${ -1 * this._rotationZ }deg) `;
}
if (this._skewX !== null || this._skewY !== null) {
const skewX = SpanStyles._valueOrDefault(this._skewX, 0);
const skewY = SpanStyles._valueOrDefault(this._skewY, 0);
transform += `matrix(1, ${ skewY }, ${ skewX }, 1, 0, 0) `;
if (this._skewX !== 0 || this._skewY !== 0) {
transform += `matrix(1, ${ this._skewY }, ${ this._skewX }, 1, 0, 0) `;
}
if (transform !== "") {
span.style.webkitTransform = transform;
@@ -244,9 +227,8 @@ export class SpanStyles {
const outlineWidth = this._scaleX * this._outlineWidth;
const outlineHeight = this._scaleY * this._outlineHeight;
const filterWrapperSpan = document.createElement("span");
filterWrapperSpan.appendChild(span);
const shadowDepthX = this._scaleX * this._shadowDepthX;
const shadowDepthY = this._scaleY * this._shadowDepthY;
let primaryColor = this._primaryColor.withAlpha(this._primaryAlpha);
let outlineColor = this._outlineColor.withAlpha(this._outlineAlpha);
@@ -268,55 +250,83 @@ export class SpanStyles {
span.style.color = primaryColor.toString();
if (this._settings.enableSvg) {
this._setSvgOutlineOnSpan(filterWrapperSpan, outlineWidth, outlineHeight, outlineColor, this._primaryAlpha);
this._svg(
span,
outlineWidth, outlineHeight, outlineColor,
shadowDepthX, shadowDepthY, shadowColor,
);
}
else {
this._setTextShadowOutlineOnSpan(span, outlineWidth, outlineHeight, outlineColor);
}
if (this._shadowDepthX !== 0 || this._shadowDepthY !== 0) {
const shadowCssString = `${ shadowColor.toString() } ${ (this._shadowDepthX * this._scaleX).toFixed(3) }px ${ (this._shadowDepthY * this._scaleY).toFixed(3) }px 0px`;
if (span.style.textShadow === "") {
span.style.textShadow = shadowCssString;
}
else {
span.style.textShadow += ", " + shadowCssString;
}
this._textShadow(
span,
outlineWidth, outlineHeight, outlineColor,
shadowDepthX, shadowDepthY, shadowColor,
);
}
if (this._rotationX !== 0 || this._rotationY !== 0) {
// Perspective needs to be set on a "transformable element"
filterWrapperSpan.style.display = "inline-block";
span.style.display = "inline-block";
}
span.style.webkitAnimation = animationCollection.animationStyle;
span.style.animation = animationCollection.animationStyle;
return filterWrapperSpan;
return span;
}
/**
* @param {!HTMLSpanElement} filterWrapperSpan
* @return {!HTMLBRElement}
*/
makeNewLine(): HTMLBRElement {
const result = document.createElement("br");
result.style.lineHeight = `${ (this._scaleY * this._fontSize).toFixed(3) }px`;
return result;
}
/**
* @param {!HTMLSpanElement} span
* @param {number} outlineWidth
* @param {number} outlineHeight
* @param {!libjass.parts.Color} outlineColor
* @param {number} primaryAlpha
* @param {number} shadowDepthX
* @param {number} shadowDepthY
* @param {!libjass.parts.Color} shadowColor
*/
private _setSvgOutlineOnSpan(filterWrapperSpan: HTMLSpanElement, outlineWidth: number, outlineHeight: number, outlineColor: Color, primaryAlpha: number): void {
const filterId = `svg-filter-${ this._id }-${ this._nextFilterId++ }`;
private _svg(
span: HTMLSpanElement,
outlineWidth: number, outlineHeight: number, outlineColor: Color,
shadowDepthX: number, shadowDepthY: number, shadowColor: Color,
): void {
const filterElement = document.createElementNS("http://www.w3.org/2000/svg", "filter");
filterElement.id = filterId;
filterElement.x.baseVal.valueAsString = "-50%";
filterElement.width.baseVal.valueAsString = "200%";
filterElement.y.baseVal.valueAsString = "-50%";
filterElement.height.baseVal.valueAsString = "200%";
if (outlineWidth > 0 || outlineHeight > 0) {
if (outlineWidth > 0 || outlineHeight > 0 || shadowDepthX > 0 || shadowDepthY > 0) {
// Start with SourceAlpha. Leave the alpha as 0 if it's 0, and set it to 1 if it's greater than 0
const source = document.createElementNS("http://www.w3.org/2000/svg", "feComponentTransfer");
filterElement.appendChild(source);
source.in1.baseVal = "SourceAlpha";
source.result.baseVal = "source";
const sourceAlphaTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncA");
source.appendChild(sourceAlphaTransferNode);
sourceAlphaTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
sourceAlphaTransferNode.intercept.baseVal = 0;
/* The alphas of all colored pixels of the SourceAlpha should be made as close to 1 as possible. This way the summed outlines below will be uniformly dark.
* Multiply the pixels by 1 / primaryAlpha so that the primaryAlpha pixels become 1. A higher value would make the outline larger and too sharp,
* leading to jagged outer edge and transparent space around the inner edge between itself and the SourceGraphic.
*/
sourceAlphaTransferNode.slope.baseVal = (this._primaryAlpha === 0) ? 1 : (1 / this._primaryAlpha);
/* Construct an elliptical border by merging together many rectangles. The border is creating using dilate morphology filters, but these only support
* generating rectangles. http://lists.w3.org/Archives/Public/public-fx/2012OctDec/0003.html
*/
// Merge the individual outlines
const mergedOutlines = document.createElementNS("http://www.w3.org/2000/svg", "feMerge");
filterElement.appendChild(mergedOutlines);
mergedOutlines.result.baseVal = "outline-alpha";
let outlineNumber = 0;
const increment = (!this._settings.preciseOutlines && this._gaussianBlur > 0) ? this._gaussianBlur : 1;
@@ -351,78 +361,61 @@ export class SpanStyles {
}
}
})((x: number, y: number): void => {
const outlineId = `outline${ outlineNumber }`;
const outlineFilter = document.createElementNS("http://www.w3.org/2000/svg", "feMorphology");
filterElement.appendChild(outlineFilter);
filterElement.insertBefore(outlineFilter, mergedOutlines);
outlineFilter.in1.baseVal = "source";
outlineFilter.operator.baseVal = SVGFEMorphologyElement.SVG_MORPHOLOGY_OPERATOR_DILATE;
outlineFilter.radiusX.baseVal = x;
outlineFilter.radiusY.baseVal = y;
outlineFilter.result.baseVal = `outline${ outlineNumber }`;
outlineFilter.result.baseVal = outlineId;
const outlineReferenceNode = document.createElementNS("http://www.w3.org/2000/svg", "feMergeNode");
mergedOutlines.appendChild(outlineReferenceNode);
outlineReferenceNode.in1.baseVal = outlineId;
outlineNumber++;
});
// Start with SourceAlpha. Leave the alpha as 0 if it's 0, and set it to 1 if it's greater than 0
const source = document.createElementNS("http://www.w3.org/2000/svg", "feComponentTransfer");
filterElement.insertBefore(source, filterElement.firstElementChild);
source.in1.baseVal = "SourceAlpha";
source.result.baseVal = "source";
((addOutline: (x: number, y: number) => void) => {
if ((outlineWidth % 1) > 0) {
addOutline(outlineWidth, 0);
addOutline(-outlineWidth, 0);
}
const sourceAlphaTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncA");
source.appendChild(sourceAlphaTransferNode);
sourceAlphaTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
if ((outlineHeight % 1) > 0) {
addOutline(0, outlineHeight);
addOutline(0, -outlineHeight);
}
})((x: number, y: number): void => {
const outlineId = `outline${ outlineNumber }`;
/* The alphas of all colored pixels of the SourceAlpha should be made as close to 1 as possible. This way the summed outlines below will be uniformly dark.
* Multiply the pixels by 1 / primaryAlpha so that the primaryAlpha pixels become 1. A higher value would make the outline larger and too sharp,
* leading to jagged outer edge and transparent space around the inner edge between itself and the SourceGraphic.
*/
sourceAlphaTransferNode.slope.baseVal = (primaryAlpha === 0) ? 1 : (1 / primaryAlpha);
const outlineFilter = document.createElementNS("http://www.w3.org/2000/svg", "feOffset");
filterElement.insertBefore(outlineFilter, mergedOutlines);
outlineFilter.in1.baseVal = "source";
outlineFilter.dx.baseVal = x;
outlineFilter.dy.baseVal = y;
outlineFilter.result.baseVal = outlineId;
sourceAlphaTransferNode.intercept.baseVal = 0;
// Merge the individual outlines
const mergedOutlines = document.createElementNS("http://www.w3.org/2000/svg", "feMerge");
filterElement.appendChild(mergedOutlines);
for (let i = 0; i < outlineNumber; i++) {
const outlineReferenceNode = document.createElementNS("http://www.w3.org/2000/svg", "feMergeNode");
mergedOutlines.appendChild(outlineReferenceNode);
outlineReferenceNode.in1.baseVal = `outline${ i }`;
}
outlineReferenceNode.in1.baseVal = outlineId;
outlineNumber++;
});
// Color it with the outline color
const coloredSource = document.createElementNS("http://www.w3.org/2000/svg", "feComponentTransfer");
filterElement.appendChild(coloredSource);
coloredSource.setAttribute("color-interpolation-filters", "sRGB");
const outlineRedTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncR");
coloredSource.appendChild(outlineRedTransferNode);
outlineRedTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
outlineRedTransferNode.slope.baseVal = 0;
outlineRedTransferNode.intercept.baseVal = outlineColor.red / 255 * outlineColor.alpha;
const outlineGreenTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncG");
coloredSource.appendChild(outlineGreenTransferNode);
outlineGreenTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
outlineGreenTransferNode.slope.baseVal = 0;
outlineGreenTransferNode.intercept.baseVal = outlineColor.green / 255 * outlineColor.alpha;
const outlineBlueTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncB");
coloredSource.appendChild(outlineBlueTransferNode);
outlineBlueTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
outlineBlueTransferNode.slope.baseVal = 0;
outlineBlueTransferNode.intercept.baseVal = outlineColor.blue / 255 * outlineColor.alpha;
const outlineAlphaTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncA");
coloredSource.appendChild(outlineAlphaTransferNode);
outlineAlphaTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
outlineAlphaTransferNode.slope.baseVal = outlineColor.alpha;
outlineAlphaTransferNode.intercept.baseVal = 0;
const coloredOutline = createComponentTransferFilter(outlineColor);
filterElement.appendChild(coloredOutline);
coloredOutline.in1.baseVal = "outline-alpha";
// Blur the merged outline
if (this._gaussianBlur > 0) {
const gaussianBlurFilter = document.createElementNS("http://www.w3.org/2000/svg", "feGaussianBlur");
filterElement.appendChild(gaussianBlurFilter);
// Don't use setStdDeviation - cloneNode() clears it in Chrome
gaussianBlurFilter.stdDeviationX.baseVal = this._gaussianBlur;
gaussianBlurFilter.stdDeviationY.baseVal = this._gaussianBlur;
}
@@ -433,21 +426,65 @@ export class SpanStyles {
blurFilter.edgeMode.baseVal = SVGFEConvolveMatrixElement.SVG_EDGEMODE_NONE;
}
// Cut out the source, so only the outline remains
const outlineCutoutNode = document.createElementNS("http://www.w3.org/2000/svg", "feComposite");
filterElement.appendChild(outlineCutoutNode);
outlineCutoutNode.in2.baseVal = "source";
outlineCutoutNode.operator.baseVal = SVGFECompositeElement.SVG_FECOMPOSITE_OPERATOR_OUT;
// Cut out the source, so only the exterior remains
const cutoutNode = document.createElementNS("http://www.w3.org/2000/svg", "feComposite");
filterElement.appendChild(cutoutNode);
cutoutNode.in2.baseVal = "source";
cutoutNode.operator.baseVal = SVGFECompositeElement.SVG_FECOMPOSITE_OPERATOR_OUT;
cutoutNode.result.baseVal = "outline-colored";
// Merge the outline with the SourceGraphic
const mergedOutlineAndSourceGraphic = document.createElementNS("http://www.w3.org/2000/svg", "feMerge");
filterElement.appendChild(mergedOutlineAndSourceGraphic);
if (shadowDepthX > 0 || shadowDepthY > 0) {
const shadowFilter = document.createElementNS("http://www.w3.org/2000/svg", "feOffset");
filterElement.appendChild(shadowFilter);
shadowFilter.in1.baseVal = "outline-alpha";
shadowFilter.dx.baseVal = shadowDepthX;
shadowFilter.dy.baseVal = shadowDepthY;
// Color it with the shadow color
const coloredShadow = createComponentTransferFilter(shadowColor);
filterElement.appendChild(coloredShadow);
let lastFilter: SVGFEComponentTransferElement | SVGFEGaussianBlurElement | SVGFEConvolveMatrixElement = coloredShadow;
// Blur the shadow
if (this._gaussianBlur > 0) {
const gaussianBlurFilter = document.createElementNS("http://www.w3.org/2000/svg", "feGaussianBlur");
filterElement.appendChild(gaussianBlurFilter);
// Don't use setStdDeviation - cloneNode() clears it in Chrome
gaussianBlurFilter.stdDeviationX.baseVal = this._gaussianBlur;
gaussianBlurFilter.stdDeviationY.baseVal = this._gaussianBlur;
lastFilter = gaussianBlurFilter;
}
for (let i = 0; i < this._blur; i++) {
const blurFilter = document.createElementNS("http://www.w3.org/2000/svg", "feConvolveMatrix");
filterElement.appendChild(blurFilter);
blurFilter.setAttribute("kernelMatrix", "1 2 1 2 4 2 1 2 1");
blurFilter.edgeMode.baseVal = SVGFEConvolveMatrixElement.SVG_EDGEMODE_NONE;
lastFilter = blurFilter;
}
lastFilter.result.baseVal = "shadow";
}
// Merge the main text, outline and shadow
const mergedResult = document.createElementNS("http://www.w3.org/2000/svg", "feMerge");
filterElement.appendChild(mergedResult);
if (shadowDepthX > 0 || shadowDepthY > 0) {
const shadowReferenceNode = document.createElementNS("http://www.w3.org/2000/svg", "feMergeNode");
mergedResult.appendChild(shadowReferenceNode);
shadowReferenceNode.in1.baseVal = "shadow";
}
const outlineReferenceNode = document.createElementNS("http://www.w3.org/2000/svg", "feMergeNode");
mergedOutlineAndSourceGraphic.appendChild(outlineReferenceNode);
mergedResult.appendChild(outlineReferenceNode);
outlineReferenceNode.in1.baseVal = "outline-colored";
const sourceGraphicReferenceNode = document.createElementNS("http://www.w3.org/2000/svg", "feMergeNode");
mergedOutlineAndSourceGraphic.appendChild(sourceGraphicReferenceNode);
mergedResult.appendChild(sourceGraphicReferenceNode);
sourceGraphicReferenceNode.in1.baseVal = "SourceGraphic";
}
else {
@@ -455,6 +492,8 @@ export class SpanStyles {
if (this._gaussianBlur > 0) {
const gaussianBlurFilter = document.createElementNS("http://www.w3.org/2000/svg", "feGaussianBlur");
filterElement.appendChild(gaussianBlurFilter);
// Don't use setStdDeviation - cloneNode() clears it in Chrome
gaussianBlurFilter.stdDeviationX.baseVal = this._gaussianBlur;
gaussianBlurFilter.stdDeviationY.baseVal = this._gaussianBlur;
}
@@ -467,10 +506,18 @@ export class SpanStyles {
}
if (filterElement.childElementCount > 0) {
this._svgDefsElement.appendChild(filterElement);
const filterId = `libjass-svg-filter-${ this._id }-${ this._nextFilterId++ }`;
filterWrapperSpan.style.webkitFilter = `url("#${ filterId }")`;
filterWrapperSpan.style.filter = `url("#${ filterId }")`;
this._svgDefsElement.appendChild(filterElement);
filterElement.id = filterId;
filterElement.x.baseVal.valueAsString = "-50%";
filterElement.width.baseVal.valueAsString = "200%";
filterElement.y.baseVal.valueAsString = "-50%";
filterElement.height.baseVal.valueAsString = "200%";
const filterProperty = `url("#${ filterId }")`;
span.style.webkitFilter = filterProperty;
span.style.filter = filterProperty;
}
}
@@ -479,10 +526,18 @@ export class SpanStyles {
* @param {number} outlineWidth
* @param {number} outlineHeight
* @param {!libjass.parts.Color} outlineColor
* @param {number} shadowDepthX
* @param {number} shadowDepthY
* @param {!libjass.parts.Color} shadowColor
*/
private _setTextShadowOutlineOnSpan(span: HTMLSpanElement, outlineWidth: number, outlineHeight: number, outlineColor: Color): void {
private _textShadow(
span: HTMLSpanElement,
outlineWidth: number, outlineHeight: number, outlineColor: Color,
shadowDepthX: number, shadowDepthY: number, shadowColor: Color,
): void {
if (outlineWidth > 0 || outlineHeight > 0) {
let outlineCssString = "";
let shadowCssString = "";
((addOutline: (x: number, y: number) => void) => {
for (let x = 0; x <= outlineWidth; x++) {
@@ -503,21 +558,35 @@ export class SpanStyles {
}
}
}
if ((outlineWidth % 1) > 0) {
addOutline(outlineWidth, 0);
addOutline(-outlineWidth, 0);
}
if ((outlineHeight % 1) > 0) {
addOutline(0, outlineHeight);
addOutline(0, -outlineHeight);
}
})((x: number, y: number): void => {
outlineCssString += `, ${ outlineColor.toString() } ${ x }px ${ y }px ${ this._gaussianBlur.toFixed(3) }px`;
outlineCssString += `, ${ outlineColor.toString() } ${ x.toFixed(3) }px ${ y.toFixed(3) }px ${ this._gaussianBlur.toFixed(3) }px`;
if (this._shadowDepthX !== 0 || this._shadowDepthY !== 0) {
shadowCssString += `, ${ shadowColor.toString() } ${ (x + shadowDepthX).toFixed(3) }px ${ (y + shadowDepthY).toFixed(3) }px ${ this._gaussianBlur.toFixed(3) }px`;
}
});
span.style.textShadow = outlineCssString.substr(", ".length);
span.style.textShadow = (outlineCssString + shadowCssString).substr(", ".length);
}
else if (this._shadowDepthX !== 0 || this._shadowDepthY !== 0) {
const shadowCssString = `${ shadowColor.toString() } ${ shadowDepthX.toFixed(3) }px ${ shadowDepthY.toFixed(3) }px 0px`;
if (span.style.textShadow === "") {
span.style.textShadow = shadowCssString;
}
else {
span.style.textShadow += ", " + shadowCssString;
}
}
}
/**
* @return {!HTMLBRElement}
*/
makeNewLine(): HTMLBRElement {
const result = document.createElement("br");
result.style.lineHeight = `${ (this._scaleY * this._fontSize).toFixed(3) }px`;
return result;
}
/**
@@ -526,16 +595,16 @@ export class SpanStyles {
* @type {?boolean}
*/
set italic(value: boolean) {
this._italic = SpanStyles._valueOrDefault(value, this._defaultStyle.italic);
this._italic = valueOrDefault(value, this._defaultStyle.italic);
}
/**
* Sets the bold property. null defaults it to the default style's value.
*
* @type {(?number|?boolean)}
* @type {(?boolean|?number)}
*/
set bold(value: Object) {
this._bold = SpanStyles._valueOrDefault(value, this._defaultStyle.bold);
set bold(value: boolean | number | null) {
this._bold = valueOrDefault(value, this._defaultStyle.bold);
}
/**
@@ -544,7 +613,7 @@ export class SpanStyles {
* @type {?boolean}
*/
set underline(value: boolean) {
this._underline = SpanStyles._valueOrDefault(value, this._defaultStyle.underline);
this._underline = valueOrDefault(value, this._defaultStyle.underline);
}
/**
@@ -553,7 +622,7 @@ export class SpanStyles {
* @type {?boolean}
*/
set strikeThrough(value: boolean) {
this._strikeThrough = SpanStyles._valueOrDefault(value, this._defaultStyle.strikeThrough);
this._strikeThrough = valueOrDefault(value, this._defaultStyle.strikeThrough);
}
/**
@@ -561,7 +630,7 @@ export class SpanStyles {
*
* @type {number}
*/
get outlineWidth() {
get outlineWidth(): number {
return this._outlineWidth;
}
@@ -571,16 +640,16 @@ export class SpanStyles {
* @type {?number}
*/
set outlineWidth(value: number) {
this._outlineWidth = SpanStyles._valueOrDefault(value, this._defaultStyle.outlineThickness);
this._outlineWidth = valueOrDefault(value, this._defaultStyle.outlineThickness);
}
/**
* Gets the outline width property.
* Gets the outline height property.
*
* @type {number}
*/
get outlineHeight() {
return this._outlineWidth;
get outlineHeight(): number {
return this._outlineHeight;
}
/**
@@ -589,7 +658,7 @@ export class SpanStyles {
* @type {?number}
*/
set outlineHeight(value: number) {
this._outlineHeight = SpanStyles._valueOrDefault(value, this._defaultStyle.outlineThickness);
this._outlineHeight = valueOrDefault(value, this._defaultStyle.outlineThickness);
}
/**
@@ -597,7 +666,7 @@ export class SpanStyles {
*
* @type {number}
*/
get shadowDepthX() {
get shadowDepthX(): number {
return this._shadowDepthX;
}
@@ -607,7 +676,7 @@ export class SpanStyles {
* @type {?number}
*/
set shadowDepthX(value: number) {
this._shadowDepthX = SpanStyles._valueOrDefault(value, this._defaultStyle.shadowDepth);
this._shadowDepthX = valueOrDefault(value, this._defaultStyle.shadowDepth);
}
/**
@@ -615,7 +684,7 @@ export class SpanStyles {
*
* @type {number}
*/
get shadowDepthY() {
get shadowDepthY(): number {
return this._shadowDepthY;
}
@@ -625,7 +694,7 @@ export class SpanStyles {
* @type {?number}
*/
set shadowDepthY(value: number) {
this._shadowDepthY = SpanStyles._valueOrDefault(value, this._defaultStyle.shadowDepth);
this._shadowDepthY = valueOrDefault(value, this._defaultStyle.shadowDepth);
}
/**
@@ -633,7 +702,7 @@ export class SpanStyles {
*
* @type {number}
*/
get blur() {
get blur(): number {
return this._blur;
}
@@ -643,7 +712,7 @@ export class SpanStyles {
* @type {?number}
*/
set blur(value: number) {
this._blur = SpanStyles._valueOrDefault(value, 0);
this._blur = valueOrDefault<number>(value, 0);
}
/**
@@ -651,7 +720,7 @@ export class SpanStyles {
*
* @type {number}
*/
get gaussianBlur() {
get gaussianBlur(): number {
return this._gaussianBlur;
}
@@ -661,7 +730,7 @@ export class SpanStyles {
* @type {?number}
*/
set gaussianBlur(value: number) {
this._gaussianBlur = SpanStyles._valueOrDefault(value, 0);
this._gaussianBlur = valueOrDefault<number>(value, 0);
}
/**
@@ -669,8 +738,8 @@ export class SpanStyles {
*
* @type {?string}
*/
set fontName(value: string) {
this._fontName = SpanStyles._valueOrDefault(value, this._defaultStyle.fontName);
set fontName(value: string | null) {
this._fontName = valueOrDefault(value, this._defaultStyle.fontName);
}
/**
@@ -678,7 +747,7 @@ export class SpanStyles {
*
* @type {number}
*/
get fontSize() {
get fontSize(): number {
return this._fontSize;
}
@@ -688,7 +757,7 @@ export class SpanStyles {
* @type {?number}
*/
set fontSize(value: number) {
this._fontSize = SpanStyles._valueOrDefault(value, this._defaultStyle.fontSize);
this._fontSize = valueOrDefault(value, this._defaultStyle.fontSize);
}
/**
@@ -696,7 +765,7 @@ export class SpanStyles {
*
* @type {number}
*/
get fontScaleX() {
get fontScaleX(): number {
return this._fontScaleX;
}
@@ -706,7 +775,7 @@ export class SpanStyles {
* @type {?number}
*/
set fontScaleX(value: number) {
this._fontScaleX = SpanStyles._valueOrDefault(value, this._defaultStyle.fontScaleX);
this._fontScaleX = valueOrDefault(value, this._defaultStyle.fontScaleX);
}
/**
@@ -714,7 +783,7 @@ export class SpanStyles {
*
* @type {number}
*/
get fontScaleY() {
get fontScaleY(): number {
return this._fontScaleY;
}
@@ -724,7 +793,7 @@ export class SpanStyles {
* @type {?number}
*/
set fontScaleY(value: number) {
this._fontScaleY = SpanStyles._valueOrDefault(value, this._defaultStyle.fontScaleY);
this._fontScaleY = valueOrDefault(value, this._defaultStyle.fontScaleY);
}
/**
@@ -732,7 +801,7 @@ export class SpanStyles {
*
* @type {number}
*/
get letterSpacing() {
get letterSpacing(): number {
return this._letterSpacing;
}
@@ -742,15 +811,15 @@ export class SpanStyles {
* @type {?number}
*/
set letterSpacing(value: number) {
this._letterSpacing = SpanStyles._valueOrDefault(value, this._defaultStyle.letterSpacing);
this._letterSpacing = valueOrDefault(value, this._defaultStyle.letterSpacing);
}
/**
* Gets the X-axis rotation property.
*
* @type {?number}
* @type {number}
*/
get rotationX() {
get rotationX(): number {
return this._rotationX;
}
@@ -760,15 +829,15 @@ export class SpanStyles {
* @type {?number}
*/
set rotationX(value: number) {
this._rotationX = value;
this._rotationX = valueOrDefault<number>(value, 0);
}
/**
* Gets the Y-axis rotation property.
*
* @type {?number}
* @type {number}
*/
get rotationY() {
get rotationY(): number {
return this._rotationY;
}
@@ -778,15 +847,15 @@ export class SpanStyles {
* @type {?number}
*/
set rotationY(value: number) {
this._rotationY = value;
this._rotationY = valueOrDefault<number>(value, 0);
}
/**
* Gets the Z-axis rotation property.
*
* @type {?number}
* @type {number}
*/
get rotationZ() {
get rotationZ(): number {
return this._rotationZ;
}
@@ -796,15 +865,15 @@ export class SpanStyles {
* @type {?number}
*/
set rotationZ(value: number) {
this._rotationZ = SpanStyles._valueOrDefault(value, this._defaultStyle.rotationZ);
this._rotationZ = valueOrDefault(value, this._defaultStyle.rotationZ);
}
/**
* Gets the X-axis skew property.
*
* @type {?number}
* @type {number}
*/
get skewX() {
get skewX(): number {
return this._skewX;
}
@@ -814,15 +883,15 @@ export class SpanStyles {
* @type {?number}
*/
set skewX(value: number) {
this._skewX = value;
this._skewX = valueOrDefault<number>(value, 0);
}
/**
* Gets the Y-axis skew property.
*
* @type {?number}
* @type {number}
*/
get skewY() {
get skewY(): number {
return this._skewY;
}
@@ -832,7 +901,7 @@ export class SpanStyles {
* @type {?number}
*/
set skewY(value: number) {
this._skewY = value;
this._skewY = valueOrDefault<number>(value, 0);
}
/**
@@ -850,7 +919,7 @@ export class SpanStyles {
* @type {libjass.Color}
*/
set primaryColor(value: Color) {
this._primaryColor = SpanStyles._valueOrDefault(value, this._defaultStyle.primaryColor);
this._primaryColor = valueOrDefault(value, this._defaultStyle.primaryColor);
}
/**
@@ -868,7 +937,7 @@ export class SpanStyles {
* @type {libjass.Color}
*/
set secondaryColor(value: Color) {
this._secondaryColor = SpanStyles._valueOrDefault(value, this._defaultStyle.secondaryColor);
this._secondaryColor = valueOrDefault(value, this._defaultStyle.secondaryColor);
}
/**
@@ -886,7 +955,7 @@ export class SpanStyles {
* @type {libjass.Color}
*/
set outlineColor(value: Color) {
this._outlineColor = SpanStyles._valueOrDefault(value, this._defaultStyle.outlineColor);
this._outlineColor = valueOrDefault(value, this._defaultStyle.outlineColor);
}
/**
@@ -904,7 +973,7 @@ export class SpanStyles {
* @type {libjass.Color}
*/
set shadowColor(value: Color) {
this._shadowColor = SpanStyles._valueOrDefault(value, this._defaultStyle.shadowColor);
this._shadowColor = valueOrDefault(value, this._defaultStyle.shadowColor);
}
/**
@@ -922,7 +991,7 @@ export class SpanStyles {
* @type {?number}
*/
set primaryAlpha(value: number) {
this._primaryAlpha = SpanStyles._valueOrDefault(value, this._defaultStyle.primaryColor.alpha);
this._primaryAlpha = valueOrDefault(value, this._defaultStyle.primaryColor.alpha);
}
/**
@@ -940,7 +1009,7 @@ export class SpanStyles {
* @type {?number}
*/
set secondaryAlpha(value: number) {
this._secondaryAlpha = SpanStyles._valueOrDefault(value, this._defaultStyle.secondaryColor.alpha);
this._secondaryAlpha = valueOrDefault(value, this._defaultStyle.secondaryColor.alpha);
}
/**
@@ -958,7 +1027,7 @@ export class SpanStyles {
* @type {?number}
*/
set outlineAlpha(value: number) {
this._outlineAlpha = SpanStyles._valueOrDefault(value, this._defaultStyle.outlineColor.alpha);
this._outlineAlpha = valueOrDefault(value, this._defaultStyle.outlineColor.alpha);
}
/**
@@ -976,8 +1045,49 @@ export class SpanStyles {
* @type {?number}
*/
set shadowAlpha(value: number) {
this._shadowAlpha = SpanStyles._valueOrDefault(value, this._defaultStyle.shadowColor.alpha);
this._shadowAlpha = valueOrDefault(value, this._defaultStyle.shadowColor.alpha);
}
private static _valueOrDefault = <T>(newValue: T, defaultValue: T): T => ((newValue !== null) ? newValue : defaultValue);
}
/**
* @param {!libjass.parts.Color} color
* @return {!SVGFEComponentTransferElement}
*/
function createComponentTransferFilter(color: Color): SVGFEComponentTransferElement {
const result = document.createElementNS("http://www.w3.org/2000/svg", "feComponentTransfer");
const redTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncR");
result.appendChild(redTransferNode);
redTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
redTransferNode.slope.baseVal = 0;
redTransferNode.intercept.baseVal = color.red / 255;
const greenTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncG");
result.appendChild(greenTransferNode);
greenTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
greenTransferNode.slope.baseVal = 0;
greenTransferNode.intercept.baseVal = color.green / 255;
const blueTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncB");
result.appendChild(blueTransferNode);
blueTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
blueTransferNode.slope.baseVal = 0;
blueTransferNode.intercept.baseVal = color.blue / 255;
const alphaTransferNode = document.createElementNS("http://www.w3.org/2000/svg", "feFuncA");
result.appendChild(alphaTransferNode);
alphaTransferNode.type.baseVal = SVGComponentTransferFunctionElement.SVG_FECOMPONENTTRANSFER_TYPE_LINEAR;
alphaTransferNode.slope.baseVal = color.alpha;
alphaTransferNode.intercept.baseVal = 0;
return result;
}
/**
* @param {?T} newValue
* @param {!T} defaultValue
* @return {!T}
*/
function valueOrDefault<T>(newValue: T | null, defaultValue: T): T {
return ((newValue !== null) ? newValue : defaultValue);
}
-49
View File
@@ -1,49 +0,0 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
interface Document {
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "defs"): SVGDefsElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feComponentTransfer"): SVGFEComponentTransferElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feComposite"): SVGFECompositeElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feConvolveMatrix"): SVGFEConvolveMatrixElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feFuncA"): SVGFEFuncAElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feFuncB"): SVGFEFuncBElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feFuncG"): SVGFEFuncGElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feFuncR"): SVGFEFuncRElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feGaussianBlur"): SVGFEGaussianBlurElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feMerge"): SVGFEMergeElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feMergeNode"): SVGFEMergeNodeElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "feMorphology"): SVGFEMorphologyElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "filter"): SVGFilterElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "g"): SVGGElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "path"): SVGPathElement;
createElementNS(namespaceURI: "http://www.w3.org/2000/svg", qualifiedName: "svg"): SVGSVGElement;
}
interface SVGFEComponentTransferElement {
appendChild(newChild: SVGFEFuncAElement): SVGFEFuncAElement;
appendChild(newChild: SVGFEFuncBElement): SVGFEFuncBElement;
appendChild(newChild: SVGFEFuncGElement): SVGFEFuncGElement;
appendChild(newChild: SVGFEFuncRElement): SVGFEFuncRElement;
}
interface SVGFEMergeElement {
appendChild(newChild: SVGFEMergeNodeElement): SVGFEMergeNodeElement;
}
+78
View File
@@ -0,0 +1,78 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Map } from "./utility/map";
const classes = new Map<number, Function & { fromJSON?(obj: any): any }>();
/**
* Registers a class as a serializable type.
*
* @param {function(new:*)} clazz
*/
export function registerClass(clazz: Function & { fromJSON?(obj: any): any }): void {
clazz.prototype._classTag = classes.size;
classes.set(clazz.prototype._classTag, clazz);
}
/**
* Serializes the given object.
*
* @param {*} obj
* @return {string}
*/
export function serialize(obj: any): string {
return JSON.stringify(obj, (/* ujs:unreferenced */ _key: string, value: any) => {
if (value && (value._classTag !== undefined) && !Object.prototype.hasOwnProperty.call(value, "_classTag")) {
// Copy the _classTag from this object's prototype to itself, so that it will be serialized.
value._classTag = value._classTag;
}
return value;
});
}
/**
* @param {string} str
* @return {*}
*/
export function deserialize(str: string): any {
return JSON.parse(str, (/* ujs:unreferenced */ _key: string, value: any) => {
if (value && (value._classTag !== undefined)) {
const clazz = classes.get(value._classTag);
if (clazz === undefined) {
throw new Error(`Unknown class of tag ${ value._classTag } cannot be deserialized.`);
}
if (typeof clazz.fromJSON === "function") {
value = clazz.fromJSON(value);
}
else {
const hydratedValue = Object.create(clazz.prototype);
for (const key of Object.keys(value)) {
hydratedValue[key] = value[key];
}
value = hydratedValue;
}
}
return value;
});
}
+18 -3
View File
@@ -1,9 +1,24 @@
{
"compilerOptions": {
"module": "CommonJS",
"lib": ["es5", "dom"],
"experimentalDecorators": true,
"forceConsistentCasingInFileNames": true,
"noFallthroughCasesInSwitch": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true,
"noUnusedLocals": true,
"noUnusedParameters": false,
"strictNullChecks": true,
"target": "es5",
"module": "amd",
"moduleResolution": "node",
"outFile": "../lib/libjass.js",
"noImplicitUseStrict": true,
"sourceMap": true,
"target": "ES5",
"experimentalDecorators": true
"inlineSources": true,
"types": []
}
}
+164
View File
@@ -0,0 +1,164 @@
{
"$schema": "http://json.schemastore.org/tslint",
"rules": {
"adjacent-overload-signatures": true,
"ban-types": false,
"member-access": false,
"member-ordering": [true, { "order": [
"public-static-field",
"public-static-method",
"protected-static-field",
"protected-static-method",
"private-static-field",
"private-static-method",
"public-instance-field",
"protected-instance-field",
"private-instance-field",
"public-constructor",
"public-instance-method",
"protected-constructor",
"protected-instance-method",
"private-constructor",
"private-instance-method"
]}],
"no-any": false,
"no-empty-interface": false,
"no-import-side-effect": true,
"no-inferrable-types": false,
"no-internal-module": true,
"no-magic-numbers": false,
"no-namespace": true,
"no-non-null-assertion": false,
"no-reference": true,
"no-var-requires": true,
"only-arrow-functions": false,
"prefer-for-of": true,
"promise-function-async": false,
"typedef": [true, "call-signature", "parameter", "property-declaration", "member-variable-declaration"],
"typedef-whitespace": [true, {
"call-signature": "nospace",
"index-signature": "nospace",
"parameter": "nospace",
"property-declaration": "nospace",
"variable-declaration": "nospace"
}, {
"call-signature": "space",
"index-signature": "space",
"parameter": "space",
"property-declaration": "space",
"variable-declaration": "space"
}],
"unified-signatures": true,
"await-promise": true,
"ban": false,
"curly": true,
"forin": true,
"import-blacklist": false,
"label-position": true,
"no-arg": true,
"no-bitwise": true,
"no-conditional-assignment": true,
"no-console": false,
"no-construct": true,
"no-debugger": true,
"no-duplicate-super": true,
"no-duplicate-variable": true,
"no-empty": false,
"no-eval": true,
"no-floating-promises": true,
"no-for-in-array": true,
"no-inferred-empty-object-type": true,
"no-invalid-template-strings": true,
"no-invalid-this": false,
"no-misused-new": true,
"no-null-keyword": false,
"no-shadowed-variable": false,
"no-sparse-arrays": true,
"no-string-literal": true,
"no-string-throw": true,
"no-switch-case-fall-through": true,
"no-unbound-method": false,
"no-unsafe-any": false,
"no-unsafe-finally": true,
"no-unused-expression": true,
"no-unused-variable": [true, "check-parameters"],
"no-use-before-declare": false,
"no-var-keyword": true,
"no-void-expression": [true, "ignore-arrow-function-shorthand"],
"radix": false,
"restrict-plus-operands": true,
"strict-boolean-expressions": false,
"strict-type-predicates": true,
"switch-default": false,
"triple-equals": true,
"typeof-compare": true,
"use-isnan": true,
"cyclomatic-complexity": false,
"eofline": true,
"indent": [true, "tabs"],
"linebreak-style": [true, "LF"],
"max-classes-per-file": false,
"max-file-line-count": false,
"max-line-length": false,
"no-default-export": true,
"no-mergeable-namespace": true,
"no-require-imports": true,
"object-literal-sort-keys": false,
"prefer-const": [true, { "destructuring": "all" }],
"trailing-comma": [true, { "multiline": "always", "singleline": "never" }],
"align": [true, "statements"],
"array-type": [true, "array"],
"arrow-parens": [true, "ban-single-arg-parens"],
"arrow-return-shorthand": true,
"callable-types": true,
"class-name": true,
"comment-format": [true, "check-space"],
"completed-docs": false,
"file-header": ["true", "Copyright \\d{4}"],
"import-spacing": true,
"interface-name": [true, "never-prefix"],
"interface-over-type-literal": false,
"jsdoc-format": true,
"match-default-export-name": true,
"newline-before-return": false,
"new-parens": true,
"no-angle-bracket-type-assertion": true,
"no-boolean-literal-compare": true,
"no-consecutive-blank-lines": true,
"no-parameter-properties": false,
"no-reference-import": true,
"no-trailing-whitespace": true,
"no-unnecessary-callback-wrapper": true,
"no-unnecessary-initializer": true,
"no-unnecessary-qualifier": true,
"object-literal-key-quotes": [true, "as-needed"],
"object-literal-shorthand": true,
"one-line": [true, "check-open-brace", "check-whitespace"],
"one-variable-per-declaration": true,
"ordered-imports": [true, { "import-sources-order": "case-insensitive", "named-imports-order": "case-insensitive" }],
"prefer-function-over-method": [true, "allow-public", "allow-protected"],
"prefer-method-signature": true,
"prefer-template": [true, "allow-single-concat"],
"quotemark": [true, "double", "avoid-escape"],
"return-undefined": true,
"space-before-function-paren": [true, {
"anonymous": "always",
"named": "never",
"asyncArrow": "always",
"method": "never",
"constructor": "never"
}],
"semicolon": [true, "always"],
"variable-name": [true, "ban-keywords", "check-format", "allow-leading-underscore"],
"whitespace": [true, "check-branch", "check-decl", "check-operator", "check-module", "check-separator", "check-type", "check-typecast", "check-preblock"]
}
}
+154 -102
View File
@@ -18,39 +18,139 @@
* limitations under the License.
*/
import { Attachment } from "./attachment";
import { Dialogue } from "./dialogue";
import { Style } from "./style";
import { ScriptProperties } from "./script-properties";
import { Format } from "./misc";
import { verboseMode } from "../settings";
import * as parser from "../parser";
import { parseLineIntoTypedTemplate } from "../parser/misc";
import { ReadableStream, TextDecoder, TextDecoderConstructor } from "../parser/streams";
import { SrtStreamParser, StreamParser } from "../parser/stream-parsers";
import { BrowserReadableStream, Stream, StringStream, XhrStream } from "../parser/streams";
import { registerClass as serializable } from "../serialization";
import { debugMode, verboseMode } from "../settings";
import { Map } from "../utility/map";
import { Promise } from "../utility/promise";
declare const global: {
fetch?(url: string): Promise<{ body: ReadableStream; ok?: boolean; status?: number; }>;
ReadableStream?: { prototype: ReadableStream; };
TextDecoder?: TextDecoderConstructor;
};
import { Attachment } from "./attachment";
import { Dialogue } from "./dialogue";
import { Format } from "./misc";
import { ScriptProperties } from "./script-properties";
import { Style } from "./style";
/**
* This class represents an ASS script. It contains the {@link libjass.ScriptProperties}, an array of {@link libjass.Style}s, and an array of {@link libjass.Dialogue}s.
*/
@serializable
export class ASS {
/**
* Creates an ASS object from the raw text of an ASS script.
*
* @param {string} raw The raw text of the script.
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>}
*/
static fromString(raw: string, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
return ASS.fromStream(new StringStream(raw), type);
}
/**
* Creates an ASS object from the given {@link libjass.parser.Stream}.
*
* @param {!libjass.parser.Stream} stream The stream to parse the script from
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromStream(stream: Stream, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
switch (type) {
case Format.ASS:
case "ass":
return new StreamParser(stream).ass;
case Format.SRT:
case "srt":
return new SrtStreamParser(stream).ass;
default:
throw new Error(`Invalid value of type: ${ type }`);
}
}
/**
* Creates an ASS object from the given URL.
*
* @param {string} url The URL of the script.
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromUrl(url: string, type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
let fetchPromise: Promise<ASS>;
if (typeof global.fetch === "function" && BrowserReadableStream.isSupported()) {
fetchPromise = global.fetch(url).then(response => {
if (response.ok === false || (response.ok === undefined && (response.status === undefined || response.status < 200 || response.status > 299))) {
throw new Error(`HTTP request for ${ url } failed with status code ${ response.status }`);
}
return ASS.fromReadableStream(response.body, "utf-8", type);
});
}
else {
fetchPromise = Promise.reject<ASS>(new Error("Not supported."));
}
return fetchPromise.catch(reason => {
if (debugMode) {
console.log("fetch() failed, falling back to XHR: %o", reason);
}
const xhr = new XMLHttpRequest();
const result = ASS.fromStream(new XhrStream(xhr), type);
xhr.open("GET", url, true);
xhr.send();
return result;
});
}
/**
* Creates an ASS object from the given ReadableStream.
*
* @param {!ReadableStream} stream
* @param {string="utf-8"} encoding
* @param {(number|string)=0} type The type of the script. One of the {@link libjass.Format} constants, or one of the strings "ass" and "srt".
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromReadableStream(stream: ReadableStream, encoding: string = "utf-8", type: Format | "ass" | "srt" = Format.ASS): Promise<ASS> {
return ASS.fromStream(new BrowserReadableStream(stream, encoding), type);
}
/**
* Custom deserialization for ASS objects.
*
* @param {!*} obj
* @return {!libjass.ASS}
*/
static fromJSON(obj: any): ASS {
const result: ASS = Object.create(ASS.prototype);
result._properties = obj._properties;
result._styles = new Map<string, Style>();
for (const name of Object.keys(obj._styles)) {
const style = obj._styles[name];
result._styles.set(name, style);
}
result._dialogues = obj._dialogues;
result._attachments = obj._attachments;
result._stylesFormatSpecifier = obj._stylesFormatSpecifier;
result._dialoguesFormatSpecifier = obj._dialoguesFormatSpecifier;
return result;
}
private _properties: ScriptProperties = new ScriptProperties();
private _styles: Map<string, Style> = new Map<string, Style>();
private _dialogues: Dialogue[] = [];
private _attachments: Attachment[] = [];
private _stylesFormatSpecifier: string[] = null;
private _dialoguesFormatSpecifier: string[] = null;
private _stylesFormatSpecifier: string[] | null = null;
private _dialoguesFormatSpecifier: string[] | null = null;
/**
* The properties of this script.
@@ -91,36 +191,36 @@ export class ASS {
/**
* The format specifier for the styles section.
*
* @type {!Array.<string>}
* @type {Array.<string>}
*/
get stylesFormatSpecifier(): string[] {
get stylesFormatSpecifier(): string[] | null {
return this._stylesFormatSpecifier;
}
/**
* The format specifier for the events section.
*
* @type {Array.<string>}
*/
set stylesFormatSpecifier(value: string[] | null) {
this._stylesFormatSpecifier = value;
}
/**
* The format specifier for the styles section.
*
* @type {!Array.<string>}
* @type {Array.<string>}
*/
get dialoguesFormatSpecifier(): string[] {
get dialoguesFormatSpecifier(): string[] | null {
return this._dialoguesFormatSpecifier;
}
/**
* The format specifier for the events section.
*
* @type {!Array.<string>}
* @type {Array.<string>}
*/
set stylesFormatSpecifier(value: string[]) {
this._stylesFormatSpecifier = value;
}
/**
* The format specifier for the events section.
*
* @type {!Array.<string>}
*/
set dialoguesFormatSpecifier(value: string[]) {
set dialoguesFormatSpecifier(value: string[] | null) {
this._dialoguesFormatSpecifier = value;
}
@@ -139,6 +239,10 @@ export class ASS {
* @param {string} line The line from the script that contains the new style.
*/
addStyle(line: string): void {
if (this._stylesFormatSpecifier === null) {
throw new Error("stylesFormatSpecifier is not set.");
}
const styleLine = parseLineIntoTypedTemplate(line, this._stylesFormatSpecifier);
if (styleLine === null || styleLine.type !== "Style") {
return;
@@ -163,6 +267,10 @@ export class ASS {
* @param {string} line The line from the script that contains the new event.
*/
addEvent(line: string): void {
if (this._dialoguesFormatSpecifier === null) {
throw new Error("dialoguesFormatSpecifier is not set.");
}
const dialogueLine = parseLineIntoTypedTemplate(line, this._dialoguesFormatSpecifier);
if (dialogueLine === null || dialogueLine.type !== "Dialogue") {
return;
@@ -190,81 +298,25 @@ export class ASS {
}
/**
* Creates an ASS object from the raw text of an ASS script.
* Custom JSON serialization for ASS objects.
*
* @param {string} raw The raw text of the script.
* @param {number=0} type The type of the script. One of the {@link libjass.Format} constants.
* @return {!Promise.<!libjass.ASS>}
* @return {!*}
*/
static fromString(raw: string, type: Format = Format.ASS): Promise<ASS> {
return ASS.fromStream(new parser.StringStream(raw), type);
}
toJSON(): any {
const result = Object.create(null);
/**
* Creates an ASS object from the given {@link libjass.parser.Stream}.
*
* @param {!libjass.parser.Stream} stream The stream to parse the script from
* @param {number=0} type The type of the script. One of the {@link libjass.Format} constants.
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromStream(stream: parser.Stream, type: Format = Format.ASS): Promise<ASS> {
switch (type) {
case Format.ASS:
return new parser.StreamParser(stream).ass;
case Format.SRT:
return new parser.SrtStreamParser(stream).ass;
default:
throw new Error(`Illegal value of type: ${ type }`);
}
}
result._properties = this._properties;
/**
* Creates an ASS object from the given URL.
*
* @param {string} url The URL of the script.
* @param {number=0} type The type of the script. One of the {@link libjass.Format} constants.
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromUrl(url: string, type: Format = Format.ASS): Promise<ASS> {
let fetchPromise: Promise<ASS>;
result._styles = Object.create(null);
this._styles.forEach((style, name) => result._styles[name] = style);
if (
typeof global.fetch === "function" &&
typeof global.ReadableStream === "function" && typeof global.ReadableStream.prototype.getReader === "function" &&
typeof global.TextDecoder === "function"
) {
fetchPromise = global.fetch(url).then(response => {
if (response.ok === false || (response.ok === undefined && (response.status < 200 || response.status > 299))) {
throw new Error(`HTTP request for ${ url } failed with status code ${ response.status }`);
}
result._dialogues = this._dialogues;
result._attachments = this._attachments;
result._stylesFormatSpecifier = this._stylesFormatSpecifier;
result._dialoguesFormatSpecifier = this._dialoguesFormatSpecifier;
return ASS.fromReadableStream(response.body, "utf-8", type);
});
}
else {
fetchPromise = Promise.reject<ASS>(new Error("Not supported."));
}
result._classTag = (ASS.prototype as any)._classTag;
return fetchPromise.catch(reason => {
console.warn("fetch() failed, falling back to XHR: %o", reason);
const xhr = new XMLHttpRequest();
const result = ASS.fromStream(new parser.XhrStream(xhr), type);
xhr.open("GET", url, true);
xhr.send();
return result;
});
}
/**
* Creates an ASS object from the given ReadableStream.
*
* @param {!ReadableStream} stream
* @param {string="utf-8"} encoding
* @param {number=0} type The type of the script. One of the {@link libjass.Format} constants.
* @return {!Promise.<!libjass.ASS>} A promise that will be resolved with the ASS object when it has been fully parsed
*/
static fromReadableStream(stream: ReadableStream, encoding: string = "utf-8", type: Format = Format.ASS): Promise<ASS> {
return ASS.fromStream(new parser.BrowserReadableStream(stream, encoding), type);
return result;
}
}
+3
View File
@@ -18,6 +18,8 @@
* limitations under the License.
*/
import { registerClass as serializable } from "../serialization";
/**
* The type of an attachment.
*/
@@ -32,6 +34,7 @@ export enum AttachmentType {
* @param {string} filename The filename of this attachment.
* @param {number} type The type of this attachment.
*/
@serializable
export class Attachment {
private _contents: string = "";
+45 -33
View File
@@ -23,12 +23,12 @@ import { Style } from "./style";
import { valueOrDefault } from "./misc";
import { parseLineIntoTypedTemplate } from "../parser/misc";
import { parse } from "../parser/parse";
import * as parts from "../parts";
import { registerClass as serializable } from "../serialization";
import { debugMode } from "../settings";
import { Map } from "../utility/map";
@@ -44,8 +44,9 @@ import { Map } from "../utility/map";
* @param {string} template["Text"] The text of this dialogue
* @param {!libjass.ASS} ass The ASS object to which this dialogue belongs
*/
@serializable
export class Dialogue {
private static _lastDialogueId = -1;
private static _lastDialogueId: number = -1;
private _id: number;
@@ -58,7 +59,7 @@ export class Dialogue {
private _alignment: number;
private _rawPartsString: string;
private _parts: parts.Part[] = null;
private _parts: parts.Part[] | null = null;
private _containsTransformTag: boolean = false;
@@ -74,34 +75,45 @@ export class Dialogue {
this._id = ++Dialogue._lastDialogueId;
let styleName = template.get("style");
if (styleName !== undefined && styleName !== null && styleName.constructor === String) {
if (typeof styleName === "string") {
styleName = styleName.replace(/^\*+/, "");
if (styleName.match(/^Default$/i) !== null) {
styleName = "Default";
}
}
this._style = ass.styles.get(styleName);
if (this._style === undefined) {
let style = (styleName !== undefined) ? ass.styles.get(styleName) : undefined;
if (style === undefined) {
if (debugMode) {
console.warn(`Unrecognized style ${ styleName }. Falling back to "Default"`);
}
this._style = ass.styles.get("Default");
}
if (this._style === undefined) {
throw new Error(`Unrecognized style ${ styleName }`);
style = ass.styles.get("Default");
if (style === undefined) {
throw new Error(`Unrecognized style ${ styleName }. Could not fall back to "Default" style since it doesn't exist.`);
}
}
this._style = style;
this._start = Dialogue._toTime(template.get("start"));
this._end = Dialogue._toTime(template.get("end"));
const start = template.get("start");
if (typeof start !== "string") {
throw new Error(`Dialogue start time ${ start } is not a string.`);
}
this._start = toTime(start);
const end = template.get("end");
if (typeof end !== "string") {
throw new Error(`Dialogue end time ${ end } is not a string.`);
}
this._end = toTime(end);
this._layer = Math.max(valueOrDefault(template, "layer", parseInt, value => !isNaN(value), "0"), 0);
this._rawPartsString = template.get("text");
if (this._rawPartsString === undefined || this._rawPartsString === null || this._rawPartsString.constructor !== String) {
throw new Error("Dialogue doesn't have any text.");
const text = template.get("text");
if (typeof text !== "string") {
throw new Error(`Dialogue text ${ text } is not a string.`);
}
this._rawPartsString = text;
}
/**
@@ -172,7 +184,7 @@ export class Dialogue {
this._parsePartsString();
}
return this._parts;
return this._parts!;
}
/**
@@ -199,7 +211,7 @@ export class Dialogue {
* Parses this dialogue's parts from the raw parts string.
*/
private _parsePartsString(): void {
this._parts = <parts.Part[]>parse(this._rawPartsString, "dialogueParts");
this._parts = parse(this._rawPartsString, "dialogueParts") as parts.Part[];
this._alignment = this._style.alignment;
@@ -209,21 +221,21 @@ export class Dialogue {
}
else if (part instanceof parts.Move) {
if (part.t1 === null || part.t2 === null) {
this._parts[index] =
this._parts![index] =
new parts.Move(
part.x1, part.y1, part.x2, part.y2,
0, this._end - this._start
0, this._end - this._start,
);
}
}
else if (part instanceof parts.Transform) {
if (part.start === null || part.end === null || part.accel === null) {
this._parts[index] =
this._parts![index] =
new parts.Transform(
(part.start === null) ? 0 : part.start,
(part.end === null) ? (this._end - this._start) : part.end,
(part.accel === null) ? 1 : part.accel,
part.tags
part.tags,
);
}
@@ -240,19 +252,19 @@ ${ this._rawPartsString }
was parsed as
${ this.toString() }
The possibly incorrect parses are:
${ possiblyIncorrectParses.join("\n") }`
${ possiblyIncorrectParses.join("\n") }`,
);
}
}
}
/**
* Converts this string into the number of seconds it represents. This string must be in the form of hh:mm:ss.MMM
*
* @param {string} str
* @return {number}
*/
private static _toTime(str: string): number {
return str.split(":").reduce<number>((previousValue, currentValue) => previousValue * 60 + parseFloat(currentValue), 0);
}
}
/**
* Converts this string into the number of seconds it represents. This string must be in the form of hh:mm:ss.MMM
*
* @param {string} str
* @return {number}
*/
function toTime(str: string): number {
return str.split(":").reduce<number>((previousValue, currentValue) => previousValue * 60 + parseFloat(currentValue), 0);
}
+1 -3
View File
@@ -18,8 +18,6 @@
* limitations under the License.
*/
import { Map } from "../utility/map";
/**
* The format of the string passed to {@link libjass.ASS.fromString}
*/
@@ -84,7 +82,7 @@ export interface TypedTemplate {
* @param {T} defaultValue
* @return {T}
*/
export function valueOrDefault<T>(template: Map<string, string>, key: string, converter: (str: string) => T, validator: (value: T) => boolean, defaultValue: string): T {
export function valueOrDefault<T>(template: Map<string, string>, key: string, converter: (str: string) => T, validator: ((value: T) => boolean) | null, defaultValue: string): T {
const value = template.get(key);
if (value === undefined) {
return converter(defaultValue);
+3
View File
@@ -18,11 +18,14 @@
* limitations under the License.
*/
import { registerClass as serializable } from "../serialization";
import { WrappingStyle } from "./misc";
/**
* This class represents the properties of a {@link libjass.ASS} script.
*/
@serializable
export class ScriptProperties {
private _resolutionX: number;
private _resolutionY: number;
+14 -11
View File
@@ -18,14 +18,16 @@
* limitations under the License.
*/
import { valueOrDefault, BorderStyle } from "./misc";
import { parse } from "../parser/parse";
import { Color } from "../parts";
import { registerClass as serializable } from "../serialization";
import { Map } from "../utility/map";
import { BorderStyle, valueOrDefault } from "./misc";
/**
* This class represents a single global style declaration in a {@link libjass.ASS} script. The styles can be obtained via the {@link libjass.ASS.styles} property.
*
@@ -50,6 +52,7 @@ import { Map } from "../utility/map";
* @param {string} template["MarginR"] The right margin
* @param {string} template["MarginV"] The vertical margin
*/
@serializable
export class Style {
private _name: string;
@@ -93,11 +96,11 @@ export class Style {
template = normalizedTemplate;
}
this._name = template.get("name");
if (this._name === undefined || this._name === null || this._name.constructor !== String) {
throw new Error("Style doesn't have a name.");
const name = template.get("name");
if (typeof name !== "string") {
throw new Error(`Style name ${ name } is not a string.`);
}
this._name = this._name.replace(/^\*+/, "");
this._name = name.replace(/^\*+/, "");
this._italic = !!valueOrDefault(template, "italic", parseFloat, value => !isNaN(value), "0");
this._bold = !!valueOrDefault(template, "bold", parseFloat, value => !isNaN(value), "0");
@@ -114,13 +117,13 @@ export class Style {
this._rotationZ = valueOrDefault(template, "angle", parseFloat, value => !isNaN(value), "0");
this._primaryColor = valueOrDefault(template, "primarycolour", str => <Color>parse(str, "colorWithAlpha"), null, "&H00FFFFFF");
this._secondaryColor = valueOrDefault(template, "secondarycolour", str => <Color>parse(str, "colorWithAlpha"), null, "&H00FFFF00");
this._outlineColor = valueOrDefault(template, "outlinecolour", str => <Color>parse(str, "colorWithAlpha"), null, "&H00000000");
this._shadowColor = valueOrDefault(template, "backcolour", str => <Color>parse(str, "colorWithAlpha"), null, "&H80000000");
this._primaryColor = valueOrDefault(template, "primarycolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00FFFFFF");
this._secondaryColor = valueOrDefault(template, "secondarycolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00FFFF00");
this._outlineColor = valueOrDefault(template, "outlinecolour", str => parse(str, "colorWithAlpha") as Color, null, "&H00000000");
this._shadowColor = valueOrDefault(template, "backcolour", str => parse(str, "colorWithAlpha") as Color, null, "&H80000000");
this._outlineThickness = valueOrDefault(template, "outline", parseFloat, value => value >= 0, "2");
this._borderStyle = valueOrDefault(template, "borderstyle", parseInt, value => (<any>BorderStyle)[(<any>BorderStyle)[value]] === value, "1");
this._borderStyle = valueOrDefault(template, "borderstyle", parseInt, value => (BorderStyle as any)[(BorderStyle as any)[value]] === value, "1");
this._shadowDepth = valueOrDefault(template, "shadow", parseFloat, value => value >= 0, "3");
+67 -96
View File
@@ -18,64 +18,6 @@
* limitations under the License.
*/
declare const global: {
Map?: typeof Map;
};
export interface Map<K, V> {
/**
* @param {K} key
* @return {V}
*/
get(key: K): V;
/**
* @param {K} key
* @return {boolean}
*/
has(key: K): boolean;
/**
* @param {K} key
* @param {V} value
* @return {libjass.Map.<K, V>} This map
*/
set(key: K, value?: V): Map<K, V>;
/**
* @param {K} key
* @return {boolean} true if the key was present before being deleted, false otherwise
*/
delete(key: K): boolean;
/**
*/
clear(): void;
/**
* @param {function(V, K, libjass.Map.<K, V>)} callbackfn A function that is called with each key and value in the map.
* @param {*} thisArg
*/
forEach(callbackfn: (value: V, index: K, map: Map<K, V>) => void, thisArg?: any): void;
/**
* @type {number}
*/
size: number;
}
/**
* Set to the global implementation of Map if the environment has one, else set to {@link ./utility/map.SimpleMap}
*
* Set it to null to force {@link ./utility/map.SimpleMap} to be used even if a global Map is present.
*
* @type {function(new:Map, !Array.<!Array.<*>>=)}
*/
export var Map: {
new <K, V>(iterable?: [K, V][]): Map<K, V>;
prototype: Map<any, any>;
} = global.Map;
/**
* Map implementation for browsers that don't support it. Only supports keys which are of Number or String type, or which have a property called "id".
*
@@ -83,7 +25,7 @@ export var Map: {
*
* @param {!Array.<!Array.<*>>=} iterable Only an array of elements (where each element is a 2-tuple of key and value) is supported.
*/
class SimpleMap<K, V> {
class SimpleMap<K, V> implements Map<K, V> {
private _keys: { [key: string]: K };
private _values: { [key: string]: V };
private _size: number;
@@ -106,10 +48,10 @@ class SimpleMap<K, V> {
/**
* @param {K} key
* @return {V}
* @return {?V}
*/
get(key: K): V {
const property = this._keyToProperty(key);
get(key: K): V | undefined {
const property = keyToProperty(key);
if (property === null) {
return undefined;
@@ -123,7 +65,7 @@ class SimpleMap<K, V> {
* @return {boolean}
*/
has(key: K): boolean {
const property = this._keyToProperty(key);
const property = keyToProperty(key);
if (property === null) {
return false;
@@ -137,8 +79,8 @@ class SimpleMap<K, V> {
* @param {V} value
* @return {libjass.Map.<K, V>} This map
*/
set(key: K, value: V): Map<K, V> {
const property = this._keyToProperty(key);
set(key: K, value: V): this {
const property = keyToProperty(key);
if (property === null) {
throw new Error("This Map implementation only supports Number and String keys, or keys with an id property.");
@@ -159,7 +101,7 @@ class SimpleMap<K, V> {
* @return {boolean} true if the key was present before being deleted, false otherwise
*/
delete(key: K): boolean {
const property = this._keyToProperty(key);
const property = keyToProperty(key);
if (property === null) {
return false;
@@ -188,7 +130,7 @@ class SimpleMap<K, V> {
* @param {function(V, K, libjass.Map.<K, V>)} callbackfn A function that is called with each key and value in the map.
* @param {*} thisArg
*/
forEach(callbackfn: (value: V, index: K, map: Map<K, V>) => void, thisArg?: any): void {
forEach(callbackfn: (value: V, index: K, map: this) => void, thisArg?: any): void {
for (const property of Object.keys(this._keys)) {
callbackfn.call(thisArg, this._values[property], this._keys[property], this);
}
@@ -200,47 +142,54 @@ class SimpleMap<K, V> {
get size(): number {
return this._size;
}
/**
* Converts the given key into a property name for the internal map.
*
* @param {K} key
* @return {string}
*/
private _keyToProperty(key: K): string {
if (typeof key === "number") {
return `#${ key }`;
}
if (typeof key === "string") {
return `'${ key }`;
}
if ((<any>key).id !== undefined) {
return `!${ (<any>key).id }`;
}
return null;
}
}
if (Map === undefined || typeof Map.prototype.forEach !== "function" || (() => {
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Map if the environment has one, else set to {@link ./utility/map.SimpleMap}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/map.SimpleMap} to be used even if a global Map is present.
*
* @type {function(new:Map, !Array.<!Array.<*>>=)}
*/
export let Map: {
new <K, V>(iterable?: [K, V][]): Map<K, V>;
/* tslint:disable-next-line:member-ordering */
prototype: Map<any, any>;
} = (() => {
const globalMap = global.Map;
if (globalMap === undefined) {
return SimpleMap;
}
if (typeof globalMap.prototype.forEach !== "function") {
return SimpleMap;
}
try {
return new Map([[1, "foo"], [2, "bar"]]).size !== 2;
if (new globalMap([[1, "foo"], [2, "bar"]]).size !== 2) {
return SimpleMap;
}
}
catch (ex) {
return true;
return SimpleMap;
}
})()) {
Map = SimpleMap;
}
return globalMap as any;
})();
/* tslint:enable:variable-name */
/**
* Sets the Map implementation used by libjass to the provided one. If null, {@link ./utility/map.SimpleMap} is used.
*
* @param {?function(new:Map, !Array.<!Array.<*>>=)} value
*/
export function setImplementation(value: typeof Map): void {
export function setImplementation(value: typeof Map | null): void {
if (value !== null) {
Map = value;
}
@@ -248,3 +197,25 @@ export function setImplementation(value: typeof Map): void {
Map = SimpleMap;
}
}
/**
* Converts the given key into a property name for the internal map.
*
* @param {*} key
* @return {?string}
*/
function keyToProperty(key: any): string | null {
if (typeof key === "number") {
return `#${ key }`;
}
if (typeof key === "string") {
return `'${ key }`;
}
if ((key as any).id !== undefined) {
return `!${ (key as any).id }`;
}
return null;
}
+164 -203
View File
@@ -18,69 +18,15 @@
* limitations under the License.
*/
declare const global: {
Promise?: typeof Promise;
MutationObserver?: typeof MutationObserver;
WebkitMutationObserver?: typeof MutationObserver;
process?: {
nextTick(callback: () => void): void;
}
};
export interface Thenable<T> {
/** @type {function(this:!Thenable.<T>, function(T|!Thenable.<T>), function(*))} */
then: ThenableThen<T>;
}
export interface ThenableThen<T> {
/** @type {function(this:!Thenable.<T>, function(T|!Thenable.<T>), function(*))} */
(resolve: (resolution: T | Thenable<T>) => void, reject: (reason: any) => void): void;
}
export interface Promise<T> extends Thenable<T> {
/**
* @param {?function(T):!Thenable.<U>} onFulfilled
* @param {?function(*):(U|!Thenable.<U>)} onRejected
* @return {!Promise.<U>}
*/
then<U>(onFulfilled?: (value: T) => Thenable<U>, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
/**
* @param {?function(T):U} onFulfilled
* @param {?function(*):(U|!Thenable.<U>)} onRejected
* @return {!Promise.<U>}
*/
then<U>(onFulfilled?: (value: T) => U, onRejected?: (reason: any) => U | Thenable<U>): Promise<U>;
/**
* @param {function(*):(T|!Thenable.<T>)} onRejected
* @return {!Promise.<T>}
*/
catch(onRejected?: (reason: any) => T | Thenable<T>): Promise<T>
}
/**
* Set to the global implementation of Promise if the environment has one, else set to {@link ./utility/promise.SimplePromise}
*
* Set it to null to force {@link ./utility/promise.SimplePromise} to be used even if a global Promise is present.
*
* @type {function(new:Promise)}
*/
export var Promise: {
new <T>(init: (resolve: (value: T | Thenable<T>) => void, reject: (reason: any) => void) => void): Promise<T>;
prototype: Promise<any>;
resolve<T>(value: T | Thenable<T>): Promise<T>;
reject<T>(reason: any): Promise<T>;
all<T>(values: (T | Thenable<T>)[]): Promise<T[]>;
race<T>(values: (T | Thenable<T>)[]): Promise<T>;
} = global.Promise;
// Based on https://github.com/petkaantonov/bluebird/blob/1b1467b95442c12378d0ea280ede61d640ab5510/src/schedule.js
const enqueueJob: (callback: () => void) => void = (function () {
const enqueueJob = (function (): (callback: () => void) => void {
/* tslint:disable-next-line:variable-name */
const MutationObserver = global.MutationObserver || global.WebkitMutationObserver;
if (global.process !== undefined && typeof global.process.nextTick === "function") {
const nextTick = global.process.nextTick;
return (callback: () => void) => {
global.process.nextTick(callback);
nextTick(callback);
};
}
else if (MutationObserver !== undefined) {
@@ -126,80 +72,6 @@ const enqueueJob: (callback: () => void) => void = (function () {
* @param {function(function(T|!Thenable.<T>), function(*))} executor
*/
class SimplePromise<T> {
private _state: SimplePromiseState = SimplePromiseState.PENDING;
private _fulfillReactions: FulfilledPromiseReaction<T, any>[] = [];
private _rejectReactions: RejectedPromiseReaction<any>[] = [];
private _fulfilledValue: T = null;
private _rejectedReason: any = null;
constructor(executor: (resolve: (resolution: T | Thenable<T>) => void, reject: (reason: any) => void) => void) {
if (typeof executor !== "function") {
throw new TypeError(`typeof executor !== "function"`);
}
const { resolve, reject } = this._createResolvingFunctions();
try {
executor(resolve, reject);
}
catch (ex) {
reject(ex);
}
}
/**
* @param {?function(T):(U|!Thenable.<U>)} onFulfilled
* @param {?function(*):(U|!Thenable.<U>)} onRejected
* @return {!Promise.<U>}
*/
then<U>(onFulfilled: (value: T) => U | Thenable<U>, onRejected: (reason: any) => U | Thenable<U>): Promise<U> {
const resultCapability = new DeferredPromise<U>();
if (typeof onFulfilled !== "function") {
onFulfilled = (value: T) => <U><any>value;
}
if (typeof onRejected !== "function") {
onRejected = (reason: any): U => { throw reason; };
}
const fulfillReaction: FulfilledPromiseReaction<T, U> = {
capabilities: resultCapability,
handler: onFulfilled,
};
const rejectReaction: RejectedPromiseReaction<U> = {
capabilities: resultCapability,
handler: onRejected,
};
switch (this._state) {
case SimplePromiseState.PENDING:
this._fulfillReactions.push(fulfillReaction);
this._rejectReactions.push(rejectReaction);
break;
case SimplePromiseState.FULFILLED:
this._enqueueFulfilledReactionJob(fulfillReaction, this._fulfilledValue);
break;
case SimplePromiseState.REJECTED:
this._enqueueRejectedReactionJob(rejectReaction, this._rejectedReason);
break;
}
return resultCapability.promise;
}
/**
* @param {function(*):(T|!Thenable.<T>)} onRejected
* @return {!Promise.<T>}
*/
catch(onRejected?: (reason: any) => T | Thenable<T>): Promise<T> {
return this.then(null, onRejected);
}
/**
* @param {T|!Thenable.<T>} value
* @return {!Promise.<T>}
@@ -217,7 +89,7 @@ class SimplePromise<T> {
* @return {!Promise.<T>}
*/
static reject<T>(reason: any): Promise<T> {
return new Promise<T>((/* ujs:unreferenced */ resolve, reject) => reject(reason));
return new Promise<T>((/* ujs:unreferenced */ _resolve, reject) => reject(reason));
}
/**
@@ -252,11 +124,83 @@ class SimplePromise<T> {
static race<T>(values: (T | Thenable<T>)[]): Promise<T> {
return new Promise<T>((resolve, reject) => {
for (const value of values) {
/* tslint:disable-next-line:no-floating-promises */
Promise.resolve(value).then(resolve, reject);
}
});
}
private _state: SimplePromiseState<T> = { state: "pending" };
private _fulfillReactions: FulfilledPromiseReaction<T, any>[] = [];
private _rejectReactions: RejectedPromiseReaction<any>[] = [];
constructor(executor: (resolve: (resolution: T | Thenable<T>) => void, reject: (reason: any) => void) => void) {
/* tslint:disable-next-line:strict-type-predicates */
if (typeof executor !== "function") {
throw new TypeError(`typeof executor !== "function"`);
}
const { resolve, reject } = this._createResolvingFunctions();
try {
executor(resolve, reject);
}
catch (ex) {
reject(ex);
}
}
/**
* @param {?function(T):(U|!Thenable.<U>)} onFulfilled
* @param {?function(*):(U|!Thenable.<U>)} onRejected
* @return {!Promise.<U>}
*/
then<U>(onFulfilled: ((value: T) => U | Thenable<U>) | undefined, onRejected?: (reason: any) => U | Thenable<U>): Promise<U> {
const resultCapability = new DeferredPromise<U>();
if (typeof onFulfilled !== "function") {
onFulfilled = (value: T) => value as any as U;
}
if (typeof onRejected !== "function") {
onRejected = (reason: any): U => { throw reason; };
}
const fulfillReaction: FulfilledPromiseReaction<T, U> = {
capabilities: resultCapability,
handler: onFulfilled,
};
const rejectReaction: RejectedPromiseReaction<U> = {
capabilities: resultCapability,
handler: onRejected,
};
switch (this._state.state) {
case "pending":
this._fulfillReactions.push(fulfillReaction);
this._rejectReactions.push(rejectReaction);
break;
case "fulfilled":
enqueueFulfilledReactionJob(fulfillReaction, this._state.value);
break;
case "rejected":
enqueueRejectedReactionJob(rejectReaction, this._state.reason);
break;
}
return resultCapability.promise;
}
/**
* @param {function(*):(T|!Thenable.<T>)} onRejected
* @return {!Promise.<T>}
*/
catch(onRejected: (reason: any) => T | Thenable<T>): Promise<T> {
return this.then(undefined, onRejected);
}
/**
* @return {{ resolve(T|!Thenable.<T>), reject(*) }}
*/
@@ -275,25 +219,29 @@ class SimplePromise<T> {
return;
}
/* tslint:disable-next-line:strict-type-predicates */
if (resolution === null || (typeof resolution !== "object" && typeof resolution !== "function")) {
this._fulfill(<T>resolution);
this._fulfill(resolution as T);
return;
}
let then: ThenableThen<T>;
try {
var then = (<Thenable<T>>resolution).then;
then = (resolution as Thenable<T>).then;
}
catch (ex) {
this._reject(ex);
return;
}
/* tslint:disable-next-line:strict-type-predicates */
if (typeof then !== "function") {
this._fulfill(<T>resolution);
this._fulfill(resolution as T);
return;
}
enqueueJob(() => this._resolveWithThenable(<Thenable<T>>resolution, then));
enqueueJob(() => this._resolveWithThenable(resolution as Thenable<T>, then));
};
const reject = (reason: any): void => {
@@ -330,13 +278,12 @@ class SimplePromise<T> {
private _fulfill(value: T): void {
const reactions = this._fulfillReactions;
this._fulfilledValue = value;
this._fulfillReactions = undefined;
this._rejectReactions = undefined;
this._state = SimplePromiseState.FULFILLED;
this._state = { state: "fulfilled", value };
this._fulfillReactions = [];
this._rejectReactions = [];
for (const reaction of reactions) {
this._enqueueFulfilledReactionJob(reaction, value);
enqueueFulfilledReactionJob(reaction, value);
}
}
@@ -346,64 +293,38 @@ class SimplePromise<T> {
private _reject(reason: any): void {
const reactions = this._rejectReactions;
this._rejectedReason = reason;
this._fulfillReactions = undefined;
this._rejectReactions = undefined;
this._state = SimplePromiseState.REJECTED;
this._state = { state: "rejected", reason };
this._fulfillReactions = [];
this._rejectReactions = [];
for (const reaction of reactions) {
this._enqueueRejectedReactionJob(reaction, reason);
enqueueRejectedReactionJob(reaction, reason);
}
}
/**
* @param {!FulfilledPromiseReaction.<T, *>} reaction
* @param {T} value
*/
private _enqueueFulfilledReactionJob(reaction: FulfilledPromiseReaction<T, any>, value: T): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(value);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}
/**
* @param {!RejectedPromiseReaction.<*>} reaction
* @param {*} reason
*/
private _enqueueRejectedReactionJob(reaction: RejectedPromiseReaction<any>, reason: any): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(reason);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}
}
if (Promise === undefined) {
Promise = SimplePromise;
}
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Promise if the environment has one, else set to {@link ./utility/promise.SimplePromise}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/promise.SimplePromise} to be used even if a global Promise is present.
*
* @type {function(new:Promise)}
*/
export let Promise: {
new <T>(init: (resolve: (value: T | Thenable<T>) => void, reject: (reason: any) => void) => void): Promise<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Promise<any>;
resolve<T>(value: T | Thenable<T>): Promise<T>;
reject<T>(reason: any): Promise<T>;
all<T>(values: (T | Thenable<T>)[]): Promise<T[]>;
race<T>(values: (T | Thenable<T>)[]): Promise<T>;
} = global.Promise || SimplePromise;
/* tslint:enable:variable-name */
interface FulfilledPromiseReaction<T, U> {
/** @type {!libjass.DeferredPromise.<U>} */
@@ -430,18 +351,14 @@ interface RejectedPromiseReaction<U> {
/**
* The state of the {@link ./utility/promise.SimplePromise}
*/
enum SimplePromiseState {
PENDING = 0,
FULFILLED = 1,
REJECTED = 2,
}
type SimplePromiseState<T> = { state: "pending" } | { state: "fulfilled"; value: T; } | { state: "rejected"; reason: any; };
/**
* Sets the Promise implementation used by libjass to the provided one. If null, {@link ./utility/promise.SimplePromise} is used.
*
* @param {?function(new:Promise)} value
*/
export function setImplementation(value: typeof Promise): void {
export function setImplementation(value: typeof Promise | null): void {
if (value !== null) {
Promise = value;
}
@@ -454,8 +371,6 @@ export function setImplementation(value: typeof Promise): void {
* A deferred promise.
*/
export class DeferredPromise<T> {
private _promise: Promise<T>;
/**
* @type {function(T|!Thenable.<T>)}
*/
@@ -466,6 +381,8 @@ export class DeferredPromise<T> {
*/
reject: (reason: any) => void;
private _promise: Promise<T>;
constructor() {
this._promise = new Promise<T>((resolve, reject) => {
Object.defineProperties(this, {
@@ -534,3 +451,47 @@ export function lastly<T>(promise: Promise<T>, body: () => void): Promise<T> {
throw reason;
});
}
/**
* @param {!FulfilledPromiseReaction.<T, *>} reaction
* @param {T} value
*/
function enqueueFulfilledReactionJob<T>(reaction: FulfilledPromiseReaction<T, any>, value: T): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(value);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}
/**
* @param {!RejectedPromiseReaction.<*>} reaction
* @param {*} reason
*/
function enqueueRejectedReactionJob(reaction: RejectedPromiseReaction<any>, reason: any): void {
enqueueJob(() => {
const { capabilities: { resolve, reject }, handler } = reaction;
let handlerResult: any | Thenable<any>;
try {
handlerResult = handler(reason);
}
catch (ex) {
reject(ex);
return;
}
resolve(handlerResult);
});
}
+59 -75
View File
@@ -18,51 +18,6 @@
* limitations under the License.
*/
declare const global: {
Set?: typeof Set;
};
export interface Set<T> {
/**
* @param {T} value
* @return {libjass.Set.<T>} This set
*/
add(value: T): Set<T>;
/**
*/
clear(): void;
/**
* @param {T} value
* @return {boolean}
*/
has(value: T): boolean;
/**
* @param {function(T, T, libjass.Set.<T>)} callbackfn A function that is called with each value in the set.
* @param {*} thisArg
*/
forEach(callbackfn: (value: T, index: T, set: Set<T>) => void, thisArg?: any): void;
/**
* @type {number}
*/
size: number;
}
/**
* Set to the global implementation of Set if the environment has one, else set to {@link ./utility/set.SimpleSet}
*
* Set it to null to force {@link ./utility/set.SimpleSet} to be used even if a global Set is present.
*
* @type {function(new:Set, !Array.<T>=)}
*/
export var Set: {
new <T>(iterable?: T[]): Set<T>;
prototype: Set<any>;
} = global.Set;
/**
* Set implementation for browsers that don't support it. Only supports Number and String elements.
*
@@ -70,7 +25,7 @@ export var Set: {
*
* @param {!Array.<T>=} iterable Only an array of values is supported.
*/
class SimpleSet<T> {
class SimpleSet<T> implements Set<T> {
private _elements: { [key: string]: T };
private _size: number;
@@ -94,8 +49,8 @@ class SimpleSet<T> {
* @param {T} value
* @return {libjass.Set.<T>} This set
*/
add(value: T): Set<T> {
const property = this._toProperty(value);
add(value: T): this {
const property = toProperty(value);
if (property === null) {
throw new Error("This Set implementation only supports Number and String values.");
@@ -122,7 +77,7 @@ class SimpleSet<T> {
* @return {boolean}
*/
has(value: T): boolean {
const property = this._toProperty(value);
const property = toProperty(value);
if (property === null) {
return false;
@@ -135,7 +90,7 @@ class SimpleSet<T> {
* @param {function(T, T, libjass.Set.<T>)} callbackfn A function that is called with each value in the set.
* @param {*} thisArg
*/
forEach(callbackfn: (value: T, index: T, set: Set<T>) => void, thisArg?: any): void {
forEach(callbackfn: (value: T, index: T, set: this) => void, thisArg?: any): void {
for (const property of Object.keys(this._elements)) {
const element = this._elements[property];
callbackfn.call(thisArg, element, element, this);
@@ -148,43 +103,54 @@ class SimpleSet<T> {
get size(): number {
return this._size;
}
/**
* Converts the given value into a property name for the internal map.
*
* @param {T} value
* @return {string}
*/
private _toProperty(value: T): string {
if (typeof value === "number") {
return `#${ value }`;
}
if (typeof value === "string") {
return `'${ value }`;
}
return null;
}
}
if (Set === undefined || typeof Set.prototype.forEach !== "function" || (() => {
/* tslint:disable:variable-name */
/**
* Set to the global implementation of Set if the environment has one, else set to {@link ./utility/set.SimpleSet}
*
* Can be set to a value using {@link libjass.configure}
*
* Set it to null to force {@link ./utility/set.SimpleSet} to be used even if a global Set is present.
*
* @type {function(new:Set, !Array.<T>=)}
*/
export let Set: {
new <T>(iterable?: T[]): Set<T>;
/* tslint:disable-next-line:member-ordering */
prototype: Set<any>;
} = (() => {
const globalSet = global.Set;
if (globalSet === undefined) {
return SimpleSet;
}
if (typeof globalSet.prototype.forEach !== "function") {
return SimpleSet;
}
try {
return new Set([1, 2]).size !== 2;
if ((new globalSet([1, 2])).size !== 2) {
return SimpleSet;
}
}
catch (ex) {
return true;
return SimpleSet;
}
})()) {
Set = SimpleSet;
}
return globalSet as any;
})();
/* tslint:enable:variable-name */
/**
* Sets the Set implementation used by libjass to the provided one. If null, {@link ./utility/set.SimpleSet} is used.
*
* @param {?function(new:Set, !Array.<T>=)} value
*/
export function setImplementation(value: typeof Set): void {
export function setImplementation(value: typeof Set | null): void {
if (value !== null) {
Set = value;
}
@@ -192,3 +158,21 @@ export function setImplementation(value: typeof Set): void {
Set = SimpleSet;
}
}
/**
* Converts the given value into a property name for the internal map.
*
* @param {*} value
* @return {?string}
*/
function toProperty(value: any): string | null {
if (typeof value === "number") {
return `#${ value }`;
}
if (typeof value === "string") {
return `'${ value }`;
}
return null;
}
-86
View File
@@ -1,86 +0,0 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Class inheritance shim.
*
* @param {!Function} derived
* @param {!Function} base
*/
export function __extends(derived: any, base: any): void {
for (const property in base) {
if (base.hasOwnProperty(property)) {
derived[property] = base[property];
}
}
function __() {
this.constructor = derived;
}
__.prototype = base.prototype;
derived.prototype = new (<any>__)();
}
/**
* Decorator shim.
*
* @param {!Array.<!Function>} decorators
* @param {!*} target
* @param {string=} key
* @return {*}
*/
export function __decorate(decorators: Function[], target: any, key?: string): any {
if (arguments.length < 3) {
return decorateClass(<any>decorators.reverse(), target);
}
else {
decorateField(<any>decorators.reverse(), target, key);
}
}
/**
* Class decorator shim.
*
* @param {!Array.<function(function(new(): T)): function(new(): T)>} decorators
* @param {function(new(): T)} clazz
* @return {function(new(): T)}
*/
function decorateClass<T>(decorators: ((clazz: { new (...args: any[]): T }) => { new (...args: any[]): T })[], clazz: { new (...args: any[]): T }): { new (...args: any[]): T } {
for (const decorator of decorators) {
clazz = decorator(clazz) || clazz;
}
return clazz;
}
/**
* Class member decorator shim.
*
* @param {!Array.<function(T, string)>} decorators
* @param {!T} proto
* @param {string} name
*/
function decorateField<T>(decorators: ((proto: T, name: string) => void)[], proto: T, name: string): void {
for (const decorator of decorators) {
decorator(proto, name);
}
}
+13 -37
View File
@@ -18,13 +18,14 @@
* limitations under the License.
*/
import { deserialize, serialize } from "../serialization";
import { Map } from "../utility/map";
import { Promise, DeferredPromise } from "../utility/promise";
import { DeferredPromise, Promise } from "../utility/promise";
import { WorkerCommands } from "./commands";
import { getWorkerCommandHandler, serialize, deserialize, registerWorkerCommand } from "./misc";
import { getWorkerCommandHandler, registerWorkerCommand } from "./misc";
/**
* Represents a communication channel between the host and the web worker. An instance of this class is created by calling {@link libjass.webworker.createWorker}
@@ -43,33 +44,7 @@ export interface WorkerChannel {
/**
* The signature of a handler registered to handle a particular command in {@link libjass.webworker.WorkerCommands}
*/
export interface WorkerCommandHandler {
(parameters: any): Promise<any>;
}
/**
* The interface implemented by a communication channel to the other side.
*/
interface WorkerCommunication {
/**
* @param {"message"} type
* @param {function(!MessageEvent): *} listener
* @param {?boolean} useCapture
*/
addEventListener(type: "message", listener: (ev: MessageEvent) => any, useCapture?: boolean): void;
/**
* @param {string} type
* @param {!EventListener} listener
* @param {?boolean} useCapture
*/
addEventListener(type: string, listener: EventListener, useCapture?: boolean): void;
/**
* @param {*} message
*/
postMessage(message: any): void;
}
export type WorkerCommandHandler = (parameters: any) => Promise<any>;
/**
* The interface implemented by a request sent to the other side of the communication channel.
@@ -132,10 +107,10 @@ interface WorkerResponseMessage {
export class WorkerChannelImpl implements WorkerChannel {
private static _lastRequestId: number = -1;
private _pendingRequests = new Map<number, DeferredPromise<any>>();
private _pendingRequests: Map<number, DeferredPromise<any>> = new Map<number, DeferredPromise<any>>();
constructor(private _comm: WorkerCommunication) {
this._comm.addEventListener("message", ev => this._onMessage(<string>ev.data), false);
this._comm.addEventListener("message", ev => this._onMessage(ev.data as string), false);
}
/**
@@ -182,10 +157,10 @@ export class WorkerChannelImpl implements WorkerChannel {
* @param {string} rawMessage
*/
private _onMessage(rawMessage: string): void {
const message = <{ command: WorkerCommands }>deserialize(rawMessage);
const message = deserialize(rawMessage) as { command: WorkerCommands };
if (message.command === WorkerCommands.Response) {
const responseMessage = <WorkerResponseMessage><any>message;
const responseMessage = message as any as WorkerResponseMessage;
const deferred = this._pendingRequests.get(responseMessage.requestId);
if (deferred !== undefined) {
@@ -199,7 +174,7 @@ export class WorkerChannelImpl implements WorkerChannel {
}
}
else {
const requestMessage = <WorkerRequestMessage>message;
const requestMessage = message as WorkerRequestMessage;
const requestId = requestMessage.requestId;
const commandCallback = getWorkerCommandHandler(requestMessage.command);
@@ -208,12 +183,13 @@ export class WorkerChannelImpl implements WorkerChannel {
return;
}
/* tslint:disable-next-line:no-floating-promises */
commandCallback(requestMessage.parameters).then<WorkerResponseMessage>(
result => ({ requestId, error: null, result }),
error => ({ requestId, error, result: null })
error => ({ requestId, error, result: null }),
).then(responseMessage => this._respond(responseMessage));
}
}
}
registerWorkerCommand(WorkerCommands.Ping, parameters => new Promise<void>(resolve => resolve(null)));
registerWorkerCommand(WorkerCommands.Ping, () => Promise.resolve(null));
+14 -12
View File
@@ -18,25 +18,19 @@
* limitations under the License.
*/
import { Map } from "../utility/map";
import { Promise, DeferredPromise } from "../utility/promise";
import { WorkerChannel, WorkerChannelImpl } from "./channel";
export { WorkerChannel } from "./channel";
export { WorkerCommands } from "./commands";
declare const exports: any;
/**
* Indicates whether web workers are supposed in this environment or not.
*
* @type {boolean}
*/
export const supported = typeof Worker !== "undefined";
export const supported = global.Worker !== undefined;
const _scriptNode = (typeof document !== "undefined" && document.currentScript !== undefined) ? document.currentScript : null;
const _scriptNode = (global.document !== undefined && global.document.currentScript !== undefined) ? global.document.currentScript : null;
/**
* Create a new web worker and returns a {@link libjass.webworker.WorkerChannel} to it.
@@ -45,13 +39,21 @@ const _scriptNode = (typeof document !== "undefined" && document.currentScript !
* the path will be determined from the src attribute of the <script> element that contains the currently running copy of libjass.js
* @return {!libjass.webworker.WorkerChannel} A communication channel to the new web worker.
*/
export function createWorker(scriptPath: string = _scriptNode.src): WorkerChannel {
export function createWorker(scriptPath?: string): WorkerChannel {
if (scriptPath === undefined) {
if (_scriptNode === null) {
throw new Error("Could not auto-detect path of libjass.js, and explicit path was not passed in.");
}
scriptPath = _scriptNode.src;
}
return new WorkerChannelImpl(new Worker(scriptPath));
}
declare const global: any;
if (typeof WorkerGlobalScope !== "undefined" && global instanceof WorkerGlobalScope) {
if (global.WorkerGlobalScope !== undefined && global instanceof global.WorkerGlobalScope) {
// This is a web worker. Set up a channel to talk back to the main thread.
/* tslint:disable-next-line:no-unused-expression */
new WorkerChannelImpl(global);
}
+2 -48
View File
@@ -20,13 +20,11 @@
import { Map } from "../utility/map";
import { WorkerCommands } from "./commands";
import { WorkerCommandHandler } from "./channel";
import { WorkerCommands } from "./commands";
const workerCommands = new Map<WorkerCommands, WorkerCommandHandler>();
const classPrototypes = new Map<number, any>();
/**
* Registers a handler for the given worker command.
*
@@ -43,50 +41,6 @@ export function registerWorkerCommand(command: WorkerCommands, handler: WorkerCo
* @param {number} command
* @return {?function(*, function(*, *))}
*/
export function getWorkerCommandHandler(command: WorkerCommands): WorkerCommandHandler {
export function getWorkerCommandHandler(command: WorkerCommands): WorkerCommandHandler | undefined {
return workerCommands.get(command);
}
/**
* Registers a prototype as a deserializable type.
*
* @param {!*} prototype
*/
export function registerClassPrototype(prototype: any): void {
prototype._classTag = classPrototypes.size;
classPrototypes.set(prototype._classTag, prototype);
}
/**
* @param {*} obj
* @return {string}
*/
export function serialize(obj: any): string {
return JSON.stringify(obj, (/* ujs:unreferenced */ key: string, value: any) => {
if (value && value._classTag !== undefined) {
value._classTag = value._classTag;
}
return value;
});
}
/**
* @param {string} str
* @return {*}
*/
export function deserialize(str: string): any {
return JSON.parse(str, (/* ujs:unreferenced */ key: string, value: any) => {
if (value && value._classTag !== undefined) {
const hydratedValue = Object.create(classPrototypes.get(value._classTag));
for (const key of Object.keys(value)) {
if (key !== "_classTag") {
hydratedValue[key] = value[key];
}
}
value = hydratedValue;
}
return value;
});
}
-44
View File
@@ -1,44 +0,0 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
interface Document {
/**
* @type {!HTMLScriptElement}
*/
currentScript: HTMLScriptElement;
}
interface WorkerGlobalScope {
/**
* @param {*} message
*/
postMessage(message: any): void;
/**
* @param {string} type
* @param {function(*)} listener
* @param {boolean} useCapture
*/
addEventListener(type: string, listener: (message: any) => void, useCapture: boolean): void;
}
declare var WorkerGlobalScope: {
prototype: WorkerGlobalScope;
new (): WorkerGlobalScope;
};
+3 -3
View File
@@ -2,8 +2,8 @@
Title:
ScriptType: v4.00+
WrapStyle: 0
PlayResX: 256
PlayResY: 144
PlayResX: 1280
PlayResY: 720
Scroll Position: 0
Active Line: 0
Video Zoom Percent: 1
@@ -11,7 +11,7 @@ ScaledBorderAndShadow: yes
[V4+ Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,100,&H7F0000FF,&H00FFFFFF,&H7F000000,&H7F000000,0,0,0,0,100,100,0,0,1,2,0,2,15,15,15,1
Style: Default,Arial,500,&H7F0000FF,&H00FFFFFF,&H7F000000,&H7F000000,0,0,0,0,100,100,0,0,1,10,0,2,75,75,75,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
+3 -2
View File
@@ -21,10 +21,11 @@
define(["intern!tdd", "require", "tests/support/test-page"], function (tdd, require, TestPage) {
tdd.suite("alpha", function () {
tdd.test("Basic", function () {
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/alpha/alpha.ass", 256, 144, "rgb(47, 163, 254)");
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/alpha/alpha.ass", 1280, 720, "rgb(47, 163, 254)");
return testPage
.prepare()
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1, require.toUrl("./alpha-1.png")); });
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1, require.toUrl("./alpha-1.png")); })
.then(function (testPage) { return testPage.done(); });
});
});
});
Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

+32
View File
@@ -0,0 +1,32 @@
[Script Info]
Title:
ScriptType: v4.00+
WrapStyle: 0
PlayResX: 1280
PlayResY: 720
Scroll Position: 0
Active Line: 0
Video Zoom Percent: 1
ScaledBorderAndShadow: yes
[V4+ Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,90,&H00FFFFFF,&H00000000,&H00000000,&H96000000,0,0,0,0,100,100,0,0,1,0,0,2,75,75,75,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an1\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an2\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an3\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an7\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an8\frz45}MM\NMM
Dialogue: 1,0:00:00.00,0:00:01.00,Default,,0,0,0,,{\an9\frz45}MM\NMM
Dialogue: 1,0:00:01.00,0:00:02.00,Default,,0,0,0,,{\an1\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:02.00,0:00:03.00,Default,,0,0,0,,{\an2\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:03.00,0:00:04.00,Default,,0,0,0,,{\an3\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:04.00,0:00:05.00,Default,,0,0,0,,{\an4\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:05.00,0:00:06.00,Default,,0,0,0,,{\an5\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:06.00,0:00:07.00,Default,,0,0,0,,{\an6\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:07.00,0:00:08.00,Default,,0,0,0,,{\an7\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:08.00,0:00:09.00,Default,,0,0,0,,{\an8\pos(640,360)\frz45}MM\NMM
Dialogue: 1,0:00:09.00,0:00:10.00,Default,,0,0,0,,{\an9\pos(640,360)\frz45}MM\NMM
+40
View File
@@ -0,0 +1,40 @@
/**
* libjass
*
* https://github.com/Arnavion/libjass
*
* Copyright 2013 Arnav Singh
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
define(["intern!tdd", "require", "tests/support/test-page"], function (tdd, require, TestPage) {
tdd.suite("fr", function () {
tdd.test("frz", function () {
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/fr/frz.ass", 1280, 720);
return testPage
.prepare()
.then(function (testPage) { return testPage.seekAndCompareScreenshot(0.5, require.toUrl("./frz-01.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1.5, require.toUrl("./frz-02.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(2.5, require.toUrl("./frz-03.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(3.5, require.toUrl("./frz-04.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(4.5, require.toUrl("./frz-05.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(5.5, require.toUrl("./frz-06.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(6.5, require.toUrl("./frz-07.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(7.5, require.toUrl("./frz-08.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(8.5, require.toUrl("./frz-09.png")); })
.then(function (testPage) { return testPage.seekAndCompareScreenshot(9.5, require.toUrl("./frz-10.png")); })
.then(function (testPage) { return testPage.done(); });
});
});
});
Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.4 KiB

+3 -3
View File
@@ -2,8 +2,8 @@
Title:
ScriptType: v4.00+
WrapStyle: 0
PlayResX: 256
PlayResY: 144
PlayResX: 1280
PlayResY: 720
Scroll Position: 0
Active Line: 0
Video Zoom Percent: 1
@@ -11,7 +11,7 @@ ScaledBorderAndShadow: yes
[V4+ Styles]
Format: Name, Fontname, Fontsize, PrimaryColour, SecondaryColour, OutlineColour, BackColour, Bold, Italic, Underline, StrikeOut, ScaleX, ScaleY, Spacing, Angle, BorderStyle, Outline, Shadow, Alignment, MarginL, MarginR, MarginV, Encoding
Style: Default,Arial,36,&H000000FF,&H00FFFFFF,&H00000000,&H00000000,0,0,0,0,100,100,0,0,1,2,1.2,2,15,15,15,1
Style: Default,Arial,180,&H000000FF,&H00FFFFFF,&H00000000,&H00000000,0,0,0,0,100,100,0,0,1,10,6,2,75,75,75,1
[Events]
Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text
+3 -2
View File
@@ -21,10 +21,11 @@
define(["intern!tdd", "require", "tests/support/test-page"], function (tdd, require, TestPage) {
tdd.suite("fscx and fscy", function () {
tdd.test("Basic", function () {
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/fsc/fsc.ass", 256, 144);
var testPage = new TestPage(this.remote, require.toUrl("tests/support/browser-test-page.html"), "/tests/functional/fsc/fsc.ass", 1280, 720);
return testPage
.prepare()
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1, require.toUrl("./fsc-1.png")); });
.then(function (testPage) { return testPage.seekAndCompareScreenshot(1, require.toUrl("./fsc-1.png")); })
.then(function (testPage) { return testPage.done(); });
});
});
});
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.0 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Some files were not shown because too many files have changed in this diff Show More