Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

consider scaling by fontSize(Tf, Tfs) and text matrix (Tm) #559

Merged
merged 2 commits into from
Dec 21, 2022
Merged

consider scaling by fontSize(Tf, Tfs) and text matrix (Tm) #559

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cce0f6
consider scaling of text space by fontSize(Tf, Tfs) and text matrix (…
Nov 12, 2022
799fea5
Update src/Smalot/PdfParser/Page.php
k00ni Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions src/Smalot/PdfParser/Page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,9 +612,7 @@ public function getDataCommands(array $extractedDecodedRawData = null): array

case 'Tf':
case 'TF':
if ($this->config->getDataTmFontInfoHasToBeIncluded()) {
$extractedData[] = $command;
}
$extractedData[] = $command;
break;

/*
Expand Down Expand Up @@ -673,20 +671,28 @@ public function getDataTm(array $dataCommands = null): array
* Set default values for font data
*/
$defaultFontId = -1;
$defaultFontSize = 0;
$defaultFontSize = 1;

/*
* Setting where are the X and Y coordinates in the matrix (Tm)
* Indexes of horizontal/vertical scaling and X,Y-coordinates in the matrix (Tm)
*/
$hSc = 0; // horizontal scaling
$vSc = 3; // vertical scaling
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity, why using 3 as default value for vertical scaling? Is there a reference in the PDF spec for instance?

Copy link
Contributor Author

@oliver681 oliver681 Dec 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@k00ni It is not the value of the vertical scaling, but the index of vertical scaling the in the array that encodes the text matrix.

grafik

So it corresponds to d here, while hSc corresponds to a

k00ni marked this conversation as resolved.
Show resolved Hide resolved
$x = 4;
$y = 5;

/*
* x,y-coordinates of text space origin in user units
*
* These will be assigned the value of the currently printed string
*/
$Tx = 0;
$Ty = 0;

$Tm = $defaultTm;
$Tl = $defaultTl;
$fontId = $defaultFontId;
$fontSize = $defaultFontSize;
$fontSize = $defaultFontSize; // reflects fontSize set by Tf or Tfs

$extractedTexts = $this->getTextArray();
$extractedData = [];
Expand All @@ -695,11 +701,11 @@ public function getDataTm(array $dataCommands = null): array
switch ($command['o']) {
/*
* BT
* Begin a text object, inicializind the Tm and Tlm to identity matrix
* Begin a text object, initializing the Tm and Tlm to identity matrix
*/
case 'BT':
$Tm = $defaultTm;
$Tl = $defaultTl; // review this.
$Tl = $defaultTl;
$Tx = 0;
$Ty = 0;
$fontId = $defaultFontId;
Expand All @@ -712,20 +718,21 @@ public function getDataTm(array $dataCommands = null): array
*/
case 'ET':
$Tm = $defaultTm;
$Tl = $defaultTl; // review this
$Tl = $defaultTl;
$Tx = 0;
$Ty = 0;
$fontId = $defaultFontId;
$fontSize = $defaultFontSize;
break;

/*
* leading TL
* text leading TL
* Set the text leading, Tl, to leading. Tl is used by the T*, ' and " operators.
* Initial value: 0
*/
case 'TL':
$Tl = (float) $command['c'];
// scaled text leading
$Tl = (float) $command['c'] * (float) $Tm[$vSc];
break;

/*
Expand All @@ -735,8 +742,8 @@ public function getDataTm(array $dataCommands = null): array
*/
case 'Td':
$coord = explode(' ', $command['c']);
$Tx += (float) $coord[0];
$Ty += (float) $coord[1];
$Tx += (float) $coord[0] * (float) $Tm[$hSc];
$Ty += (float) $coord[1] * (float) $Tm[$vSc];
$Tm[$x] = (string) $Tx;
$Tm[$y] = (string) $Ty;
break;
Expand All @@ -752,9 +759,9 @@ public function getDataTm(array $dataCommands = null): array
*/
case 'TD':
$coord = explode(' ', $command['c']);
$Tl = (float) $coord[1];
$Tx += (float) $coord[0];
$Ty -= (float) $coord[1];
$Tl = -((float) $coord[1] * (float) $Tm[$vSc]);
$Tx += (float) $coord[0] * (float) $Tm[$hSc];
$Ty += (float) $coord[1] * (float) $Tm[$vSc];
$Tm[$x] = (string) $Tx;
$Tm[$y] = (string) $Ty;
break;
Expand Down
83 changes: 77 additions & 6 deletions tests/Integration/PageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,9 @@ public function testGetDataCommands(): void
$pages = $document->getPages();
$page = $pages[0];
$dataCommands = $page->getDataCommands();
$this->assertCount(168, $dataCommands);
$this->assertCount(174, $dataCommands);

$tmItem = $dataCommands[1];
$tmItem = $dataCommands[2];
$this->assertCount(3, $tmItem);
$this->assertArrayHasKey('t', $tmItem);
$this->assertArrayHasKey('o', $tmItem);
Expand All @@ -267,7 +267,7 @@ public function testGetDataCommands(): void
$this->assertStringContainsString('Tm', $tmItem['o']);
$this->assertStringContainsString('0.999429 0 0 1 201.96 720.68', $tmItem['c']);

$tjItem = $dataCommands[2];
$tjItem = $dataCommands[3];
$this->assertCount(3, $tjItem);
$this->assertArrayHasKey('t', $tjItem);
$this->assertArrayHasKey('o', $tjItem);
Expand All @@ -292,6 +292,7 @@ public function testGetDataTm(): void
$page = $pages[0];

$dataTm = $page->getDataTm();

$this->assertCount(81, $dataTm);

$item = $dataTm[0];
Expand All @@ -308,8 +309,8 @@ public function testGetDataTm(): void
],
$item[0]
);

$this->assertStringContainsString('Document title', $item[1]);

$item = $dataTm[2];
$this->assertEquals(
[
Expand All @@ -322,7 +323,6 @@ public function testGetDataTm(): void
],
$item[0]
);

$this->assertStringContainsString('Calibri : Lorem ipsum dolor sit amet, consectetur a', $item[1]);

$item = $dataTm[80];
Expand All @@ -332,7 +332,7 @@ public function testGetDataTm(): void
'0',
'0',
'1',
'343.003',
'342.840222606',
'81.44',
],
$item[0]
Expand Down Expand Up @@ -443,6 +443,77 @@ public function testGetDataTm(): void
$item[0]
);
$this->assertStringContainsString('Purchase 2', $item[1]);

// test if scaling by fontSize (Tf, Tfs) and test matrix (Tm) are taken into account
$dataCommands = [
['t' => '', 'o' => 'BT', 'c' => ''], // begin text
['t' => '/', 'o' => 'Tf', 'c' => 'TT0 1'], // set font and scale font by 1 pt
['t' => '', 'o' => 'Tm', 'c' => '7.5 -0 0 8.5 45.36 791.52'], // additionally scale by 7.5 pt
['t' => '', 'o' => 'Td', 'c' => '0.568 0'], // move 0.568 * 7.5 pts (7.5 is horizontal scaling) to the right
['t' => '(', 'o' => 'Tj', 'c' => 'test'], // print "test"
['t' => '', 'o' => 'TD', 'c' => '-3.5 -1.291'], // move 3.5 * 7.5 pts left, 1.291 * 8.5 (vertical scaling) pts down and set text leading to 9.464
['t' => '(', 'o' => 'Tj', 'c' => 'another test'], // print "another test"
['t' => '', 'o' => '\'', 'c' => 'again a test'], // go to next line and print "again a test"
['t' => '', 'o' => 'TL', 'c' => '5'], // set text leading by TL
['t' => '', 'o' => '\'', 'c' => 'the next line'], // go to next line and print "the next line"
];

// verify scaling is taken into account for Td
$dataTm = $page->getDataTm($dataCommands);
$item = $dataTm[0];
$this->assertEquals(
[
'7.5',
'-0',
'0',
'8.5',
'49.62',
'791.52',
],
$item[0]
);

// verify scaling is taken into account for TD
$item = $dataTm[1];
$this->assertEquals(
[
'7.5',
'-0',
'0',
'8.5',
'23.37',
'780.5465',
],
$item[0]
);

// verify scaling is taken into account for text leading set by TD
$item = $dataTm[2];
$this->assertEquals(
[
'7.5',
'-0',
'0',
'8.5',
'23.37',
'769.573',
],
$item[0]
);

// verify scaling is taken into account for text leading set by TL
$item = $dataTm[3];
$this->assertEquals(
[
'7.5',
'-0',
'0',
'8.5',
'23.37',
'727.073',
],
$item[0]
);
}

public function testDataTmFontInfoHasToBeIncluded(): void
Expand Down