/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * Licensed 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.
 */
package com.android.internal.widget.remotecompose.core;

import android.annotation.NonNull;
import android.annotation.Nullable;

import com.android.internal.widget.remotecompose.core.operations.FloatExpression;
import com.android.internal.widget.remotecompose.core.operations.ShaderData;
import com.android.internal.widget.remotecompose.core.operations.Theme;
import com.android.internal.widget.remotecompose.core.operations.Utils;
import com.android.internal.widget.remotecompose.core.operations.layout.Component;
import com.android.internal.widget.remotecompose.core.operations.layout.managers.LayoutManager;
import com.android.internal.widget.remotecompose.core.operations.layout.utils.DebugLog;
import com.android.internal.widget.remotecompose.core.operations.utilities.ArrayAccess;
import com.android.internal.widget.remotecompose.core.operations.utilities.CollectionsAccess;
import com.android.internal.widget.remotecompose.core.operations.utilities.DataMap;
import com.android.internal.widget.remotecompose.core.operations.utilities.IntMap;

import java.util.ArrayList;

/**
 * Specify an abstract context used to playback RemoteCompose documents
 *
 * <p>This allows us to intercept the different operations in a document and react to them.
 *
 * <p>We also contain a PaintContext, so that any operation can draw as needed.
 */
public abstract class RemoteContext {
    private static final int MAX_OP_COUNT = 20_000; // Maximum cmds per frame
    private @NonNull RemoteClock mClock;
    protected @NonNull CoreDocument mDocument;
    public @NonNull RemoteComposeState mRemoteComposeState =
            new RemoteComposeState(); // todo, is this a valid use of RemoteComposeState -- bbade@
    private long mDocLoadTime;
    @Nullable protected PaintContext mPaintContext = null;
    protected float mDensity = Float.NaN;
    private int mPaintTheme = -3;
    @NonNull ContextMode mMode = ContextMode.UNSET;

    int mDebug = 0;

    private int mOpCount;
    private int mTheme = Theme.UNSPECIFIED;

    public float mWidth = 0f;
    public float mHeight = 0f;

    public float mViewportWidth = 0f;
    public float mViewportHeight = 0f;

    private float mAnimationTime;

    private boolean mAnimate = true;

    public @Nullable Component mLastComponent;
    public long currentTime = 0L;

    private boolean mUseChoreographer = true;

    private int mTouchVersion = LayoutManager.DEFAULT_TOUCH_VERSION;

    public RemoteContext() {
        this(RemoteClock.SYSTEM);
    }

    public RemoteContext(@NonNull RemoteClock clock) {
        this.mClock = clock;
        setDocLoadTime();
        mDocument = new CoreDocument(clock); // todo: is this a valid way to initialize? bbade@
    }

    /**
     * Returns true if the document has been encoded for at least the given version MAJOR.MINOR
     *
     * @param major major version number
     * @param minor minor version number
     * @param patch patch version number
     * @return true if the document was written at least with the given version
     */
    public boolean supportsVersion(int major, int minor, int patch) {
        return mDocument.mVersion.supportsVersion(major, minor, patch);
    }

    public float getDensity() {
        return mDensity;
    }

    /**
     * Set the density of the document
     *
     * @param density density value
     */
    public void setDensity(float density) {
        if (!Float.isNaN(density) && density > 0) {
            mDensity = density;
            loadFloat(ID_DENSITY, density);
        }
    }

    /**
     * Get the time the document was loaded
     *
     * @return time in ms since the document was loaded
     */
    public long getDocLoadTime() {
        return mDocLoadTime;
    }

    /** Set the time the document was loaded */
    public void setDocLoadTime() {
        mDocLoadTime = getClock().millis();
    }

    public boolean isAnimationEnabled() {
        return mAnimate;
    }

    public void setAnimationEnabled(boolean value) {
        mAnimate = value;
    }

    /**
     * Provide access to the table of collections
     *
     * @return the CollectionsAccess implementation
     */
    public @Nullable CollectionsAccess getCollectionsAccess() {
        return mRemoteComposeState;
    }

    /**
     * Load a path under an id. Paths can be use in clip drawPath and drawTweenPath
     *
     * @param instanceId the id to save this path under
     * @param floatPath the path as a float array
     */
    public abstract void loadPathData(int instanceId, int winding, @NonNull float [] floatPath);

    /**
     * Load a path under an id. Paths can be use in clip drawPath and drawTweenPath
     *
     * @param instanceId the id
     * @return the a
     */
    public abstract @Nullable float [] getPathData(int instanceId);

    /**
     * Associate a name with a give id.
     *
     * @param varName the name
     * @param varId the id (color,integer,float etc.)
     * @param varType thetype
     */
    public abstract void loadVariableName(@NonNull String varName, int varId, int varType);

    /**
     * Save a color under a given id
     *
     * @param id the id of the color
     * @param color the color to set
     */
    public abstract void loadColor(int id, int color);

    /**
     * Set the animation time allowing the creator to control animation rates
     *
     * @param time the animation time in seconds
     */
    public void setAnimationTime(float time) {
        mAnimationTime = time;
    }

    /**
     * gets the time animation clock as float in seconds
     *
     * @return a monotonic time in seconds (arbitrary zero point)
     */
    public float getAnimationTime() {
        return mAnimationTime;
    }

    /**
     * Set the value of a named Color. This overrides the color in the document
     *
     * @param colorName the name of the color to override
     * @param color Override the default color
     */
    public abstract void setNamedColorOverride(@NonNull String colorName, int color);

    /**
     * Set the value of a named String. This overrides the string in the document
     *
     * @param stringName the name of the string to override
     * @param value Override the default string
     */
    public abstract void setNamedStringOverride(@NonNull String stringName, @NonNull String value);

    /**
     * Allows to clear a named String.
     *
     * <p>If an override exists, we revert back to the default value in the document.
     *
     * @param stringName the name of the string to override
     */
    public abstract void clearNamedStringOverride(@NonNull String stringName);

    /**
     * Set the value of a named Boolean. This overrides the boolean in the document
     *
     * @param booleanName the name of the boolean to override
     * @param value Override the default boolean
     */
    public abstract void setNamedBooleanOverride(@NonNull String booleanName, boolean value);

    /**
     * Allows to clear a named Boolean.
     *
     * <p>If an override exists, we revert back to the default value in the document.
     *
     * @param booleanName the name of the boolean to override
     */
    public abstract void clearNamedBooleanOverride(@NonNull String booleanName);

    /**
     * Set the value of a named Integer. This overrides the integer in the document
     *
     * @param integerName the name of the integer to override
     * @param value Override the default integer
     */
    public abstract void setNamedIntegerOverride(@NonNull String integerName, int value);

    /**
     * Allows to clear a named Integer.
     *
     * <p>If an override exists, we revert back to the default value in the document.
     *
     * @param integerName the name of the integer to override
     */
    public abstract void clearNamedIntegerOverride(@NonNull String integerName);

    /**
     * Set the value of a named float. This overrides the float in the document
     *
     * @param floatName the name of the float to override
     * @param value Override the default float
     */
    public abstract void setNamedFloatOverride(@NonNull String floatName, float value);

    /**
     * Allows to clear a named Float.
     *
     * <p>If an override exists, we revert back to the default value in the document.
     *
     * @param floatName the name of the float to override
     */
    public abstract void clearNamedFloatOverride(@NonNull String floatName);

    /**
     * Set the value of a named long. This modifies the content of a LongConstant
     *
     * @param name the name of the float to override
     * @param value Override the default float
     */
    public abstract void setNamedLong(@NonNull String name, long value);

    /**
     * Set the value of a named Object. This overrides the Object in the document
     *
     * @param dataName the name of the Object to override
     * @param value Override the default float
     */
    public abstract void setNamedDataOverride(@NonNull String dataName, @NonNull Object value);

    /**
     * Allows to clear a named Object.
     *
     * <p>If an override exists, we revert back to the default value in the document.
     *
     * @param dataName the name of the Object to override
     */
    public abstract void clearNamedDataOverride(@NonNull String dataName);

    /**
     * Support Collections by registering this collection
     *
     * @param id id of the collection
     * @param collection the collection under this id
     */
    public abstract void addCollection(int id, @NonNull ArrayAccess collection);

    /**
     * put DataMap under an id
     *
     * @param id the id of the DataMap
     * @param map the DataMap
     */
    public abstract void putDataMap(int id, @NonNull DataMap map);

    /**
     * Get a DataMap given an id
     *
     * @param id the id of the DataMap
     * @return the DataMap
     */
    public abstract @Nullable DataMap getDataMap(int id);

    /**
     * Run an action
     *
     * @param id the id of the action
     * @param metadata the metadata of the action
     */
    public abstract void runAction(int id, @NonNull String metadata);

    // TODO: we might add an interface to group all valid parameter types

    /**
     * Run an action with a named parameter
     *
     * @param id the text id of the action
     * @param value the value of the parameter
     */
    public abstract void runNamedAction(int id, @Nullable Object value);

    /**
     * Put an object under an id
     *
     * @param id the id of the object
     * @param value the object
     */
    public abstract void putObject(int id, @NonNull Object value);

    /**
     * Get an object given an id
     *
     * @param id the id of the object
     * @return the object
     */
    public abstract @Nullable Object getObject(int id);

    /**
     * Add a touch listener to the context
     *
     * @param touchExpression the touch expression
     */
    public void addTouchListener(@NonNull TouchListener touchExpression) {}

    /**
     * Vibrate the device
     *
     * @param type 0 = none, 1-21 ,see HapticFeedbackConstants
     */
    public abstract void hapticEffect(int type);

    /** Set the repaint flag. This will trigger a repaint of the current document. */
    public void needsRepaint() {
        if (mPaintContext != null) {
            mPaintContext.needsRepaint();
        }
    }

    /**
     * Returns true if we should use the choreographter
     *
     * @return true if we use the choreographer
     */
    public boolean getUseChoreographer() {
        return mUseChoreographer;
    }

    /**
     * Set to true to use the android choreographer
     *
     * @param value true to use the choreographer
     */
    public void setUseChoreographer(boolean value) {
        mUseChoreographer = value;
    }

    public @NonNull RemoteClock getClock() {
        return mClock;
    }

    public void setClock(@NonNull RemoteClock clock) {
        this.mClock = clock;
    }

    /**
     * Load a font under an id
     *
     * @param fontId the id of the font
     * @param fontData the font data
     */
    public void loadFont(int fontId, @NonNull byte [] fontData) {
        Object info = getObject(fontId);
        if (info != null) {
            FontInfo fi = (FontInfo) info;
            if (fi.mFontData == fontData) {
                return;
            }
        }
        putObject(fontId, new FontInfo(fontId, fontData));
    }

    /**
     * Set the theme under which it will be painted
     * @param theme the theme
     */
    public void setPaintTheme(int theme) {
        mPaintTheme = theme;
    }

    /**
     * Get the theme under which it will be painted
     * @return the paint theme
     */
    public int getPaintTheme() {
        return mPaintTheme;
    }

    /**
     * Set the touch version
     * @param touchVersion
     */
    public void setTouchVersion(int touchVersion) {
        mTouchVersion = touchVersion;
    }

    /**
     * Get the touch version
     * @return
     */
    public int getTouchVersion() {
        return mTouchVersion;
    }

    /**
     * Return true if the provided feature is enabled in the document
     * @param feature feature id
     * @return
     */
    public boolean useFeature(short feature) {
        return mDocument.useFeature(feature);
    }

    /** The font information */
    public static class FontInfo {
        /** the id of the font */
        public final int mFontId;

        /** the byte array of the font data */
        public final byte[] mFontData;

        /** opaque cache of a font builder */
        public @Nullable Object fontBuilder = null;

        /**
         * Create a font info object
         *
         * @param fontId the id of the font
         * @param fontData the font data
         */
        FontInfo(int fontId, byte[] fontData) {
            this.mFontId = fontId;
            this.mFontData = fontData;
        }
    }

    /**
     * The context can be used in a few different mode, allowing operations to skip being executed:
     * - UNSET : all operations will get executed - DATA : only operations dealing with DATA (eg
     * loading a bitmap) should execute - PAINT : only operations painting should execute
     */
    public enum ContextMode {
        UNSET,
        DATA,
        PAINT
    }

    public int getTheme() {
        return mTheme;
    }

    public void setTheme(int theme) {
        this.mTheme = theme;
    }

    public @NonNull ContextMode getMode() {
        return mMode;
    }

    public void setMode(@NonNull ContextMode mode) {
        this.mMode = mode;
    }

    /**
     * Create an edge effect
     * Used in scroll views when hitting start/end of the scroll area
     *
     * @param direction : TOP/BOTTOM/LEFT/RIGHT
     * @return a platform-specific implementation or null
     */
    public @Nullable ScrollingEdgeEffect createEdgeEffect(int direction) {
        return null;
    }

    @Nullable
    public PaintContext getPaintContext() {
        return mPaintContext;
    }

    public void setPaintContext(@NonNull PaintContext paintContext) {
        this.mPaintContext = paintContext;
    }

    public @Nullable CoreDocument getDocument() {
        return mDocument;
    }

    public boolean isBasicDebug() {
        return mDebug == 1;
    }

    public boolean isVisualDebug() {
        return mDebug == 2;
    }

    public boolean isLayoutDebug() {
        return mDebug == 3;
    }

    public void setDebug(int debug) {
        this.mDebug = debug;
        DebugLog.DEBUG_LAYOUT_ON = mDebug == 3;
    }

    /**
     * Set the document on the context
     *
     * @param document document used
     */
    public void setDocument(@NonNull CoreDocument document) {
        this.mDocument = document;
        mClock = document.getClock();
    }

    ///////////////////////////////////////////////////////////////////////////////////////////////
    // Operations
    ///////////////////////////////////////////////////////////////////////////////////////////////

    /**
     * Set the main information about a document
     *
     * @param majorVersion major version of the document protocol used
     * @param minorVersion minor version of the document protocol used
     * @param patchVersion patch version of the document protocol used
     * @param width original width of the document when created
     * @param height original height of the document when created
     * @param capabilities bitmask of capabilities used in the document (TBD)
     * @param properties properties of the document (TBD)
     */
    public void header(
            int majorVersion,
            int minorVersion,
            int patchVersion,
            int width,
            int height,
            long capabilities,
            @Nullable IntMap<Object> properties) {
        mRemoteComposeState.setWindowWidth(width);
        mRemoteComposeState.setWindowHeight(height);
        mDocument.setVersion(majorVersion, minorVersion, patchVersion);
        mDocument.setWidth(width);
        mDocument.setHeight(height);
        mDocument.setRequiredCapabilities(capabilities);
        mDocument.setProperties(properties);
    }

    /**
     * Sets the way the player handles the content
     *
     * @param scroll set the horizontal behavior (NONE|SCROLL_HORIZONTAL|SCROLL_VERTICAL)
     * @param alignment set the alignment of the content (TOP|CENTER|BOTTOM|START|END)
     * @param sizing set the type of sizing for the content (NONE|SIZING_LAYOUT|SIZING_SCALE)
     * @param mode set the mode of sizing, either LAYOUT modes or SCALE modes the LAYOUT modes are:
     *     - LAYOUT_MATCH_PARENT - LAYOUT_WRAP_CONTENT or adding an horizontal mode and a vertical
     *     mode: - LAYOUT_HORIZONTAL_MATCH_PARENT - LAYOUT_HORIZONTAL_WRAP_CONTENT -
     *     LAYOUT_HORIZONTAL_FIXED - LAYOUT_VERTICAL_MATCH_PARENT - LAYOUT_VERTICAL_WRAP_CONTENT -
     *     LAYOUT_VERTICAL_FIXED The LAYOUT_*_FIXED modes will use the intrinsic document size
     */
    public void setRootContentBehavior(int scroll, int alignment, int sizing, int mode) {
        mDocument.setRootContentBehavior(scroll, alignment, sizing, mode);
    }

    /**
     * Set a content description for the document
     *
     * @param contentDescriptionId the text id pointing at the description
     */
    public void setDocumentContentDescription(int contentDescriptionId) {
        String contentDescription = (String) mRemoteComposeState.getFromId(contentDescriptionId);
        mDocument.setContentDescription(contentDescription);
    }

    ///////////////////////////////////////////////////////////////////////////////////////////////
    // Data handling
    ///////////////////////////////////////////////////////////////////////////////////////////////

    /**
     * Mark the variable as dirty
     * @param id
     */
    public void markVariableDirty(int id) {
        // empty
    }

    /**
     * Save a bitmap under an imageId
     *
     * @param imageId the id of the image
     * @param encoding how the data is encoded 0 = png, 1 = raw, 2 = url
     * @param type the type of the data 0 = RGBA 8888, 1 = 888, 2 = 8 gray
     * @param width the width of the image
     * @param height the height of the image
     * @param bitmap the bytes that represent the image
     */
    public abstract void loadBitmap(
            int imageId,
            short encoding,
            short type,
            int width,
            int height,
            @NonNull byte [] bitmap);

    /**
     * Save a string under a given id
     *
     * @param id the id of the string
     * @param text the value to set
     */
    public abstract void loadText(int id, @NonNull String text);

    /**
     * Get a string given an id
     *
     * @param id the id of the string
     * @return a string if found, null otherwise
     */
    public abstract @Nullable String getText(int id);

    /**
     * Load a float
     *
     * @param id id of the float
     * @param value the value to set
     */
    public abstract void loadFloat(int id, float value);

    /**
     * Override an existing float value
     *
     * @param id the value id
     * @param value the new value
     */
    public abstract void overrideFloat(int id, float value);

    /**
     * Load a integer
     *
     * @param id id of the integer
     * @param value the value to set
     */
    public abstract void loadInteger(int id, int value);

    /**
     * Override an existing int value
     *
     * @param id the value id
     * @param value the new value
     */
    public abstract void overrideInteger(int id, int value);

    /**
     * Override an existing text value
     *
     * @param id the value id
     * @param valueId the new value
     */
    public abstract void overrideText(int id, int valueId);

    /**
     * Load an animated float associated with an id Todo: Remove? cc @hoford
     *
     * @param id the id of the float
     * @param animatedFloat The animated float
     */
    public abstract void loadAnimatedFloat(int id, @NonNull FloatExpression animatedFloat);

    /**
     * Save a shader under and ID
     *
     * @param id the id of the Shader
     * @param value the shader
     */
    public abstract void loadShader(int id, @NonNull ShaderData value);

    /**
     * Get a float given an id
     *
     * @param id the id of the float
     * @return the value of the float
     */
    public abstract float getFloat(int id);

    /**
     * Get a Integer given an id
     *
     * @param id of the integer
     * @return the value
     */
    public abstract int getInteger(int id);

    /**
     * Get a Long given an id
     *
     * @param id of the long
     * @return the value
     */
    public abstract long getLong(int id);

    /**
     * Get the color given and ID
     *
     * @param id of the color
     * @return the color
     */
    public abstract int getColor(int id);

    /**
     * called to notify system that a command is interested in a variable
     *
     * @param id track when this id changes value
     * @param variableSupport call back when value changes
     */
    public abstract void listensTo(int id, @NonNull VariableSupport variableSupport);

    /**
     * Get the listeners for a given id
     *
     * @param id
     * @return
     */
    public @Nullable ArrayList<VariableSupport> getListeners(int id) {
        return null;
    }

    /**
     * Notify commands with variables have changed
     *
     *
     * @return the number of ms to next update
     */
    public abstract int updateOps();

    /**
     * Get a shader given the id
     *
     * @param id get a shader given the id
     * @return The shader
     */
    @Nullable
    public abstract ShaderData getShader(int id);

    public static final int ID_CONTINUOUS_SEC = 1;
    public static final int ID_TIME_IN_SEC = 2;
    public static final int ID_TIME_IN_MIN = 3;
    public static final int ID_TIME_IN_HR = 4;
    public static final int ID_WINDOW_WIDTH = 5;
    public static final int ID_WINDOW_HEIGHT = 6;
    public static final int ID_COMPONENT_WIDTH = 7;
    public static final int ID_COMPONENT_HEIGHT = 8;
    public static final int ID_CALENDAR_MONTH = 9;
    public static final int ID_OFFSET_TO_UTC = 10;
    public static final int ID_WEEK_DAY = 11;
    public static final int ID_DAY_OF_MONTH = 12;
    public static final int ID_TOUCH_POS_X = 13;
    public static final int ID_TOUCH_POS_Y = 14;

    public static final int ID_TOUCH_VEL_X = 15;
    public static final int ID_TOUCH_VEL_Y = 16;

    public static final int ID_ACCELERATION_X = 17;
    public static final int ID_ACCELERATION_Y = 18;
    public static final int ID_ACCELERATION_Z = 19;

    public static final int ID_GYRO_ROT_X = 20;
    public static final int ID_GYRO_ROT_Y = 21;
    public static final int ID_GYRO_ROT_Z = 22;

    public static final int ID_MAGNETIC_X = 23;
    public static final int ID_MAGNETIC_Y = 24;
    public static final int ID_MAGNETIC_Z = 25;

    public static final int ID_LIGHT = 26;

    public static final int ID_DENSITY = 27;

    /** Defines when the last build was made */
    public static final int ID_API_LEVEL = 28;

    /** Defines when the TOUCH EVENT HAPPENED */
    public static final int ID_TOUCH_EVENT_TIME = 29;

    /** Animation time in seconds */
    public static final int ID_ANIMATION_TIME = 30;

    /** The delta between current and last Frame */
    public static final int ID_ANIMATION_DELTA_TIME = 31;

    public static final int ID_EPOCH_SECOND = 32;

    public static final int ID_FONT_SIZE = 33;

    /** DAY OF THE YEAR 1-366 */
    public static final int ID_DAY_OF_YEAR = 34;

    /** The YEAR e.g. 2026 */
    public static final int ID_YEAR = 35;

    /** First baseline (for alignment) */
    public static final int ID_FIRST_BASELINE = 36;

    /** last baseline (for alignment) */
    public static final int ID_LAST_BASELINE = 37;

    public static final float FLOAT_DENSITY = Utils.asNan(ID_DENSITY);

    /** CONTINUOUS_SEC is seconds from midnight looping every hour 0-3600 */
    public static final float FLOAT_CONTINUOUS_SEC = Utils.asNan(ID_CONTINUOUS_SEC);

    /** seconds run from Midnight=0 quantized to seconds hour 0..3599 */
    public static final float FLOAT_TIME_IN_SEC = Utils.asNan(ID_TIME_IN_SEC);

    /** minutes run from Midnight=0 quantized to minutes 0..1439 */
    public static final float FLOAT_TIME_IN_MIN = Utils.asNan(ID_TIME_IN_MIN);

    /** hours run from Midnight=0 quantized to Hours 0-23 */
    public static final float FLOAT_TIME_IN_HR = Utils.asNan(ID_TIME_IN_HR);

    /** Moth of Year quantized to MONTHS 1-12. 1 = January */
    public static final float FLOAT_CALENDAR_MONTH = Utils.asNan(ID_CALENDAR_MONTH);

    /** DAY OF THE WEEK 1-7. 1 = Monday */
    public static final float FLOAT_WEEK_DAY = Utils.asNan(ID_WEEK_DAY);

    /** DAY OF THE MONTH 1-31 */
    public static final float FLOAT_DAY_OF_MONTH = Utils.asNan(ID_DAY_OF_MONTH);

    /** DAY OF THE YEAR 1-366 */
    public static final float FLOAT_DAY_OF_YEAR = Utils.asNan(ID_DAY_OF_YEAR);

    /** The YEAR e.g. 2026 */
    public static final float FLOAT_YEAR = Utils.asNan(ID_YEAR);

    public static final float FLOAT_WINDOW_WIDTH = Utils.asNan(ID_WINDOW_WIDTH);
    public static final float FLOAT_WINDOW_HEIGHT = Utils.asNan(ID_WINDOW_HEIGHT);
    public static final float FLOAT_COMPONENT_WIDTH = Utils.asNan(ID_COMPONENT_WIDTH);
    public static final float FLOAT_COMPONENT_HEIGHT = Utils.asNan(ID_COMPONENT_HEIGHT);

    /** ID_OFFSET_TO_UTC is the offset from UTC in sec (typically / 3600f) */
    public static final float FLOAT_OFFSET_TO_UTC = Utils.asNan(ID_OFFSET_TO_UTC);

    /** TOUCH_POS_X is the x position of the touch */
    public static final float FLOAT_TOUCH_POS_X = Utils.asNan(ID_TOUCH_POS_X);

    /** TOUCH_POS_Y is the y position of the touch */
    public static final float FLOAT_TOUCH_POS_Y = Utils.asNan(ID_TOUCH_POS_Y);

    /** TOUCH_VEL_X is the x velocity of the touch */
    public static final float FLOAT_TOUCH_VEL_X = Utils.asNan(ID_TOUCH_VEL_X);

    /** TOUCH_VEL_Y is the x velocity of the touch */
    public static final float FLOAT_TOUCH_VEL_Y = Utils.asNan(ID_TOUCH_VEL_Y);

    /** TOUCH_EVENT_TIME the time of the touch */
    public static final float FLOAT_TOUCH_EVENT_TIME = Utils.asNan(ID_TOUCH_EVENT_TIME);

    /** Animation time in seconds */
    public static final float FLOAT_ANIMATION_TIME = Utils.asNan(ID_ANIMATION_TIME);

    /** Animation time in seconds */
    public static final float FLOAT_ANIMATION_DELTA_TIME = Utils.asNan(ID_ANIMATION_DELTA_TIME);

    /** X acceleration sensor value in M/s^2 */
    public static final float FLOAT_ACCELERATION_X = Utils.asNan(ID_ACCELERATION_X);

    /** Y acceleration sensor value in M/s^2 */
    public static final float FLOAT_ACCELERATION_Y = Utils.asNan(ID_ACCELERATION_Y);

    /** Z acceleration sensor value in M/s^2 */
    public static final float FLOAT_ACCELERATION_Z = Utils.asNan(ID_ACCELERATION_Z);

    /** X Gyroscope rotation rate sensor value in radians/second */
    public static final float FLOAT_GYRO_ROT_X = Utils.asNan(ID_GYRO_ROT_X);

    /** Y Gyroscope rotation rate sensor value in radians/second */
    public static final float FLOAT_GYRO_ROT_Y = Utils.asNan(ID_GYRO_ROT_Y);

    /** Z Gyroscope rotation rate sensor value in radians/second */
    public static final float FLOAT_GYRO_ROT_Z = Utils.asNan(ID_GYRO_ROT_Z);

    /** Ambient magnetic field in X. sensor value in micro-Tesla (uT) */
    public static final float FLOAT_MAGNETIC_X = Utils.asNan(ID_MAGNETIC_X);

    /** Ambient magnetic field in Y. sensor value in micro-Tesla (uT) */
    public static final float FLOAT_MAGNETIC_Y = Utils.asNan(ID_MAGNETIC_Y);

    /** Ambient magnetic field in Z. sensor value in micro-Tesla (uT) */
    public static final float FLOAT_MAGNETIC_Z = Utils.asNan(ID_MAGNETIC_Z);

    /** Ambient light level in SI lux */
    public static final float FLOAT_LIGHT = Utils.asNan(ID_LIGHT);

    /** When was this player built */
    public static final float FLOAT_API_LEVEL = Utils.asNan(ID_API_LEVEL);

    /** The default font size */
    public static final float FLOAT_FONT_SIZE = Utils.asNan(ID_FONT_SIZE);

    /** The time in seconds since the epoch. */
    public static final long INT_EPOCH_SECOND = ((long) ID_EPOCH_SECOND) + 0x100000000L;

    /** First Baseline */
    public static final float FIRST_BASELINE = Utils.asNan(ID_FIRST_BASELINE);

    /** Last Baseline */
    public static final float LAST_BASELINE = Utils.asNan(ID_LAST_BASELINE);

    ///////////////////////////////////////////////////////////////////////////////////////////////
    // Click handling
    ///////////////////////////////////////////////////////////////////////////////////////////////

    /**
     * Is this a time id float
     *
     * @param fl the floatId to test
     * @return true if it is a time id
     */
    public static boolean isTime(float fl) {
        int value = Utils.idFromNan(fl);
        return value >= ID_CONTINUOUS_SEC && value <= ID_DAY_OF_MONTH;
    }

    /**
     * Add a click area to the doc
     *
     * @param id the id of the click area
     * @param contentDescriptionId the content description of the click area
     * @param left the left bounds of the click area
     * @param top the top bounds of the click area
     * @param right the right bounds of the click area
     * @param bottom the
     * @param metadataId the id of the metadata string
     */
    public abstract void addClickArea(
            int id,
            int contentDescriptionId,
            float left,
            float top,
            float right,
            float bottom,
            int metadataId);

    /** increments the count of operations executed in a pass */
    public void incrementOpCount() {
        mOpCount++;
        if (mOpCount > MAX_OP_COUNT) {
            throw new RuntimeException("Too many operations executed");
        }
    }

    /**
     * Get the last Op Count and clear the count.
     *
     * @return the number of ops executed.
     */
    public int getLastOpCount() {
        int count = mOpCount;
        mOpCount = 0;
        return count;
    }

    /** Explicitly clear the operation counter */
    public void clearLastOpCount() {
        mOpCount = 0;
    }
}
