package jmri.jmrit.ctc.ctcserialdata;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;

import jmri.Turnout;

/**
 *
 * @author Gregory J. Bedlek Copyright (C) 2018, 2019
 */
public class CTCSerialData {

    private OtherData _mOtherData;
    private ArrayList<CodeButtonHandlerData> _mCodeButtonHandlerDataArrayList;

    /**
     * "Return" value from function "getCTCTurnoutData":
     */
    public static class CTCTurnoutData {
        public final String   _mOSSectionText;
        public final int      _mUniqueID;
        public CTCTurnoutData(String OSSectionText, int uniqueID) {
            _mOSSectionText = OSSectionText;
            _mUniqueID = uniqueID;
        }
    }

    public CTCSerialData() {
        _mOtherData = new OtherData();
        _mCodeButtonHandlerDataArrayList = new ArrayList<>();
    }

    public OtherData getOtherData() {
        return _mOtherData;
    }

    public int getUniqueNumber() {
        return _mOtherData.getNextUniqueNumber();
    }

    public CodeButtonHandlerData getCodeButtonHandlerDataViaUniqueID(int uniqueID) {
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData._mUniqueID == uniqueID) {
                return codeButtonHandlerData;
            }
        }
        return null;    // In case it's not found.
    }

    public String getMyShortStringNoCommaViaUniqueID(int uniqueID) {
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData._mUniqueID == uniqueID) {
                return codeButtonHandlerData.myShortStringNoComma();
            }
        }
        return "UNKNOWN";    // In case it's not found.
    }

    public int getIndexOfUniqueID(int uniqueID) {
        for (int index = 0; index < _mCodeButtonHandlerDataArrayList.size(); index++) {
            if (_mCodeButtonHandlerDataArrayList.get(index)._mUniqueID == uniqueID) {
                return index;    // That's it.
            }
        }
        return -1;  // not found.
    }

    public void setOtherData(OtherData otherData) {
        _mOtherData = otherData;
    }

    public ArrayList<CodeButtonHandlerData> getCodeButtonHandlerDataArrayList() {
        return _mCodeButtonHandlerDataArrayList;
    }

    public void addCodeButtonHandlerData(CodeButtonHandlerData codeButtonHandlerData) {
        _mCodeButtonHandlerDataArrayList.add(codeButtonHandlerData);
    }

    public void removeCodeButtonHandlerData(int index) {
        _mCodeButtonHandlerDataArrayList.remove(index);
    }

    public CodeButtonHandlerData getCodeButtonHandlerData(int index) {
        return _mCodeButtonHandlerDataArrayList.get(index);
    }

    public int getCodeButtonHandlerDataSize() {
        return _mCodeButtonHandlerDataArrayList.size();
    }

    public void moveUp(int index) {
        try {
            Collections.swap(_mCodeButtonHandlerDataArrayList, index, index - 1);
        } catch (IndexOutOfBoundsException e) {
        }    // Do NOTHING in this case!  Technically should never happen, since buttons aren't enabled for such possibilities
    }

    public void moveDown(int index) {
        try {
            Collections.swap(_mCodeButtonHandlerDataArrayList, index, index + 1);
        } catch (IndexOutOfBoundsException e) {
        }    // Do NOTHING in this case!  Technically should never happen, since buttons aren't enabled for such possibilities
    }

    /**
     * Change the identifying attributes with the exception of the uniqueID.  The potential
     * primary changes are the switch and signal numbers.
     * @param index The row being changed.
     * @param newSwitchNumber The new switch number which is always odd.
     * @param newSignalEtcNumber The new signal number which is always one more than the switch number.
     * @param newGUIColumnNumber The location on the panel.  Used by the GUI export process.
     * @param newGUIGeneratedAtLeastOnceAlready A flag to indicate whether the GUI export should include this column.
     */
    public void updateSwitchAndSignalEtcNumbersEverywhere(int index, int newSwitchNumber, int newSignalEtcNumber, int newGUIColumnNumber, boolean newGUIGeneratedAtLeastOnceAlready) {
        CodeButtonHandlerData codeButtonHandlerData = _mCodeButtonHandlerDataArrayList.get(index);
        codeButtonHandlerData._mSwitchNumber = newSwitchNumber;
        codeButtonHandlerData._mSignalEtcNumber = newSignalEtcNumber;
        codeButtonHandlerData._mGUIColumnNumber = newGUIColumnNumber;
        codeButtonHandlerData._mGUIGeneratedAtLeastOnceAlready = newGUIGeneratedAtLeastOnceAlready;
        int UniqueIDBeingModified = codeButtonHandlerData._mUniqueID;
        String replacementString = codeButtonHandlerData.myShortStringNoComma();
        for (CodeButtonHandlerData temp : _mCodeButtonHandlerDataArrayList) {
            updateTrlUserText(temp._mTRL_LeftTrafficLockingRules, UniqueIDBeingModified, replacementString);
            updateTrlUserText(temp._mTRL_RightTrafficLockingRules, UniqueIDBeingModified, replacementString);
        }
    }

    /**
     * Update the text description of entries in the traffic locking rules located in TrafficLockingData.
     * Each alignment entry in each rule is checked for match on uniqueID.  If so, the text is replaced.
     * @param rulesToFix An array of TrafficLockingData entries.  Each entry is a rule.
     * @param uniqueIDBeingModified The uniqueID being checked.
     * @param replacementString The new sw/sig string.
     */
    private void updateTrlUserText(ArrayList<TrafficLockingData> rulesToFix, int uniqueIDBeingModified, String replacementString) {
        rulesToFix.forEach(rule -> {
            rule._mSwitchAlignments.forEach(alignment -> {
                if (uniqueIDBeingModified == alignment._mUniqueID) {
                    alignment._mUserText = replacementString;
                }
            });
        });
    }

    public void setCodeButtonHandlerData(int index, CodeButtonHandlerData codeButtonHandlerData) {
        _mCodeButtonHandlerDataArrayList.set(index, codeButtonHandlerData);
    }

//  If none are found, return -1 (which we'll then increment by 2 to 1, which is a good "add" default starting point):
    public int findHighestSwitchNumberUsedSoFar() {
        int highestSwitchNumber = -1;
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData._mSwitchNumber > highestSwitchNumber) {
                highestSwitchNumber = codeButtonHandlerData._mSwitchNumber;
            }
        }
        return highestSwitchNumber;
    }

//  If none are found, return 0 (which we'll then increment by 1 to 1, which is a good "add" default starting point):
    public int findHighestColumnNumberUsedSoFar() {
        int highestColumnNumber = 0;
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData._mGUIColumnNumber > highestColumnNumber) {
                highestColumnNumber = codeButtonHandlerData._mGUIColumnNumber;
            }
        }
        return highestColumnNumber;
    }

    /**
     * Routine to search our _mCodeButtonHandlerDataArrayList for the O.S. section
     * that contains the passed turnout.
     *
     * @param turnout   The turnout to search for in our table.
     * @return          CTCTurnoutData, else if turnout not found, null.
     */
    public CTCTurnoutData getCTCTurnoutData(Turnout turnout) {
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData._mSWDI_Enabled) { // Only if it has one:
                if (codeButtonHandlerData._mSWDI_ExternalTurnout.getBean().equals(turnout)) { // Ah match, this is us:
                    return new CTCTurnoutData(codeButtonHandlerData.myShortStringNoComma(), codeButtonHandlerData._mUniqueID);
                }
            }
        }
        return null;
    }

    /**
     * This routine is used to support FrmTUL.java.  It generates a HashSet (which
     * prevents duplicate strings) of all such locked turnouts, EXCLUDING the
     * passed "excludedOne", since that one will be handled locally in the calling
     * code.
     *
     * @param excludedOne The one to NOT include in the returned information.
     * @return All locked turnouts NOT INCLUDING excludedOne.
     */
    public HashSet<String> getHashSetOfAllLockedTurnoutsExcludingPassedOne(CodeButtonHandlerData excludedOne) {
        HashSet<String> lockedTurnouts = new HashSet<>();
        for (CodeButtonHandlerData codeButtonHandlerData : _mCodeButtonHandlerDataArrayList) {
            if (codeButtonHandlerData != excludedOne) { // Process this one:
                if (codeButtonHandlerData._mTUL_ExternalTurnout.valid()) { lockedTurnouts.add(codeButtonHandlerData._mTUL_ExternalTurnout.getHandleName()); }
                if (codeButtonHandlerData._mTUL_AdditionalExternalTurnout1.valid()) { lockedTurnouts.add(codeButtonHandlerData._mTUL_AdditionalExternalTurnout1.getHandleName()); }
                if (codeButtonHandlerData._mTUL_AdditionalExternalTurnout2.valid()) { lockedTurnouts.add(codeButtonHandlerData._mTUL_AdditionalExternalTurnout2.getHandleName()); }
                if (codeButtonHandlerData._mTUL_AdditionalExternalTurnout3.valid()) { lockedTurnouts.add(codeButtonHandlerData._mTUL_AdditionalExternalTurnout3.getHandleName()); }
            }
        }
        return lockedTurnouts;
    }

}