Comparable.java

package net.aufdemrand.denizen.scripts.commands.core;

import net.aufdemrand.denizen.objects.*;
import net.aufdemrand.denizencore.objects.*;
import net.aufdemrand.denizen.utilities.debugging.dB;
import org.bukkit.ChatColor;

public class Comparable {

    // TODO: Expand upon this.
    //
    // <--[language]
    // @name Comparable
    // @group Comparables
    // @description
    // A Comparable is a method that the IF command and Element dObject uses to compare objects.
    // (This lang is TODO! )
    // See <@link language operator>
    // -->

    // <--[language]
    // @name Operator
    // @group Comparables
    // @description
    // An operator is the type of comparison that a comparable will check. Not all types of
    // comparables are compatible with all operators. See <@link language comparable> for more information.
    //
    // Available Operators include:
    // EQUALS (==), MATCHES, OR_MORE (>=), OR_LESS (<=), MORE (>), LESS (<), CONTAINS, and IS_EMPTY.
    //
    // Operators which have a symbol alternative (as marked by parenthesis) can be referred to by either
    // their name or symbol. Using a '!' in front of the operator will also reverse logic, effectively
    // turning 'EQUALS' into 'DOES NOT EQUAL', for example.
    //
    // == <= >= > < all compare arguments as text or numbers.
    //
    // CONTAINS checks whether a list contains an element, or an element contains another element.
    //
    // IS_EMPTY checks whether a list is empty. (This exists for back-support).
    //
    // MATCHES checks whether the first element matches a given type.
    // EG, "if 1 matches number" or "if p@bob matches player".
    // Match types: location, material, materiallist, script, entity, spawnedentity, entitytype,
    // npc, player, offlineplayer, onlineplayer, item, pose, duration, cuboid, decimal,
    // number, even number, odd number, boolean.
    //
    // Note: When using an operator in a replaceable tag (such as <el@element.is[...].than[...]>),
    // keep in mind that < and >, and even >= and <= must be either escaped, or referred to by name.
    // Example: "<player.health.is[<&lt>].than[10]>" or "<player.health.is[LESS].than[10]>",
    // but <player.health.is[<].than[10]> will produce undesired results. <>'s must be escaped or replaced since
    // they are normally notation for a replaceable tag. Escaping is not necessary when the argument
    // contains no replaceable tags.
    //
    // -->
    public static enum Operator {
        EQUALS, MATCHES, OR_MORE, OR_LESS, MORE,
        LESS, CONTAINS, IS_EMPTY
    }

    public static final Operator[] OperatorValues = Operator.values();

    public static enum Bridge {
        OR, AND, FIRST, THEN, ELSE
    }

    public static final Bridge[] BridgeValues = Bridge.values();

    public static enum Logic {
        REGULAR, NEGATIVE
    }

    Logic         logic = Logic.REGULAR;
    Bridge       bridge = Bridge.FIRST;
    Object   comparable = null;
    Operator   operator = Operator.EQUALS;
    Object   comparedto = "true";
    Boolean     outcome = null;


    public void setNegativeLogic() {
        logic = Logic.NEGATIVE;
    }


    public void setOperator(Operator operator) {
        this.operator = operator;
    }


    public void setComparable(String arg) {

        // If a Number
        if (arg.length() > 0 && aH.matchesInteger(arg))
            comparable = aH.getLongFrom(arg);
        else if (arg.length() > 0 && aH.matchesDouble(arg))
            comparable = aH.getDoubleFrom(arg);

            // If a List<Object>
        else if (arg.length() > 0 && dList.matches(arg)) {
            comparable = dList.valueOf(arg);
        }

        // If none of the above, must be a String! :D
        // 'arg' is already a String.
        else comparable = arg;
    }


    public void setComparedto(String arg) {

        // If MATCHES, change comparable to String
        if (operator == Comparable.Operator.MATCHES)
            comparable = String.valueOf(comparable);

        // Comparable is String, return String
        if (comparable instanceof String)
            comparedto = arg;

            // Comparable is a Number, return Double
        else if (comparable instanceof Double || comparable instanceof Long) {
            if (aH.matchesInteger(arg))
                comparedto = aH.getLongFrom(arg);
            else if (aH.matchesDouble(arg))
                comparedto = aH.getDoubleFrom(arg);
            else {
                if (!arg.equalsIgnoreCase("null"))
                    // TODO: echoDebug instead of log
                 //   dB.log(ChatColor.YELLOW + "WARNING! " + ChatColor.WHITE + "Cannot compare NUMBER("
                 //           + comparable + ") with '" + arg + "'. Outcome for this Comparable will be false.");
                comparedto = Double.NaN;
            }
        }

        else if (comparable instanceof Boolean) {
            comparedto = aH.getBooleanFrom(arg);
        }

        else if (comparable instanceof dList) {
            if (dList.matches(arg))
                comparedto = dList.valueOf(arg);
            else
                comparedto = arg;
        }

        else comparedto = arg;
    }


    public boolean determineOutcome() {

        outcome = false;

        // Check '== null' right now
        if (comparedto.toString().equals("null")) {
            if (comparable.toString().equals("null"))
                outcome = true;
        }

        // or... compare 'compared_to' as the type of 'comparable'
        else if (comparable instanceof String) {
            compare_as_strings();
        }

        else if (comparable instanceof dList) {
            compare_as_list();
        }

        else if (comparable instanceof Double || comparable instanceof Long) {
            if (comparedto instanceof Double || comparedto instanceof Long) {
                compare_as_numbers();
            }
        }

        else if (comparable instanceof Boolean) {
            // Check to make sure comparedto is Boolean
            if (comparedto instanceof Boolean) {
                // Comparing booleans.. let's do the logic
                outcome = comparable.equals(comparedto);
            }
            // Not comparing booleans, outcome = false
        }

        if (logic == Comparable.Logic.NEGATIVE) outcome = !outcome;

        return outcome;
    }


    private void compare_as_numbers() {

        outcome = false;

        Double comparable;
        if (this.comparable instanceof Double)
            comparable = (Double) this.comparable;
        else
            comparable = ((Long) this.comparable).doubleValue();
        Double comparedto;
        if (this.comparedto instanceof Double)
            comparedto = (Double) this.comparedto;
        else
            comparedto = ((Long) this.comparedto).doubleValue();

        switch(operator) {

            case EQUALS:
                if (comparable.doubleValue() == comparedto.doubleValue()) outcome = true;
                break;

            case OR_MORE:
                if (comparable.compareTo(comparedto) >= 0) outcome = true;
                break;

            case OR_LESS:
                if (comparable.compareTo(comparedto) <= 0) outcome = true;
                break;

            case MORE:
                if (comparable.compareTo(comparedto) > 0) outcome = true;
                break;

            case LESS:
                if (comparable.compareTo(comparedto) < 0) outcome = true;
                break;
        }
    }


    private void compare_as_list() {
        outcome = false;

        dList comparable = (dList) this.comparable;

        switch(operator) {

            case CONTAINS:
                dMaterial compared_mat = null;
                if (comparable.containsObjectsFrom(dLocation.class) &&
                        comparedto instanceof String && dMaterial.matches((String)comparedto)) {
                    compared_mat = dMaterial.valueOf((String)comparedto);
                }
                for (String string : comparable) {
                    if (comparedto instanceof Long) {
                        if (aH.matchesInteger(string)
                                && aH.getLongFrom(string) == (Long) comparedto) {
                            outcome = true;
                            break;
                        }
                    }
                    else if (comparedto instanceof Double) {
                        if (aH.matchesDouble(string) &&
                                aH.getDoubleFrom(string) == (Double) comparedto) {
                            outcome = true;
                            break;
                        }
                    }
                    else if (comparedto instanceof String) {
                        if (compared_mat != null && dLocation.matches(string)) {
                            dLocation compareMe = dLocation.valueOf(string);
                            dMaterial current_mat = dMaterial.getMaterialFrom(compareMe.getBlock().getType(), compareMe.getBlock().getData());
                            if (compared_mat.equals(current_mat)) {
                                outcome = true;
                                break;
                            }
                        }
                        else if (string.equalsIgnoreCase((String) comparedto)) {
                            outcome = true;
                            break;
                        }
                    }
                }
                break;

            case OR_MORE:
                if (!(comparedto instanceof Double)) break;
                outcome = (comparable.size() >= ((Double) comparedto).intValue());
                break;

            case OR_LESS:
                if (!(comparedto instanceof Double)) break;
                outcome = (comparable.size() <= ((Double) comparedto).intValue());
                break;

            case MORE:
                if (!(comparedto instanceof Double)) break;
                outcome = (comparable.size() > ((Double) comparedto).intValue());
                break;

            case LESS:
                if (!(comparedto instanceof Double)) break;
                outcome = (comparable.size() < ((Double) comparedto).intValue());
                break;

            case EQUALS:
                if (comparedto instanceof dList)
                    outcome = ((dList) comparedto).containsAll(comparable);
                break;
        }

    }

    private void compare_as_strings() {

        outcome = false;

        String comparable = String.valueOf(this.comparable);
        String comparedto = String.valueOf(this.comparedto);

        if (comparable == null || comparedto == null) return;

        switch(operator) {
            // For checking if a FLAG is empty.
            case IS_EMPTY:
                outcome = comparable.length() == 0;
                break;

            // For checking straight up if comparable is equal to (ignoring case) comparedto
            case EQUALS:
                outcome = comparable.equalsIgnoreCase(comparedto);
                break;

            // For checking if the comparable contains comparedto
            case CONTAINS:
                outcome = comparable.toLowerCase().contains(comparedto.toLowerCase());
                break;

            // OR_MORE/OR_LESS/etc. deal with the LENGTH of the the comparable/comparedto strings
            case OR_MORE:
                dB.echoError("Comparing text as if it were a number - calculating based on text length");
                outcome = comparable.length() >= comparedto.length();
                break;

            case OR_LESS:
                dB.echoError("Comparing text as if it were a number - calculating based on text length");
                outcome = comparable.length() <= comparedto.length();
                break;

            case MORE:
                dB.echoError("Comparing text as if it were a number - calculating based on text length");
                outcome = comparable.length() > comparedto.length();
                break;

            case LESS:
                dB.echoError("Comparing text as if it were a number - calculating based on text length");
                outcome = comparable.length() < comparedto.length();
                break;

            // Check if the string comparable MATCHES a specific argument type,
            // as specified by comparedto
            case MATCHES:
                comparedto = comparedto.replace("_", "");

                if (comparedto.equalsIgnoreCase("location"))
                    outcome = dLocation.matches(comparable);

                else if (comparedto.equalsIgnoreCase("material"))
                    outcome = dMaterial.matches(comparable);

                else if (comparedto.equalsIgnoreCase("materiallist"))
                    outcome = dList.valueOf(comparable).containsObjectsFrom(dMaterial.class);

                else if (comparedto.equalsIgnoreCase("script"))
                    outcome = dScript.matches(comparable);

                else if (comparedto.equalsIgnoreCase("entity"))
                    outcome = dEntity.matches(comparable);

                else if (comparedto.equalsIgnoreCase("spawnedentity"))
                    outcome = (dEntity.matches(comparable) && dEntity.valueOf(comparable).isSpawned());

                /** TODO: FIX
                else if (comparedto.equalsIgnoreCase("entitytype"))
                    outcome = aH.matchesEntityType(comparable);
                 */

                else if (comparedto.equalsIgnoreCase("npc"))
                    outcome = dNPC.matches(comparable);

                else if (comparedto.equalsIgnoreCase("player"))
                    outcome = dPlayer.matches(comparable);

                else if (comparedto.equalsIgnoreCase("offlineplayer"))
                    outcome = (dPlayer.valueOf(comparable) != null && !dPlayer.valueOf(comparable).isOnline());

                else if (comparedto.equalsIgnoreCase("onlineplayer"))
                    outcome = (dPlayer.valueOf(comparable) != null && dPlayer.valueOf(comparable).isOnline());

                else if (comparedto.equalsIgnoreCase("item"))
                    outcome = dItem.matches(comparable);

                //else if (comparedto.equalsIgnoreCase("pose"))
                //    outcome = true; // TODO: outcome = aH.matchesPose(comparable);

                else if (comparedto.equalsIgnoreCase("duration"))
                    outcome = Duration.matches(comparable);

                else if (comparedto.equalsIgnoreCase("cuboid"))
                    outcome = dCuboid.matches(comparable);

                    // Use aH on primitives

                else if (comparedto.equalsIgnoreCase("double")
                        || comparedto.equalsIgnoreCase("decimal"))
                    outcome = aH.matchesDouble(comparable);

                else if (comparedto.equalsIgnoreCase("integer")
                        || comparedto.equalsIgnoreCase("number"))
                    outcome = aH.matchesInteger(comparable);

                else if (comparedto.equalsIgnoreCase("even integer")
                        || comparedto.equalsIgnoreCase("even number"))
                    outcome = aH.matchesInteger(comparable) && (aH.getLongFrom(comparable) % 2) == 0;

                else if (comparedto.equalsIgnoreCase("odd integer")
                        || comparedto.equalsIgnoreCase("odd number"))
                    outcome = aH.matchesInteger(comparable) && (aH.getLongFrom(comparable) % 2) == 1;

                else if (comparedto.equalsIgnoreCase("boolean"))
                    outcome = (comparable.equalsIgnoreCase("true") || comparable.equalsIgnoreCase("false"));

                break;
        }
    }

    public String log(String str) {
        dB.log("Warning: Unknown comparable type: " + str);
        return str;
    }

    @Override
    public String toString() {
        return  (logic != Logic.REGULAR ? "Logic='" + logic.toString() + "', " : "")
                + "Comparable='" + (comparable == null ? "null'" : (comparable instanceof Double ? "Decimal":
                comparable instanceof String ? "Element": (comparable instanceof Long ? "Number": (comparable instanceof dList ? "dList" :log(comparable.getClass().getSimpleName()))))
                + "(" + ChatColor.AQUA + comparable + ChatColor.WHITE + ")'")
                + ", Operator='" + operator.toString()
                + "', ComparedTo='" + (comparedto == null ? "null'" : (comparedto instanceof Double ? "Decimal":
                comparedto instanceof String ? "Element": (comparedto instanceof Long ? "Number": (comparedto instanceof dList ? "dList" :log(comparedto.getClass().getSimpleName()))))
                + "(" + ChatColor.AQUA + comparedto + ChatColor.WHITE + ")' ")
                + ChatColor.YELLOW + "--> OUTCOME='" + outcome + "'";
    }
}