-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} from "../canva";
+import * as fontkit from "fontkit";
+import * as breakLines from "./breakLines";
+const PDFDocument = require('pdfkit');
+import * as fs from "fs";
+
/**
* TYPES
* 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{
+ stretchFactor: number
+}
+
+export interface BreakPoint{
+ original : BoxesItem,
+ newLined : BoxesItem
+}
+
+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,
/**
* 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 : "FreeSerif",
+ 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
* @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;
}
* REGISTER PART
*/
+/**
+ * convert '\n\n' to newline command ["nl"]
+ * @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(["nl"]); // 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{
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<hyphenatedSplitted.length-1;j++){
+ newSplitted.push(hyphenatedSplitted[j]);
+ // "bp" for breakpoint
+ newSplitted.push(["bp", "", "-"]); //insert a breakable point (bp) mark
+ }
+ newSplitted.push(hyphenatedSplitted[hyphenatedSplitted.length-1]);
+
+ result = result.concat(newSplitted);
+
+ }else{
+ result.push(element);
+ }
+
+ }
+
+ return result;
+}
+
+/**
+ * calculate the text width and Height with a given `TextStyle`
+ * @param preprocessed
+ * @param defaultFontStyle
+ */
+export async function calculateTextWidthHeight(element : tkTree, style : TextStyle): Promise<BoxesItem[]> {
+ var res = [];
+
+ for (var i=0; i<element.length; i++){
+ res.push(await calculateTextWidthHeightAux(element[i], style));
+ }
+
+ 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): Promise<BoxesItem> {
+ var result : BoxesItem = [];
+
+
+
+ let fontPair = fontStyleTofont(style);
+ if (fontPair.path.match(/\.ttc$/)){
+ var font = await fontkit.openSync(fontPair.path, fontPair.psName);
+ }
+ else{
+ var font = await fontkit.openSync(fontPair.path);
+ }
+ if (!Array.isArray(element)){
+ var run = font.layout(element, undefined, undefined, undefined, "ltr");
+
+
+
+ for (var j=0;j<run.glyphs.length;j++){
+ let runGlyphsItem = run.glyphs[j];
+
+
+ let item : CharBox = {
+ x : null,
+ y : null,
+ textStyle : style,
+ direction : Direction.LTR,
+ width : (runGlyphsItem.advanceWidth)*(style.size)/1000 * 0.75, // in pt
+ height : (runGlyphsItem.bbox.maxY - runGlyphsItem.bbox.minY)*(style.size)/1000 * 0.75, // in pt
+ content : element[j],
+ minX : runGlyphsItem.bbox.minX,
+ maxX : runGlyphsItem.bbox.maxX,
+ minY : runGlyphsItem.bbox.minY,
+ maxY : runGlyphsItem.bbox.maxY
+ }
+
+ result.push(item);
+
+ }
+ return result;
+
+
+
+
+ }else if(element[0] == "bp"){
+
+ var beforeNewLine = await calculateTextWidthHeightAux(element[1], style);
+ if (Array.isArray(beforeNewLine)){
+ beforeNewLine = beforeNewLine.flat();
+ }
+
+ let afterNewLine = await calculateTextWidthHeightAux(element[2], style);
+ if (Array.isArray(afterNewLine)){
+ afterNewLine = afterNewLine.flat();
+ }
+
+ let breakPointNode : BreakPoint = {
+ original : beforeNewLine,
+ newLined : afterNewLine,
+ }
+
+ return breakPointNode;
+ }else if(element[0] == "hglue" && !Array.isArray(element[1])){
+ let hGlue : HGlue = {stretchFactor : parseFloat(element[1])}
+ return hGlue;
+ }
+ else{
+ return calculateTextWidthHeight(element, style);
+ }
+}
+
+
+
+
+/**
+ * whole document-representing class
+ */
export class Clo{
+ /** storing the text string into the main frame */
mainStream : Array<string>;
+ /** array of preprocessor functions to preprocess the `mainStream` */
preprocessors : Array<Function>;
- 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;
}
this.preprocessors.push(f);
}
- public generatePdf(){
+ public async generatePdf(){
// preprocessed
- var prepro = this.mainStream;
+ var preprocessed = this.mainStream;
for (var i = 0; i<this.preprocessors.length; i++){
- prepro = this.preprocessors[i](prepro);
+ preprocessed = this.preprocessors[i](preprocessed, this);
}
+ // generate the width and height of the stream
+
+ let defaultFontStyle : TextStyle = this.attrs.defaultFrameStyle.textStyle;
+ let a = await calculateTextWidthHeight(preprocessed, defaultFontStyle);
+
+ let breakLineAlgorithms = new breakLines.BreakLineAlgorithm();
// TODO
- console.log("test"+prepro);
+ //console.log(breakLineAlgorithms.totalCost(a,70));
+ let segmentedNodes = breakLineAlgorithms.segmentedNodes(a, this.attrs.defaultFrameStyle.width);
+
+ let segmentedNodesToBox =
+ this.segmentedNodesToFrameBox(segmentedNodes, <FrameBox>this.attrs.defaultFrameStyle);
+
+
+
+ let boxesFixed = this.fixenBoxesPosition(segmentedNodesToBox);
+
+
+
+
+ // generate pdf7
+ const doc = new PDFDocument({size: 'A4'});
+ doc.pipe(fs.createWriteStream('output.pdf'));
+ this.grid(doc);
+
+ await this.putText(doc, boxesFixed);
+ // putChar
+ doc.end();
+
+ }
+
+ async putText(doc : PDFKit.PDFDocument, box : Box): Promise<PDFKit.PDFDocument>{
+
+ if (box.textStyle !== null){
+ let fontInfo = fontStyleTofont(box.textStyle);
+
+ if (fontInfo.path.match(/\.ttc$/g)){
+ doc
+ .font(fontInfo.path, fontInfo.psName)
+ .fontSize(box.textStyle.size * 0.75);}
+ else{
+ doc
+ .font(fontInfo.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; k<box.content.length; k++){
+
+ doc = await this.putText(doc, box.content[k]);
+ }
+ }else if (box.content !== null){
+ await doc.text(box.content,
+ (box.x!==null? box.x: undefined),
+ (box.y!==null? box.y: undefined));
+ }
+
+ }
+ return doc;
+ };
+
+
+
+ private grid(doc: any) {
+ for (var j = 0; j < A4_IN_PX.width; j += 5) {
+ if (j % 50 == 0) {
+ doc.save().fill('#000000')
+ .fontSize(8).text(j.toString(), j*0.75, 50);
+
+ doc
+ .save()
+ .lineWidth(0.4)
+ .strokeColor("#dddddd")
+ .moveTo(j*0.75, 0)
+ .lineTo(j*0.75, 1000)
+ .stroke();
+ }
+
+ doc
+ .save()
+ .lineWidth(0.2)
+ .strokeColor("#dddddd")
+ .moveTo(j*0.75, 0)
+ .lineTo(j*0.75, 1000)
+ .stroke();
+ }
+
+ for (var i = 0; i < 1050; i += 5) {
+ if (i % 50 == 0) {
+ doc.save()
+ .fontSize(8).text(i.toString(), 50, i*0.75);
+
+ doc
+ .save()
+ .lineWidth(0.4)
+ .strokeColor("#bbbbbb")
+ .moveTo(0, i*0.75)
+ .lineTo(1000, i*0.75)
+ .stroke();
+ }
+ doc
+ .save()
+ .lineWidth(0.2)
+ .strokeColor("#bbbbbb")
+ .moveTo(0, i*0.75)
+ .lineTo(1000, i*0.75)
+ .stroke();
+ }
+ doc
+ .save()
+ .moveTo(0, 200)
+ .lineTo(1000, 200)
+ .fill('#FF3300');
+ }
+
+ /**
+ * make all the nest boxes's position fixed
+ * @param box the main boxes
+ * @returns the fixed boxes
+ */
+ fixenBoxesPosition(box : Box) : Box{
+ var currX : number = (box.x!==null?box.x:0); // current x
+ var currY : number =(box.y!==null?box.y:0); // current y
+ if (Array.isArray(box.content)){
+ for (var i=0; i<box.content.length; i++){
+ if (box.direction == Direction.LTR){
+ box.content[i].x = currX;
+ box.content[i].y = currY;
+ let elementWidth = box.content[i].width;
+ if(elementWidth !== null){
+ currX += elementWidth;
+ }
+
+ }
+ if (box.direction == Direction.TTB){
+ box.content[i].x = currX;
+ box.content[i].y = currY;
+ let elementHeight = box.content[i].height;
+ if(elementHeight !== null){
+ currY += elementHeight;
+ }
+
+ }
+
+
+ box.content[i] = this.fixenBoxesPosition(box.content[i]);
+ }
+ }
+
+ return box;
+ }
+
+ /**
+ * input a `segmentedNodes` and a layed `frame`, return a big `Box` that nodes is put in.
+ * @param segmentedNodes the segmentnodes to be input
+ * @param frame the frame to be layed out.
+ * @returns the big `Box`.
+ */
+ segmentedNodesToFrameBox(segmentedNodes : BoxesItem[][], frame : FrameBox) : Box{
+ let baseLineskip = frame.baseLineskip;
+ let boxArrayEmpty : Box[] = [];
+ let bigBox : Box = {
+ x : (frame.x !==null? frame.x * 0.75 : null),
+ y : (frame.y !==null? frame.y * 0.75 : null),
+ textStyle : frame.textStyle,
+ direction : frame.direction,
+ width : frame.width,
+ height :frame.height,
+ content : boxArrayEmpty,
+ }
+
+ var bigBoxContent : Box[] = boxArrayEmpty;
+
+ let segmentedNodesFixed = segmentedNodes.map((x)=>this.removeBreakPoints
+(x).flat());
+ let segmentedNodeUnglue = segmentedNodesFixed.map((x)=>this.removeGlue(x, frame).flat());
+
+ for (var i=0; i<segmentedNodeUnglue.length; i++){
+ var currentLineSkip = baseLineskip;
+ var glyphMaxHeight = this.getGlyphMaxHeight(segmentedNodesFixed[i]);
+ if (currentLineSkip === null || glyphMaxHeight >currentLineSkip ){
+ currentLineSkip = glyphMaxHeight;
+ }
+
+ var currentLineBox : Box = {
+ x : null,
+ y : null,
+ textStyle : defaultTextStyle,
+ direction : frame.directionInsideLine,
+ width : frame.width,
+ height : currentLineSkip,
+ content : <Box[]>segmentedNodeUnglue[i],
+ }
+
+ bigBoxContent.push(currentLineBox);
+
+ }
+
+ bigBox.content = bigBoxContent;
+
+ 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<nodeLine.length; i++){
+ var ele = nodeLine[i];
+ if (breakLineAlgorithms.isHGlue(ele)){
+ let tmp : Box = {
+ x : null,
+ y : null,
+ textStyle : null,
+ direction : frame.directionInsideLine,
+ //width : 0, // ragged
+ width : ele.stretchFactor / sumStretchFactor * offset,
+ height : 0,
+ content : "",
+
+ }
+
+ res.push(tmp);
+ }else{
+ res.push(ele);
+ }
+ }
+
+ return res;
+ }
+
+ /**
+ * remove breakpoints
+ * @param boxitemline boxitem in a line with a breakpoint
+ * @returns boxitemline with break points removed
+ */
+ removeBreakPoints(boxitemline : BoxesItem[]) : BoxesItem[]{
+ var res : BoxesItem[] = [];
+ let breakLineAlgorithms = new breakLines.BreakLineAlgorithm();
+
+ for (var i = 0; i<boxitemline.length; i++){
+ let ele = boxitemline[i];
+ if (breakLineAlgorithms.isBreakPoint(ele)){
+ if (i == boxitemline.length-1){
+ res.push(ele.newLined);
+ }else{
+ res.push(ele.original);
+ }
+ }else{
+ res.push(ele);
+ }
+ }
+
+ return res;
}
}
+
+/*
export let a = new Clo();
-export default a;
\ No newline at end of file
+export default a; */
\ No newline at end of file