/*
* Copyright (c) 2009, 2011, 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 VM memory address.
*/
public abstract class MemoryRegionInputDialog extends InspectorDialog {
private final AddressInputField.Hex addressInputField;
private final String actionButtonTitle;
private final NumberInputField sizeField;
// Most recently entered/updated address from the input field, if valid; null if not valid.
//private MemoryRegion memoryRegion;
private Address address = null;
private long nBytes = 0;
/**
* Notifies subclasses that the dialog is closing with a valid address entered.
*
* @param address valid address entered.
*/
public abstract void entered(Address address, long nBytes);
/**
* 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();
sizeField.attemptUpdate();
if (MemoryRegionInputDialog.this.address != null && MemoryRegionInputDialog.this.nBytes != 0) {
dispose();
entered(MemoryRegionInputDialog.this.address, MemoryRegionInputDialog.this.nBytes);
}
} catch (NumberFormatException numberFormatException) {
gui().errorMessage("Badly formed address: " + numberFormatException.getMessage());
}
}
}
/**
* Subclasses override to validate an entered address, above and beyond being a valid hex number.
*
* @param address an address to validate
* @return {@code null} is {@code address} is valid, an error message if not
*/
protected String validateInput(Address address) {
return 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
*/
public MemoryRegionInputDialog(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 MemoryRegionInputDialog(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 MemoryRegionInputDialog(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;
}
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) {
MemoryRegionInputDialog.this.address = address;
} else {
MemoryRegionInputDialog.this.address = null;
JOptionPane.showMessageDialog(dialogPanel, errorMessage, "Invalid Address", JOptionPane.ERROR_MESSAGE);
}
}
};
sizeField = new NumberInputField(inspection, 8) {
@Override
public void update(long value) {
if (value == 0) {
MemoryRegionInputDialog.this.nBytes = 0;
JOptionPane.showMessageDialog(dialogPanel, "Insert valid size in dec or hex (0x...).", "Invalid Size", JOptionPane.ERROR_MESSAGE);
} else {
MemoryRegionInputDialog.this.nBytes = value;
}
}
};
fieldPanel.add(addressInputField);
fieldPanel.add(new TextLabel(inspection(), " Size: "));
fieldPanel.add(sizeField);
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(new EnterAction()));
dialogPanel.add(buttonPanel, BorderLayout.SOUTH);
setContentPane(dialogPanel);
pack();
inspection.gui().moveToMiddle(this);
setVisible(true);
}
}