Provide hex dump of binary files in Default Binary File Editor

eclipse-cdt · Jun 13, 2023 · 74bcb42 · 74bcb42
1 parent d4c444e
commit 74bcb42
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 3 deletions.
diff --git a/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF b/core/org.eclipse.cdt.ui/META-INF/MANIFEST.MF
@@ -102,6 +102,7 @@ Export-Package: org.eclipse.cdt.internal.corext;x-internal:=true,
  org.eclipse.cdt.ui.wizards,
  org.eclipse.cdt.ui.wizards.conversion,
  org.eclipse.cdt.utils.ui.controls
+Import-Package: org.apache.commons.io;version="[2.8.0,3.0.0)"
 Require-Bundle: org.eclipse.cdt.core;bundle-version="[8.0.0,9.0.0)",
  org.eclipse.compare;bundle-version="[3.8.500,4.0.0)",
  org.eclipse.core.expressions;bundle-version="[3.8.200,4.0.0)",

diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/editor/DefaultBinaryFileEditor.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/editor/DefaultBinaryFileEditor.java
@@ -11,13 +11,21 @@
  * Contributors:
  *     Anton Leherbauer (Wind River Systems) - initial API and implementation
  *     John Dallaway - support both IArchive and IBinary as input (#413)
+ *     John Dallaway - provide hex dump when no GNU tool factory (#416)
  *******************************************************************************/
 
 package org.eclipse.cdt.internal.ui.editor;
 
+import java.io.BufferedInputStream;
 import java.io.ByteArrayInputStream;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
 
+import org.apache.commons.io.HexDump;
 import org.eclipse.cdt.core.IBinaryParser;
 import org.eclipse.cdt.core.model.CoreModel;
 import org.eclipse.cdt.core.model.IArchive;
@@ -36,6 +44,7 @@
 import org.eclipse.core.resources.IStorage;
 import org.eclipse.core.resources.ResourcesPlugin;
 import org.eclipse.core.runtime.CoreException;
+import org.eclipse.core.runtime.IPath;
 import org.eclipse.core.runtime.PlatformObject;
 import org.eclipse.core.runtime.content.IContentType;
 import org.eclipse.jface.resource.ImageDescriptor;
@@ -54,7 +63,7 @@
 
 /**
  * A readonly editor to view binary files. This default implementation displays the GNU objdump output of the
- * binary as plain text. If no objdump output can be obtained, the binary content is displayed.
+ * binary as plain text. If no objdump output can be obtained, a hex dump is displayed.
  */
 public class DefaultBinaryFileEditor extends AbstractTextEditor implements IResourceChangeListener {
 
@@ -124,9 +133,10 @@ public IStorage getStorage() throws CoreException {
 			if (fStorage == null) {
 				IBinaryParser.IBinaryFile file = fBinary.getAdapter(IBinaryParser.IBinaryFile.class);
 				if (file != null) {
+					IPath filePath = file.getPath();
 					IGnuToolFactory factory = file.getBinaryParser().getAdapter(IGnuToolFactory.class);
 					if (factory != null) {
-						Objdump objdump = factory.getObjdump(file.getPath());
+						Objdump objdump = factory.getObjdump(filePath);
 						if (objdump != null) {
 							try {
 								// limit editor to X MB, if more - users should use objdump in command
@@ -141,11 +151,17 @@ public IStorage getStorage() throws CoreException {
 									System.arraycopy(message.getBytes(), 0, output, limitBytes - message.length(),
 											message.length());
 								}
-								fStorage = new FileStorage(new ByteArrayInputStream(output), file.getPath());
+								fStorage = new FileStorage(new ByteArrayInputStream(output), filePath);
 							} catch (IOException exc) {
 								CUIPlugin.log(exc);
 							}
 						}
+					} else { // provide a hex dump of the binary file in the absence of a GNU tool factory
+						try {
+							fStorage = new FileStorage(getHexDumpInputStream(filePath), filePath);
+						} catch (IOException e) {
+							CUIPlugin.log(e);
+						}
 					}
 				}
 				if (fStorage == null) {
@@ -159,6 +175,42 @@ public IStorage getStorage() throws CoreException {
 			}
 			return fStorage;
 		}
+
+		private InputStream getHexDumpInputStream(IPath filePath) throws IOException {
+			final PipedInputStream pipedInputStream = new PipedInputStream();
+			final OutputStream pipedOutputStream = new PipedOutputStream(pipedInputStream);
+			new Thread(() -> {
+				try {
+					writeHexDump(filePath, pipedOutputStream);
+				} catch (IOException e) {
+					CUIPlugin.log(e);
+				} finally {
+					try {
+						pipedOutputStream.close();
+					} catch (IOException e) {
+						CUIPlugin.log(e);
+					}
+				}
+			}).start();
+			return pipedInputStream;
+		}
+
+		private void writeHexDump(IPath filePath, OutputStream outputStream) throws IOException {
+			final int BYTES_PER_LINE = 16; // hard-coded in HexDump class - do not modify
+			try (InputStream fileStream = new BufferedInputStream(new FileInputStream(filePath.toFile()))) {
+				int offset = 0;
+				while (true) {
+					// read data for 64 complete lines of hex dump output (1 KiB buffer)
+					final byte[] buffer = fileStream.readNBytes(BYTES_PER_LINE * 64);
+					if (0 == buffer.length) { // end of file stream
+						break;
+					}
+					HexDump.dump(buffer, offset, outputStream, 0);
+					offset += buffer.length;
+				}
+			}
+		}
+
 	}
 
 	/**