package jmri.jmrit.operations.routes;

import java.awt.Color;
import java.awt.Point;

import org.jdom2.Attribute;
import org.jdom2.Element;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import jmri.InstanceManager;
import jmri.beans.PropertyChangeSupport;
import jmri.jmrit.operations.locations.Location;
import jmri.jmrit.operations.locations.LocationManager;
import jmri.jmrit.operations.setup.Control;
import jmri.jmrit.operations.setup.Setup;
import jmri.jmrit.operations.trains.trainbuilder.TrainCommon;
import jmri.util.ColorUtil;

/**
 * Represents a location in a route, a location can appear more than once in a
 * route.
 *
 * @author Daniel Boudreau Copyright (C) 2008, 2013, 2026
 */
public class RouteLocation extends PropertyChangeSupport implements java.beans.PropertyChangeListener {

    public static final String NONE = "";

    protected String _id = NONE;
    protected Location _location = null; // the location in the route
    protected String _locationId = NONE; // the location's id
    protected int _trainDir = (Setup.getTrainDirection() == Setup.EAST + Setup.WEST) ? EAST : NORTH; // train direction
    protected int _maxTrainLength = Setup.getMaxTrainLength();
    protected int _maxCarMoves = Setup.getCarMoves();
    protected String _randomControl = DISABLED;
    protected boolean _drops = true; // when true set outs allowed at this location
    protected boolean _pickups = true; // when true pick ups allowed at this location
    protected boolean _localMoves = true; // when true local moves allowed at this location
    protected int _sequenceNum = 0; // used to determine location order in a route
    protected double _grade = 0; // maximum grade between locations
    protected int _wait = 0; // wait time at this location
    protected String _departureTime = NONE; // hh:mm departure time from this location
    protected String _departureDay = "0"; // departure day from this location
    protected int _trainIconX = 0; // the x & y coordinates for the train icon
    protected int _trainIconY = 0;
    protected int _blockingOrder = 0;
    protected String _comment = NONE;
    protected Color _commentColor = Color.black;
    protected boolean _bold = false; // when true bold text

    protected int _carMoves = 0; // number of moves at this location
    protected int _trainWeight = 0; // total car weight departing this location
    protected int _trainLength = 0; // train length departing this location

    public static final int EAST = 1; // train direction
    public static final int WEST = 2;
    public static final int NORTH = 4;
    public static final int SOUTH = 8;

    public static final String EAST_DIR = Setup.EAST_DIR; // train directions text
    public static final String WEST_DIR = Setup.WEST_DIR;
    public static final String NORTH_DIR = Setup.NORTH_DIR;
    public static final String SOUTH_DIR = Setup.SOUTH_DIR;

    public static final String DISPOSE = "routeLocationDispose"; // NOI18N
    public static final String DELETED = Bundle.getMessage("locationDeleted");

    public static final String DROP_CHANGED_PROPERTY = "dropChange"; // NOI18N
    public static final String PICKUP_CHANGED_PROPERTY = "pickupChange"; // NOI18N
    public static final String LOCAL_MOVES_CHANGED_PROPERTY = "localMovesChange"; // NOI18N
    public static final String MAX_MOVES_CHANGED_PROPERTY = "maxMovesChange"; // NOI18N
    public static final String TRAIN_DIRECTION_CHANGED_PROPERTY = "trainDirectionChange"; // NOI18N
    public static final String DEPARTURE_TIME_CHANGED_PROPERTY = "routeDepartureTimeChange"; // NOI18N
    public static final String MAX_LENGTH_CHANGED_PROPERTY = "maxLengthChange"; // NOI18N

    public static final String DISABLED = "Off";

    public RouteLocation(String id, Location location) {
        log.debug("New route location ({}) id: {}", location.getName(), id);
        _location = location;
        _id = id;
        // listen for name change or delete
        location.addPropertyChangeListener(this);
    }

    // for combo boxes
    @Override
    public String toString() {
        return getName();
    }

    public String getId() {
        return _id;
    }

    public String getName() {
        if (getLocation() != null) {
            return getLocation().getName();
        }
        return DELETED;
    }

    public String getSplitName() {
        if (getLocation() != null) {
            return getLocation().getSplitName();
        }
        return DELETED;
    }

    private String getNameId() {
        if (_location != null) {
            return _location.getId();
        }
        return _locationId;
    }

    public Location getLocation() {
        return _location;
    }

    public int getSequenceNumber() {
        return _sequenceNum;
    }

    public void setSequenceNumber(int sequence) {
        // property change not needed
        _sequenceNum = sequence;
    }

    public int getBlockingOrder() {
        return _blockingOrder;
    }

    public void setBlockingOrder(int order) {
        _blockingOrder = order;
    }

    public void setComment(String comment) {
        String old = _comment;
        _comment = comment;
        if (!old.equals(_comment)) {
            setDirtyAndFirePropertyChange("RouteLocationComment", old, comment); // NOI18N
        }
    }

    public String getComment() {
        return _comment;
    }

    /**
     * Sets the text color for the route comment
     * 
     * @param color The color of the text
     */
    public void setCommentColor(Color color) {
        Color old = _commentColor;
        _commentColor = color;
        if (!old.equals(_commentColor)) {
            setDirtyAndFirePropertyChange("RouteLocationCommentColor", old, color); // NOI18N
        }
    }

    public Color getCommentColor() {
        return _commentColor;
    }
    
    public boolean isCommentBoldEnabled() {
        return _bold;
    }
    
    public void setCommentBoldEnabled(boolean enabled) {
        boolean old = _bold;
        _bold = enabled;
        if (old != _bold) {
            setDirtyAndFirePropertyChange("RouteLocationBoldText", old, enabled); // NOI18N
        }
    }

    public String getCommentWithColor() {
        return TrainCommon.formatColorString(getComment(), getCommentColor(), isCommentBoldEnabled());
    }

    public void setCommentTextColor(String color) {
        setCommentColor(ColorUtil.stringToColor(color));
    }

    public String getCommentTextColor() {
        return ColorUtil.colorToColorName(getCommentColor());
    }

    public void setTrainDirection(int direction) {
        int old = _trainDir;
        _trainDir = direction;
        if (old != direction) {
            setDirtyAndFirePropertyChange(TRAIN_DIRECTION_CHANGED_PROPERTY, old, direction);
        }
    }

    /**
     * Gets the binary representation of the train's direction at this location
     *
     * @return int representing train direction EAST WEST NORTH SOUTH
     */
    public int getTrainDirection() {
        return _trainDir;
    }

    /**
     * Gets the String representation of the train's direction at this location
     *
     * @return String representing train direction at this location
     */
    public String getTrainDirectionString() {
        return Setup.getDirectionString(getTrainDirection());
    }

    public void setMaxTrainLength(int length) {
        int old = _maxTrainLength;
        _maxTrainLength = length;
        if (old != length) {
            setDirtyAndFirePropertyChange(MAX_LENGTH_CHANGED_PROPERTY, old, length);
        }
    }

    public int getMaxTrainLength() {
        return _maxTrainLength;
    }

    /**
     * Set the train length departing this location when building a train
     * 
     * @param length The train's current length.
     */
    public void setTrainLength(int length) {
        int old = _trainLength;
        _trainLength = length;
        if (old != length) {
            firePropertyChange("trainLength", old, length); // NOI18N
        }
    }

    public int getTrainLength() {
        return _trainLength;
    }

    /**
     * Set the train weight departing this location when building a train
     * 
     * @param weight The train's current weight.
     */
    public void setTrainWeight(int weight) {
        int old = _trainWeight;
        _trainWeight = weight;
        if (old != weight) {
            firePropertyChange("trainWeight", old, weight); // NOI18N
        }
    }

    public int getTrainWeight() {
        return _trainWeight;
    }

    public void setMaxCarMoves(int moves) {
        int old = _maxCarMoves;
        _maxCarMoves = moves;
        if (old != moves) {
            setDirtyAndFirePropertyChange(MAX_MOVES_CHANGED_PROPERTY, old, moves);
        }
    }

    /**
     * Get the maximum number of moves for this location
     *
     * @return maximum number of moves
     */
    public int getMaxCarMoves() {
        return _maxCarMoves;
    }

    public void setRandomControl(String value) {
        String old = _randomControl;
        _randomControl = value;
        if (!old.equals(value)) {
            setDirtyAndFirePropertyChange("randomControl", old, value); // NOI18N
        }
    }

    public String getRandomControl() {
        return _randomControl;
    }

    /**
     * When true allow car drops at this location
     *
     * @param drops when true drops allowed at this location
     */
    public void setDropAllowed(boolean drops) {
        boolean old = _drops;
        _drops = drops;
        if (old != drops) {
            setDirtyAndFirePropertyChange(DROP_CHANGED_PROPERTY, old, drops);
        }
    }

    public boolean isDropAllowed() {
        return _drops;
    }

    /**
     * When true allow car pick ups at this location
     *
     * @param pickups when true pick ups allowed at this location
     */
    public void setPickUpAllowed(boolean pickups) {
        boolean old = _pickups;
        _pickups = pickups;
        if (old != pickups) {
            setDirtyAndFirePropertyChange(PICKUP_CHANGED_PROPERTY, old, pickups);
        }
    }

    public boolean isPickUpAllowed() {
        return _pickups;
    }

    /**
     * When true allow local car moves at this location
     *
     * @param local when true local moves allowed at this location
     */
    public void setLocalMovesAllowed(boolean local) {
        boolean old = _localMoves;
        _localMoves = local;
        if (old != local) {
            setDirtyAndFirePropertyChange(LOCAL_MOVES_CHANGED_PROPERTY, old, local);
        }
    }

    public boolean isLocalMovesAllowed() {
        return _localMoves;
    }

    /**
     * Set the number of moves completed when building a train
     * 
     * @param moves An integer representing the amount of moves completed.
     */
    public void setCarMoves(int moves) {
        int old = _carMoves;
        _carMoves = moves;
        if (old != moves) {
            firePropertyChange("carMoves", old, moves); // NOI18N
        }
    }

    public int getCarMoves() {
        return _carMoves;
    }

    public void setWait(int time) {
        int old = _wait;
        _wait = time;
        if (old != time) {
            setDirtyAndFirePropertyChange("waitTime", old, time); // NOI18N
        }
    }

    public int getWait() {
        return _wait;
    }

    /**
     * Sets the formated departure time from this location
     * 
     * @param time format hours:minutes
     */
    public void setDepartureTimeHourMinutes(String time) {
        String old = _departureTime;
        _departureTime = time;
        if (!old.equals(time)) {
            setDirtyAndFirePropertyChange(DEPARTURE_TIME_CHANGED_PROPERTY, old, time);
        }
    }

    public String getDepartureTimeHourMinutes() {
        return _departureTime;
    }

    /**
     * Sets the departure time from this route location
     * 
     * @param time days:hours:minutes or hours:minutes or NONE
     */
    public void setDepartureTime(String time) {
        String[] t = time.split(":");
        if (t.length > 2) {
            setDepartureTime(t[0], t[1], t[2]);
        } else if (t.length > 1) {
            setDepartureTime("0", t[0], t[1]);
        } else {
            setDepartureTimeHourMinutes(NONE);
        }
    }

    public void setDepartureTime(String day, String hour, String minute) {
        setDepartureTimeDay(day);
        hour = String.format("%02d", Integer.parseInt(hour));
        minute = String.format("%02d", Integer.parseInt(minute));
        String time = hour + ":" + minute;
        setDepartureTimeHourMinutes(time);
    }

    /**
     * @return departure time day:hour:minutes
     */
    public String getDepartureTime() {
        return getDepartureTimeDay() + ":" + getDepartureTimeHourMinutes();
    }

    /**
     * Sets the departure day from this route location
     * 
     * @param day the day where "0" is today, and "1, 2 .." are the following
     *            days.
     */
    public void setDepartureTimeDay(String day) {
        String old = _departureDay;
        if (!old.equals(day)) {
            setDirtyAndFirePropertyChange(DEPARTURE_TIME_CHANGED_PROPERTY, old, day);
        }
        _departureDay = day;
    }

    public String getDepartureTimeDay() {
        return _departureDay;
    }

    public String getDepartureTimeHour() {
        String[] time = getDepartureTime().split(":");
        return time[1];
    }

    public String getDepartureTimeMinute() {
        String[] time = getDepartureTime().split(":");
        return time[2];
    }

    /**
     * Gets the formated departure time from this route location. Provides the
     * day at the start if day is greater than zero. Format days:hours:minutes
     * or hours:minutes if day = 0. Optional AM or PM 12 hour format.
     * 
     * @return days:hours:minutes or hours:minutes. Optional AM/PM
     */
    public String getFormatedDepartureTime() {
        if (getDepartureTimeHourMinutes().equals(NONE)) {
            return NONE;
        }
        String sDay = "";
        if (!getDepartureTimeDay().equals("0")) {
            sDay = getDepartureTimeDay() + ":";
        }
        if (!Setup.is12hrFormatEnabled()) {
            return sDay + getDepartureTimeHourMinutes();
        }
        String AM_PM = TrainCommon.SPACE + Bundle.getMessage("AM");
        int hour = Integer.parseInt(getDepartureTimeHour());
        if (hour >= 12) {
            AM_PM = TrainCommon.SPACE + Bundle.getMessage("PM");
            hour = hour - 12;
        }
        if (hour == 0) {
            hour = 12;
        }
        String shour = Integer.toString(hour);
        return sDay + shour + ":" + getDepartureTimeMinute() + AM_PM;
    }

    @SuppressFBWarnings(value = "FE_FLOATING_POINT_EQUALITY", justification = "firing property change doesn't matter")
    public void setGrade(double grade) {
        double old = _grade;
        _grade = grade;
        if (old != grade) {
            setDirtyAndFirePropertyChange("grade", old, grade); // NOI18N
        }
    }

    public double getGrade() {
        return _grade;
    }

    public void setTrainIconX(int x) {
        int old = _trainIconX;
        _trainIconX = x;
        if (old != x) {
            setDirtyAndFirePropertyChange("trainIconX", old, x); // NOI18N
        }
    }

    public int getTrainIconX() {
        return _trainIconX;
    }

    public void setTrainIconY(int y) {
        int old = _trainIconY;
        _trainIconY = y;
        if (old != y) {
            setDirtyAndFirePropertyChange("trainIconY", old, y); // NOI18N
        }
    }

    public int getTrainIconY() {
        return _trainIconY;
    }

    /**
     * Gets the X range for detecting the manual movement of a train icon.
     * 
     * @return the range for detection
     */
    public int getTrainIconRangeX() {
        return getLocation().getTrainIconRangeX();
    }

    /**
     * Gets the Y range for detecting the manual movement of a train icon.
     * 
     * @return the range for detection
     */
    public int getTrainIconRangeY() {
        return getLocation().getTrainIconRangeY();
    }

    /**
     * Set the train icon panel coordinates to the location defaults.
     * Coordinates are dependent on the train's departure direction.
     */
    public void setTrainIconCoordinates() {
        Location l = InstanceManager.getDefault(LocationManager.class).getLocationByName(getName());
        if ((getTrainDirection() & Location.EAST) == Location.EAST) {
            setTrainIconX(l.getTrainIconEast().x);
            setTrainIconY(l.getTrainIconEast().y);
        }
        if ((getTrainDirection() & Location.WEST) == Location.WEST) {
            setTrainIconX(l.getTrainIconWest().x);
            setTrainIconY(l.getTrainIconWest().y);
        }
        if ((getTrainDirection() & Location.NORTH) == Location.NORTH) {
            setTrainIconX(l.getTrainIconNorth().x);
            setTrainIconY(l.getTrainIconNorth().y);
        }
        if ((getTrainDirection() & Location.SOUTH) == Location.SOUTH) {
            setTrainIconX(l.getTrainIconSouth().x);
            setTrainIconY(l.getTrainIconSouth().y);
        }
    }

    public Point getTrainIconCoordinates() {
        return new Point(getTrainIconX(), getTrainIconY());
    }

    public void dispose() {
        if (_location != null) {
            _location.removePropertyChangeListener(this);
        }
        firePropertyChange(DISPOSE, null, DISPOSE);
    }

    /**
     * Construct this Entry from XML. This member has to remain synchronized
     * with the detailed DTD in operations-config.xml
     *
     * @param e Consist XML element
     */
    public RouteLocation(Element e) {
        Attribute a;
        if ((a = e.getAttribute(Xml.ID)) != null) {
            _id = a.getValue();
        } else {
            log.warn("no id attribute in route location element when reading operations");
        }
        if ((a = e.getAttribute(Xml.LOCATION_ID)) != null) {
            _locationId = a.getValue();
            _location = InstanceManager.getDefault(LocationManager.class).getLocationById(a.getValue());
            if (_location != null) {
                _location.addPropertyChangeListener(this);
            }
        } // old way of storing a route location
        else if ((a = e.getAttribute(Xml.NAME)) != null) {
            _location = InstanceManager.getDefault(LocationManager.class).getLocationByName(a.getValue());
            if (_location != null) {
                _location.addPropertyChangeListener(this);
            }
            // force rewrite of route file
            InstanceManager.getDefault(RouteManagerXml.class).setDirty(true);
        }
        if ((a = e.getAttribute(Xml.TRAIN_DIRECTION)) != null) {
            // early releases had text for train direction
            if (Setup.getTrainDirectionList().contains(a.getValue())) {
                _trainDir = Setup.getDirectionInt(a.getValue());
                log.debug("found old train direction {} new direction {}", a.getValue(), _trainDir);
            } else {
                try {
                    _trainDir = Integer.parseInt(a.getValue());
                } catch (NumberFormatException ee) {
                    log.error("Route location ({}) direction ({}) is unknown", getName(), a.getValue());
                }
            }
        }
        if ((a = e.getAttribute(Xml.MAX_TRAIN_LENGTH)) != null) {
            try {
                _maxTrainLength = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) maximum train length ({}) isn't a valid number", getName(),
                        a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.GRADE)) != null) {
            try {
                _grade = Double.parseDouble(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) grade ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.MAX_CAR_MOVES)) != null) {
            try {
                _maxCarMoves = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) maximum car moves ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.RANDOM_CONTROL)) != null) {
            _randomControl = a.getValue();
        }
        if ((a = e.getAttribute(Xml.PICKUPS)) != null) {
            _pickups = a.getValue().equals(Xml.YES);
        }
        if ((a = e.getAttribute(Xml.DROPS)) != null) {
            _drops = a.getValue().equals(Xml.YES);
        }
        if ((a = e.getAttribute(Xml.LOCAL_MOVES)) != null) {
            _localMoves = a.getValue().equals(Xml.YES);
        } else {
            if (!isPickUpAllowed() || !isDropAllowed()) {
                _localMoves = false; // disable local moves
            }
        }
        if ((a = e.getAttribute(Xml.WAIT)) != null) {
            try {
                _wait = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) wait ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.DEPART_DAY)) != null) {
            _departureDay = a.getValue();
        }
        if ((a = e.getAttribute(Xml.DEPART_TIME)) != null) {
            _departureTime = a.getValue();
        }
        if ((a = e.getAttribute(Xml.BLOCKING_ORDER)) != null) {
            try {
                _blockingOrder = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) blocking order ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.TRAIN_ICON_X)) != null) {
            try {
                _trainIconX = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) icon x ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.TRAIN_ICON_Y)) != null) {
            try {
                _trainIconY = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) icon y ({}) isn't a valid number", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.SEQUENCE_ID)) != null) {
            try {
                _sequenceNum = Integer.parseInt(a.getValue());
            } catch (NumberFormatException ee) {
                log.error("Route location ({}) sequence id isn't a valid number {}", getName(), a.getValue());
            }
        }
        if ((a = e.getAttribute(Xml.COMMENT_COLOR)) != null) {
            setCommentTextColor(a.getValue());
        }
        if ((a = e.getAttribute(Xml.COMMENT_BOLD)) != null) {
            _bold = a.getValue().equals(Xml.YES);
        }
        if ((a = e.getAttribute(Xml.COMMENT)) != null) {
            _comment = a.getValue();
        }
    }

    /**
     * Create an XML element to represent this Entry. This member has to remain
     * synchronized with the detailed DTD in operations-config.xml.
     *
     * @return Contents in a JDOM Element
     */
    public Element store() {
        Element e = new Element(Xml.LOCATION);
        e.setAttribute(Xml.ID, getId());
        e.setAttribute(Xml.NAME, getName());
        e.setAttribute(Xml.LOCATION_ID, getNameId());
        e.setAttribute(Xml.SEQUENCE_ID, Integer.toString(getSequenceNumber()));
        e.setAttribute(Xml.TRAIN_DIRECTION, Integer.toString(getTrainDirection()));
        e.setAttribute(Xml.MAX_TRAIN_LENGTH, Integer.toString(getMaxTrainLength()));
        e.setAttribute(Xml.GRADE, Double.toString(getGrade()));
        e.setAttribute(Xml.MAX_CAR_MOVES, Integer.toString(getMaxCarMoves()));
        e.setAttribute(Xml.RANDOM_CONTROL, getRandomControl());
        e.setAttribute(Xml.PICKUPS, isPickUpAllowed() ? Xml.YES : Xml.NO);
        e.setAttribute(Xml.DROPS, isDropAllowed() ? Xml.YES : Xml.NO);
        e.setAttribute(Xml.LOCAL_MOVES, isLocalMovesAllowed() ? Xml.YES : Xml.NO);
        e.setAttribute(Xml.WAIT, Integer.toString(getWait()));
        e.setAttribute(Xml.DEPART_DAY, getDepartureTimeDay());
        e.setAttribute(Xml.DEPART_TIME, getDepartureTimeHourMinutes());
        e.setAttribute(Xml.BLOCKING_ORDER, Integer.toString(getBlockingOrder()));
        e.setAttribute(Xml.TRAIN_ICON_X, Integer.toString(getTrainIconX()));
        e.setAttribute(Xml.TRAIN_ICON_Y, Integer.toString(getTrainIconY()));
        e.setAttribute(Xml.COMMENT_COLOR, getCommentTextColor());
        e.setAttribute(Xml.COMMENT, getComment());
        e.setAttribute(Xml.COMMENT_BOLD, isCommentBoldEnabled() ? Xml.YES : Xml.NO);
        return e;
    }

    @Override
    public void propertyChange(java.beans.PropertyChangeEvent e) {
        if (Control.SHOW_PROPERTY) {
            log.debug("Property change: ({}) old: ({}) new: ({})", e.getPropertyName(), e.getOldValue(), e
                    .getNewValue());
        }
        if (e.getPropertyName().equals(Location.DISPOSE_CHANGED_PROPERTY)) {
            if (_location != null) {
                _location.removePropertyChangeListener(this);
            }
            _location = null;
        }
        // forward property name change
        if (e.getPropertyName().equals(Location.NAME_CHANGED_PROPERTY)) {
            firePropertyChange(e.getPropertyName(), e.getOldValue(), e.getNewValue());
        }
    }

    protected void setDirtyAndFirePropertyChange(String p, Object old, Object n) {
        InstanceManager.getDefault(RouteManagerXml.class).setDirty(true);
        firePropertyChange(p, old, n);
    }

    private static final Logger log = LoggerFactory.getLogger(RouteLocation.class);

}