/*
 * Copyright (c) 2011, Lukas Gross
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * * Neither the name of the jo-widgets.org nor the
 *   names of its contributors may be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL jo-widgets.org BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */

package org.jowidgets.addons.testtool.internal;

import java.util.LinkedList;

import org.jowidgets.api.widgets.IContainer;
import org.jowidgets.api.widgets.ITabItem;
import org.jowidgets.api.widgets.IToolBarItem;
import org.jowidgets.api.widgets.ITreeNode;
import org.jowidgets.api.widgets.IWidget;
import org.jowidgets.util.Assert;

// TODO LG generate unique id
public final class TestToolUtilities {

    public static final String ELEMENT_SEPARATOR = "/";
    public static final String PROPERTY_SEPARATOR = ":";
    public static final String CHILD_INDEX_SEPARATOR = "_";
    public static final String DEFAULT_IDENTIFIER = "test";

    public TestToolUtilities() {}

    public String createWidgetID(final IWidget widget) {
        return createWidgetID(widget, "");
    }

    public String createWidgetID(final IWidget widget, final String identifier) {
        Assert.paramNotNull(widget, "widget");
        Assert.paramNotNull(identifier, "identifier");

        final LinkedList<IWidget> widgetList = getWidgetHierarchy(widget);

        final StringBuilder sb = new StringBuilder();
        while (!widgetList.isEmpty()) {
            if (widgetList.size() > 1) {
                final IWidget tmpWidget = widgetList.getLast();
                if (tmpWidget instanceof IContainer) {
                    final IContainer tmpContainer = (IContainer) tmpWidget;
                    final IWidget childWidget = widgetList.get(widgetList.size() - 2);
                    final int childPosition = tmpContainer.getChildren().indexOf(childWidget);
                    sb.append(widgetList.getLast().getClass().getSimpleName());
                    sb.append(PROPERTY_SEPARATOR);
                    sb.append(getIdentifier(widgetList.getLast()));
                    sb.append(ELEMENT_SEPARATOR);
                    if (childPosition != -1) {
                        sb.append(childPosition);
                        sb.append(CHILD_INDEX_SEPARATOR);
                    }
                    widgetList.removeLast();
                }
                else {
                    sb.append(widgetList.getLast().getClass().getSimpleName());
                    sb.append(PROPERTY_SEPARATOR);
                    sb.append(getIdentifier(widgetList.getLast()));
                    sb.append(ELEMENT_SEPARATOR);
                    widgetList.removeLast();
                }
            }
            else {
                sb.append(widgetList.getLast().getClass().getSimpleName());
                sb.append(PROPERTY_SEPARATOR);
                if (!identifier.isEmpty()) {
                    sb.append(identifier);
                }
                else {
                    sb.append(getIdentifier(widgetList.getLast()));
                }
                widgetList.removeLast();
            }
        }
        return sb.toString();
    }

    private LinkedList<IWidget> getWidgetHierarchy(final IWidget widget) {
        final LinkedList<IWidget> results = new LinkedList<IWidget>();
        results.add(widget);
        IWidget parent = widget.getParent();

        if (widget instanceof ITreeNode) {
            final ITreeNode node = (ITreeNode) widget;
            parent = node.getTree();
        }
        while (parent != null) {
            results.add(parent);
            parent = parent.getParent();
        }
        return results;
    }

    // TODO LG add IButtonUi, IFrameUi... 
    // TODO LG replace non ui interfaces with ui interfaces
    private String getIdentifier(final IWidget widget) {
        if (widget instanceof ITreeNode) {
            return ((ITreeNode) widget).getText();
        }
        if (widget instanceof IToolBarItem) {
            return ((IToolBarItem) widget).getToolTipText();
        }
        if (widget instanceof ITabItem) {
            return ((ITabItem) widget).getText();
        }
        return DEFAULT_IDENTIFIER;
    }
}