pdf.js/src/scripting_api/color.js
Jonas Jenwald 155c17c99a [Regression] Prevent the *built* pdf.scripting.js/pdf.sandbox.js files from accidentally including most of the main-thread code (PR 12631 follow-up)
*This is a recent regression, which I stumbled upon while working on cleaning-up the gulpfile related to `pdf.sandbox.js` building.*

By placing the `ColorConverters` functionality in the `src/display/display_utils.js` file, you end up including a *significant* chunk of the `pdf.js` file in the built `pdf.scripting.js`/`pdf.sandbox.js` files.
Given that I cannot imagine that this was actually intended, since it inflates the built files with unnecessary/unused code, this moves `ColorConverters` to a new file instead (thus breaking the dependencies).

To hopefully reduce the risk future bugs, along these lines, a big comment is also placed at the top of the new file.
Finally, the `ColorConverters` is converted to a class with static methods, since this felt slightly cleaner overall.
2020-12-04 14:17:26 +01:00

130 lines
3.2 KiB
JavaScript

/* Copyright 2020 Mozilla Foundation
*
* 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 { ColorConverters } from "../shared/scripting_utils.js";
import { PDFObject } from "./pdf_object.js";
class Color extends PDFObject {
constructor() {
super({});
this.transparent = ["T"];
this.black = ["G", 0];
this.white = ["G", 1];
this.red = ["RGB", 1, 0, 0];
this.green = ["RGB", 0, 1, 0];
this.blue = ["RGB", 0, 0, 1];
this.cyan = ["CMYK", 1, 0, 0, 0];
this.magenta = ["CMYK", 0, 1, 0, 0];
this.yellow = ["CMYK", 0, 0, 1, 0];
this.dkGray = ["G", 0.25];
this.gray = ["G", 0.5];
this.ltGray = ["G", 0.75];
}
static _isValidSpace(cColorSpace) {
return (
typeof cColorSpace === "string" &&
(cColorSpace === "T" ||
cColorSpace === "G" ||
cColorSpace === "RGB" ||
cColorSpace === "CMYK")
);
}
static _isValidColor(colorArray) {
if (!Array.isArray(colorArray) || colorArray.length === 0) {
return false;
}
const space = colorArray[0];
if (!Color._isValidSpace(space)) {
return false;
}
switch (space) {
case "T":
if (colorArray.length !== 1) {
return false;
}
break;
case "G":
if (colorArray.length !== 2) {
return false;
}
break;
case "RGB":
if (colorArray.length !== 4) {
return false;
}
break;
case "CMYK":
if (colorArray.length !== 5) {
return false;
}
break;
default:
return false;
}
return colorArray
.slice(1)
.every(c => typeof c === "number" && c >= 0 && c <= 1);
}
static _getCorrectColor(colorArray) {
return Color._isValidColor(colorArray) ? colorArray : ["G", 0];
}
convert(colorArray, cColorSpace) {
if (!Color._isValidSpace(cColorSpace)) {
return this.black;
}
if (cColorSpace === "T") {
return ["T"];
}
colorArray = Color._getCorrectColor(colorArray);
if (colorArray[0] === cColorSpace) {
return colorArray;
}
if (colorArray[0] === "T") {
return this.convert(this.black, cColorSpace);
}
return ColorConverters[`${colorArray[0]}_${cColorSpace}`](
colorArray.slice(1)
);
}
equal(colorArray1, colorArray2) {
colorArray1 = Color._getCorrectColor(colorArray1);
colorArray2 = Color._getCorrectColor(colorArray2);
if (colorArray1[0] === "T" || colorArray2[0] === "T") {
return colorArray1[0] === "T" && colorArray2[0] === "T";
}
if (colorArray1[0] !== colorArray2[0]) {
colorArray2 = this.convert(colorArray2, colorArray1[0]);
}
return colorArray1.slice(1).every((c, i) => c === colorArray2[i + 1]);
}
}
export { Color };