package jmri.jmrit.symbolicprog;

import java.awt.Component;
import java.util.HashMap;
import javax.swing.JComponent;
import javax.swing.JLabel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Represents a single Variable value; abstract base class.
 * <p>
 * The "changed" parameter (non-bound, accessed via isChanged) indicates whether
 * a "write changes" or "read changes" operation should handle this object.
 * <br><br>
 * The mask shown below comes in two forms:
 * <ul>
 *   <li> A character-by-character bit mask of 8 or 16 binary digits, e.g.
 *   "XXVVVVXXX"
 *   <br>
 *   In this case, the "V" bits denote a continuous bit field that contains the
 *   datum. For use in SplitVariableValue this mask can also be entered a a list of
 *   multiple bit masks, separated by spaces.
 *   <li>A small decimal value, i.e. "9"
 *   <br>
 *   In this case, aka Radix mask, it forms the multiplier (N) which combines with the
 *   maximum value (maxVal, defined in a subclass) to break the CV into three
 *   parts:
 *   <ul>
 *     <li>lowest part, stored as 1 times a value 0-(N-1)
 *     <li>datum stored as datum*N (datum is limited to maxVal)
 *     <li>highest part, which stored as N*(maxVal+1) times the value
 *   </ul>
 *   As an example, consider storing two decimal digits as a decimal value. You
 *   can't use a bit mask changing the 2nd digit from 1 to 7, for example with a
 *   total value of 14 to 74, changes bits that are also used by the first digit.
 *   Instead, code this as
 *   <ul>
 *     <li> mask="1" maxVal="9"
 *     <li> mask="10" maxVal="9"
 *   </ul>
 *   and you'll get the desired effect. (This requires Schema
 *   <a href="http://jmri.org/xml/schema/decoder-4-15-2.xsd">xml/schema/decoder-4-15-2.xsd</a>
 *   for validation)
 * </ul>
 * <p>
 * Variables track their states, as shown below.<br>
 * <a href="doc-files/VariableStates.png"><img src="doc-files/VariableStates.png" alt="States for variables and their colors" height="33%" width="33%"></a>
 *
 * @author Bob Jacobsen Copyright (C) 2001, 2002, 2003, 2004, 2005, 2013
 * @author Howard G. Penny Copyright (C) 2005
 */
public abstract class VariableValue extends AbstractValue implements java.beans.PropertyChangeListener {

    private String _label;
    private String _item;
    private String _cvName;

    /**
     * A vector of CV objects used to look up CVs.
     */
    protected HashMap<String, CvValue> _cvMap;

    /**
     * Field holds the current status.
     */
    protected JLabel _status = null;

    /**
     * Field holds the current tool tip text.
     */
    protected String _tooltipText = null;
    // and thus can be called without limit
    // and thus should be called a limited number of times

    /**
     * Get a display representation {@code Object} of this variable.
     * <br><br>
     * The actual stored value of a variable is not the most interesting thing.
     * Instead, you usually get an {@code Object} representation for display in
     * a table, etc. Modification of the state of that object then gets
     * reflected back, causing the underlying CV objects to change.
     *
     * @return the {@code Object} representation for display purposes
     */
    public abstract Component getCommonRep(); // and thus should be called a limited number of times

    /**
     * Creates a new {@code Object} representation for display purposes, using
     * the specified format.
     *
     * @param format a name representing
     * @return an {@code Object} representation for display purposes
     */
    public abstract Component getNewRep(String format); // this one is returning a new object

    /**
     * @return String that can (usually) be interpreted as an integer
     */
    public abstract String getValueString();

    /**
     * @return Value as a native-form Object
     */
    public abstract Object getValueObject();

    /**
     * @return User-desired value, which may or may not be an integer
     */
    public String getTextValue() {
        return getValueString();
    }

    /**
     * Provide a user-readable description of the CVs accessed by this variable.
     * <p>
     * Default is a single CV number
     *
     * @return a user-readable description
     */
    public String getCvDescription() {
        return "CV" + _cvNum;
    }

    /**
     * Set the value from a single number.
     * <p>
     * In some cases, e.g. speed tables, this will result in complex behavior,
     * where setIntValue(getIntValue()) results in something unexpected.
     *
     * @param i the integer value to set
     */
    public abstract void setIntValue(int i);

    /**
     * Set value from a String value.
     * <p>
     * The current implementation is a stand-in. Note that e.g. Speed Tables
     * don't use a single Int. The solution to that is to override this in
     * complicated variable types.
     * <p>
     * Since variable values can now be non-integer (text, long, hex etc.) we
     * need a universally-usable method for setting values, such as default
     * values in decoder definitions.
     * <p>
     * In the long term we don't want to have this method failing silently.
     * Subclasses that need silent failure should override this method.
     *
     * @param value the String value to set
     */
    public void setValue(String value) {
        try {
            int val = Integer.parseInt(value);
            setIntValue(val);
        } catch (NumberFormatException e) {
            log.warn("skipping set of non-integer value \"{}\"", value);
        }
    }

    /**
     * Get the value as a single integer.
     * <p>
     * In some cases, e.g. speed tables, this will result in complex behavior,
     * where setIntValue(getIntValue()) results in something unexpected.
     *
     * @return the value as an integer
     */
    public abstract int getIntValue();

    /**
     * Get the value as an Unsigned Long.
     * <p>
     * Some subclasses (e.g. {@link SplitVariableValue}) store the value as a
     * {@code long} rather than an {@code integer}. This method should be used
     * in cases where such a class may be queried (e.g. by
     * {@link ArithmeticQualifier}).
     * <p>
     * If not overridden by a subclass, it will return an
     * {@link Integer#toUnsignedLong UnsignedLong} conversion of the value
     * returned by {@link #getIntValue getIntValue()}.
     *
     * @return the value as a long
     */
    public long getLongValue() {
        return Integer.toUnsignedLong(getIntValue());
    }

    /**
     * This should be overridden by any implementation.
     */
    void updatedTextField() {
        log.error("unexpected use of updatedTextField()", new Exception("traceback"));
    }

    /**
     * Always read the contents of this Variable.
     */
    public abstract void readAll();

    /**
     * Always write the contents of this Variable.
     */
    public abstract void writeAll();

    /**
     * Confirm the contents of this Variable.
     */
    public void confirmAll() {
        log.error("should never execute this");
    }

    /**
     * Read the contents of this Variable if it's in a state that indicates it
     * was "changed".
     *
     * @see #isChanged
     */
    public abstract void readChanges();

    /**
     * Write the contents of this Variable if it's in a state that indicates it
     * was "changed".
     *
     * @see #isChanged
     */
    public abstract void writeChanges();

    /**
     * Determine whether this Variable is "changed", so that "read changes" and
     * "write changes" will act on it.
     *
     * @see #considerChanged
     * @return true if Variable is "changed"
     */
    public abstract boolean isChanged();

    /**
     * Default implementation for subclasses to tell if a CV meets a common
     * definition of "changed". This implementation will only consider a
     * variable to be changed if the underlying CV(s) state is EDITED, e.g. if
     * the CV(s) has been manually edited, or UNKNOWN.
     *
     * @param c CV to be examined
     * @return true if to be considered changed
     */
    public static boolean considerChanged(CvValue c) {
        if (c == null) {
            return false; // if no CV was assigned to a decoder variable
        }
        ValueState state = c.getState();
        return (state == ValueState.EDITED || state == ValueState.UNKNOWN);
    }

    // handle incoming parameter notification
    @Override
    public abstract void propertyChange(java.beans.PropertyChangeEvent e);

    /**
     * Dispose of the object.
     */
    public abstract void dispose();

    /**
     * Gets a (usually text) description of the variable type and range.
     *
     * @return description of the variable type and range
     */
    public abstract Object rangeVal();

    // methods implemented here:
    /**
     *
     * @param label     the displayed label for the Variable
     * @param comment   for information only, generally not displayed
     * @param cvName    the name for the CV. Seems to be generally ignored and
     *                  set to "".
     * @param readOnly  true if the variable is to be readable-only
     * @param infoOnly  true if the variable is to be for information only (a
     *                  fixed value that is neither readable or writable)
     * @param writeOnly true if the variable is to be writable-only
     * @param opsOnly   true if the variable is to be programmable in ops mode
     *                  only
     * @param cvNum     the CV number
     * @param mask      a bit mask like XXXVVVXX (converts to a value like
     *                  0b00011100) or a series of masks separated by spaces
     * @param v         a vector of CV objects used to look up CVs
     * @param status    a field that holds the current status
     * @param item      the unique name for this Variable
     * @see VariableValue
     */
    public VariableValue(String label, String comment, String cvName,
            boolean readOnly, boolean infoOnly, boolean writeOnly, boolean opsOnly,
            String cvNum, String mask, HashMap<String, CvValue> v, JLabel status, String item) {
        _label = label;
        _comment = comment;
        _cvName = cvName;
        _readOnly = readOnly;
        _infoOnly = infoOnly;
        _writeOnly = writeOnly;
        _opsOnly = opsOnly;
        _cvNum = cvNum;
        _mask = mask; // normally a single 8 bit mask but could be a space separated list of masks
        _cvMap = v;
        _status = status;
        _item = item;
    }

    /**
     * Create a null object. Normally only used for tests and to pre-load
     * classes.
     */
    protected VariableValue() {
    }

    // common information - none of these are bound
    /**
     * Gets the displayed label for the Variable.
     *
     * @return the displayed label for the Variable
     */
    public String label() {
        return _label;
    }

    /**
     * Gets the unique name for this Variable.
     *
     * @return the unique name for this Variable
     */
    public String item() {
        return _item;
    }

    /**
     * Get the CV name.
     *
     * @return the name for the CV
     */
    public String cvName() {
        return _cvName;
    }

    /**
     * Set tooltip text to be used by both the "value" and representations of
     * this Variable.
     * <p>
     * This is expected to be overridden in subclasses to change their internal
     * info.
     *
     * @param t the tooltip text to be used
     * @see #updateRepresentation
     */
    public void setToolTipText(String t) {
        _tooltipText = t;
    }

    /**
     * Add the proper tooltip text to a graphical rep before returning it, sets
     * the visibility.
     *
     * @param c the current graphical representation
     * @return the updated graphical representation
     */
    protected JComponent updateRepresentation(JComponent c) {
        c.setToolTipText(_tooltipText);
        c.setVisible(getAvailable());
        return c;
    }

    /**
     *
     * @return the comment
     */
    public String getComment() {
        return _comment;
    }
    private String _comment;

    /**
     *
     * @return the value of the readOnly attribute
     */
    public boolean getReadOnly() {
        return _readOnly;
    }
    private boolean _readOnly;

    /**
     *
     * @return the value of the infoOnly attribute
     */
    public boolean getInfoOnly() {
        return _infoOnly;
    }
    private boolean _infoOnly;

    /**
     *
     * @return the value of the writeOnly attribute
     */
    public boolean getWriteOnly() {
        return _writeOnly;
    }
    private boolean _writeOnly;

    /**
     *
     * @return the value of the opsOnly attribute
     */
    public boolean getOpsOnly() {
        return _opsOnly;
    }
    private boolean _opsOnly;

    /**
     *
     * @return the CV number
     */
    public String getCvNum() {
        return _cvNum;
    }
    private String _cvNum;

    /**
     *
     * @return the CV name
     */
    public String getCvName() {
        return _cvName;
    }

    /**
     * Extending classes should override to return a single mask in case a list
     * of masks was provided and the class only uses one.
     *
     * @return the CV bitmask in the form XXXVVVXX
     */
    public String getMask() {
        return _mask;
    }
    private String _mask;

    /**
     *
     * @return the current state of the Variable
     */
    public ValueState getState() {
        return _state;
    }

    /**
     * Sets the current state of the variable.
     *
     * @param state the desired state as per definitions in AbstractValue
     * @see AbstractValue
     */
    public void setState(ValueState state) {
        setColor(state.getColor());
        if (_state != state || _state == ValueState.UNKNOWN) {
            prop.firePropertyChange("State", _state, state);
        }
        _state = state;
    }
    private ValueState _state = ValueState.UNKNOWN;

    /**
     * {@inheritDoc}
     * <p>
     * Simple implementation for the case of a single CV. Intended to be
     * sufficient for many subclasses.
     */
    @Override
    public void setToRead(boolean state) {
        boolean newState = state;

        // if this variable is disabled, then don't read, unless
        // some other variable has already set that
        if (!getAvailable() && !state) { // do want to set when state is true
            log.debug("Variable not available, skipping setToRead(false) to leave as is");
            return;
        }

        // if read not available, don't force read
        if (getInfoOnly() || getWriteOnly()) {
            newState = false;
        }

        if (log.isDebugEnabled()) {
            // avoid method calls unless debugging
            log.debug("setToRead({}) with overrides {},{},{} sets {}", state, getInfoOnly(), getWriteOnly(), !getAvailable(), newState);
        }
        if (getCvNum() == null || getCvNum().equals("")) {
            log.debug("no CV defined for value {}. setToRead skipped", _item);
            return;
        }
        _cvMap.get(getCvNum()).setToRead(newState);
    }

    /**
     * {@inheritDoc}
     * <p>
     * Simple implementation for the case of a single CV. Intended to be
     * sufficient for many subclasses.
     */
    @Override
    public boolean isToRead() {
        if (_cvMap.get(getCvNum()) != null) { // skip displayed variables without a CV
            return _cvMap.get(getCvNum()).isToRead();
        }
        return false;
    }

    /**
     * {@inheritDoc}
     * <p>
     * Simple implementation for the case of a single CV. Intended to be
     * sufficient for many subclasses.
     */
    @Override
    public void setToWrite(boolean state) {
        boolean newState = state;

        // if this variable is disabled, then don't write, unless
        // some other variable has already set that
        if (!getAvailable() && !state) { // do want to set when state is true
            log.debug("Variable not available, skipping setToRead(false) to leave as is");
            return;
        }

        // if read not available, don't force read
        if (getInfoOnly() || getReadOnly()) {
            newState = false;
        }

        if (log.isDebugEnabled()) {
            // avoid method calls unless debugging
            log.debug("setToRead({}) with overrides {},{},{} sets {}",
                    state, getInfoOnly(), getWriteOnly(), !getAvailable(), newState);
        }
        CvValue cvVal; // null check in case decoder variable has no CV defined (yet)
        try {
            cvVal = _cvMap.get(getCvNum());
        } catch (NullPointerException e) {
            log.error("no CV defined for value {}. setToWrite skipped. Verify variable was defined", _item);
            return;
        }
        if (cvVal != null) {
            cvVal.setToWrite(newState);
        }
    }

    /**
     * {@inheritDoc}
     * <p>
     * Simple implementation for the case of a single CV. Intended to be
     * sufficient for many subclasses.
     */
    @Override
    public boolean isToWrite() {
        if (_cvMap.get(getCvNum()) != null) { // skip displayed variables without a CV
            return _cvMap.get(getCvNum()).isToWrite();
        }
        return false;
    }

    /**
     * Propagate a state change here to the CVs that are related, which will in
     * turn propagate back to here.
     *
     * @param state the new state to set
     */
    public abstract void setCvState(ValueState state);

    /**
     * Check if a variable is busy (during read, write operations).
     *
     * @return {@code true} if busy
     */
    public boolean isBusy() {
        return _busy;
    }

    /**
     *
     * @param newBusy the desired state
     */
    protected void setBusy(boolean newBusy) {
        boolean oldBusy = _busy;
        _busy = newBusy;
        if (newBusy != oldBusy) {
            prop.firePropertyChange("Busy", Boolean.valueOf(oldBusy), Boolean.valueOf(newBusy));
        }
    }
    private boolean _busy = false;

    /**
     * In case a set of masks was provided, at end of Ctor pick the first mask
     * for implementing classes that use just one. Call not required if mask is
     * ignored.
     */
    protected void simplifyMask() {
        if (_mask != null && _mask.contains(" ")) {
            log.debug("Mask for var {} was:{}", getCvName(), _mask);
            _mask = _mask.split(" ")[0];
            log.debug("Mask1 for var {} is:{}", getCvName(), _mask);
        }
    }

    /**
     * Create a "VVV" style mask matching the size of max value in bits.
     * @param maxVal the maximum value to be stored in the cv as decimal
     * @return a string of V's
     */
    protected static String getMaxMask(int maxVal) {
        int length = Integer.toBinaryString(maxVal).length();
        StringBuilder sb = new StringBuilder();
        while (sb.length() < length) {
            sb.append('V');
        }
        return sb.toString();
    }

    /**
     * Convert a String bit mask like XXXVVVXX to an int like 0b00011100.
     *
     * @param maskString the textual (XXXVVVXX style) mask
     * @return the binary integer (0b00011100 style) mask
     */
    protected int maskValAsInt(String maskString) {
        // convert String mask to int
        int mask = 0;
        for (int i = 0; i < maskString.length(); i++) {
            mask = mask << 1;
            try {
                if (maskString.charAt(i) == 'V') {
                    mask = mask | 1;
                }
            } catch (StringIndexOutOfBoundsException e) {
                log.error("mask \"{}\" could not be handled for variable {}", maskString, label());
            }
        }
        return mask;
    }

    /**
     * Is this a bit mask (such as XVVVXXXX form) vs. radix mask (small
     * integer)?
     *
     * @param mask the bit mask to check
     * @return {@code true} if XVVVXXXX form
     */
    protected boolean isBitMask(String mask) {
        return mask.isEmpty() || mask.startsWith("X") || mask.startsWith("V");
    }

    /**
     * Find number of places to shift a value left to align it with a mask.
     * <p>
     * For example, a mask of "XXVVVXXX" means that the value 5 needs to be
     * shifted left 3 places before being masked and stored as XX101XXX
     *
     * @param maskString the (XXXVVVXX style) mask
     * @return the number of places to shift left before masking
     */
    protected int offsetVal(String maskString) {
        // convert String mask to int
        int offset = 0;
        for (int i = 0; i < maskString.length(); i++) {
            if (maskString.charAt(i) == 'V') {
                offset = maskString.length() - 1 - i;  // number of places to shift left
            }
        }
        return offset;
    }

    /**
     * Extract the current value from the CV, using the mask as needed.
     *
     * @param Cv         the full CV value of interest.
     * @param maskString the (XXXVVVXX style or small int) mask for extracting the Variable
     *                   value from this CV
     * @param maxVal     the maximum possible value for this Variable position in the CV.
     *                   Note it's 10 (0-9) in a single digit using a radix mask.
     * @return the current value of the Variable. Optional factor and offset not yet applied.
     */
    protected int getValueInCV(int Cv, String maskString, int maxVal) {
        if (isBitMask(maskString)) {
            return (Cv & maskValAsInt(maskString)) >>> offsetVal(maskString);
        } else {
            int radix = Integer.parseInt(maskString);
            log.trace("get value {} radix {} returns {}", Cv, radix, Cv / radix);
            return (Cv / radix) % (maxVal + 1);
        }
    }

    /**
     * Insert a value into a CV, using the mask as needed.
     *
     * @param oldCv      Value of the CV before this update is applied
     * @param newVal     Value for this variable (e.g. not the CV value). Optional factor and offset already applied.
     * @param maskString The (XXXVVVXX style or small int) mask for this variable in character form
     * @param maxVal     the maximum possible value for this Variable
     * @return int new value for the full CV
     */
    protected int setValueInCV(int oldCv, int newVal, String maskString, int maxVal) {
        if (isBitMask(maskString)) {
            int mask = maskValAsInt(maskString);
            int offset = offsetVal(maskString);
            return (oldCv & ~mask) + ((newVal << offset) & mask);
        } else {
            int radix = Integer.parseInt(maskString);
            int lowPart = oldCv % radix;
            int newPart = newVal % (maxVal + 1) * radix;
            int highPart = (oldCv / (radix * (maxVal + 1))) * (radix * (maxVal + 1));
            int retval = highPart + newPart + lowPart;
            log.trace("Set sees oldCv {} radix {}, lowPart {}, newVal {}, highPart {}, does {}", oldCv, radix, lowPart, newVal, highPart, retval);
            return retval;
        }
    }

    /**
     * Provide access to CVs used by this Variable.
     *
     * @return an array of CVs used by this Variable
     */
    public abstract CvValue[] usesCVs();

    // initialize logging
    private static final Logger log = LoggerFactory.getLogger(VariableValue.class);

}