/*
 * Copyright (c) 2007, 2012, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.max.ins.gui;

import java.awt.*;
import java.awt.event.*;

import javax.swing.*;

import com.sun.max.ins.*;
import com.sun.max.unsafe.*;

/**
 * A dialog that permits entering of a hex-specified memory address.
 */
public abstract class AddressInputDialog extends InspectorDialog {

    /**
     * Action that attempts to close the dialog; fails if input value not valid.
     */
    private final class EnterAction extends InspectorAction {
        private EnterAction() {
            super(inspection(), actionButtonTitle);
        }

        @Override
        protected void procedure() {
            try {
                addressInputField.attemptUpdate();
                if (AddressInputDialog.this.address != null) {
                    dispose();
                    entered(AddressInputDialog.this.address);
                }
            } catch (NumberFormatException numberFormatException) {
                gui().errorMessage("Badly formed address: " + numberFormatException.getMessage());
            }
        }
    }

    private final InspectorAction enterAction;
    private final AddressInputField.Hex addressInputField;
    private final String actionButtonTitle;

    // Most recently entered/updated address from the input field, if valid; null if not valid.
    private Address address;

    /**
     * Creates and displays an interactive dialog that allows entering of a hex-specified memory address.
     *
     * @param inspection
     * @param initialAddress default value for the address
     */
    public AddressInputDialog(Inspection inspection, Address initialAddress) {
        this(inspection, initialAddress, "Address", null);
    }

    /**
     * Creates and displays an interactive dialog that allows entering of a hex-specified memory address.
     *
     * @param inspection
     * @param initialAddress default value for the address
     * @param frameTitle optional title to appear in the window frame of the dialog
     */
    public AddressInputDialog(Inspection inspection, Address initialAddress, String frameTitle) {
        this(inspection, initialAddress, frameTitle, null);
    }

    /**
     * Creates and displays an interactive dialog that allows entering of a hex-specified memory address.
     *
     * @param inspection
     * @param address default value for the address
     * @param frameTitle optional title to appear in the window frame of the dialog
     * @param actionButtonTitle  optional text to appear on the button that triggers action; if null, button text will be "OK".
     */
    public AddressInputDialog(Inspection inspection, Address address, String frameTitle, String actionButtonTitle) {
        super(inspection, frameTitle, true);
        this.address = address;
        if (actionButtonTitle == null) {
            this.actionButtonTitle = "OK";
        } else {
            this.actionButtonTitle = actionButtonTitle;
        }
        this.enterAction = new EnterAction();

        final JPanel dialogPanel = new InspectorPanel(inspection, new BorderLayout());

        final JPanel fieldPanel = new InspectorPanel(inspection);
        fieldPanel.add(new TextLabel(inspection(), "Address:    0x"));
        addressInputField = new AddressInputField.Hex(inspection, address) {

            @Override
            public void update(Address address) {
                final String errorMessage = validateInput(address);
                if (errorMessage == null) {
                    AddressInputDialog.this.address = address;
                } else {
                    AddressInputDialog.this.address = null;
                    JOptionPane.showMessageDialog(dialogPanel, errorMessage, "Invalid Address", JOptionPane.ERROR_MESSAGE);
                }
            }

            @Override
            public void returnPressed() {
                enterAction.perform();
            }
        };
        fieldPanel.add(addressInputField);
        dialogPanel.add(fieldPanel, BorderLayout.NORTH);

        final JPanel buttonPanel = new InspectorPanel(inspection);
        buttonPanel.add(new JButton(new AbstractAction("Cancel") {
            public void actionPerformed(ActionEvent event) {
                dispose();
            }
        }));
        buttonPanel.add(new JButton(enterAction));
        dialogPanel.add(buttonPanel, BorderLayout.SOUTH);

        setContentPane(dialogPanel);
        pack();
        inspection.gui().moveToMiddle(this);
        setVisible(true);
    }

    /**
     * Notifies subclasses that the dialog is closing with a valid address entered.
     *
     * @param address valid address entered.
     */
    protected abstract void entered(Address address);

    /**
     * Subclasses override to validate an entered address, above and beyond being a valid hex number.
     *
     * @param address an address to validate
     * @return {@code null} if {@code address} is valid, an error message if not
     */
    protected String validateInput(Address address) {
        return null;
    }

}