You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ad...@apache.org on 2006/08/24 22:32:03 UTC
svn commit: r434513 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop/fo:
FOPropertyMapping.java FObj.java
Author: adelmelle
Date: Thu Aug 24 13:32:02 2006
New Revision: 434513
URL: http://svn.apache.org/viewvc?rev=434513&view=rev
Log:
A few changes combined:
1) Bugzilla #40308
Added relaxed validation for non-unique ids
as suggested by Hussein Shafi (hussein.at.xmlmind.com)
2) Checkstyle cleanup in FObj
3) Changed propertyMakerTable to a static final, and
altered FOPropertyMapping, to be 100% certain that
the static arrays are only structurally modified
once
Modified:
xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOPropertyMapping.java
xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FObj.java
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOPropertyMapping.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOPropertyMapping.java?rev=434513&r1=434512&r2=434513&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOPropertyMapping.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FOPropertyMapping.java Thu Aug 24 13:32:02 2006
@@ -76,8 +76,7 @@
private static Map s_htSubPropNames = new HashMap();
private static Map s_htPropIds = new HashMap();
- private static PropertyMaker[] s_generics =
- new PropertyMaker[PROPERTY_COUNT + 1];
+ private static PropertyMaker[] s_generics = null;
// The rest is only used during the building of the s_generics array.
private Property[] enums = null;
@@ -98,7 +97,8 @@
* Create the generic property maker templates. These templates
* are used be the actual makers as a parameter to .useGeneric(...).
*/
- public void createGenerics() {
+ private void createGenerics() {
+
PropertyMaker sub;
genericColor = new ColorProperty.Maker(0);
@@ -261,7 +261,7 @@
*/
private Property getEnumProperty(int enumValue, String text) {
if (enums == null) {
- enums = new Property[ENUM_COUNT+1];
+ enums = new Property[ENUM_COUNT + 1];
}
if (enums[enumValue] == null) {
enums[enumValue] = new EnumProperty(enumValue, text);
@@ -274,48 +274,56 @@
* @return the maker array.
*/
public static PropertyMaker[] getGenericMappings() {
- FOPropertyMapping gp = new FOPropertyMapping();
- // Create the shorthand first, they are referenced by the real properties.
- gp.createShorthandProperties();
- gp.createGenerics();
- gp.createAccessibilityProperties();
- gp.createAbsolutePositionProperties();
- gp.createAuralProperties();
- gp.createBorderPaddingBackgroundProperties();
- gp.createFontProperties();
- gp.createHyphenationProperties();
- gp.createMarginBlockProperties();
- gp.createMarginInlineProperties();
- gp.createRelativePosProperties();
- gp.createAreaAlignmentProperties();
- gp.createAreaDimensionProperties();
- gp.createBlockAndLineProperties();
- gp.createCharacterProperties();
- gp.createColorProperties();
- gp.createFloatProperties();
- gp.createKeepsAndBreaksProperties();
- gp.createLayoutProperties();
- gp.createLeaderAndRuleProperties();
- gp.createDynamicProperties();
- gp.createMarkersProperties();
- gp.createNumberToStringProperties();
- gp.createPaginationAndLayoutProperties();
- gp.createTableProperties();
- gp.createWritingModeProperties();
- gp.createMiscProperties();
-
- // Hardcode the subproperties.
- addSubpropMakerName("length", CP_LENGTH);
- addSubpropMakerName("conditionality", CP_CONDITIONALITY);
- addSubpropMakerName("block-progression-direction", CP_BLOCK_PROGRESSION_DIRECTION);
- addSubpropMakerName("inline-progression-direction", CP_INLINE_PROGRESSION_DIRECTION);
- addSubpropMakerName("within-line", CP_WITHIN_LINE);
- addSubpropMakerName("within-column", CP_WITHIN_COLUMN);
- addSubpropMakerName("within-page", CP_WITHIN_PAGE);
- addSubpropMakerName("minimum", CP_MINIMUM);
- addSubpropMakerName("maximum", CP_MAXIMUM);
- addSubpropMakerName("optimum", CP_OPTIMUM);
- addSubpropMakerName("precedence", CP_PRECEDENCE);
+
+ if (s_generics == null) {
+ /* this method was never called before */
+ s_generics = new PropertyMaker[PROPERTY_COUNT + 1];
+ FOPropertyMapping gp = new FOPropertyMapping();
+
+ /* Create the shorthand first. They are
+ * referenced by the real properties.
+ */
+ gp.createShorthandProperties();
+ gp.createGenerics();
+ gp.createAccessibilityProperties();
+ gp.createAbsolutePositionProperties();
+ gp.createAuralProperties();
+ gp.createBorderPaddingBackgroundProperties();
+ gp.createFontProperties();
+ gp.createHyphenationProperties();
+ gp.createMarginBlockProperties();
+ gp.createMarginInlineProperties();
+ gp.createRelativePosProperties();
+ gp.createAreaAlignmentProperties();
+ gp.createAreaDimensionProperties();
+ gp.createBlockAndLineProperties();
+ gp.createCharacterProperties();
+ gp.createColorProperties();
+ gp.createFloatProperties();
+ gp.createKeepsAndBreaksProperties();
+ gp.createLayoutProperties();
+ gp.createLeaderAndRuleProperties();
+ gp.createDynamicProperties();
+ gp.createMarkersProperties();
+ gp.createNumberToStringProperties();
+ gp.createPaginationAndLayoutProperties();
+ gp.createTableProperties();
+ gp.createWritingModeProperties();
+ gp.createMiscProperties();
+
+ // Hardcode the subproperties.
+ addSubpropMakerName("length", CP_LENGTH);
+ addSubpropMakerName("conditionality", CP_CONDITIONALITY);
+ addSubpropMakerName("block-progression-direction", CP_BLOCK_PROGRESSION_DIRECTION);
+ addSubpropMakerName("inline-progression-direction", CP_INLINE_PROGRESSION_DIRECTION);
+ addSubpropMakerName("within-line", CP_WITHIN_LINE);
+ addSubpropMakerName("within-column", CP_WITHIN_COLUMN);
+ addSubpropMakerName("within-page", CP_WITHIN_PAGE);
+ addSubpropMakerName("minimum", CP_MINIMUM);
+ addSubpropMakerName("maximum", CP_MAXIMUM);
+ addSubpropMakerName("optimum", CP_OPTIMUM);
+ addSubpropMakerName("precedence", CP_PRECEDENCE);
+ }
return s_generics;
}
@@ -350,7 +358,11 @@
return -1;
}
- // returns a property, compound, or property.compound name
+ /**
+ * Returns the property name corresponding to the PR_* id
+ * @param id the property id in Constants
+ * @return the property name
+ */
public static String getPropertyName(int id) {
if (((id & Constants.COMPOUND_MASK) == 0)
|| ((id & Constants.PROPERTY_MASK) == 0)) {
Modified: xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FObj.java
URL: http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FObj.java?rev=434513&r1=434512&r2=434513&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FObj.java (original)
+++ xmlgraphics/fop/trunk/src/java/org/apache/fop/fo/FObj.java Thu Aug 24 13:32:02 2006
@@ -40,7 +40,8 @@
public abstract class FObj extends FONode implements Constants {
/** the list of property makers */
- private static PropertyMaker[] propertyListTable = null;
+ private static PropertyMaker[] propertyListTable
+ = FOPropertyMapping.getGenericMappings();
/** The immediate child nodes of this node. */
protected List childNodes = null;
@@ -52,23 +53,12 @@
private Map foreignAttributes = null;
/** Used to indicate if this FO is either an Out Of Line FO (see rec)
- or a descendant of one. Used during validateChildNode() FO
- validation.
- */
+ * or a descendant of one. Used during FO validation.
+ */
private boolean isOutOfLineFODescendant = false;
/** Markers added to this element. */
- protected Map markers = null;
-
- static {
- propertyListTable = new PropertyMaker[Constants.PROPERTY_COUNT + 1];
- PropertyMaker[] list = FOPropertyMapping.getGenericMappings();
- for (int i = 1; i < list.length; i++) {
- if (list[i] != null) {
- propertyListTable[i] = list[i];
- }
- }
- }
+ private Map markers = null;
/**
* Create a new formatting object.
@@ -81,7 +71,7 @@
// determine if isOutOfLineFODescendant should be set
if (parent != null && parent instanceof FObj) {
- if (((FObj)parent).getIsOutOfLineFODescendant()) {
+ if (((FObj) parent).getIsOutOfLineFODescendant()) {
isOutOfLineFODescendant = true;
} else {
int foID = getNameId();
@@ -151,10 +141,11 @@
/**
* Setup the id for this formatting object.
* Most formatting objects can have an id that can be referenced.
- * This methods checks that the id isn't already used by another
- * fo and sets the id attribute of this object.
- * @param id ID to check
+ * This methods checks that the id isn't already used by another FO
+ *
+ * @param id the id to check
* @throws ValidationException if the ID is already defined elsewhere
+ * (strict validation only)
*/
protected void checkId(String id) throws ValidationException {
if (!inMarker() && !id.equals("")) {
@@ -162,9 +153,25 @@
if (!idrefs.contains(id)) {
idrefs.add(id);
} else {
- throw new ValidationException("Property id \"" + id
- + "\" previously used; id values must be unique"
- + " in document.", locator);
+ if (getUserAgent().validateStrictly()) {
+ throw new ValidationException("Property id \"" + id
+ + "\" previously used; id values must be unique"
+ + " in document.", locator);
+ } else {
+ if (log.isWarnEnabled()) {
+ StringBuffer msg = new StringBuffer();
+ msg.append("Found non-unique id on ").append(getName());
+ if (locator.getLineNumber() != -1) {
+ msg.append(" (at ").append(locator.getLineNumber())
+ .append("/").append(locator.getColumnNumber())
+ .append(")");
+ }
+ msg.append("\nAny reference to it will be considered "
+ + "a reference to the first occurrence "
+ + "in the document.");
+ log.warn(msg);
+ }
+ }
}
}
}
@@ -200,7 +207,14 @@
}
}
- protected static void addChildTo(FONode child, FObj parent) throws FOPException {
+ /**
+ * Used by RetrieveMarker during Marker-subtree cloning
+ * @param child the (cloned) child node
+ * @param parent the (cloned) parent node
+ * @throws FOPException when the child could not be added to the parent
+ */
+ protected static void addChildTo(FONode child, FObj parent)
+ throws FOPException {
parent.addChildNode(child);
}
@@ -275,7 +289,9 @@
/**
* Notifies a FObj that one of it's children is removed.
- * This method is subclassed by Block to clear the firstInlineChild variable.
+ * This method is subclassed by Block to clear the
+ * firstInlineChild variable in case it doesn't generate
+ * any areas (see addMarker()).
* @param node the node that was removed
*/
protected void notifyChildRemoval(FONode node) {
@@ -294,19 +310,16 @@
if (childNodes != null) {
// check for empty childNodes
for (Iterator iter = childNodes.iterator(); iter.hasNext();) {
- FONode node = (FONode)iter.next();
- if (node instanceof FOText) {
- FOText text = (FOText)node;
- if (text.willCreateArea()) {
- getLogger().error("fo:marker must be an initial child: " + mcname);
- return;
- } else {
- iter.remove();
- notifyChildRemoval(node);
- }
- } else {
- getLogger().error("fo:marker must be an initial child: " + mcname);
+ FONode node = (FONode) iter.next();
+ if (node instanceof FObj
+ || (node instanceof FOText
+ && ((FOText) node).willCreateArea())) {
+ getLogger().error(
+ "fo:marker must be an initial child: " + mcname);
return;
+ } else if (node instanceof FOText) {
+ iter.remove();
+ notifyChildRemoval(node);
}
}
}
@@ -329,22 +342,12 @@
}
/**
- * @return th collection of Markers attached to this object
+ * @return the collection of Markers attached to this object
*/
public Map getMarkers() {
return markers;
}
- /*
- * Return a string representation of the fo element.
- * Deactivated in order to see precise ID of each fo element created
- * (helpful for debugging)
- */
-/* public String toString() {
- return getName() + " at line " + line + ":" + column;
- }
-*/
-
/** @see org.apache.fop.fo.FONode#gatherContextInfo() */
protected String gatherContextInfo() {
if (getLocator() != null) {
@@ -356,7 +359,7 @@
}
StringBuffer sb = new StringBuffer();
while (iter.hasNext()) {
- FONode node = (FONode)iter.next();
+ FONode node = (FONode) iter.next();
String s = node.gatherContextInfo();
if (s != null) {
if (sb.length() > 0) {
@@ -412,7 +415,8 @@
|| (lName.equals("multi-toggle")
&& (getNameId() == FO_MULTI_CASE
|| findAncestor(FO_MULTI_CASE) > 0))
- || (lName.equals("footnote") && !isOutOfLineFODescendant)
+ || (lName.equals("footnote")
+ && !isOutOfLineFODescendant)
|| isNeutralItem(nsURI, lName)));
}
@@ -448,9 +452,9 @@
/**
* Convenience method for validity checking. Checks if the
* current node has an ancestor of a given name.
- * @param ancestorID -- Constants ID of node name to check for (e.g., FO_ROOT)
+ * @param ancestorID ID of node name to check for (e.g., FO_ROOT)
* @return number of levels above FO where ancestor exists,
- * -1 if not found
+ * -1 if not found
*/
protected int findAncestor(int ancestorID) {
int found = 1;
@@ -477,19 +481,23 @@
}
/**
- * Add a new extension attachment to this FObj. See org.apache.fop.fo.FONode for details.
+ * Add a new extension attachment to this FObj.
+ * (see org.apache.fop.fo.FONode for details)
+ *
* @param attachment the attachment to add.
*/
public void addExtensionAttachment(ExtensionAttachment attachment) {
if (attachment == null) {
- throw new NullPointerException("Parameter attachment must not be null");
+ throw new NullPointerException(
+ "Parameter attachment must not be null");
}
if (extensionAttachments == null) {
extensionAttachments = new java.util.ArrayList();
}
if (log.isDebugEnabled()) {
- getLogger().debug("ExtensionAttachment of category " + attachment.getCategory()
- + " added to " + getName() + ": " + attachment);
+ getLogger().debug("ExtensionAttachment of category "
+ + attachment.getCategory() + " added to "
+ + getName() + ": " + attachment);
}
extensionAttachments.add(attachment);
}
@@ -508,10 +516,12 @@
* @param uri the namespace URI
* @param qName the fully qualified name
* @param value the attribute value
- * @todo Handle this over FOP's property mechanism so we can use inheritance.
*/
public void addForeignAttribute(String uri,
- String qName, String value) {
+ String qName, String value) {
+ /* TODO: Handle this over FOP's property mechanism so we can use
+ * inheritance.
+ */
if (qName == null) {
throw new NullPointerException("Parameter qName must not be null");
}
@@ -536,6 +546,4 @@
return foreignAttributes;
}
}
-
}
-
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: fop-commits-help@xmlgraphics.apache.org
Re: svn commit: r434513 - in /xmlgraphics/fop/trunk/src/java/org/apache/fop/fo: FOPropertyMapping.java FObj.java
Posted by Andreas L Delmelle <a_...@pandora.be>.
On Aug 25, 2006, at 20:33, Simon Pepping wrote:
> On Thu, Aug 24, 2006 at 08:32:03PM -0000, adelmelle@apache.org wrote:
> <snip />
> I prefer a separate commit per issue.
Preference noted. I'll try to keep an eye on it.
Cheers,
Andreas
Re: svn commit: r434513 - in
/xmlgraphics/fop/trunk/src/java/org/apache/fop/fo: FOPropertyMapping.java
FObj.java
Posted by Simon Pepping <sp...@leverkruid.eu>.
Andreas,
On Thu, Aug 24, 2006 at 08:32:03PM -0000, adelmelle@apache.org wrote:
> A few changes combined:
>
> 1) Bugzilla #40308
> Added relaxed validation for non-unique ids
> as suggested by Hussein Shafi (hussein.at.xmlmind.com)
>
> 2) Checkstyle cleanup in FObj
>
> 3) Changed propertyMakerTable to a static final, and
> altered FOPropertyMapping, to be 100% certain that
> the static arrays are only structurally modified
> once
I prefer a separate commit per issue.
Regards, Simon
--
Simon Pepping
home page: http://www.leverkruid.eu