]> git.kianting.info Git - clo/blobdiff - src/libclo/index.ts
update readme
[clo] / src / libclo / index.ts
index b9c3b094ca39a23ffa0fe7e9a48487cbaf7f89a2..d074e9c91ce127b4d03f560ae25a6f8c4c74b9aa 100644 (file)
@@ -1,14 +1,13 @@
-import { isBoxedPrimitive, isKeyObject, isStringObject } from "util/types";
 import {tkTree} from "../parser";
-import {FontStyle, TextStyle, TextWeight, fontStyleTofont} from "../canva";
-import { JSDOM } from "jsdom";
+import {FontStyle, TextStyle, TextWeight, fontStyleTofont, fontPathPSNamePair} from "../canva";
 import * as fontkit from "fontkit";
-import * as util from "node:util";
 import * as breakLines from "./breakLines";
-import "pdfkit";
-import PDFKitPage from "pdfkit/js/page";
-import { ColorTypes, PDFDocument, rgb } from "pdf-lib";
+const PDFDocument = require('pdfkit');
 import * as fs from "fs";
+import { Style } from "util";
+import { time } from "console";
+import {memfs} from "memfs";
+
 
 /**
  * TYPES
@@ -26,12 +25,17 @@ export enum Direction{
     TTB,
     BTT,
 }
-
 /**
  * Horizonal glue.
  * - stretchFactor : the stretch factor in float
  */
 export interface HGlue{
+    isHorizonalGlue : true,
+    stretchFactor: number
+}
+
+export interface VGlue{
+    isHorizonalGlue : false,
     stretchFactor: number
 }
 
@@ -40,6 +44,11 @@ export interface BreakPoint{
     newLined : BoxesItem  
 }
 
+/** BR is like html br */
+export interface BR extends BreakPoint{
+    isBR : true;
+}
+
 export type BoxesItem = HGlue | Box | BreakPoint | BoxesItem[] ;
 
 /**
@@ -62,11 +71,11 @@ export interface CharBox extends Box{
 
 /**
  * a basic Box
- * - x :
- * - y : 
+ * - x : pt
+ * - y : pt
  * - textStyle :
  * - direction :
- * - width : x_advance
+ * - width : x_advance pt
  * - content :
  */
 export interface Box{
@@ -87,7 +96,7 @@ export const A4_IN_PX = {"width" : 793.7,
                   "height" : 1122.5};
 
 export const defaultTextStyle : TextStyle = {
-        family : "FreeSerif",
+        family : "Noto Sans CJK TC",
         size : ptToPx(12),
         textWeight : TextWeight.REGULAR,
         fontStyle : FontStyle.ITALIC,
@@ -98,10 +107,10 @@ export const defaultFrameStyle : FrameBox = {
     direction : Direction.TTB,
     baseLineskip : ptToPx(15),
     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,
+    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,
 };
 
@@ -136,7 +145,7 @@ export function ptToPx(pt : number) : number{
  */
 
 /**
- * convert '\n\n' to newline command ["nl"]
+ * convert '\n\n' to new paragraph command ["br"]
  * @param arr the input `tkTree`
  * @param clo the `Clo` object
  * @returns the input tktree
@@ -158,7 +167,7 @@ export function twoReturnsToNewline(arr : tkTree, clo : Clo): 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`
+            result.push(["br"]); // push a newline command to the result `tkTree`
         }
         else{
             result.push(middle[j]);
@@ -283,6 +292,8 @@ export function hyphenTkTree(arr : tkTree, lang: string) : tkTree{
     return result;
 }
 
+
+
 /**
  * calculate the text width and Height with a given `TextStyle` 
  * @param preprocessed 
@@ -290,9 +301,14 @@ export function hyphenTkTree(arr : tkTree, lang: string) : tkTree{
  */
 export async function calculateTextWidthHeight(element : tkTree, style : TextStyle): Promise<BoxesItem[]> {
     var res = [];
+    var styleCache = {};
+    var fontCache = {};
     
     for (var i=0; i<element.length; i++){
-        res.push(await calculateTextWidthHeightAux(element[i], style));
+        let item = await calculateTextWidthHeightAux(element[i], style, <TextStyle>styleCache, <fontkit.Font>fontCache);
+        styleCache = item[1];
+        fontCache = item[2];
+        res.push(item[0]);
     }
 
     res = res.flat();
@@ -306,18 +322,37 @@ export async function calculateTextWidthHeight(element : tkTree, style : TextSty
  * @param preprocessed 
  * @param defaultFontStyle 
  */
-export async function calculateTextWidthHeightAux(element : tkTree, style : TextStyle): Promise<BoxesItem> {
+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$/)){
-        var font = await fontkit.openSync(fontPair.path, fontPair.psName);
+        font = await fontkit.openSync(fontPair.path, fontPair.psName);
+        styleCache = style;
+        fontCache = font;
+
     }
     else{
-        var font = await fontkit.openSync(fontPair.path);
+        font = await fontkit.openSync(fontPair.path);
+        styleCache = style;
+        fontCache = font;
+    }
+
+    
+
     }
+
+
     if (!Array.isArray(element)){
         var run = font.layout(element, undefined, undefined, undefined, "ltr");
 
@@ -332,8 +367,8 @@ export async function calculateTextWidthHeightAux(element : tkTree, style : Text
                 y : null,
                 textStyle : style,
                 direction : Direction.LTR,
-                width : (runGlyphsItem.advanceWidth)*(style.size)/1000,
-                height : (runGlyphsItem.bbox.maxY - runGlyphsItem.bbox.minY)*(style.size)/1000,
+                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,
@@ -344,19 +379,20 @@ export async function calculateTextWidthHeightAux(element : tkTree, style : Text
             result.push(item);
 
         }
-    return result;
+    return [result, styleCache, fontCache];
 
 
         
-
+    // break point of a line
     }else if(element[0] == "bp"){
 
-        var beforeNewLine = await calculateTextWidthHeightAux(element[1], style);
+
+        var beforeNewLine = (await calculateTextWidthHeightAux(element[1], style, styleCache, fontCache))[0];
         if (Array.isArray(beforeNewLine)){
             beforeNewLine = beforeNewLine.flat();
         }
 
-        let afterNewLine = await calculateTextWidthHeightAux(element[2], style);
+        let afterNewLine = (await calculateTextWidthHeightAux(element[2], style, styleCache, fontCache))[0];
         if (Array.isArray(afterNewLine)){
             afterNewLine = afterNewLine.flat();
         }
@@ -366,18 +402,66 @@ export async function calculateTextWidthHeightAux(element : tkTree, style : Text
             newLined : afterNewLine,
         }
 
-        return breakPointNode;
+    
+        return [breakPointNode, styleCache, fontCache];
+    // hglue
     }else if(element[0] == "hglue" && !Array.isArray(element[1])){
-        let hGlue : HGlue = {stretchFactor : parseFloat(element[1])}
-        return hGlue;
+        let hGlue : HGlue = {
+            isHorizonalGlue : true,
+            stretchFactor : parseFloat(element[1])}
+        return [hGlue, styleCache, fontCache];
+    }
+    // new line <br/>
+    else if(element[0] == "br"){
+        let brBoxItem = await calculateTextWidthHeightAux(["hglue", "10000"],
+                                        style, styleCache, fontCache);
+        // <br/>
+        let BR : BR = {
+                isBR : true,
+                original : brBoxItem[0],
+                newLined : brBoxItem[0]};
+        return [BR, styleCache, fontCache];
     }
     else{
-        return calculateTextWidthHeight(element, style);
+        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;i<childrenBox.length-1;i++){
+        voffset[i+1] = voffset[i] + childrenBox[i].height;
+        
+    }
+    console.log("~", voffset);
+    for (var i=0; i<childrenBox.length; i++){
+        childrenBox[i] = applyVOffset(childrenBox[i], voffset[i]);
+        childrenBox[i].y += voffset[i];
+    }
 
+    parentBox.content = childrenBox;
+    return parentBox;
+}
+
+/**
+ * apply vertical offset to a box
+ * @param box the box to be applied
+ * @param voffset the vertical offset
+ * @returns applied box
+ */
+export function applyVOffset(box : Box, voffset : number){
+    if(box.y !== null){
+        box.y += voffset;
+    }
+    if (Array.isArray(box.content)){
+        box.content = box.content.map((x)=>applyVOffset(x, voffset));
+    }
+    return box;
+}
 
 /**
  * whole document-representing class
@@ -432,71 +516,234 @@ export class Clo{
     }
 
     public async generatePdf(){
+
         // preprocessed
         var preprocessed = this.mainStream;
         for (var i = 0; i<this.preprocessors.length; i++){
             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 defaultFontStyle : TextStyle = this.attrs.defaultFrameStyle.textStyle;
+
+        // calculate the width and height of each chars
+        let calculated = await calculateTextWidthHeight(preprocessed, defaultFontStyle);
+
+        //
+        let paragraphized = this.paragraphize(calculated);
+
 
         let breakLineAlgorithms = new breakLines.BreakLineAlgorithm();
-        // TODO
-        //console.log(breakLineAlgorithms.totalCost(a,70));
-        let segmentedNodes = breakLineAlgorithms.segmentedNodes(a, 70);
 
-        console.log(
-            this.segmentedNodesToFrameBox(segmentedNodes, <FrameBox>this.attrs["defaultFrameStyle"]));
+        let segmentedNodes = paragraphized.map((x)=>breakLineAlgorithms.segmentedNodes(x, this.attrs.defaultFrameStyle.width));
+
+        let segmentedNodesToBox = segmentedNodes.map((x)=>
+            this.segmentedNodesToFrameBoxAux(x, <FrameBox>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);
+
+        
+        (<Box[]>boxesFixed.content).map((e)=>{console.log(e.y)});
+
 
         // generate pdf
-        const pdfDoc = await PDFDocument.create();
-        var page = pdfDoc.addPage();
-        page.drawText('You can create PDFs!');
+        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, <TextStyle>styleCache, fontPairCache);
+        // putChar
+        doc.end();
+
+
+    }
 
-        for (var j = 0; j<1000; j+=5){
-            if (j %50 == 0){
-                page.drawText(j.toString(), {x: 50, y: j});
+    paragraphize(calculated :  BoxesItem[]): BoxesItem[][]{
+        var res : BoxesItem[][] = [[]];
+        for (var i=0;i<calculated.length;i++){
+            if ("isBR" in <Box>(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;
+    }
 
-            page.drawLine({
-                start: { x: 0, y: j },
-                end: { x: 1000, y: j },
-                thickness: 0.5,
-                color: rgb(0.75, 0.2, 0.2),
-                opacity: 0.20,
-              });
+    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; k<box.content.length; k++){
+
+                    let tmp = await this.putText(doc, box.content[k], styleCache, fontPairCache);
+                    doc = tmp[0];
+                    styleCache = tmp[1];
+                    fontPairCache = tmp[2];
+                }
+            }else if (box.content !== null){
+                await doc.text(box.content,
+                    (box.x!==null? box.x: undefined),
+                    (box.y!==null? box.y: undefined));
+            }
+        
+        }
+
 
-        for (var i = 0; i<1000; i+=5){
-        if (i % 50 == 0){
-            page.drawText(i.toString(), {x: i, y: 50});
+        return [doc, styleCache, fontPairCache];
+    };
+
+
+
+    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();
         }
-        page.drawLine({
-            start: { x: i, y: 0 },
-            end: { x: i, y: 1000 },
-            thickness: 0.5,
-            color: rgb(0.75, 0.2, 0.2),
-            opacity: 0.20,
-          });
+
+        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]);
+            }
         }
-        pdfDoc.save();
 
-        const pdfBytes = await pdfDoc.save();
-        fs.writeFileSync("blank.pdf", pdfBytes);
+        return box;
     }
 
-    segmentedNodesToFrameBox(segmentedNodes : BoxesItem[][], frame : FrameBox) : 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`.
+     */
+    segmentedNodesToFrameBoxAux(segmentedNodes : BoxesItem[][], frame : FrameBox) : Box{
         let baseLineskip = frame.baseLineskip;
         let boxArrayEmpty  : Box[] = [];
         let bigBox : Box = {
-            x : frame.x,
-            y : frame.y,
+            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,
+            height :frame.height,
             content : boxArrayEmpty,
         }
 
@@ -505,8 +752,8 @@ export class Clo{
         let segmentedNodesFixed = segmentedNodes.map((x)=>this.removeBreakPoints
 (x).flat());
         let segmentedNodeUnglue = segmentedNodesFixed.map((x)=>this.removeGlue(x, frame).flat());
-        
-        for (var i=0; i<segmentedNodesFixed.length-1; i++){
+
+        for (var i=0; i<segmentedNodeUnglue.length; i++){
             var currentLineSkip = baseLineskip;
             var glyphMaxHeight = this.getGlyphMaxHeight(segmentedNodesFixed[i]);
             if (currentLineSkip === null || glyphMaxHeight >currentLineSkip ){
@@ -528,6 +775,8 @@ export class Clo{
         }
 
         bigBox.content = bigBoxContent;
+        let bigBoxHeight = bigBoxContent.map((x)=>x.height).reduce((x,y)=>x+y, 0);
+        bigBox.height = bigBoxHeight;
 
         return bigBox;
     }
@@ -552,7 +801,7 @@ export class Clo{
 
         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 - glueRemovedWidth;
+        let offset = frame.width * 0.75 - glueRemovedWidth;
         var res = [];
         for (var i=0; i<nodeLine.length; i++){
             var ele = nodeLine[i];
@@ -562,6 +811,7 @@ export class Clo{
                     y : null,
                     textStyle : null,
                     direction : frame.directionInsideLine,
+                    //width : 0, // ragged
                     width : ele.stretchFactor / sumStretchFactor * offset,
                     height : 0,
                     content : "",