development/ghidra
development/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra synced 2024-08-27 21:10:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

GP-4296 - Fixed screen reader support of tooltips using html

Browse source
This commit is contained in:
dragonmacher 2024-02-06 17:29:55 -05:00
parent dffb5fd859
commit 0b0356528d
43 changed files with 349 additions and 342 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/analysis/rust/RustDemanglerAnalyzer.java
View file

@ -27,9 +27,7 @@ import ghidra.app.util.demangler.*;
import ghidra.app.util.importer.MessageLog;
import ghidra.framework.options.*;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.Function;
import ghidra.program.model.listing.Program;
import ghidra.program.model.symbol.SourceType;
import ghidra.util.HelpLocation;
import ghidra.util.SystemUtilities;
import ghidra.util.task.TaskMonitor;

5
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/calltree/CallTreeProvider.java
View file

@ -45,7 +45,6 @@ import ghidra.program.model.listing.Function;
import ghidra.program.model.listing.Program;
import ghidra.program.model.symbol.Symbol;
import ghidra.program.util.*;
import ghidra.util.HTMLUtilities;
import ghidra.util.HelpLocation;
import ghidra.util.exception.CancelledException;
import ghidra.util.task.SwingUpdateManager;
@ -443,10 +442,10 @@ public class CallTreeProvider extends ComponentProviderAdapter implements Domain
navigateIncomingToggleAction.setSelected(isPrimary);
navigateIncomingToggleAction.setToolBarData(new ToolBarData(
Icons.NAVIGATE_ON_INCOMING_EVENT_ICON, navigationOptionsToolbarGroup, "2"));
navigateIncomingToggleAction.setDescription(HTMLUtilities.toHTML("Incoming Navigation" +
navigateIncomingToggleAction.setDescription("<html>Incoming Navigation" +
"<br><br>Toggle <b>On</b> - change the displayed " +
"function on Listing navigation events" +
"<br>Toggled <b>Off</b> - don't change the displayed function on Listing navigation events"));
"<br>Toggled <b>Off</b> - don't change the displayed function on Listing navigation events");
navigateIncomingToggleAction.setHelpLocation(
new HelpLocation(plugin.getName(), "Call_Tree_Action_Incoming_Navigation"));
tool.addLocalAction(this, navigateIncomingToggleAction);

2
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/clear/ClearDialog.java
View file

@ -124,7 +124,7 @@ public class ClearDialog extends DialogComponentProvider {
symbolsCb = new GCheckBox("Symbols");
commentsCb = new GHtmlCheckBox(
"<HTML>Comments <FONT SIZE=\"2\">(does not affect automatic comments)</FONT>");
"<html>Comments <FONT SIZE=\"2\">(does not affect automatic comments)</FONT>");
commentsCb.setVerticalTextPosition(SwingConstants.TOP);
propertiesCb = new GCheckBox("Properties");
codeCb = new GCheckBox("Code");

8
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/hover/DataTypeListingHover.java
View file

@ -103,17 +103,17 @@ public class DataTypeListingHover extends AbstractConfigurableHover implements L
toolTipText = toolTipText.replace("Unsized", Integer.toString(dataLen));
}
if (dataInstance != null) {
toolTipText = toolTipText.replace("</HTML>",
getLocationSupplimentalToolTipText(dt, dataInstance) + "</HTML>");
toolTipText = toolTipText.replace("</html>",
getLocationSupplimentalToolTipText(dt, dataInstance) + "</html>");
}
String warningMsg = "";
if (hasInvalidStorage) {
warningMsg += "WARNING! Invalid Storage";
}
if (warningMsg.length() != 0) {
String errorText = "<HTML><center><font color=\"" + Messages.ERROR.toHexString() +
String errorText = "<html><center><font color=\"" + Messages.ERROR.toHexString() +
"\">" + warningMsg + "!</font></center><BR>";
toolTipText = toolTipText.replace("<HTML>", errorText);
toolTipText = toolTipText.replace("<html>", errorText);
}
return createTooltipComponent(toolTipText);
}

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/codebrowser/hover/ProgramAddressRelationshipListingHover.java
View file

@ -39,7 +39,7 @@ import ghidra.util.StringUtilities;
* The tool tip text shows relationships to key topological elements of the program relative to
* the address -- offset from image base, offset from current memory block; if the address is
* within the bounds of a function, the offset from function entry point; if the address is within
* the bounds of defined data, the offset from the start of the data.
* the bounds of defined data, the offset from the start of the data.
*/
public class ProgramAddressRelationshipListingHover extends AbstractConfigurableHover
implements ListingHoverService {
@ -84,7 +84,7 @@ public class ProgramAddressRelationshipListingHover extends AbstractConfigurable
return null;
}
StringBuilder sb = new StringBuilder("<HTML><table>");
StringBuilder sb = new StringBuilder("<html><table>");
Address loc = programLocation.getAddress();
if (isInDefaultSpace(program, loc)) {

48
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/BitFieldPlacementComponent.java
View file

@ -130,7 +130,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
* Construct a bit field viewer/editor component. Non-edit use limits bit
* attribute computation to visible range only which facilitate use within
* scroll pane for very large structures. Edit use will determine bit attributes
* for full allocation size.
* for full allocation size.
* @param composite composite data type to be viewed/modified.
* @param editUseEnabled if true use of editing bitfield editing/placement is
* supported, else viewing only.
@ -311,7 +311,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
* When {@link #editMode} is not {@link EditMode#NONE} the specified
* bitSize and bitOffset specify the active edit bitfield.
* @param bitSize component bitsize
* @param bitOffset component lsb bit offset from lsb of allocation unit
* @param bitOffset component lsb bit offset from lsb of allocation unit
* (allocation unit size is determine by current {@link #allocationByteSize}).
*/
void refresh(int bitSize, int bitOffset) {
@ -339,7 +339,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
/**
* Update the size and offset of the allocation unit. Since this can
* Update the size and offset of the allocation unit. Since this can
* affect the size of this component, its bounds will be updated the component
* repainted.
* @param byteSize allocation byte size
@ -413,9 +413,9 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
return bitFieldAllocation.hasConflict;
// TODO: Improve conflict detection with zero-length components.
// Zero-length components can share common offset, although
// zero-length components should have a lower ordinal than a
// TODO: Improve conflict detection with zero-length components.
// Zero-length components can share common offset, although
// zero-length components should have a lower ordinal than a
// sized component at the same offset.
}
@ -544,7 +544,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
/**
* Get the bit attributes object which corresponds to the specified point p within the
* bounds of this component. NOTE: use of non-visible bitAttributes within the
* bounds of this component. NOTE: use of non-visible bitAttributes within the
* allocation range requires edit use enablement (see {@link #editUseEnabled}).
* @param p point within the bounds of this component
* @return bit attributes object or null
@ -562,7 +562,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
/**
* Get the bit attributes index which corresponds to the specified horizontal x position
* Get the bit attributes index which corresponds to the specified horizontal x position
* within the bounds of this component.
* @param x horizontal x position within the bounds of this component
* @return bit attributes index or -1 if not found
@ -623,9 +623,9 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
conflictMsg += "<div style=\"color: red;font-style: italic\">overlaps " +
HTMLUtilities.escapeHTML(conflictTip) + "</div>";
}
return "<HTML><div style=\"text-align:center\">" + HTMLUtilities.escapeHTML(tip) +
return "<html><div style=\"text-align:center\">" + HTMLUtilities.escapeHTML(tip) +
conflictMsg +
"<div style=\"color: gray;font-style: italic\">(Shift-wheel to zoom)</div></div></HTML>";
"<div style=\"color: gray;font-style: italic\">(Shift-wheel to zoom)</div></div>";
}
@Override
@ -729,7 +729,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
int x = BYTE_SEPARATOR_THICKNESS;
if (bitAttributes[0] != null && bitAttributes[0].leftEndType == EndBitType.TRUNCATED_END) {
// adjust left-most line to reflect truncated component
// adjust left-most line to reflect truncated component
x -= BIT_SEPARATOR_THICKNESS; // backup to left line location
drawTruncationLine(g, x, y, CELL_HEIGHT);
x += BIT_SEPARATOR_THICKNESS;
@ -740,7 +740,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
BitAttributes prevAttrs = null;
// Limit rendered bits to those contained within the visible view port
// of this scrolled component.
// of this scrolled component.
JViewport viewPort = (JViewport) getParent();
Rectangle bounds = viewPort.getViewRect();
@ -850,9 +850,9 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
/**
* <code>BitFieldPlacement</code> provides the ability to translate a
* <code>BitFieldPlacement</code> provides the ability to translate a
* composite component to a bit-level placement within the allocation
* range including the notion of clipped edges when one or both sides
* range including the notion of clipped edges when one or both sides
* extend beyond the allocation range.
*/
private class BitFieldPlacement {
@ -883,7 +883,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
BitFieldDataType bitfield = (BitFieldDataType) component.getDataType();
int storageSize = 8 * bitfield.getStorageSize();
rightBit = leftAdj + storageSize - bitfield.getBitOffset() - 1;
// Use effective bit-size since non-packed uses are only concerned with actual
// Use effective bit-size since non-packed uses are only concerned with actual
// bits stored (NOTE: this may cause a transition from declared to effective
// bit-size when editing a bitfield where the these bit-sizes differ).
int bitSize = bitfield.getBitSize();
@ -913,7 +913,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
/**
* <code>BitFieldAllocation</code> provides the bit-level details within the
* allocation range including the optional overlay of an edit component
* with confict detection. The bit-level details are defined via
* with confict detection. The bit-level details are defined via
* {@link BitAttributes}.
*/
class BitFieldAllocation {
@ -937,10 +937,10 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
private int leftChopBytes;
/**
* Bit attributes array reflects bit layout normalized to big-endian
* layout where left-most allocation bit has array index of 0. In edit
* mode this array covers the full span of {@link #allocationByteSize}, while in
* non-edit mode the array size is reduced based upon visibility as
* Bit attributes array reflects bit layout normalized to big-endian
* layout where left-most allocation bit has array index of 0. In edit
* mode this array covers the full span of {@link #allocationByteSize}, while in
* non-edit mode the array size is reduced based upon visibility as
* indicated by {@link #leftChopBytes} and {@link #rightChopBytes}.
*/
private BitAttributes[] bitAttributes;
@ -1003,7 +1003,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
/**
* Refresh the computed bitAttributes. When editUseEnabled is false
* Refresh the computed bitAttributes. When editUseEnabled is false
* the computed bitAttributes will correspond to the visible portion
* of the component. This method does not handle changes to
* {@link #allocationByteSize} which require a new {@link BitFieldAllocation}
@ -1090,7 +1090,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
/**
* Allocate {@link #bitAttributes} for all structure members which reside
* within the byte range covered by {@link #allocationBytes}.
* @param struct structure whose component bit attributes should be
* @param struct structure whose component bit attributes should be
* computed.
*/
private void allocateStructureMembers(Structure struct) {
@ -1126,7 +1126,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
/**
* Allocate {@link #bitAttributes} for the specified component within
* the byte range covered by {@link #allocationBytes}.
* the byte range covered by {@link #allocationBytes}.
* @param dtc composite component
* @param leftBit left bit index within the full {@link #allocationByteSize}
* where 0 is the left-most bit index.
@ -1200,7 +1200,7 @@ public class BitFieldPlacementComponent extends JPanel implements Scrollable {
}
/**
* <code>BitAttributes</code> provide bit attributes which identify the
* <code>BitAttributes</code> provide bit attributes which identify the
* associated component, a conflict component and left/right line
* types to be displayed.
*/

28
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/CompEditorPanel.java
View file

@ -394,10 +394,10 @@ public class CompEditorPanel extends CompositeEditorPanel {
new HelpLocation(provider.getHelpTopic(), provider.getHelpName() + "_" + "Align"));
}
String alignmentToolTip =
"<HTML>The <B>align</B> control allows the overall minimum alignment of this<BR>" +
"<html>The <B>align</B> control allows the overall minimum alignment of this<BR>" +
"data type to be specified. The actual computed alignment<BR>" +
"may be any multiple of this value. " + "<font color=\"" +
Palette.BLUE.toHexString() + "\" size=\"-2\">(&lt;F1&gt; for help)</HTML>";
Palette.BLUE.toHexString() + "\" size=\"-2\">(&lt;F1&gt; for help)</html>";
alignPanel.setToolTipText(alignmentToolTip);
addMinimumAlignmentComponents();
@ -449,10 +449,10 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupDefaultMinAlignButton() {
defaultAlignButton.setName("Default Alignment");
String alignmentToolTip = "<HTML>Sets this data type to use <B>default</B> alignment.<BR>" +
String alignmentToolTip = "<html>Sets this data type to use <B>default</B> alignment.<BR>" +
"If packing is disabled, the default will be 1 byte. If packing<BR>" +
"is enabled, the alignment is computed based upon the pack<BR>" +
"setting and the alignment of each component data type.</HTML>";
"setting and the alignment of each component data type.</html>";
defaultAlignButton.addActionListener(e -> {
((CompEditorModel) model).setAlignmentType(AlignmentType.DEFAULT, -1);
@ -468,10 +468,10 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupMachineMinAlignButton() {
machineAlignButton.setName("Machine Alignment");
String alignmentToolTip =
"<HTML>Sets this data type to use the <B>machine</B> alignment<BR>" +
"<html>Sets this data type to use the <B>machine</B> alignment<BR>" +
"as specified by the compiler specification. If packing is<BR>" +
"enabled, the computed alignment of this composite should be<BR>" +
"the machine alignment value.</HTML>";
"the machine alignment value.</html>";
machineAlignButton.setToolTipText(alignmentToolTip);
machineAlignButton.addActionListener(e -> {
@ -487,9 +487,9 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupExplicitAlignButton() {
explicitAlignButton.setName("Explicit Alignment");
String alignmentToolTip =
"<HTML>Sets this data type to use the <B>explicit</B> alignment value<BR>" +
"<html>Sets this data type to use the <B>explicit</B> alignment value<BR>" +
"specified. If packing is enabled, the computed alignment of<BR>" +
"this composite may be any multiple of this value.</HTML>";
"this composite may be any multiple of this value.</html>";
explicitAlignButton.setToolTipText(alignmentToolTip);
explicitAlignButton.addActionListener(e -> {
@ -555,10 +555,10 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupActualAlignment() {
GridBagConstraints gridBagConstraints = new GridBagConstraints();
String actualAlignmentToolTip =
"<HTML>The actual alignment to be used for this data type.<BR>" +
"<html>The actual alignment to be used for this data type.<BR>" +
"A combination of the pack and alignment settings made to this datatype<BR>" +
"combined with alignments of the individual components are used to<BR>" +
"to compute the actual alignment of this datatype.</HTML>";
"to compute the actual alignment of this datatype.</html>";
JPanel actualAlignmentPanel = new JPanel(new BorderLayout());
actualAlignmentLabel = new GDLabel("Alignment:");
@ -672,10 +672,10 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupPackingEnablementButton() {
packingEnablementButton.setName("Packing Enablement");
String packingToolTipText =
"<HTML>Enable packing when details of all components are known (including sizing and" +
"<html>Enable packing when details of all components are known (including sizing and" +
" alignment).<BR>" + "Disable packing when Reverse Engineering composite. " +
"<font color=\"" + Palette.BLUE.toHexString() +
"\" size=\"-2\">(&lt;F1&gt; for help)</font></HTML>";
"\" size=\"-2\">(&lt;F1&gt; for help)</font></html>";
packingEnablementButton.addActionListener(e -> {
((CompEditorModel) model).setPackingType(
packingEnablementButton.isSelected() ? PackingType.DEFAULT : PackingType.DISABLED,
@ -692,7 +692,7 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupDefaultPackingButton() {
defaultPackingButton.setName("Default Packing");
String packingToolTipText =
"<HTML>Indicates <B>default</B> compiler packing rules should be applied.</HTML>";
"<html>Indicates <B>default</B> compiler packing rules should be applied.</html>";
defaultPackingButton.addActionListener(e -> {
((CompEditorModel) model).setPackingType(PackingType.DEFAULT, -1);
@ -708,7 +708,7 @@ public class CompEditorPanel extends CompositeEditorPanel {
private void setupExplicitPackingButton() {
explicitPackingButton.setName("Explicit Packing");
String packingToolTipText =
"<HTML>Indicates an explicit pack size should be applied.</HTML>";
"<html>Indicates an explicit pack size should be applied.</html>";
explicitPackingButton.addActionListener(e -> chooseByValuePacking());
explicitPackingButton.setToolTipText(packingToolTipText);

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/compositeeditor/DataTypeCellRenderer.java
View file

@ -94,8 +94,8 @@ public class DataTypeCellRenderer extends GTableCellRenderer {
displayName = HTMLUtilities.friendlyEncodeHTML(displayName);
String toolTipText = ToolTipUtils.getToolTipText(dataType);
String headerText = "<HTML><b>" + displayName + "</b><BR>";
toolTipText = toolTipText.replace("<HTML>", headerText);
String headerText = "<html><b>" + displayName + "</b><BR>";
toolTipText = toolTipText.replace("<html>", headerText);
return toolTipText;
}
}

6
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/data/CreateStructureDialog.java
View file

@ -273,8 +273,8 @@ public class CreateStructureDialog extends ReusableDialogComponentProvider {
return matchingStylePanel;
}
// toggles whether the structure being created is new, based upon the name field, or a current
// structure, based upon a structure in the table. This method updates the GUI to reflect the
// toggles whether the structure being created is new, based upon the name field, or a current
// structure, based upon a structure in the table. This method updates the GUI to reflect the
// current creation state.
private void setCreateStructureByName(boolean createStructureByName) {
if (createStructureByName) {
@ -572,7 +572,7 @@ public class CreateStructureDialog extends ReusableDialogComponentProvider {
message = EXISITING_STRUCTURE_STATUS_PREFIX;
}
setStatusText("<HTML>" + message + "<BR>\"" + HTMLUtilities.escapeHTML(name) + "\"");
setStatusText("<html>" + message + "<BR>\"" + HTMLUtilities.escapeHTML(name) + "\"");
}
// this class is used instead of a cell renderer so that sorting will

8
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/datamgr/DataTypeSynchronizer.java
View file

@ -117,7 +117,7 @@ public class DataTypeSynchronizer {
public static void commitAssumingTransactionsOpen(DataTypeManager sourceDTM, DataType refDT) {
// Must refresh associations of refDt and its dependencies to ensure that any
// Must refresh associations of refDt and its dependencies to ensure that any
// non-sourced datatype is properly associated to the sourceDTM
DataTypeManager refDTM = refDT.getDataTypeManager();
SourceArchive sourceArchive = refDTM.getSourceArchive(sourceDTM.getUniversalID());
@ -359,7 +359,7 @@ public class DataTypeSynchronizer {
// aesthetically pleasing
String spacerString = createHTMLSpacerString(htmlContent, otherContent);
StringBuilder buffy = new StringBuilder();
buffy.append("<HTML>");
buffy.append("<html>");
// -we use CELLPADDING here to allow us to create a narrow column within the table
// -the CELLSPACING gives us some space around the narrow column
@ -412,8 +412,8 @@ public class DataTypeSynchronizer {
private static String createHTMLSpacerString(String htmlContent, String otherHTMLContent) {
// unfortunately, to get the displayed widths, we have to have rendered content, which
// is what the JLabels below are doing for us
JLabel label1 = new GDHtmlLabel("<HTML>" + htmlContent);
JLabel label2 = new GDHtmlLabel("<HTML>" + otherHTMLContent);
JLabel label1 = new GDHtmlLabel("<html>" + htmlContent);
JLabel label2 = new GDHtmlLabel("<html>" + otherHTMLContent);
int maxPixelWidth =
Math.max(label1.getPreferredSize().width, label2.getPreferredSize().width);

80
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/disassembler/DisassembledViewPlugin.java
View file

@ -48,13 +48,13 @@ import ghidra.util.*;
import ghidra.util.exception.UsrException;
/**
* A plugin to disassemble the address at the current ProgramLocation and to
* A plugin to disassemble the address at the current ProgramLocation and to
* display the Instruction. This work of this plugin is temporary in that it
* will not change the state of the program.
*
*
*
* TODO Change the PseudoCodeUnit's getComment(int) method or change its
* TODO Change the PseudoCodeUnit's getComment(int) method or change its
* getPreview(int) method not to call getComment(int) and then change
* this class to not handle the UnsupportedOperationException.
* TODO are the category and names correct?
@ -82,7 +82,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
new GColor("color.fg.plugin.disassembledview.address");
/**
* The number of addresses that should be disassembled, including the
* The number of addresses that should be disassembled, including the
* address of the current {@link ProgramLocation}.
*/
private static final int LOOK_AHEAD_COUNT = 5;
@ -94,7 +94,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
new DisassembledViewComponentProvider();
/**
* The last program location received from the
* The last program location received from the
* {@link #locationChanged(ProgramLocation)} method.
*/
private ProgramLocation lastUpdatedLocation;
@ -113,7 +113,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
public DisassembledViewPlugin(PluginTool plugintool) {
// We want to know about program activated events, location changed
// events and selection changed events. The first type we get from
// our parent, the other two we get by passing true to our parent's
// our parent, the other two we get by passing true to our parent's
// constructor
super(plugintool);
}
@ -153,8 +153,8 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* We want to make sure that we no longer have any contents when the
* program is deactivated so that we do not make any more calls to the
* We want to make sure that we no longer have any contents when the
* program is deactivated so that we do not make any more calls to the
* program or its plugins.
*
* @param program The program being deactivated.
@ -189,7 +189,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
// we only want to update if:
// 1) we have a valid location,
// 2) the location is different than the last location we processed, and
// TODO: **Note: this step is believed to be a bug--we should only be
// TODO: **Note: this step is believed to be a bug--we should only be
// getting one location change at a time, not two
// 3) the display is visible.
if (loc == null || loc.equals(lastUpdatedLocation) || !displayComponent.isVisible()) {
@ -211,7 +211,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
/**
* Called when we receive program selection events.
*
* @param selection The ProgramSelection object that is the current
* @param selection The ProgramSelection object that is the current
* selection.
* @see ProgramPlugin#selectionChanged(ProgramSelection)
*/
@ -222,19 +222,19 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
// TODO:
// if there are multiple lines selected then we need to update the
// if there are multiple lines selected then we need to update the
// display. Should we:
// 1) Show each line selected with some sort of visual delimiter
// 1) Show each line selected with some sort of visual delimiter
// between each value?
// 2) Clear the display when there are multiple values selected?
// 3) Do nothing and allow selections, while showing only the current
// location as determined by the cursor?
//
// Currently solution 3) is used
//
// Currently solution 3) is used
if (selection != null) {
if (containsMultipleSelection()) {
disassembleLocation(currentLocation);
// changed in SCR 6875
// changed in SCR 6875
// displayComponent.clearContents();
}
else if (selection.isEmpty()) {
@ -250,7 +250,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
/**
* Gets the pseudo disassembler used by this class. This method will lazy
* load the disassembler to prevent wasting of resources. If the
* load the disassembler to prevent wasting of resources. If the
* program location changes, then the disassembler will be recreated.
*
* @return the pseudo disassembler used by this class.
@ -263,8 +263,8 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Gets the {@link DisassembledAddressInfo}s for the given address.
* This method will disassamble {@link #LOOK_AHEAD_COUNT a few} addresses
* Gets the {@link DisassembledAddressInfo}s for the given address.
* This method will disassamble {@link #LOOK_AHEAD_COUNT a few} addresses
* after the one that is passed in.
*
* @param address The address for which an info object will be obtained.
@ -278,7 +278,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
try {
DisassembledAddressInfo addressInfo = new DisassembledAddressInfo(address);
// Now get some follow-on addresses to provide a small level of
// Now get some follow-on addresses to provide a small level of
// context. This loop will stop if we cannot find an Address
// or a CodeUnit for a given address.
for (int i = 0; (i < LOOK_AHEAD_COUNT) && (address != null) &&
@ -304,7 +304,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Takes the provided program location object and locates a
* Takes the provided program location object and locates a
* {@link CodeUnit} for it's address that is used to display a disassembled
* preview of the location.
*
@ -317,7 +317,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
DisassembledAddressInfo[] addressInfos =
getAddressInformation(newLocation.getAddress());
// add our preview content to our display (this will be empty if we
// add our preview content to our display (this will be empty if we
// did not get a valid address or any valid code unit previews)
displayComponent.setContents(addressInfos);
}
@ -329,14 +329,14 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
private class DisassembledViewComponentProvider extends ComponentProviderAdapter {
/**
* The constant part of the tooltip text for the list cells. This
* string is prepended to the currently selected address in the
* string is prepended to the currently selected address in the
* program.
* <p>
* Note: This value was just set on the list, but when that was done
* the help key triggers (Ctrl-F1) did not work correctly.
*/
private static final String TOOLTIP_TEXT_PREPEND =
"<HTML>Currently selected<br> Code Browser program location<br>" + "address: ";
"<html>Currently selected<br> Code Browser program location<br>address: ";
/**
* The component that will house our view.
@ -481,10 +481,10 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Notifies the provider that the user pressed the "close" button.
* The provider should take appropriate action. Usually the
* appropriate action is to hide the component or remove the
* component. If the provider does nothing in this method,
* Notifies the provider that the user pressed the "close" button.
* The provider should take appropriate action. Usually the
* appropriate action is to hide the component or remove the
* component. If the provider does nothing in this method,
* then the close button will appear broken.
*/
@Override
@ -521,7 +521,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* An object that provides information about the address that it wraps. The info knows how to
* An object that provides information about the address that it wraps. The info knows how to
* locate an info object for the address and can generate a string preview of the address.
*/
private class DisassembledAddressInfo {
@ -531,7 +531,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
private Address wrappedAddress;
/**
* The code unit for the address of this info. This will be null
* The code unit for the address of this info. This will be null
* after construction if not code unit exists for the address.
*/
private CodeUnit addressCodeUnit;
@ -558,7 +558,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
/**
* Returns the address described by this info.
*
* @return Returns the address described by this info.
* @return Returns the address described by this info.
*/
private Address getAddress() {
@ -566,10 +566,10 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Returns true if there is a {@link CodeUnit} for the address
* Returns true if there is a {@link CodeUnit} for the address
* wrapped by this info. If not, then we do not have a valid addreess.
*
* @return true if there is a {@link CodeUnit} for the address
* @return true if there is a {@link CodeUnit} for the address
* wrapped by this info.
*/
public boolean isValidAddress() {
@ -577,14 +577,14 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Gets the length of the {@link CodeUnit} for the address wrapped
* by this info.
* Gets the length of the {@link CodeUnit} for the address wrapped
* by this info.
* <p>
* Note: If {@link #isValidAddress()} returns false, then this method
* will return <code>-1</code>.
*
* @return the length of the code unit for the address wrapped by this
* info.
* @return the length of the code unit for the address wrapped by this
* info.
*/
public int getCodeUnitLength() {
if (isValidAddress()) {
@ -607,7 +607,7 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
Listing listing = currentProgram.getListing();
codeUnit = listing.getCodeUnitAt(address);
// if the CodeUnit is Data and is not defined, then we need to try to virtually
// if the CodeUnit is Data and is not defined, then we need to try to virtually
// disassemble it
if (codeUnit instanceof Data) {
if (!((Data) codeUnit).isDefined()) {
@ -624,8 +624,8 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
}
/**
* Attempts to disassemble the provided address virtually
* (without changing the state of the program) by making use of the
* Attempts to disassemble the provided address virtually
* (without changing the state of the program) by making use of the
* {@link PseudoDisassembler}.
*
* @param address The address that will be disassembled.
@ -641,8 +641,8 @@ public class DisassembledViewPlugin extends ProgramPlugin implements DomainObjec
codeUnit = disassembler.disassemble(address);
}
catch (UsrException ue) {
// these exceptions happen if there is insufficient data from the program:
// InsufficientBytesException, UnknownInstructionException,
// these exceptions happen if there is insufficient data from the program:
// InsufficientBytesException, UnknownInstructionException,
// UnknownContextException
}
}

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/function/editor/FunctionEditorDialog.java
View file

@ -656,9 +656,9 @@ public class FunctionEditorDialog extends DialogComponentProvider implements Mod
color = getErrorForegroundColor(isSelected);
}
String toolTipText = ToolTipUtils.getToolTipText(dataType);
String headerText = "<HTML><b>" +
String headerText = "<html><b>" +
HTMLUtilities.friendlyEncodeHTML(dataType.getPathName()) + "</b><BR>";
toolTipText = toolTipText.replace("<HTML>", headerText);
toolTipText = toolTipText.replace("<html>", headerText);
setToolTipText(toolTipText);
}
else {

4
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/help/ProcessorListPlugin.java
View file

@ -125,7 +125,7 @@ public class ProcessorListPlugin extends Plugin implements ApplicationLevelPlugi
private String getProcessorList(boolean asHtml) {
StringBuilder strBuilder = new StringBuilder();
if (asHtml) {
strBuilder.append("<HTML><BODY>\n");
strBuilder.append("<html><BODY>\n");
strBuilder.append("<table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\">\n<tr>");
}
@ -152,7 +152,7 @@ public class ProcessorListPlugin extends Plugin implements ApplicationLevelPlugi
}
if (asHtml) {
strBuilder.append("</ul>\n</td></tr>\n</table>");
strBuilder.append("</BODY></HTML>");
strBuilder.append("</BODY></html>");
}
return strBuilder.toString();
}

36
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/script/GhidraScriptComponentProvider.java
View file

@ -93,12 +93,12 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
private TaskListener cleanupTaskSetListener = new TaskListener() {
@Override
public void taskCompleted(Task task) {
runningScriptTaskSet.remove((RunScriptTask) task);
runningScriptTaskSet.remove(task);
}
@Override
public void taskCancelled(Task task) {
runningScriptTaskSet.remove((RunScriptTask) task);
runningScriptTaskSet.remove(task);
}
};
@ -176,7 +176,7 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
});
scriptCategoryTree.getSelectionModel()
.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
.setSelectionMode(TreeSelectionModel.SINGLE_TREE_SELECTION);
}
private void build() {
@ -475,11 +475,11 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
*/
public List<ResourceFile> getScriptDirectories() {
return bundleHost.getGhidraBundles()
.stream()
.filter(GhidraSourceBundle.class::isInstance)
.filter(GhidraBundle::isEnabled)
.map(GhidraBundle::getFile)
.collect(Collectors.toList());
.stream()
.filter(GhidraSourceBundle.class::isInstance)
.filter(GhidraBundle::isEnabled)
.map(GhidraBundle::getFile)
.collect(Collectors.toList());
}
/**
@ -487,12 +487,12 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
*/
public List<ResourceFile> getWritableScriptDirectories() {
return bundleHost.getGhidraBundles()
.stream()
.filter(GhidraSourceBundle.class::isInstance)
.filter(Predicate.not(GhidraBundle::isSystemBundle))
.filter(GhidraBundle::isEnabled)
.map(GhidraBundle::getFile)
.collect(Collectors.toList());
.stream()
.filter(GhidraSourceBundle.class::isInstance)
.filter(Predicate.not(GhidraBundle::isSystemBundle))
.filter(GhidraBundle::isEnabled)
.map(GhidraBundle::getFile)
.collect(Collectors.toList());
}
boolean isEditorOpen(ResourceFile script) {
@ -647,9 +647,9 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
AtomicReference<GhidraScript> ref = new AtomicReference<>();
TaskBuilder.withRunnable(monitor -> ref.set(scriptSupplier.get()))
.setTitle("Compiling Script Directory")
.setLaunchDelay(1000)
.launchModal();
.setTitle("Compiling Script Directory")
.setLaunchDelay(1000)
.launchModal();
return ref.get();
}
@ -1012,7 +1012,7 @@ public class GhidraScriptComponentProvider extends ComponentProviderAdapter {
return list;
}
});
tableFilterPanel.setToolTipText("<HTML>Include scripts with <b>Names</b> or " +
tableFilterPanel.setToolTipText("<html>Include scripts with <b>Names</b> or " +
"<b>Descriptions</b> containing this text.");
tableFilterPanel.setFocusComponent(scriptCategoryTree);
}

18
Ghidra/Features/Base/src/main/java/ghidra/app/plugin/core/script/ScriptSelectionEditor.java
View file

@ -31,7 +31,7 @@ import ghidra.util.HTMLUtilities;
import ghidra.util.UserSearchUtils;
/**
* A widget that allows the user to choose an existing script by typing its name or picking it
* A widget that allows the user to choose an existing script by typing its name or picking it
* from a list.
*/
public class ScriptSelectionEditor {
@ -102,7 +102,7 @@ public class ScriptSelectionEditor {
/**
* Adds a document listener to the text field editing component of this editor so that users
* can be notified when the text contents of the editor change. You may verify whether the
* can be notified when the text contents of the editor change. You may verify whether the
* text changes represent a valid DataType by calling {@link #validateUserSelection()}.
* @param listener the listener to add.
* @see #validateUserSelection()
@ -176,7 +176,7 @@ public class ScriptSelectionEditor {
}
private boolean containsValidScript() {
// look for the case where the user made a selection from the matching window, but
// look for the case where the user made a selection from the matching window, but
// then changed the text field text.
ScriptInfo selectedInfo = selectionField.getSelectedValue();
if (selectedInfo != null &&
@ -211,7 +211,7 @@ public class ScriptSelectionEditor {
//=================================================================================================
// Inner Classes
//=================================================================================================
//=================================================================================================
private class ScriptTextFieldModel extends DefaultDropDownSelectionDataModel<ScriptInfo> {
@ -252,7 +252,7 @@ public class ScriptSelectionEditor {
protected boolean shouldReplaceTextFieldTextWithSelectedItem(String textFieldText,
ScriptInfo selectedItem) {
// This is called when the user presses Enter with a list item selected. By
// This is called when the user presses Enter with a list item selected. By
// default, the text field will not replace the text field text if the given item
// does not match the text. This is to allow users to enter custom text. We do
// not want custom text, as the user must pick an existing script. Thus, we always
@ -265,7 +265,7 @@ public class ScriptSelectionEditor {
@Override
public String getString(ScriptInfo info) {
StringBuilder buffy = new StringBuilder("<HTML><P>");
StringBuilder buffy = new StringBuilder("<html><P>");
KeyStroke keyBinding = info.getKeyBinding();
if (keyBinding != null) {
@ -289,9 +289,9 @@ public class ScriptSelectionEditor {
private String formatDescription(String description) {
//
// We are going to wrap lines at 50 columns so that they fit the tooltip window. We
// will also try to keep the original structure of manually separated lines by
// will also try to keep the original structure of manually separated lines by
// preserving empty lines included in the original description. Removing all newlines
// except for the blank lines allows the line wrapping utility to create the best
// except for the blank lines allows the line wrapping utility to create the best
// output.
//
@ -309,7 +309,7 @@ public class ScriptSelectionEditor {
}
// Remove all newlines, except for consecutive newlines, which represent blank lines.
// Then, for any remaining newline, add back the extra blank line.
// Then, for any remaining newline, add back the extra blank line.
String trimmed = bufffy.toString();
String stripped = trimmed.replaceAll("(?<!\n)\n", "");
stripped = stripped.replaceAll("\n", "\n\n");

4
Ghidra/Features/Base/src/main/java/ghidra/app/util/exporter/ProgramTextWriter.java
View file

@ -81,7 +81,7 @@ class ProgramTextWriter {
//boolean sk = false;
if (options.isHTML()) {
writer.print("<HTML><BODY BGCOLOR=#ffffe0>");
writer.print("<html><BODY BGCOLOR=#ffffe0>");
writer.println("<FONT FACE=COURIER SIZE=3><STRONG><PRE>");
}
TemplateSimplifier simplifier = new TemplateSimplifier();
@ -339,7 +339,7 @@ class ProgramTextWriter {
}
if (options.isHTML()) {
writer.println("</PRE></STRONG></FONT></BODY></HTML>");
writer.println("</PRE></STRONG></FONT></BODY></html>");
}
writer.close();

11
Ghidra/Features/Base/src/main/java/ghidra/app/util/html/HTMLDataTypeRepresentation.java
View file

@ -40,9 +40,10 @@ public abstract class HTMLDataTypeRepresentation {
protected final static int MAX_CHARACTER_LENGTH = 80;
protected final static int MAX_LINE_LENGTH = MAX_CHARACTER_LENGTH * 3;
// HTML Tag constants
protected static final String HTML_OPEN = "<HTML>";
protected static final String HTML_CLOSE = "</HTML>";
// HTML Tag constants. Intentionally lower-case to match external checks for isHtml(), some of
// which check case-sensitive for "<html>"
protected static final String HTML_OPEN = "<html>";
protected static final String HTML_CLOSE = "</html>";
// single HTML space
protected static final String HTML_SPACE = "&nbsp;";
@ -300,11 +301,11 @@ public abstract class HTMLDataTypeRepresentation {
*/
protected HTMLDataTypeRepresentation(String htmlText) {
this.originalHTMLData = htmlText.trim();
// NOTE: the text expected here should not have <HTML></HTML> tags!
// NOTE: the text expected here should not have <html></html> tags!
boolean htmlStart = StringUtilities.startsWithIgnoreCase(htmlText, HTML_OPEN);
boolean htmlEnd = StringUtilities.startsWithIgnoreCase(htmlText, HTML_CLOSE);
if (htmlStart || htmlEnd) {
throw new AssertException("Invalid HTML format: text must not include HTML tag");
throw new AssertException("Invalid HTML format: text must not include <html> tag");
}
}

6
Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/field/EolExtraCommentsPropertyEditor.java
View file

@ -37,7 +37,7 @@ public class EolExtraCommentsPropertyEditor extends PropertyEditorSupport
private static final String ABBREVIATED_LABEL = "Use Abbreviated Comments";
private static final String REPEATABLE_TOOLTIP =
"<HTML>For repeatable comments:" +
"<html>For repeatable comments:" +
"<UL>" +
" <LI>ALWAYS - show even if an EOL comment exists</LI>" +
" <LI>DEFAULT - show only when no EOL comment exists</LI>" +
@ -45,7 +45,7 @@ public class EolExtraCommentsPropertyEditor extends PropertyEditorSupport
"</UL>";
private static final String REF_REPEATABLE_TOOLTIP =
"<HTML>For referenced repeatable comments:" +
"<html>For referenced repeatable comments:" +
"<UL>" +
" <LI>ALWAYS - show even if a higher priority comment exists</LI>" +
" <LI>DEFAULT - show only when no higher priority comment exists</LI>" +
@ -53,7 +53,7 @@ public class EolExtraCommentsPropertyEditor extends PropertyEditorSupport
"</UL>";
private static final String AUTO_TOOLTIP =
"<HTML>For automatic comments:" +
"<html>For automatic comments:" +
"<UL>" +
" <LI>ALWAYS - show even if a higher priority comment exists</LI>" +
" <LI>DEFAULT - show only when no higher priority comment exists</LI>" +

12
Ghidra/Features/Base/src/main/java/ghidra/app/util/viewer/listingpanel/ListingCodeComparisonPanel.java
View file

@ -522,7 +522,7 @@ public class ListingCodeComparisonPanel
class ToggleOrientationAction extends ToggleDockingAction {
ToggleOrientationAction() {
super("Dual Listing Toggle Orientation", owner);
setDescription("<HTML>Toggle the layout of the listings " +
setDescription("<html>Toggle the layout of the listings " +
"<BR>between side-by-side and one above the other.</HTML>");
setEnabled(true);
setSelected(isSideBySide);
@ -1071,7 +1071,7 @@ public class ListingCodeComparisonPanel
saveState.remove("_BYTE_ADDR");
Address desiredByteAddress = null;
if (byteAddress != null) {
// Try to get the indicated side's byte address using one of the address
// Try to get the indicated side's byte address using one of the address
// correlators or by inferring it.
desiredByteAddress = inferDesiredByteAddress(address, desiredAddress, byteAddress,
programLocation.getProgram(), programs[leftOrRight]);
@ -1852,7 +1852,7 @@ public class ListingCodeComparisonPanel
titlePanels[LEFT] = new TitledPanel(leftProgramName, listingPanels[LEFT], 5);
titlePanels[RIGHT] = new TitledPanel(rightProgramName, listingPanels[RIGHT], 5);
// Set the MINIMUM_PANEL_WIDTH for the left and right panel to prevent the split pane's
// Set the MINIMUM_PANEL_WIDTH for the left and right panel to prevent the split pane's
// divider from becoming locked (can't be moved) due to extra long title names.
titlePanels[LEFT].setMinimumSize(
new Dimension(MINIMUM_PANEL_WIDTH, titlePanels[LEFT].getMinimumSize().height));
@ -1871,7 +1871,7 @@ public class ListingCodeComparisonPanel
if (!titlePrefix.isEmpty()) {
titlePrefix += " "; // Add a space between prefix and title.
}
String htmlPrefix = "<HTML>";
String htmlPrefix = "<html>";
if (title.startsWith(htmlPrefix)) {
titlePanel.setTitleName(htmlPrefix + HTMLUtilities.friendlyEncodeHTML(titlePrefix) +
title.substring(htmlPrefix.length()));
@ -2187,7 +2187,7 @@ public class ListingCodeComparisonPanel
* @return the matching address in the indicated program or null.
*/
private Address getFunctionAddress(int leftOrRight, Address otherSidesAddress) {
// Try to get the address using the correlator.
// Try to get the address using the correlator.
// If the correlator couldn't determine it, then try to infer it.
int otherSide = (leftOrRight == RIGHT) ? LEFT : RIGHT;
// Finding desired side's address.
@ -2215,7 +2215,7 @@ public class ListingCodeComparisonPanel
}
private Address getDataAddress(int leftOrRight, Address otherSidesAddress) {
// Correlator doesn't handle data compare, so associate beginning of data and
// Correlator doesn't handle data compare, so associate beginning of data and
// infer the others based on relative position.
Address leftDataAddress = getLeftDataAddress();
Address rightDataAddress = getRightDataAddress();

2
Ghidra/Features/Base/src/main/java/ghidra/framework/main/InfoPanel.java
View file

@ -193,7 +193,7 @@ class InfoPanel extends JPanel {
private HyperlinkComponent buildJavaVersionComponent() {
String anchorName = "java_version";
final HyperlinkComponent javaVersionComponent =
new HyperlinkComponent("<HTML><CENTER>Java Version " + "<A HREF=\"" + anchorName +
new HyperlinkComponent("<html><CENTER>Java Version " + "<A HREF=\"" + anchorName +
"\">" + System.getProperty("java.version") + "</A></CENTER>");
javaVersionComponent.addHyperlinkListener(anchorName, e -> {
if (e.getEventType() != HyperlinkEvent.EventType.ACTIVATED) {

2
Ghidra/Features/Base/src/test.slow/java/ghidra/app/plugin/core/disassembler/ClearTest.java
View file

@ -52,7 +52,7 @@ import ghidra.test.TestEnv;
public class ClearTest extends AbstractGhidraHeadedIntegrationTest {
private static final String COMMENTS_CHECK_BOX_TEXT =
"<HTML>Comments <FONT SIZE=\"2\">(does not affect automatic comments)</FONT>";
"<html>Comments <FONT SIZE=\"2\">(does not affect automatic comments)</FONT>";
private TestEnv env;
private PluginTool tool;

4
Ghidra/Features/Base/src/test/java/ghidra/app/util/html/HTMLDataTypeRepresentationTest.java
View file

@ -361,8 +361,8 @@ public class HTMLDataTypeRepresentationTest extends AbstractGenericTest {
private String getParamText(String html) {
// function html format:
// <HTML>void&nbsp;myFunction(<BR>&nbsp;&nbsp;&nbsp;&nbsp;byte&nbsp;)<BR></HTML>
// function html format:
// <html>void&nbsp;myFunction(<BR>&nbsp;&nbsp;&nbsp;&nbsp;byte&nbsp;)<BR></HTML>
Pattern p = Pattern.compile("\\((.*)\\)");
Matcher matcher = p.matcher(html);

16
Ghidra/Features/Decompiler/src/main/java/ghidra/app/decompiler/component/DecompilerCodeComparisonPanel.java
View file

@ -26,7 +26,6 @@ import docking.ComponentProvider;
import docking.action.*;
import docking.options.OptionsService;
import docking.widgets.fieldpanel.FieldPanel;
import docking.widgets.fieldpanel.internal.FieldPanelCoordinator;
import docking.widgets.fieldpanel.support.FieldLocation;
import docking.widgets.label.GDHtmlLabel;
import ghidra.GhidraOptions;
@ -40,7 +39,8 @@ import ghidra.program.model.address.AddressSetView;
import ghidra.program.model.listing.*;
import ghidra.program.util.FunctionUtility;
import ghidra.program.util.ProgramLocation;
import ghidra.util.*;
import ghidra.util.HTMLUtilities;
import ghidra.util.HelpLocation;
/**
* Panel that displays two decompilers for comparison
@ -133,7 +133,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
if (!titlePrefix.isEmpty()) {
titlePrefix += " "; // Add a space between prefix and title.
}
String htmlPrefix = "<HTML>";
String htmlPrefix = "<html>";
if (title.startsWith(htmlPrefix)) {
titlePanel.setTitleName(htmlPrefix + HTMLUtilities.friendlyEncodeHTML(titlePrefix) +
title.substring(htmlPrefix.length()));
@ -285,7 +285,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
titlePanels[LEFT] = new TitledPanel(leftTitleLabel, cPanels[LEFT], 5);
titlePanels[RIGHT] = new TitledPanel(rightTitleLabel, cPanels[RIGHT], 5);
// Set the MINIMUM_PANEL_WIDTH for the left and right panel to prevent the split pane's
// Set the MINIMUM_PANEL_WIDTH for the left and right panel to prevent the split pane's
// divider from becoming locked (can't be moved) due to extra long title names.
titlePanels[LEFT].setMinimumSize(
new Dimension(MINIMUM_PANEL_WIDTH, titlePanels[LEFT].getMinimumSize().height));
@ -341,7 +341,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
}
/**
* Sets the coordinator for the two decompiler panels within this code comparison panel.
* Sets the coordinator for the two decompiler panels within this code comparison panel.
* It coordinates their scrolling and location synchronization.
* @param fieldPanelCoordinator the coordinator for the two decompiler panels
*/
@ -589,7 +589,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
/**
* Sets whether or not the decompilers are displayed side by side.
*
* @param sideBySide if true, the decompilers are side by side, otherwise one is above
* @param sideBySide if true, the decompilers are side by side, otherwise one is above
* the other.
*/
private void showSideBySide(boolean sideBySide) {
@ -648,7 +648,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
new MyDecompileResultsListener(leftCursorLocation, rightCursorLocation);
//TEMP FIX - correct when refactoring
// Clear any previous MyDecompileResultsListener that is for a decompiler load
// Clear any previous MyDecompileResultsListener that is for a decompiler load
//that hasn't finished.
Set<MyDecompileResultsListener> toRemove = new HashSet<>();
for (DualDecompileResultsListener l : dualDecompileResultsListenerList) {
@ -780,7 +780,7 @@ public abstract class DecompilerCodeComparisonPanel<T extends DualDecompilerFiel
ToggleOrientationAction() {
super("Dual Decompiler Toggle Orientation", "FunctionComparison");
setDescription("<HTML>Toggle the layout of the decompiler " +
setDescription("<html>Toggle the layout of the decompiler " +
"<BR>between side-by-side and one above the other.");
setEnabled(true);
setSelected(isSideBySide);

13
Ghidra/Features/GraphFunctionCalls/src/main/java/functioncalls/plugin/FcgProvider.java
View file

@ -52,7 +52,8 @@ import ghidra.graph.viewer.vertex.VertexClickListener;
import ghidra.program.model.address.Address;
import ghidra.program.model.listing.*;
import ghidra.program.util.ProgramLocation;
import ghidra.util.*;
import ghidra.util.HelpLocation;
import ghidra.util.SystemUtilities;
import ghidra.util.exception.CancelledException;
import ghidra.util.task.TaskMonitor;
import resources.Icons;
@ -172,9 +173,9 @@ public class FcgProvider
if (!graphData.hasResults()) {
return;
}
// The graph component won't contain valid perspective information if it's not 'initialized'
// (i.e. rendered or displayed to the user). It may happen if the graph has been kept minimized
// (i.e. rendered or displayed to the user). It may happen if the graph has been kept minimized
// in the separate tab. Related method: `GraphComponent::viewerInitialized`
if (view.getGraphComponent().isUninitialized()) {
return;
@ -425,10 +426,10 @@ public class FcgProvider
navigateIncomingToggleAction.setSelected(true);
navigateIncomingToggleAction.setToolBarData(
new ToolBarData(Icons.NAVIGATE_ON_INCOMING_EVENT_ICON, TOOLBAR_GROUP_A));
navigateIncomingToggleAction.setDescription(HTMLUtilities.toHTML(
"Incoming Navigation<br><br>Toggle <b>On</b> - change the graphed " +
navigateIncomingToggleAction.setDescription(
"<html>Incoming Navigation<br><br>Toggle <b>On</b> - change the graphed " +
"function on Listing navigation events" +
"<br>Toggled <b>Off</b> - don't change the graph on Listing navigation events"));
"<br>Toggled <b>Off</b> - don't change the graph on Listing navigation events");
navigateIncomingToggleAction.setHelpLocation(
new HelpLocation(plugin.getName(), "Navigation_Incoming"));
addLocalAction(navigateIncomingToggleAction);

4
Ghidra/Features/GraphServices/src/main/java/ghidra/graph/visualization/AttributedToolTipInfo.java
View file

@ -33,7 +33,7 @@ import ghidra.service.graph.*;
import ghidra.util.HTMLUtilities;
/**
* Generates tool tips for an {@link AttributedVertex} or {@link AttributedEdge} in
* Generates tool tips for an {@link AttributedVertex} or {@link AttributedEdge} in
* an {@link AttributedGraph}
*/
public class AttributedToolTipInfo extends ToolTipInfo<Attributed> {
@ -79,7 +79,7 @@ public class AttributedToolTipInfo extends ToolTipInfo<Attributed> {
}
StringBuilder buf = new StringBuilder();
buf.append("<HTML>");
buf.append("<html>");
if (graphObject instanceof AttributedVertex) {
addToolTipTextForVertex(buf, (AttributedVertex) graphObject);

6
Ghidra/Features/ProgramDiff/src/main/java/ghidra/app/plugin/core/diff/DiffApplySettingsProvider.java
View file

@ -36,8 +36,8 @@ import ghidra.program.util.ProgramMergeFilter;
import ghidra.util.HelpLocation;
/**
* The DiffSettingsDialog is used to change the types of differences currently
* highlighted. It also allows the user to change the types of differences being
* The DiffSettingsDialog is used to change the types of differences currently
* highlighted. It also allows the user to change the types of differences being
* applied and whether labels and/or comments are being merged or replaced.
*/
public class DiffApplySettingsProvider extends ComponentProviderAdapter {
@ -262,7 +262,7 @@ public class DiffApplySettingsProvider extends ComponentProviderAdapter {
createChoices();
VariableHeightPanel panel = new VariableHeightPanel(false, 10, 3);
panel.setToolTipText("<HTML>" +
panel.setToolTipText("<html>" +
"For each difference type, select whether to ignore, replace, or merge." +
"<BR>&nbsp&nbsp<B>Ignore</B> - don't apply this type of difference." +
"<BR>&nbsp&nbsp<B>Replace</B> - replace the difference type with the one from program 2." +

78
Ghidra/Features/VersionTracking/src/main/java/ghidra/feature/vt/gui/provider/matchtable/ApplyMarkupPropertyEditor.java
View file

@ -44,75 +44,75 @@ import ghidra.util.layout.*;
import help.HelpService;
/**
* The ApplyMarkupPropertyEditor provides a custom GUI layout for the options that are used when
* The ApplyMarkupPropertyEditor provides a custom GUI layout for the options that are used when
* applying version tracking markup.
*/
public class ApplyMarkupPropertyEditor implements OptionsEditor {
// help tooltips
private static final String DATA_MATCH_DATA_TYPE_TOOLTIP =
"<HTML>The apply action for the <b>data type on a data match</b> when performing bulk apply operations</HTML>";
"<html>The apply action for the <b>data type on a data match</b> when performing bulk apply operations</html>";
private static final String LABELS_TOOLTIP =
"<HTML>The apply action for <b>labels</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>labels</b> when performing bulk apply operations</html>";
private static final String FUNCTION_NAME_TOOLTIP =
"<HTML>The apply action for <b>function name</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>function name</b> when performing bulk apply operations</html>";
private static final String FUNCTION_SIGNATURE_TOOLTIP =
"<HTML>The apply action for the <b>function signature</b> " +
"when performing bulk apply operations</HTML>";
"<html>The apply action for the <b>function signature</b> " +
"when performing bulk apply operations</html>";
private static final String PLATE_COMMENT_TOOLTIP =
"<HTML>The apply action for <b>plate comments</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>plate comments</b> when performing bulk apply operations</html>";
private static final String PRE_COMMENT_TOOLTIP =
"<HTML>The apply action for <b>pre comments</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>pre comments</b> when performing bulk apply operations</html>";
private static final String END_OF_LINE_COMMENT_TOOLTIP =
"<HTML>The apply action for <b>end of line comments</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>end of line comments</b> when performing bulk apply operations</html>";
private static final String REPEATABLE_COMMENT_TOOLTIP =
"<HTML>The apply action for <b>repeatable comments</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>repeatable comments</b> when performing bulk apply operations</html>";
private static final String POST_COMMENT_TOOLTIP =
"<HTML>The apply action for <b>post comments</b> when performing bulk apply operations</HTML>";
"<html>The apply action for <b>post comments</b> when performing bulk apply operations</html>";
private static final String FUNCTION_RETURN_TYPE_TOOLTIP =
"<HTML>The apply action for <b>function return type</b> when the function signature is applied</HTML>";
"<html>The apply action for <b>function return type</b> when the function signature is applied</html>";
private static final String INLINE_TOOLTIP =
"<HTML>The apply action to use for the <b>function inline flag</b> " +
"when applying the function signature</HTML>";
"<html>The apply action to use for the <b>function inline flag</b> " +
"when applying the function signature</html>";
private static final String NO_RETURN_TOOLTIP =
"<HTML>The apply action to use for the <b>function no return flag</b> " +
"when applying the function signature</HTML>";
"<html>The apply action to use for the <b>function no return flag</b> " +
"when applying the function signature</html>";
private static final String CALLING_CONVENTION_TOOLTIP =
"<HTML>The apply action to use for the <b>function calling convention</b> " +
"when applying the function signature</HTML>";
"<html>The apply action to use for the <b>function calling convention</b> " +
"when applying the function signature</html>";
private static final String CALL_FIXUP_TOOLTIP =
"<HTML>The apply action for <b>whether or not to apply call fixup</b> " +
"when applying the function signature</HTML>";
"<html>The apply action for <b>whether or not to apply call fixup</b> " +
"when applying the function signature</html>";
private static final String VAR_ARGS_TOOLTIP =
"<HTML>The apply action to use for the <b>var args flag</b> " +
"when applying the function signature</HTML>";
"<html>The apply action to use for the <b>var args flag</b> " +
"when applying the function signature</html>";
private static final String PARAMETER_DATA_TYPES_TOOLTIP =
"<HTML>The apply action for <b>function parameter data types</b> when applying the function signature</HTML>";
"<html>The apply action for <b>function parameter data types</b> when applying the function signature</html>";
private static final String PARAMETER_NAMES_TOOLTIP =
"<HTML>The apply action for <b>function parameter names</b> when applying the function signature</HTML>";
"<html>The apply action for <b>function parameter names</b> when applying the function signature</html>";
private static final String PARAMETER_NAME_PRIORITY_TOOTIP =
"<HTML>Choose whether a parameter name with a User source type or Import source type is highest " +
"priority when determining whether to replace the name or not when using the priority.</HTML>";
"<html>Choose whether a parameter name with a User source type or Import source type is highest " +
"priority when determining whether to replace the name or not when using the priority.</html>";
private static final String HIGHEST_NAME_PRIORITY_TOOLTIP =
"<HTML>The apply action for <b>which source type is the highest priority</b> " +
"when applying parameter names using a priority replace</HTML>";
"<html>The apply action for <b>which source type is the highest priority</b> " +
"when applying parameter names using a priority replace</html>";
private static final String USER_PRIORITY_TOOLTIP =
"<HTML>Parameter Name Source Type Priority <br>from highest to lowest:<br>" +
"<blockquote>User Defined<br>Imported<br>Analysis<br>default (i.e. param_...)</blockquote></HTML>";
"<html>Parameter Name Source Type Priority <br>from highest to lowest:<br>" +
"<blockquote>User Defined<br>Imported<br>Analysis<br>default (i.e. param_...)</blockquote></html>";
private static final String IMPORT_PRIORITY_TOOLTIP =
"<HTML>Parameter Name Source Type Priority <br>from highest to lowest:<br>" +
"<blockquote>Imported<br>User Defined<br>Analysis<br>default (i.e. param_...)</blockquote></HTML>";
"<html>Parameter Name Source Type Priority <br>from highest to lowest:<br>" +
"<blockquote>Imported<br>User Defined<br>Analysis<br>default (i.e. param_...)</blockquote></html>";
private static final String PARAMETER_NAMES_REPLACE_IF_SAME_PRIORITY_TOOLTIP =
"<HTML>When function signature parameter names are being replaced based on source type priority, " +
"replace the destination name with the source name if their source types are the same.</HTML>";
"<html>When function signature parameter names are being replaced based on source type priority, " +
"replace the destination name with the source name if their source types are the same.</html>";
private static final String PARAMETER_COMMENTS_TOOLTIP =
"<HTML>The apply action for <b>parameter comments</b> when applying the function signature</HTML>";
"<html>The apply action for <b>parameter comments</b> when applying the function signature</html>";
private static final String IGNORE_EXCLUDED_TOOLTIP =
"<HTML>Markup items whose \"apply option\" is set to <b>Do Not Apply</b> should be" +
" changed to a status of <b>Ignored</b> by applying a match.</HTML>";
"<html>Markup items whose \"apply option\" is set to <b>Do Not Apply</b> should be" +
" changed to a status of <b>Ignored</b> by applying a match.</html>";
private static final String IGNORE_INCOMPLETE_TOOLTIP =
"<HTML>Markup items that are <b>incomplete</b> (for example, no destination address is specified) " +
"should be changed to a status of <b>Ignored</b> by applying a match.</HTML>";
"<html>Markup items that are <b>incomplete</b> (for example, no destination address is specified) " +
"should be changed to a status of <b>Ignored</b> by applying a match.</html>";
private JComponent editorComponent;

4
Ghidra/Framework/Docking/src/main/java/docking/StatusBar.java
View file

@ -182,7 +182,7 @@ public class StatusBar extends JPanel {
*/
public void setStatusText(String text) {
// Run this later in case we are in the midst of a Java focus transition, such as when a
// dialog is closing. If we don't let the focus transition finish, then we will not
// dialog is closing. If we don't let the focus transition finish, then we will not
// correctly locate the active window.
Swing.runLater(() -> doSetStatusText(text));
}
@ -278,7 +278,7 @@ public class StatusBar extends JPanel {
@Override
public String getToolTipText() {
if (messageQueue.size() > 0) {
StringBuffer buffer = new StringBuffer("<HTML>");
StringBuffer buffer = new StringBuffer("<html>");
Iterator<String> iter = messageQueue.iterator();
for (int i = 0; iter.hasNext(); i++) {

4
Ghidra/Framework/Docking/src/main/java/docking/menu/DockingToolBarUtils.java
View file

@ -52,8 +52,8 @@ class DockingToolBarUtils {
private static String combingToolTipTextWithKeyBinding(String toolTipText,
String keyBindingText) {
StringBuilder buffy = new StringBuilder(toolTipText);
if (StringUtilities.startsWithIgnoreCase(toolTipText, "<HTML>")) {
String endHTMLTag = "</HTML>";
if (StringUtilities.startsWithIgnoreCase(toolTipText, "<html>")) {
String endHTMLTag = "</html>";
int closeTagIndex = StringUtils.indexOfIgnoreCase(toolTipText, endHTMLTag);
if (closeTagIndex < 0) {
// no closing tag, which is acceptable

4
Ghidra/Framework/Docking/src/main/java/docking/menu/HorizontalRuleAction.java
View file

@ -56,13 +56,13 @@ public class HorizontalRuleAction extends DockingAction {
String topHtml = HTMLUtilities.escapeHTML(topName);
String bottomHtml = HTMLUtilities.escapeHTML(bottomName);
menuData.setMenuItemNamePlain(String.format("""
<HTML><CENTER><FONT SIZE=2 COLOR="%s">%s<BR>%s</FONT></CENTER>
<html><CENTER><FONT SIZE=2 COLOR="%s">%s<BR>%s</FONT></CENTER>
""", Palette.SILVER, topHtml, bottomHtml));
setMenuBarData(menuData);
// the description is meant to be used for the tooltip and is larger
setDescription(String.format("""
<HTML><CENTER><B>%s</B><HR><B>%s</B></CENTER>
<html><CENTER><B>%s</B><HR><B>%s</B></CENTER>
""", PADDING + topHtml + PADDING, PADDING + bottomHtml + PADDING));
}

2
Ghidra/Framework/Docking/src/main/java/docking/options/editor/ColorEditor.java
View file

@ -91,7 +91,7 @@ public class ColorEditor extends PropertyEditorSupport {
String colorString =
WebColors.toString(ColorUtils.contrastForegroundColor(newColor), false);
previewLabel.setText(
"<HTML><CENTER><I><FONT SIZE=2 COLOR=" + colorString + ">click</FONT></I></CENTER>");
"<html><CENTER><I><FONT SIZE=2 COLOR=" + colorString + ">click</FONT></I></CENTER>");
previewLabel.setBackground(color);
}

57
Ghidra/Framework/Gui/src/main/java/ghidra/util/HTMLUtilities.java
View file

@ -123,11 +123,13 @@ public class HTMLUtilities {
private static final int MAX_TOOLTIP_LENGTH = 2000; // arbitrary
private static final int TAB_SIZE = 4;
public static final String HTML = "<HTML>";
public static final String HTML_CLOSE = "</HTML>";
public static final String BR = "<BR>";
public static final String PRE = "<PRE>";
public static final String PRE_CLOSE = "</PRE>";
// Intentionally lower-case to match external checks for isHtml(), some of which check
// case-sensitive for "<html>"
public static final String HTML = "<html>";
public static final String HTML_CLOSE = "</html>";
public static final String BR = "<br>";
public static final String PRE = "<pre>";
public static final String PRE_CLOSE = "</pre>";
/**
* A tag to mark code that could be made into a hyperlink. This allows you to mark
@ -171,35 +173,35 @@ public class HTMLUtilities {
*/
public static String colorString(Color color, String text) {
String rgb = toHexString(color);
return "<FONT COLOR=\"" + rgb + "\">" + text + "</FONT>";
return "<font color=\"" + rgb + "\">" + text + "</font>";
}
/**
* Surrounds the indicated text with HTML font coloring tags so that the
* text will display in color within HTML.
* @param rgbColor (eg. "#8c0000") a string indicating the RGB hexadecimal color
* @param rgbColor (e.g., "#8c0000") a string indicating the RGB hexadecimal color
* @param text the original text
* @return the string for HTML colored text
*/
public static String colorString(String rgbColor, String text) {
return "<FONT COLOR=\"" + rgbColor + "\">" + text + "</FONT>";
return "<font color=\"" + rgbColor + "\">" + text + "</font>";
}
/**
* Surrounds the indicated numeric value with HTML font coloring tags so that the
* numeric value will display in color within HTML.
* @param rgbColor (eg. "#8c0000") a string indicating the RGB hexadecimal color
* @param rgbColor (e.g., "#8c0000") a string indicating the RGB hexadecimal color
* @param value the numeric value to be converted to text and wrapped with color tags.
* @return the string for the HTML colored number
*/
public static String colorString(String rgbColor, int value) {
return "<FONT COLOR=\"" + rgbColor + "\">" + value + "</FONT>";
return "<font color=\"" + rgbColor + "\">" + value + "</font>";
}
/**
* Creates a string with the indicated number of HTML space characters (<code>&#x26;nbsp;</code>).
* @param num the number of HTML spaces
* @return the string o HTML spaces
* @return the string of HTML spaces
*/
public static String spaces(int num) {
StringBuilder buf = new StringBuilder(HTML_SPACE.length() * num);
@ -289,7 +291,7 @@ public class HTMLUtilities {
}
/**
* Sets the font size of the given text by wrapping it in &lt;font&gt; tags.
* Sets the font size of the given text by wrapping it in &lt;span&gt; tags.
*
* @param text the text to size
* @param ptSize the point size of the text
@ -303,19 +305,19 @@ public class HTMLUtilities {
}
StringBuilder buffy = new StringBuilder(text);
buffy.insert(start, "<SPAN STYLE=\"font-size: " + ptSize + "pt\">");
buffy.insert(start, "<span style=\"font-size: " + ptSize + "pt\">");
int end = buffy.length();
if (StringUtilities.endsWithIgnoreCase(text, HTML_CLOSE)) {
end = end - HTML_CLOSE.length();
}
buffy.insert(end, "</SPAN>");
buffy.insert(end, "</span>");
return buffy.toString();
}
/**
* Sets the font size and color of the given text by wrapping it in &lt;font&gt; tags.
* Sets the font size and color of the given text by wrapping it in &lt;span&gt; tags.
*
* @param text the text to size
* @param color the color of the text
@ -330,14 +332,14 @@ public class HTMLUtilities {
}
StringBuilder buffy = new StringBuilder(text);
buffy.insert(start, "<SPAN STYLE=\"font-size: " + ptSize + "pt; color: " + rgb + "\">");
buffy.insert(start, "<span style=\"font-size: " + ptSize + "pt; color: " + rgb + "\">");
int end = buffy.length();
if (StringUtilities.endsWithIgnoreCase(text, HTML_CLOSE)) {
end = end - HTML_CLOSE.length();
}
buffy.insert(end, "</SPAN>");
buffy.insert(end, "</span>");
return buffy.toString();
}
@ -363,8 +365,8 @@ public class HTMLUtilities {
/**
* Takes HTML text wrapped by {@link #wrapWithLinkPlaceholder(String, String)} and replaces
* the custom link comment tags with HTML anchor (<code>A</code>) tags, where the <code>HREF</code>
* value is the value that was in the <code>CONTENT</code> attribute.
* the custom link comment tags with HTML anchor (<code>A</code>) tags, where the
* <code>HREF</code> value is the value that was in the <code>CONTENT</code> attribute.
*
* @param text the text for which to replace the markup
* @return the updated text
@ -378,14 +380,14 @@ public class HTMLUtilities {
while (matcher.find()) {
String content = matcher.group(1);
String escaped = content.replace("$", "\\$");
String updated = "<A HREF=\"" + escaped + "\">";
String updated = "<a href=\"" + escaped + "\">";
matcher.appendReplacement(buffy, updated);
}
matcher.appendTail(buffy);
String pass1 = buffy.toString();
String pass2 = pass1.replaceAll(LINK_PLACEHOLDER_CLOSE, "</A>");
String pass2 = pass1.replaceAll(LINK_PLACEHOLDER_CLOSE, "</a>");
return pass2;
}
@ -398,8 +400,7 @@ public class HTMLUtilities {
*/
public static String toHTML(String text) {
int noMax = 0;
String html = toWrappedHTML(text, noMax);
return html;
return toWrappedHTML(text, noMax);
}
/**
@ -593,7 +594,7 @@ public class HTMLUtilities {
* <p>
* See also <code>StringEscapeUtils#escapeHtml3(String)</code> if you need quote-safe html encoding.
* <p>
*
*
* @param text plain-text that might have some characters that should NOT be interpreted as HTML
* @return string with any html characters replaced with equivalents
*/
@ -628,8 +629,8 @@ public class HTMLUtilities {
}
/**
* Tests a unicode code point (i.e., 32 bit character) to see if it needs to be escaped before
* being added to a HTML document because it is non-printable or a non-standard control
* Tests a unicode code point (i.e., 32 bit character) to see if it needs to be escaped before
* being added to a HTML document because it is non-printable or a non-standard control
* character
*
* @param codePoint character to test
@ -787,8 +788,8 @@ public class HTMLUtilities {
// formatting tags (like <B>, <FONT>, etc). So, just normalize the text, not
// preserving any of the line breaks.
//
// Note: Calling this method here causes unwanted removal of newlines. If the original
// need for this call is found, this can be revisited.
// Note: Calling this method here causes unwanted removal of newlines. If the original
// need for this call is found, this can be revisited.
// (see history for condense() code)
// String condensed = condense(updated);
return updated;

4
Ghidra/Framework/Gui/src/test/java/ghidra/util/HTMLUtilitiesTest.java
View file

@ -107,7 +107,7 @@ public class HTMLUtilitiesTest {
@Test
public void testToLiteralHTML_AlreadyStartingWithHTML() {
String s = "<HTML>Wrap<BR>here";
String s = "<html>Wrap<BR>here";
String html = HTMLUtilities.toLiteralHTML(s, 4);
assertEquals(HTML + "&lt;HTM<BR>\nL&gt;Wr<BR>\nap&lt;B<BR>\nR&gt;he<BR>\nre", html);
}
@ -121,7 +121,7 @@ public class HTMLUtilitiesTest {
@Test
public void testFromHTML() {
String s = "<HTML><b>Bold</b>, <i>italics</i>, <font size='3'>sized font!</font>";
String s = "<html><b>Bold</b>, <i>italics</i>, <font size='3'>sized font!</font>";
String text = Swing.runNow(() -> HTMLUtilities.fromHTML(s));
assertEquals("Bold, italics, sized font!", text);
}

62
Ghidra/Framework/Help/src/main/java/help/screenshot/HelpMissingScreenShotReportGenerator.java
View file

@ -15,14 +15,6 @@
*/
package help.screenshot;
import help.GHelpBuilder;
import help.HelpBuildUtils;
import help.validator.UnusedHelpImageFileFinder;
import help.validator.location.DirectoryHelpModuleLocation;
import help.validator.location.HelpModuleLocation;
import help.validator.model.HelpTopic;
import help.validator.model.IMG;
import java.awt.image.BufferedImage;
import java.io.*;
import java.lang.reflect.Method;
@ -36,6 +28,14 @@ import java.util.Map.Entry;
import javax.imageio.ImageIO;
import help.GHelpBuilder;
import help.HelpBuildUtils;
import help.validator.UnusedHelpImageFileFinder;
import help.validator.location.DirectoryHelpModuleLocation;
import help.validator.location.HelpModuleLocation;
import help.validator.model.HelpTopic;
import help.validator.model.IMG;
public class HelpMissingScreenShotReportGenerator {
private static boolean debugEnabled;
@ -68,17 +68,17 @@ public class HelpMissingScreenShotReportGenerator {
generator.generateReport();
}
private Set<HelpModuleLocation> helpDirectories = new HashSet<HelpModuleLocation>();
private Map<String, HelpTopic> topicNameToTopic = new HashMap<String, HelpTopic>();
private Set<HelpTestCase> testCases = new HashSet<HelpTestCase>();
private Map<String, HelpTestCase> imageNameToTestCase = new HashMap<String, HelpTestCase>();
private Set<HelpModuleLocation> helpDirectories = new HashSet<>();
private Map<String, HelpTopic> topicNameToTopic = new HashMap<>();
private Set<HelpTestCase> testCases = new HashSet<>();
private Map<String, HelpTestCase> imageNameToTestCase = new HashMap<>();
private SortedSet<String> badlyNamedTestFiles = new TreeSet<String>();
private SortedSet<HelpTestCase> badlyNamedTestCases = new TreeSet<HelpTestCase>();
private SortedSet<String> badlyNamedTestFiles = new TreeSet<>();
private SortedSet<HelpTestCase> badlyNamedTestCases = new TreeSet<>();
// private Map<HelpDirectory, IMG> untestedImages = new TreeMap<HelpDirectory, IMG>();
private Map<HelpTopic, Set<IMG>> untestedImages = new TreeMap<HelpTopic, Set<IMG>>();
private Map<HelpTopic, Set<IMG>> untestedImages = new TreeMap<>();
private Set<Path> examinedImageFiles = new HashSet<Path>();
private Set<Path> examinedImageFiles = new HashSet<>();
private File outputFile;
@ -125,8 +125,8 @@ public class HelpMissingScreenShotReportGenerator {
writer.write("<P>\n");
//
// Total Image File Count
//
// Total Image File Count
//
int untestedCount = 0;
Collection<Set<IMG>> values = untestedImages.values();
for (Set<IMG> set : values) {
@ -141,7 +141,7 @@ public class HelpMissingScreenShotReportGenerator {
//
// All Tested Images
//
//
writer.write("<H3>\n");
writer.write("Total Tested Images: " + imageNameToTestCase.size() + "\n");
writer.write("</H3>\n");
@ -432,7 +432,7 @@ public class HelpMissingScreenShotReportGenerator {
Set<IMG> set = untestedImages.get(topic);
if (set == null) {
set = new TreeSet<IMG>();
set = new TreeSet<>();
untestedImages.put(topic, set);
}
@ -619,7 +619,7 @@ public class HelpMissingScreenShotReportGenerator {
}
private void writeHeader(BufferedWriter writer) throws IOException {
writer.write("<HTML>\n");
writer.write("<html>\n");
writer.write("<HEAD>\n");
createStyleSheet(writer);
writer.write("</HEAD>\n");
@ -635,7 +635,7 @@ public class HelpMissingScreenShotReportGenerator {
writer.write("<BR>\n");
writer.write("</BODY>\n");
writer.write("</HTML>\n");
writer.write("</html>\n");
}
private void createStyleSheet(BufferedWriter writer) throws IOException {
@ -643,11 +643,16 @@ public class HelpMissingScreenShotReportGenerator {
writer.write("<!--\n");
writer.write("body { font-family:arial; font-size:22pt }\n");
writer.write("h1 { color:#000080; font-family:times new roman; font-size:28pt; font-weight:bold; text-align:center; }\n");
writer.write("h2 { color:#984c4c; font-family:times new roman; font-size:28pt; font-weight:bold; }\n");
writer.write("h2.title { color:#000080; font-family:times new roman; font-size:14pt; font-weight:bold; text-align:center;}\n");
writer.write("h3 { color:#0000ff; font-family:times new roman; font-size:14pt; font-weight:bold; margin-left:.5in }\n");
writer.write("table { margin-left:1in; margin-right:1in; min-width:20em; width:90%; background-color:#EEEEFF }\n");
writer.write(
"h1 { color:#000080; font-family:times new roman; font-size:28pt; font-weight:bold; text-align:center; }\n");
writer.write(
"h2 { color:#984c4c; font-family:times new roman; font-size:28pt; font-weight:bold; }\n");
writer.write(
"h2.title { color:#000080; font-family:times new roman; font-size:14pt; font-weight:bold; text-align:center;}\n");
writer.write(
"h3 { color:#0000ff; font-family:times new roman; font-size:14pt; font-weight:bold; margin-left:.5in }\n");
writer.write(
"table { margin-left:1in; margin-right:1in; min-width:20em; width:90%; background-color:#EEEEFF }\n");
writer.write("th { text-align:center; }\n");
writer.write("td { text-align:left; padding: 20px }\n");
@ -665,7 +670,8 @@ public class HelpMissingScreenShotReportGenerator {
private Path filePath;
private HelpTopic helpTopic;
HelpTestFile(HelpModuleLocation helpDir, HelpTopic helpTopic, Path filePath, String filename) {
HelpTestFile(HelpModuleLocation helpDir, HelpTopic helpTopic, Path filePath,
String filename) {
this.helpDir = helpDir;
this.helpTopic = helpTopic;
this.filePath = filePath;

4
Ghidra/Framework/Help/src/main/java/help/screenshot/HelpScreenShotReportGenerator.java
View file

@ -146,7 +146,7 @@ public class HelpScreenShotReportGenerator {
}
private void writeHeader(BufferedWriter writer) throws IOException {
writer.write("<HTML>\n");
writer.write("<html>\n");
writer.write("<HEAD>\n");
createStyleSheet(writer);
writer.write("</HEAD>\n");
@ -178,7 +178,7 @@ public class HelpScreenShotReportGenerator {
writer.write("</P>\n");
writer.write("</BODY>\n");
writer.write("</HTML>\n");
writer.write("</html>\n");
}
private void createStyleSheet(BufferedWriter writer) throws IOException {

42
Ghidra/Framework/Help/src/test/java/help/AbstractHelpTest.java
View file

@ -94,8 +94,8 @@ public abstract class AbstractHelpTest extends AbstractGenericTest {
Path file = Files.createFile(fullTOCPath);
//@formatter:off
String TOCXML = "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +
"<!-- Auto-generated on Fri Apr 03 09:37:08 EDT 2015 -->\n\n" +
String TOCXML = "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +
"<!-- Auto-generated on Fri Apr 03 09:37:08 EDT 2015 -->\n\n" +
"<tocroot>\n" +
"</tocroot>\n";
@ -114,14 +114,14 @@ public abstract class AbstractHelpTest extends AbstractGenericTest {
}
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
" <H1><A name=\""+anchor+"\"></A>Configure Tool</H1>\n" +
" Some text with reference to shared image <IMG src=\"help/shared/note.png\">\n" +
" \n" +
@ -140,19 +140,19 @@ public abstract class AbstractHelpTest extends AbstractGenericTest {
assertNotNull("Must specify the A tag HREF attribute", HREF);
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
" <H1><A name=\"Fake_Anchor\"></A>Configure Tool</H1>\n" +
" And this is a link <A HREF=\""+HREF+"\">Click Me</A>" +
" And this is a link <A HREF=\""+HREF+"\">Click Me</A>" +
" \n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);
@ -167,19 +167,19 @@ public abstract class AbstractHelpTest extends AbstractGenericTest {
assertNotNull("Must specify the A tag SRC attribute", SRC);
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
" <H1><A name=\"Fake_Anchor\"></A>Configure Tool</H1>\n" +
" Some text with reference to shared image <IMG src=\""+SRC+"\">\n" +
" Some text with reference to shared image <IMG src=\""+SRC+"\">\n" +
" \n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);

64
Ghidra/Framework/Help/src/test/java/help/validator/model/HelpFileTest.java
View file

@ -150,7 +150,7 @@ public class HelpFileTest extends AbstractHelpTest {
assertTrue(hrefs.isEmpty());
}
// @Test
// @Test
// for debugging a real help file
public void test() throws Exception {
@ -183,18 +183,18 @@ public class HelpFileTest extends AbstractHelpTest {
String badAttr = "bob=1";
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
"<H1><A name=\"ManagePluginsDialog\"></A>Configure Tool</H1>\n" +
"Some text with reference to shared image <a "+badAttr+">Click me</a>\n" +
"\n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);
@ -208,18 +208,18 @@ public class HelpFileTest extends AbstractHelpTest {
String badAttr = "bob=1";
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
"<H1><A name=\"ManagePluginsDialog\"></A>Configure Tool</H1>\n" +
"Some text with reference to shared image <IMG "+badAttr+"s>\n" +
"\n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);
@ -233,18 +233,18 @@ public class HelpFileTest extends AbstractHelpTest {
String badURI = ":baduri"; // no scheme name on this URI
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
"<H1><A name=\"ManagePluginsDialog\"></A>Configure Tool</H1>\n" +
"Some text with reference to shared image <a href=\""+badURI+"\">Click me</a>\n" +
"\n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);
@ -258,18 +258,18 @@ public class HelpFileTest extends AbstractHelpTest {
String badName = "bad_name";
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"../../shared/"+badName+".css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
"<H1><A name=\"ManagePluginsDialog\"></A>Configure Tool</H1>\n" +
"Some text with reference to shared image <IMG src=\"help/shared/DefaultStyle.css\">\n" +
"\n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);
@ -284,20 +284,20 @@ public class HelpFileTest extends AbstractHelpTest {
String badURI = ":baduri"; // no scheme name on this URI
//@formatter:off
String HTML =
"<HTML>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
String HTML =
"<html>\n" +
"<HEAD>\n" +
"<TITLE>Configure Tool</TITLE>\n" +
"<LINK rel=\"stylesheet\" type=\"text/css\" href=\"help/shared/DefaultStyle.css\">\n" +
"</HEAD>\n" +
"<BODY>\n" +
"<BODY>\n" +
"<H1><A name=\"ManagePluginsDialog\"></A>Configure Tool</H1>\n" +
" <!--" +
" Some text with reference to shared image <a href=\""+badURI+"\">Click me</a>\n" +
" -->" +
" -->" +
"\n" +
"</BODY>\n" +
"</HTML>\n";
"</html>\n";
//@formatter:on
Files.write(file, HTML.getBytes(), StandardOpenOption.CREATE);

11
Ghidra/Framework/Project/src/main/java/ghidra/framework/main/datatable/ProjectDataTablePanel.java
View file

@ -54,9 +54,9 @@ public class ProjectDataTablePanel extends JPanel {
public Set<DomainFile> filesPendingSelection;
private GHtmlLabel capacityExceededText =
new GHtmlLabel("<HTML><CENTER><I>Table view disabled for very large projects, or<BR>" +
new GHtmlLabel("<html><CENTER><I>Table view disabled for very large projects, or<BR>" +
"if an older project/repository filesystem is in use.<BR>" +
"View will remain disabled until project is closed.</I></CENTER></HTML>");
"View will remain disabled until project is closed.</I></CENTER></html>");
private GGlassPanePainter painter = new TableGlassPanePainter();
@ -95,8 +95,9 @@ public class ProjectDataTablePanel extends JPanel {
checkOpen(e);
}
});
gTable.getSelectionModel().addListSelectionListener(
e -> plugin.getTool().contextChanged(null));
gTable.getSelectionModel()
.addListSelectionListener(
e -> plugin.getTool().contextChanged(null));
gTable.setDefaultRenderer(Date.class, new DateCellRenderer());
gTable.setDefaultRenderer(DomainFileType.class, new TypeCellRenderer());
@ -275,7 +276,7 @@ public class ProjectDataTablePanel extends JPanel {
//==================================================================================================
// Inner Classes
//==================================================================================================
//==================================================================================================
private class ProjectDataTableDomainFolderChangeListener implements DomainFolderChangeListener {

6
Ghidra/Framework/Project/src/main/java/ghidra/framework/main/projectdata/actions/ProjectDataDeleteAction.java
View file

@ -89,17 +89,17 @@ public class ProjectDataDeleteAction extends FrontendProjectTreeAction {
if (fileCount == 1) {
if (!selectedFiles.isEmpty()) {
DomainFile file = CollectionUtils.any(selectedFiles);
return "<HTML>Are you sure you want to <B><U>permanently</U></B> delete \"" +
return "<html>Are you sure you want to <B><U>permanently</U></B> delete \"" +
HTMLUtilities.escapeHTML(file.getName()) + "\"?";
}
// only folders are selected, but they contain files
return "<HTML>Are you sure you want to <B><U>permanently</U></B> delete the " +
return "<html>Are you sure you want to <B><U>permanently</U></B> delete the " +
" selected files and folders?";
}
// multiple files selected
return "<HTML>Are you sure you want to <B><U>permanently</U></B> delete the " + fileCount +
return "<html>Are you sure you want to <B><U>permanently</U></B> delete the " + fileCount +
" selected files?";
}

2
Ghidra/Framework/Project/src/main/java/ghidra/framework/plugintool/dialog/PluginDetailsPanel.java
View file

@ -68,7 +68,7 @@ class PluginDetailsPanel extends AbstractDetailsPanel {
List<PluginDescription> dependencies = model.getDependencies(descriptor);
Collections.sort(dependencies, (pd1, pd2) -> pd1.getName().compareTo(pd2.getName()));
StringBuilder buffer = new StringBuilder("<HTML>");
StringBuilder buffer = new StringBuilder("<html>");
buffer.append("<TABLE cellpadding=2>");

4
Ghidra/Framework/Project/src/main/java/ghidra/framework/project/extensions/ExtensionDetailsPanel.java
View file

@ -57,7 +57,7 @@ class ExtensionDetailsPanel extends AbstractDetailsPanel {
createFieldAttributes();
createMainPanel();
// Any time the table is reloaded or a new selection is made, we want to reload this
// Any time the table is reloaded or a new selection is made, we want to reload this
// panel. This ensures we are always viewing data for the currently-selected item.
tablePanel.getTableModel().addThreadedTableModelListener(new ThreadedTableModelListener() {
@ -94,7 +94,7 @@ class ExtensionDetailsPanel extends AbstractDetailsPanel {
return;
}
StringBuilder buffer = new StringBuilder("<HTML>");
StringBuilder buffer = new StringBuilder("<html>");
buffer.append("<TABLE cellpadding=2>");
insertRowTitle(buffer, "Name");

2
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/ProgramCompilerSpec.java
View file

@ -244,7 +244,7 @@ public class ProgramCompilerSpec extends BasicCompilerSpec {
return;
}
StringBuilder buffer = new StringBuilder();
buffer.append("<HTML>User-defined extensions failed to parse: ");
buffer.append("<html>User-defined extensions failed to parse: ");
buffer.append("<ul>");
for (String line : errorList) {
buffer.append("<li>").append(line).append("</li>");

4
Ghidra/Framework/SoftwareModeling/src/main/java/ghidra/program/database/data/DataTypeArchiveTransformerPanel.java
View file

@ -57,9 +57,9 @@ public class DataTypeArchiveTransformerPanel extends JPanel {
private void setupDescription() {
JLabel label = new GHtmlLabel(
"<HTML>Specify the files for converting a new data type archive (.gdt)<BR>" +
"<html>Specify the files for converting a new data type archive (.gdt)<BR>" +
"to match the IDs of data types in an old data type archive.<BR>" +
"The result will be saved to the destination archive.</HTML>");
"The result will be saved to the destination archive.</html>");
label.setBorder(BorderFactory.createEmptyBorder(0, 0, 8, 0));
label.setHorizontalAlignment(SwingConstants.CENTER);
add(label, BorderLayout.NORTH);