X-Git-Url: https://git.kianting.info/?a=blobdiff_plain;f=src%2Flibclo%2Findex.ts;h=d074e9c91ce127b4d03f560ae25a6f8c4c74b9aa;hb=714bbb4a64531268d17ca8f7ae60800ec2046a27;hp=7fd58c67868378a167ac574afca354868eaddaab;hpb=796e0c20c767e214b104fa3d17e754ce58da6e73;p=clo diff --git a/src/libclo/index.ts b/src/libclo/index.ts index 7fd58c6..d074e9c 100644 --- a/src/libclo/index.ts +++ b/src/libclo/index.ts @@ -1,7 +1,13 @@ -import { isKeyObject, isStringObject } from "util/types"; import {tkTree} from "../parser"; -import {TextStyle, FontStyle, TextWeight} from "../canva"; -import { isString } from "util"; +import {FontStyle, TextStyle, TextWeight, fontStyleTofont, fontPathPSNamePair} from "../canva"; +import * as fontkit from "fontkit"; +import * as breakLines from "./breakLines"; +const PDFDocument = require('pdfkit'); +import * as fs from "fs"; +import { Style } from "util"; +import { time } from "console"; +import {memfs} from "memfs"; + /** * TYPES @@ -13,30 +19,69 @@ import { isString } from "util"; * TTB - top to bottom * etc. */ -enum Direction{ +export enum Direction{ LTR, RTL, TTB, BTT, } +/** + * Horizonal glue. + * - stretchFactor : the stretch factor in float + */ +export interface HGlue{ + isHorizonalGlue : true, + stretchFactor: number +} + +export interface VGlue{ + isHorizonalGlue : false, + stretchFactor: number +} + +export interface BreakPoint{ + original : BoxesItem, + newLined : BoxesItem +} + +/** BR is like html br */ +export interface BR extends BreakPoint{ + isBR : true; +} + +export type BoxesItem = HGlue | Box | BreakPoint | BoxesItem[] ; /** * frame box is a subclass of box * - directionInsideLine : text direction inside a line * - baselineskip : the distance between baselines in px */ -interface FrameBox extends Box{ +export interface FrameBox extends Box{ directionInsideLine : Direction, baseLineskip : number | null, } +export interface CharBox extends Box{ + minX: number, + maxX: number, + minY: number, + maxY: number, + +} + /** * a basic Box + * - x : pt + * - y : pt + * - textStyle : + * - direction : + * - width : x_advance pt + * - content : */ -interface Box{ +export interface Box{ x : number | null, y : number | null, - fontStyle : FontStyle | null, + textStyle : TextStyle | null, direction : Direction, width : number, height : number, @@ -47,31 +92,39 @@ interface Box{ /** * DEFAULT CONST PART */ -const A4_IN_PX = {"width" : 793.7, +export const A4_IN_PX = {"width" : 793.7, "height" : 1122.5}; -const defaultTextStyle : FontStyle = { - family : "FreeSans", - size : 12, +export const defaultTextStyle : TextStyle = { + family : "Noto Sans CJK TC", + size : ptToPx(12), textWeight : TextWeight.REGULAR, - textStyle : TextStyle.ITALIC, + fontStyle : FontStyle.ITALIC, } -const defaultFrameStyle : FrameBox = { +export const defaultFrameStyle : FrameBox = { directionInsideLine : Direction.LTR, direction : Direction.TTB, baseLineskip : ptToPx(15), - fontStyle : defaultTextStyle, - x : A4_IN_PX.width * 0.10, - y : A4_IN_PX.height * 0.10, - width : A4_IN_PX.width * 0.80, - height : A4_IN_PX.height * 0.80, + textStyle : defaultTextStyle, + x : A4_IN_PX.width * 0.10 , + y : A4_IN_PX.height * 0.10 , + width : A4_IN_PX.width * 0.80 , + height : A4_IN_PX.height * 0.80 , content : null, }; -const cjkvBlocksInRegex = ["Hani"]; +/** + * definition for cjk scripts + * - Hani : Han Character + * - Hang : Hangul + * - Bopo : Bopomofo + * - Kana : Katakana + * - Hira : Hiragana +*/ +export const cjkvBlocksInRegex = ["Hani", "Hang", "Bopo", "Kana", "Hira"]; -const cjkvRegexPattern = new RegExp("((?:" + +export const cjkvRegexPattern = new RegExp("((?:" + cjkvBlocksInRegex.map((x)=>"\\p{Script_Extensions="+x+"}").join("|") + ")+)", "gu"); /** * FUNCTION PART @@ -81,8 +134,8 @@ const cjkvRegexPattern = new RegExp("((?:" + * @param pt pt size value * @returns the corresponding px value */ -function ptToPx(pt : number) : number{ - return pt * 4 / 3.0; +export function ptToPx(pt : number) : number{ + return pt * 4.0 / 3.0; } @@ -91,19 +144,54 @@ function ptToPx(pt : number) : number{ * REGISTER PART */ +/** + * convert '\n\n' to new paragraph command ["br"] + * @param arr the input `tkTree` + * @param clo the `Clo` object + * @returns the input tktree + */ +export function twoReturnsToNewline(arr : tkTree, clo : Clo): tkTree{ + var middle : tkTree = []; + + for (let i = 0; i < arr.length; i++) { + var item = arr[i]; + if (!Array.isArray(item)){ + middle = middle.concat(item.split(/(\n\n)/g)); + } + else{ + middle.push(item); + } + } + + var result : tkTree = []; + for (let j = 0; j < middle.length; j++){ + var item = middle[j]; + if (!Array.isArray(item) && item == "\n\n"){ + result.push(["br"]); // push a newline command to the result `tkTree` + } + else{ + result.push(middle[j]); + } + } + + return result; +} /** * split CJKV and non-CJKV * * @param arr : input tkTree - * @returns + * @returns a splitted tkTree (by CJK and NonCJK) + * - Examples: + * ``` + * [`many臺中daylight`] => [`many`, `臺中`, `dahylight`] + * ``` */ -function splitCJKV(arr : tkTree): tkTree{ +export function splitCJKV(arr : tkTree, clo : Clo): tkTree{ var result : tkTree = []; for (let i = 0; i < arr.length; i++) { var item = arr[i]; if (!Array.isArray(item)){ - console.log(item.split(cjkvRegexPattern)); result = result.concat(item.split(cjkvRegexPattern)); } else{ @@ -114,30 +202,305 @@ function splitCJKV(arr : tkTree): tkTree{ return result; } +/** + * hyphenation for a clo document + * @param arr the array for a `tkTree` + * @param clo the Clo object + */ +export function hyphenForClo(arr : tkTree, clo : Clo): tkTree{ + let hyphenLanguage : string = clo.attrs["hyphenLanguage"]; + let res = hyphenTkTree(arr, hyphenLanguage); + return res; + +} + +/** + * convert spaces to Breakpoint + * \s+ => ["bp" [\s+] ""] + * @param arr the tkTree input text stream + * @param clo the Clo object + * @returns the converted object + */ +export function spacesToBreakpoint(arr : tkTree, clo : Clo) : tkTree{ + let spacePattern = /^([ \t]+)$/g; + var result : tkTree = []; + for (let i = 0; i < arr.length; i++){ + var item = arr[i]; + if (!Array.isArray(item) && item.match(spacePattern)){ + // push a breakpoint command to the result `tkTree` + result.push([ 'bp', [["hglue", "0.1"], item] , "" ]); + } + else{ + result.push(item); + } + } + + return result; +} + +/** + * remove all the `` (empty string) in the arr + * @param arr the tkTree to be filtered + * @param clo the Clo file + */ +export function filterEmptyString(arr : tkTree, clo : Clo) : tkTree{ + if (Array.isArray(arr)){ + arr.filter((x)=>{return x != ``;}); + } + + return arr; +} + + +/** + * OTHER FUNCTIONS + */ + +/** + * hyphenate for a tkTree + * - hyphenation => ["bp", "", "-"] + * @param arr the tkTree array + * @param lang ISO 639 code for the language + */ +export function hyphenTkTree(arr : tkTree, lang: string) : tkTree{ + // import corresponding hyphen language data and function + let hyphen = require("hyphen/"+lang); + + let result :tkTree[] = []; + for (let i = 0; i < arr.length; i++) { + let element = arr[i]; + let splitter = "分"; // a CJKV + if (!Array.isArray(element)){ + let hyphenatedElement : string = hyphen.hyphenateSync(element, {hyphenChar :splitter}); + let hyphenatedSplitted : tkTree = hyphenatedElement.split(splitter); + var newSplitted : tkTree = []; + for (var j=0; j { + var res = []; + var styleCache = {}; + var fontCache = {}; + + for (var i=0; istyleCache, fontCache); + styleCache = item[1]; + fontCache = item[2]; + res.push(item[0]); + } + + res = res.flat(); + + return res; +} + + +/** + * calculate the text width and Height with a given `TextStyle` + * @param preprocessed + * @param defaultFontStyle + */ +export async function calculateTextWidthHeightAux(element : tkTree, + style : TextStyle, + styleCache : TextStyle, + fontCache : fontkit.Font): Promise<[BoxesItem, TextStyle, fontkit.Font] > { + var result : BoxesItem = []; + var font; + + if (style === styleCache){ + font = fontCache; + }else { + + + let fontPair = fontStyleTofont(style); + + if (fontPair.path.match(/\.ttc$/)){ + font = await fontkit.openSync(fontPair.path, fontPair.psName); + styleCache = style; + fontCache = font; + + } + else{ + font = await fontkit.openSync(fontPair.path); + styleCache = style; + fontCache = font; + } + + + + } + + + if (!Array.isArray(element)){ + var run = font.layout(element, undefined, undefined, undefined, "ltr"); + + + + for (var j=0;j + else if(element[0] == "br"){ + let brBoxItem = await calculateTextWidthHeightAux(["hglue", "10000"], + style, styleCache, fontCache); + //
+ let BR : BR = { + isBR : true, + original : brBoxItem[0], + newLined : brBoxItem[0]}; + return [BR, styleCache, fontCache]; + } + else{ + return [await calculateTextWidthHeight(element, style), styleCache, fontCache]; + } +} + +/** + * put childrenBox inside VBox + */ +export function putInVBox(childrenBox: Box[], parentBox: Box) : Box{ + var voffset = Array(childrenBox.length).fill(0); + + for (var i=0;iapplyVOffset(x, voffset)); + } + return box; +} + +/** + * whole document-representing class + */ export class Clo{ + /** storing the text string into the main frame */ mainStream : Array; + /** array of preprocessor functions to preprocess the `mainStream` */ preprocessors : Array; - attributes: {[index: string]:any} ; // a4 size(x,y) + /** the attributes for the Clo */ + attrs: {[index: string]:any} ; // a4 size(x,y) constructor(){ this.preprocessors = []; this.mainStream = []; - this.attributes = {"page" : A4_IN_PX}; + this.attrs = { + "page" : A4_IN_PX, // default for a4. in px of [x, y] + "defaultFrameStyle" : defaultFrameStyle, // defaultFrameStyle + "hyphenLanguage" : 'en' // hyphenated in the language (in ISO 639) + }; // register the precessor functions this.preprocessorRegister(splitCJKV); + this.preprocessorRegister(hyphenForClo); + this.preprocessorRegister(twoReturnsToNewline); + this.preprocessorRegister(spacesToBreakpoint); + this.preprocessorRegister(filterEmptyString); } public setAttr(attr : string, val : any):void{ - Object.assign(this.attributes, attr, val); + Object.assign(this.attrs, attr, val); } public getAttr(attr:string) : any{ - if (Object.keys(this.attributes).length === 0){ - return this.attributes[attr]; + if (Object.keys(this.attrs).length === 0){ + return this.attrs[attr]; }else{ return undefined; } @@ -152,18 +515,347 @@ export class Clo{ this.preprocessors.push(f); } - public generatePdf(){ + public async generatePdf(){ + // preprocessed - var prepro = this.mainStream; + var preprocessed = this.mainStream; for (var i = 0; ibreakLineAlgorithms.segmentedNodes(x, this.attrs.defaultFrameStyle.width)); + + let segmentedNodesToBox = segmentedNodes.map((x)=> + this.segmentedNodesToFrameBoxAux(x, this.attrs.defaultFrameStyle)); + + let boxWithParagraph = putInVBox(segmentedNodesToBox, this.attrs.defaultFrameStyle); + + console.log(boxWithParagraph); + + // fix the bug of main Frame x & y + if(boxWithParagraph.x !== null) + {boxWithParagraph.x *= 0.75} + if(boxWithParagraph.y !== null) + {boxWithParagraph.y *= 0.75} + + let boxesFixed = this.fixenBoxesPosition(boxWithParagraph); + + + (boxesFixed.content).map((e)=>{console.log(e.y)}); + + + // generate pdf + const doc = new PDFDocument({size: 'A4'}); + doc.pipe(fs.createWriteStream('output.pdf')); + this.grid(doc); + + let styleCache : any = {}; + let fontPairCache : fontPathPSNamePair = {path : "", psName : ""}; + await this.putText(doc, boxesFixed, styleCache, fontPairCache); + // putChar + doc.end(); + + + } + + paragraphize(calculated : BoxesItem[]): BoxesItem[][]{ + var res : BoxesItem[][] = [[]]; + for (var i=0;i(calculated[i])){ + res[res.length-1] = res[res.length-1].concat(calculated[i]); + res.push([]); + }else{ + res[res.length-1] = res[res.length-1].concat(calculated[i]); + } + } + + res = res.filter((x)=>x.length !== 0); + return res; + } + + async putText(doc : PDFKit.PDFDocument, box : Box, styleCache : TextStyle, + fontPairCache : fontPathPSNamePair): + Promise<[PDFKit.PDFDocument, TextStyle, fontPathPSNamePair]>{ + var fontPair; + + + if (box.textStyle !== null){ + + if(box.textStyle == styleCache){ + fontPair = fontPairCache; + }else{ + fontPair = fontStyleTofont(box.textStyle); + styleCache = box.textStyle; + fontPairCache = fontPair; + let textColor = box.textStyle.color; + + if (fontPair.path.match(/\.ttc$/g)){ + doc + .fillColor(textColor !== undefined ? textColor : "#000000") + .font(fontPair.path, fontPair.psName) + .fontSize(box.textStyle.size * 0.75);} + else{ + doc + .fillColor(textColor !== undefined ? textColor : "#000000") + .font(fontPair.path) + .fontSize(box.textStyle.size * 0.75); // 0.75 must added! + } + } + + if (box.textStyle.color !== undefined){ + doc.fill(box.textStyle.color); + } + + if (Array.isArray(box.content)){ + for (var k=0; kthis.removeBreakPoints +(x).flat()); + let segmentedNodeUnglue = segmentedNodesFixed.map((x)=>this.removeGlue(x, frame).flat()); + + for (var i=0; icurrentLineSkip ){ + currentLineSkip = glyphMaxHeight; + } + + var currentLineBox : Box = { + x : null, + y : null, + textStyle : defaultTextStyle, + direction : frame.directionInsideLine, + width : frame.width, + height : currentLineSkip, + content : segmentedNodeUnglue[i], + } + + bigBoxContent.push(currentLineBox); + + } + + bigBox.content = bigBoxContent; + let bigBoxHeight = bigBoxContent.map((x)=>x.height).reduce((x,y)=>x+y, 0); + bigBox.height = bigBoxHeight; + + return bigBox; + } + + /** + * get the max height of the glyph`[a, b, c]` + * @param nodeLine the node line [a, b, c, ...] + * @returns + */ + getGlyphMaxHeight(nodeLine : BoxesItem[]) : number{ + let segmentedNodeLineHeight = nodeLine.map((x : BoxesItem)=>{if ("height" in x && x.height > 0.0){return x.height}else{return 0.0}}); + let maxHeight = Math.max(...segmentedNodeLineHeight); + return maxHeight; + } + + removeGlue(nodeLine : BoxesItem[], frame : FrameBox) : BoxesItem[]{ + let breakLineAlgorithms = new breakLines.BreakLineAlgorithm(); + let glueRemoved = nodeLine.filter((x)=>!breakLineAlgorithms.isHGlue(x)); + let onlyGlue = nodeLine.filter((x)=>breakLineAlgorithms.isHGlue(x)); + let sumStretchFactor = onlyGlue.map((x)=>{if("stretchFactor" in x){ return x.stretchFactor} else{return 0;}}) + .reduce((acc, cur)=>acc+cur , 0); + + let glueRemovedWidth = glueRemoved.map((x)=>{if("width" in x){ return x.width} else{return 0;}}) + .reduce((acc, cur)=>acc+cur , 0); + let offset = frame.width * 0.75 - glueRemovedWidth; + var res = []; + for (var i=0; i