* 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: FOPropertyMapping.java 488960 2006-12-20 08:34:28Z spepping $ */

* This class creates and returns an array of Property.Maker instances

* indexed by the PR_* propId from Constants.java.

*

* @todo Check multi-threading safety of the statics below

*/

    private static Map s_htPropNames = new HashMap();

    private static Map s_htSubPropNames = new HashMap();

    private static Map s_htPropIds = new HashMap();

    private static PropertyMaker[] s_generics = null;

    // The rest is only used during the building of the s_generics array.

    private Property[] enums = null;

    private PropertyMaker genericColor = null;

    private PropertyMaker genericBoolean = null;

    private PropertyMaker genericKeep = null;

    private PropertyMaker genericCondLength = null;

    private PropertyMaker genericCondPadding = null;

    private PropertyMaker genericPadding = null;

    private PropertyMaker genericCondBorderWidth = null;

    private PropertyMaker genericBorderWidth = null;

    private PropertyMaker genericBorderStyle = null;

    private PropertyMaker genericBreak = null;

    private PropertyMaker genericSpace = null;

    /**

     * Create the generic property maker templates. These templates

     * are used be the actual makers as a parameter to .useGeneric(...).

     */

    private void createGenerics() {

       

        PropertyMaker sub;

        genericColor = new ColorProperty.Maker(0);

        // GenericBoolean

        genericBoolean = new EnumProperty.Maker(0);

        genericBoolean.addEnum("true", getEnumProperty(EN_TRUE, "TRUE"));

        genericBoolean.addEnum("false", getEnumProperty(EN_FALSE, "FALSE"));

        // GenericKeep

        genericKeep = new KeepProperty.Maker(0);

        sub = new NumberProperty.Maker(CP_WITHIN_PAGE);

        sub.setByShorthand(true);

        sub.setDefault("auto");

        sub.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        sub.addEnum("always", getEnumProperty(EN_ALWAYS, "ALWAYS"));

        genericKeep.addSubpropMaker(sub);

        sub = new NumberProperty.Maker(CP_WITHIN_LINE);

        sub.setByShorthand(true);

        sub.setDefault("auto");

        sub.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        sub.addEnum("always", getEnumProperty(EN_ALWAYS, "ALWAYS"));

        genericKeep.addSubpropMaker(sub);

        sub = new NumberProperty.Maker(CP_WITHIN_COLUMN);

        sub.setByShorthand(true);

        sub.setDefault("auto");

        sub.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        sub.addEnum("always", getEnumProperty(EN_ALWAYS, "ALWAYS"));

        genericKeep.addSubpropMaker(sub);

        // GenericCondLength

        genericCondLength = new CondLengthProperty.Maker(0);

        sub = new LengthProperty.Maker(CP_LENGTH);

        sub.setByShorthand(true);

        genericCondLength.addSubpropMaker(sub);

        sub = new EnumProperty.Maker(CP_CONDITIONALITY);

        sub.addEnum("discard", getEnumProperty(EN_DISCARD, "DISCARD"));

        sub.addEnum("retain", getEnumProperty(EN_RETAIN, "RETAIN"));

        genericCondLength.addSubpropMaker(sub);

        // GenericCondPadding

        genericCondPadding = new CondLengthProperty.Maker(0);

        genericCondPadding.useGeneric(genericCondLength);

        genericCondPadding.setInherited(false);

        genericCondPadding.getSubpropMaker(CP_LENGTH).setDefault("0pt");

        genericCondPadding.setPercentBase(LengthBase.CONTAINING_BLOCK_WIDTH);

        // GenericPadding

        genericPadding = new LengthProperty.Maker(0);

        genericPadding.setInherited(false);

        genericPadding.setDefault("0pt");

        genericPadding.setPercentBase(LengthBase.CONTAINING_BLOCK_WIDTH);

        genericPadding.addShorthand(s_generics[PR_PADDING]);

        // GenericCondBorderWidth

        genericCondBorderWidth = new CondLengthProperty.Maker(0);

        genericCondBorderWidth.setInherited(false);

        genericCondBorderWidth.addKeyword("thin", "0.5pt");

        genericCondBorderWidth.addKeyword("medium", "1pt");

        genericCondBorderWidth.addKeyword("thick", "2pt");

        sub = new LengthProperty.Maker(CP_LENGTH);

        sub.setByShorthand(true);

        sub.addKeyword("thin", "0.5pt");

        sub.addKeyword("medium", "1pt");

        sub.addKeyword("thick", "2pt");

        sub.setDefault("medium");

        genericCondBorderWidth.addSubpropMaker(sub);

        sub = new EnumProperty.Maker(CP_CONDITIONALITY);

        sub.addEnum("discard", getEnumProperty(EN_DISCARD, "DISCARD"));

        sub.addEnum("retain", getEnumProperty(EN_RETAIN, "RETAIN"));

        genericCondBorderWidth.addSubpropMaker(sub);

        // GenericBorderWidth

        genericBorderWidth = new LengthProperty.Maker(0);

        genericBorderWidth.setInherited(false);

        genericBorderWidth.addKeyword("thin", "0.5pt");

        genericBorderWidth.addKeyword("medium", "1pt");

        genericBorderWidth.addKeyword("thick", "2pt");

        genericBorderWidth.setDefault("medium");

        // GenericBorderStyle

        genericBorderStyle = new EnumProperty.Maker(0);

        genericBorderStyle.setInherited(false);

        genericBorderStyle.addEnum("none", getEnumProperty(EN_NONE, "NONE"));

        genericBorderStyle.addEnum("hidden", getEnumProperty(EN_HIDDEN, "HIDDEN"));

        genericBorderStyle.addEnum("dotted", getEnumProperty(EN_DOTTED, "DOTTED"));

        genericBorderStyle.addEnum("dashed", getEnumProperty(EN_DASHED, "DASHED"));

        genericBorderStyle.addEnum("solid", getEnumProperty(EN_SOLID, "SOLID"));

        genericBorderStyle.addEnum("double", getEnumProperty(EN_DOUBLE, "DOUBLE"));

        genericBorderStyle.addEnum("groove", getEnumProperty(EN_GROOVE, "GROOVE"));

        genericBorderStyle.addEnum("ridge", getEnumProperty(EN_RIDGE, "RIDGE"));

        genericBorderStyle.addEnum("inset", getEnumProperty(EN_INSET, "INSET"));

        genericBorderStyle.addEnum("outset", getEnumProperty(EN_OUTSET, "OUTSET"));

        genericBorderStyle.setDefault("none");

        // GenericBreak

        genericBreak = new EnumProperty.Maker(0);

        genericBreak.setInherited(false);

        genericBreak.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        genericBreak.addEnum("column", getEnumProperty(EN_COLUMN, "COLUMN"));

        genericBreak.addEnum("page", getEnumProperty(EN_PAGE, "PAGE"));

        genericBreak.addEnum("even-page", getEnumProperty(EN_EVEN_PAGE, "EVEN_PAGE"));

        genericBreak.addEnum("odd-page", getEnumProperty(EN_ODD_PAGE, "ODD_PAGE"));

        genericBreak.setDefault("auto");

        // GenericSpace

        genericSpace = new SpaceProperty.Maker(0);

        genericSpace.setInherited(false);

        sub = new LengthProperty.Maker(CP_MINIMUM);

        sub.setDefault("0pt");

        sub.setByShorthand(true);

        genericSpace.addSubpropMaker(sub);

        sub = new LengthProperty.Maker(CP_OPTIMUM);

        sub.setDefault("0pt");

        sub.setByShorthand(true);

        genericSpace.addSubpropMaker(sub);

        sub = new LengthProperty.Maker(CP_MAXIMUM);

        sub.setDefault("0pt");

        sub.setByShorthand(true);

        genericSpace.addSubpropMaker(sub);

        sub = new NumberProperty.Maker(CP_PRECEDENCE);

        sub.addEnum("force", getEnumProperty(EN_FORCE, "FORCE"));

        sub.setDefault("0");

        genericSpace.addSubpropMaker(sub);

        sub = new EnumProperty.Maker(CP_CONDITIONALITY);

        sub.addEnum("discard", getEnumProperty(EN_DISCARD, "DISCARD"));

        sub.addEnum("retain", getEnumProperty(EN_RETAIN, "RETAIN"));

        sub.setDefault("discard");

        genericSpace.addSubpropMaker(sub);

    }

    /**

     * Add a property maker to the generics array.

     * Also creates the name <-> id mapping in s_htPropNames and s_htPropIds.

     *

     * @param name  the name of the property maker.

     * @param maker the maker.

     */

    private static void addPropertyMaker(String name, PropertyMaker maker) {

        s_generics[maker.getPropId()] = maker;

        s_htPropNames.put(name, new Integer(maker.getPropId()));

        s_htPropIds.put(new Integer(maker.getPropId()), name);

    }

    /**

     * Create the name<->id mapping for the subproperty names.

     * @param name name of the subproperty.

     * @param id   Id for the subproperty from CP_* in Constants.java.

     */

    private static void addSubpropMakerName(String name, int id) {

        s_htSubPropNames.put(name, new Integer(id));

        s_htPropIds.put(new Integer(id), name);

    }

    /**

     * Return a (possibly cached) enum property based in the enum value.

     * @param enum A enum value from Constants.java.

     * @param text the text value by which this enum property is known

     * @return An EnumProperty instance.

     */

    private Property getEnumProperty(int enumValue, String text) {

        if (enums == null) {

            enums = new Property[ENUM_COUNT + 1];

        }

        if (enums[enumValue] == null) {

            enums[enumValue] = EnumProperty.getInstance(enumValue, text);

        }

        return enums[enumValue];

    }

    /**

     * Return the array of Makers.

     * @return the maker array.

     */

    public static PropertyMaker[] getGenericMappings() {

       

        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;

    }

    /**

     * Return the propId for a property name.

     * @param name the property name

     * @return a propId that matches the property name.

     */

    public static int getPropertyId(String name) {

        if (name != null) {

            Integer i = (Integer) s_htPropNames.get(name);

            if (i != null) {

                return i.intValue();

            }

        }

        return -1;

    }

    /**

     * Return the subpropId for a subproperty name.

     * @param name the subproperty name.

     * @return a subpropId that matches the subproperty name.

     */

    public static int getSubPropertyId(String name) {

        if (name != null) {

            Integer i = (Integer) s_htSubPropNames.get(name);

            if (i != null) {

                return i.intValue();

            }

        }

        return -1;

    }

    /**

     * 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)) {

            return (String) s_htPropIds.get(new Integer(id));

        } else {

            return (String) s_htPropIds.get(new Integer(

                    id & Constants.PROPERTY_MASK)) + "." + s_htPropIds.get(

                            new Integer(id & Constants.COMPOUND_MASK));

        }

    }

    private void createAccessibilityProperties() {

        PropertyMaker m;

        // source-document

        m  = new StringProperty.Maker(PR_SOURCE_DOCUMENT);

        m.setInherited(false);

        m.setDefault("none");

        addPropertyMaker("source-document", m);

        // role

        m  = new StringProperty.Maker(PR_ROLE);

        m.setInherited(false);

        m.setDefault("none");

        addPropertyMaker("role", m);

    }

    private void createAbsolutePositionProperties() {

        PropertyMaker m;

        LengthProperty.Maker l;

        // absolute-position

        m  = new EnumProperty.Maker(PR_ABSOLUTE_POSITION);

        m.setInherited(false);

        m.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        m.addEnum("fixed", getEnumProperty(EN_FIXED, "FIXED"));

        m.addEnum("absolute", getEnumProperty(EN_ABSOLUTE, "ABSOLUTE"));

        m.setDefault("auto");

        m.addShorthand(s_generics[PR_POSITION]);

        addPropertyMaker("absolute-position", m);

        // top

        l  = new LengthProperty.Maker(PR_TOP);

        l.setInherited(false);

        l.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        l.setDefault("auto");

        addPropertyMaker("top", l);

        // right

        l  = new LengthProperty.Maker(PR_RIGHT);

        l.setInherited(false);

        l.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        l.setDefault("auto");

        addPropertyMaker("right", l);

        // bottom

        l  = new LengthProperty.Maker(PR_BOTTOM);

        l.setInherited(false);

        l.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        l.setDefault("auto");

        addPropertyMaker("bottom", l);

        // left

        l  = new LengthProperty.Maker(PR_LEFT);

        l.setInherited(false);

        l.addEnum("auto", getEnumProperty(EN_AUTO, "AUTO"));

        l.setDefault("auto");

        addPropertyMaker("left", l);

    }

    private void createAuralProperties() {

        PropertyMaker m;

        // azimuth

        m  = new ToBeImplementedProperty.Maker(PR_AZIMUTH);

        m.setInherited(true);

        m.setDefault("center");

        addPropertyMaker("azimuth", m);

        // cue-after

        m  = new ToBeImplementedProperty.Maker(PR_CUE_AFTER);

        m.setInherited(false);

        m.setDefault("none");

        addPropertyMaker("cue-after", m);

        // cue-before

        m  = new ToBeImplementedProperty.Maker(PR_CUE_BEFORE);

        m.setInherited(false);

        m.setDefault("none");

        addPropertyMaker("cue-before", m);

        // elevation

        m  = new ToBeImplementedProperty.Maker(PR_ELEVATION);

        m.setInherited(true);

        m.setDefault("level");

        addPropertyMaker("elevation", m);

        // pause-after

        m  = new ToBeImplementedProperty.Maker(PR_PAUSE_AFTER);

        m.setInherited(false);

        m.setDefault("");

        addPropertyMaker("pause-after", m);

        // pause-before

        m  = new ToBeImplementedProperty.Maker(PR_PAUSE_BEFORE);

        m.setInherited(false);

        m.setDefault("");

        addPropertyMaker("pause-before", m);

        // pitch

        m  = new ToBeImplementedProperty.Maker(PR_PITCH);

        m.setInherited(true);

        m.setDefault("medium");

        addPropertyMaker("pitch", m);

        // pitch-range

        m  = new ToBeImplementedProperty.Maker(PR_PITCH_RANGE);

        m.setInherited(true);

        m.setDefault("50");

        addPropertyMaker("pitch-range", m);

        // play-during

        m  = new ToBeImplementedProperty.Maker(PR_PLAY_DURING);

        m.setInherited(false);

        m.setDefault("auto");

        addPropertyMaker("play-during", m);

        // richness

        m  = new ToBeImplementedProperty.Maker(PR_RICHNESS);

        m.setInherited(true);

        m.setDefault("50");

        addPropertyMaker("richness", m);

        // speak

        m  = new ToBeImplementedProperty.Maker(PR_SPEAK);

        m.setInherited(true);

        m.setDefault("normal");

        addPropertyMaker("speak", m);

        // speak-header

        m  = new ToBeImplementedProperty.Maker(PR_SPEAK_HEADER);

        m.setInherited(true);

        m.setDefault("once");

        addPropertyMaker("speak-header", m);

        // speak-numeral

        m  = new ToBeImplementedProperty.Maker(PR_SPEAK_NUMERAL);

        m.setInherited(true);

        m.setDefault("continuous");

        addPropertyMaker("speak-numeral", m);

        // speak-punctuation

        m  = new ToBeImplementedProperty.Maker(PR_SPEAK_PUNCTUATION);

        m.setInherited(true);

        m.setDefault("none");

        addPropertyMaker("speak-punctuation", m);

        // speech-rate

        m  = new ToBeImplementedProperty.Maker(PR_SPEECH_RATE);

        m.setInherited(true);

        m.setDefault("medium");

        addPropertyMaker("speech-rate", m);

        // stress

        m  = new ToBeImplementedProperty.Maker(PR_STRESS);

        m.setInherited(true);

        m.setDefault("50");

        addPropertyMaker("stress", m);

        // voice-family

        m  = new ToBeImplementedProperty.Maker(PR_VOICE_FAMILY);

        m.setInherited(true);

        m.setDefault("");

        addPropertyMaker("voice-family", m);

        // volume

        m  = new ToBeImplementedProperty.Maker(PR_VOLUME);

        m.setInherited(true);

        m.setDefault("medium");

        addPropertyMaker("volume", m);

    }

    private void createBorderPaddingBackgroundProperties() {

        PropertyMaker m;

        BorderWidthPropertyMaker bwm;

        CorrespondingPropertyMaker corr;

        // background-attachment

        m  = new EnumProperty.Maker(PR_BACKGROUND_ATTACHMENT);

        m.setInherited(false);

        m.addEnum("scroll", getEnumProperty(EN_SCROLL, "SCROLL"));

        m.addEnum("fixed", getEnumProperty(EN_FIXED, "FIXED"));

        m.setDefault("scroll");

        addPropertyMaker("background-attachment", m);

        // background-color

        m  = new ColorProperty.Maker(PR_BACKGROUND_COLOR) {

            protected Property convertPropertyDatatype(

                    Property p, PropertyList propertyList, FObj fo) throws PropertyException {