Skip to content

Commit

Permalink
Merge pull request #324 from metanorma/fix/page_number_rotation
Browse files Browse the repository at this point in the history
Fix/page number rotation
  • Loading branch information
Intelligent2013 authored Jan 31, 2025
2 parents 9d44a74 + 9ef4251 commit a4b35c2
Show file tree
Hide file tree
Showing 12 changed files with 2,538 additions and 9 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SHELL ?= /bin/bash
endif

#JAR_VERSION := $(shell mvn -q -Dexec.executable="echo" -Dexec.args='$${project.version}' --non-recursive exec:exec -DforceStdout)
JAR_VERSION := 2.14
JAR_VERSION := 2.15
JAR_FILE := mn2pdf-$(JAR_VERSION).jar

all: target/$(JAR_FILE)
Expand Down
10 changes: 5 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,14 @@ You will need the Java Development Kit (JDK) version 8, Update 241 (8u241) or hi

[source,sh]
----
java -Xss5m -Xmx2048m -jar target/mn2pdf-2.14.jar --xml-file <XML-FileName> --xsl-file <XSLT-FileName> --pdf-file <Output-PDF-FileName> [--syntax-highlight]
java -Xss5m -Xmx2048m -jar target/mn2pdf-2.15.jar --xml-file <XML-FileName> --xsl-file <XSLT-FileName> --pdf-file <Output-PDF-FileName> [--syntax-highlight]
----

e.g.

[source,sh]
----
java -Xss5m -Xmx2048m -jar target/mn2pdf-2.14.jar --xml-file tests/G.191.xml --xsl-file tests/itu.recommendation.xsl --pdf-file tests/G.191.pdf
java -Xss5m -Xmx2048m -jar target/mn2pdf-2.15.jar --xml-file tests/G.191.xml --xsl-file tests/itu.recommendation.xsl --pdf-file tests/G.191.pdf
----

=== PDF encryption features
Expand Down Expand Up @@ -100,7 +100,7 @@ Update version in `pom.xml`, e.g.:
----
<groupId>org.metanorma.fop</groupId>
<artifactId>mn2pdf</artifactId>
<version>2.14</version>
<version>2.15</version>
<name>Metanorma XML to PDF converter</name>
----

Expand All @@ -111,8 +111,8 @@ Tag the same version in Git:

[source,xml]
----
git tag v2.14
git push origin v2.14
git tag v2.15
git push origin v2.15
----

Then the corresponding GitHub release will be automatically created at:
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.metanorma.fop</groupId>
<artifactId>mn2pdf</artifactId>
<version>2.14</version>
<version>2.15</version>
<name>Metanorma XML to PDF converter</name>
<packaging>jar</packaging>
<url>https://www.metanorma.org</url>
Expand Down
58 changes: 58 additions & 0 deletions src/main/java/org/apache/fop/area/inline/ResolvedPageNumber.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/

/* $Id$ */

package org.apache.fop.area.inline;

import java.io.IOException;
import java.io.ObjectInputStream;

import org.apache.fop.fonts.Font;

/**
* Always (pre-) resolved page number area. Needed by BIDI code to distinguish
* from UnresolvedPageNumber.
*/
public class ResolvedPageNumber extends TextArea {

private static final long serialVersionUID = -1758369835371647979L;

//Transient fields
transient Font font;

private boolean isVertical;

public ResolvedPageNumber(Font f, boolean v) {
font = f;
isVertical = v;
}

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {
ois.defaultReadObject();
}

@Override
public void addWord(String word, int offset, int level) {
if(isVertical) {
for(int i=0; i<word.length(); i++) {
addWord(word.substring(i, i+1), font.getFontSize(), null, null, null, offset, false, true);
}
} else
super.addWord(word, offset, level);
}
}
190 changes: 190 additions & 0 deletions src/main/java/org/apache/fop/area/inline/UnresolvedPageNumber.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/

/* $Id$ */

package org.apache.fop.area.inline;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.List;

import org.apache.fop.area.PageViewport;
import org.apache.fop.area.Resolvable;
import org.apache.fop.complexscripts.bidi.InlineRun;
import org.apache.fop.fonts.Font;

/**
* Unresolvable page number area.
* This is a word area that resolves itself to a page number
* from an id reference.
*/
public class UnresolvedPageNumber extends ResolvedPageNumber implements Resolvable {


private static final long serialVersionUID = -1758090835371647980L;

private boolean resolved;
private String pageIDRef;
private String text;
private boolean pageType;

/** Indicates that the reference refers to the first area generated by a formatting object. */
public static final boolean FIRST = true;
/** Indicates that the reference refers to the last area generated by a formatting object. */
public static final boolean LAST = false;

public UnresolvedPageNumber() {
this(null, null, FIRST, false);
}

/**
* Create a new unresolved page number.
*
* @param id the id reference for resolving this
* @param f the font for formatting the page number
*/
public UnresolvedPageNumber(String id, Font f) {
this(id, f, FIRST, false);
}

/**
* Create a new unresolved page number.
*
* @param id the id reference for resolving this
* @param f the font for formatting the page number
* @param type indicates whether the reference refers to the first or last area generated by
* a formatting object
*/
public UnresolvedPageNumber(String id, Font f, boolean type) {
this(id, f, FIRST, false);
}

/**
* Create a new unresolved page number.
*
* @param id the id reference for resolving this
* @param f the font for formatting the page number
* @param type indicates whether the reference refers to the first or last area generated by
* a formatting object
* @param vert indicates whether the writing mode is vertical
*/
public UnresolvedPageNumber(String id, Font f, boolean type, boolean v) {
super(f, v);
pageIDRef = id;
text = "?";
pageType = type;
}

private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {
ois.defaultReadObject();
}

/**
* Get the id references for this area.
*
* @return the id reference for this unresolved page number
*/
public String[] getIDRefs() {
return new String[] {pageIDRef};
}

/**
* Get the (resolved or unresolved) text.
*
* @return the text
*/
public String getText() {
return text;
}

/**
* Resolve the page number idref
* This resolves the idref for this object by getting the page number
* string from the first page in the list of pages that apply
* for this ID. The page number text is then set to the String value
* of the page number.
*
* TODO: [GA] May need to run bidi algorithm and script processor
* on resolved page number.
*
* @param id an id whose PageViewports have been determined
* @param pages the list of PageViewports associated with this ID
*/
public void resolveIDRef(String id, List<PageViewport> pages) {
if (!resolved && pageIDRef.equals(id) && pages != null) {
if (log.isDebugEnabled()) {
log.debug("Resolving pageNumber: " + id);
}
resolved = true;
int pageIndex = pageType ? 0 : pages.size() - 1;
PageViewport page = pages.get(pageIndex);
// replace the text
removeText();
text = page.getPageNumberString();
addWord(text, 0, getBidiLevel());
// update ipd
if (font != null) {
handleIPDVariation(font.getWordWidth(text) - getIPD());
// set the Font object to null, as we don't need it any more
font = null;
} else {
log.warn("Cannot update the IPD of an unresolved page number."
+ " No font information available.");
}
}
}

/**
* Check if this is resolved.
*
* @return true when this has been resolved
*/
public boolean isResolved() {
return resolved;
}

/**
* recursively apply the variation factor to all descendant areas
* @param variationFactor the variation factor that must be applied to adjustment ratios
* @param lineStretch the total stretch of the line
* @param lineShrink the total shrink of the line
* @return true if there is an UnresolvedArea descendant
*/
@Override
public boolean applyVariationFactor(double variationFactor,
int lineStretch, int lineShrink) {
return true;
}

/**
* Collection bidi inline runs.
* Override of @{link InlineParent} implementation.
*
* N.B. [GA] without this override, the page-number-citation_writing_mode_rl
* layout engine test will fail. It may be that the test needs to
* be updated rather than using this override.
* @param runs current list of inline runs
* @return modified list of inline runs, having appended new run
*/
@Override
public List collectInlineRuns(List runs) {
assert runs != null;
runs.add(new InlineRun(this, new int[] {getBidiLevel()}));
return runs;
}
}
Loading

0 comments on commit a4b35c2

Please sign in to comment.