BinEd - Binary / Hex Editor

User Manual for BinEd IntelliJ Plugin

Binary/hex editor plugin for IntelliJ Idea IDE and other IDEs based on IntelliJ Platform from JetBrains written in Java.

Features

• Visualize data as numerical (hexadecimal) codes and text representation
• Codes can be also binary, octal or decimal
• Support for Unicode, UTF-8 and other charsets
• Insert and overwrite edit modes
• Searching for text / hexadecimal code with matching highlighting
• Support for undo/redo
• Support for files with size up to exabytes

Application

Example look of the application's GUI:

For other variants please visit project's website:

https://bined.exbin.org

License

Project uses Apache License 2.0, see:

https://www.apache.org/licenses/LICENSE-2.0

Requirements

Plugin requires Jetbrains IntelliJ Platform application, latest version requires platform version 2022.2.1 or higher and Java 11.

Main aim is to support IntelliJ Platform IDEs, but other applications/IDEs using this platform should be also supported.

Installation

Choose one of the following options:

• In File/Settings/Plugins search for "bined" in Marketplace tab and press install button
• Use "Install plugin from disk" from additional actions menu (cog-gear icon) to install downloaded .zip file
• Unzip downloaded file into plugins directory to make it part of the IDE installation

Plugin is available in JetBrains Marketplace:

https://plugins.jetbrains.com/plugin/9339

Plugin is available for download on the project's website:

https://bined.exbin.org/intellij-plugin

How to Use

In IntelliJ-based IDE:

• Use "Open as Binary" action in toolbar of "File/Open" dialog or "Open In/Binary Editor" in project files context menu
• Use "View as Binary" action in context menu in variables/debug window
• Associate file extension with "Binary File" file type in Options/Editor/File Types
• Use "Byte-to-byte compare" in Compare files dialog
• Use "Edit as Binary" in column context menu in DB view

Main Window

Application consists of (from top to bottom):

• Toolbar strip with quick action buttons
• Main data area, optionally with content parsing panel on right side
• Optionally status bar showing currently selected encoding, cursor position and other states

Toolbar

Toolbar provides access to some of typically used actions.

• You can toggle code type between binary, octal, decimal and hexadecimal
• You can toggle visibility of unprintable characters
• Action to open options dialog
• Action to open online manual

Code Area

In basic mode, data are shown as matrix of numeric codes and also as regular text at the same time.

Optionally there is header, which represents position offset for the particular code on the given column.

Row starts optionally by row position. Row position can be represented by numbers in octal, decimal or hexadecimal base independent on code base.

Popup menu is available with actions which depends on which section of the code area was clicked on.

Parsing Panel

Content parsing panel provides analysis of the data at the cursor position.

Currently, only simple list of values is available. Values are updated when cursor in code area is moved.

It's possible to edit the values and overwrite content of the document on the cursor position with ENTER key.

Values panel supports options for big and little endian - this affects order of bytes for multibyte values.Support for signed and unsigned variants of some values - first bit is typically used for negativity sign.

Status Bar

Status bar is bottom section of the main window.

It has following 5 sections - from left to right:

Current Encoding

Left click cycles throw set list of encodings.

Popup menu provides ability to select specific encoding from the list or to manage it.

Document Size

Shows document size in specific code type and in brackets difference to size of the saved document.

If there is selection active in the document then it shows size of the selection to size of the document.

Tooltip shows document size in three numeral systems of base 8, 10 and 16.

Popup menu allows selecting code type or to copy the value.

Cursor Position

Shows current position of the cursor in the document as position in the document and position in the code.

If there is selection active in the document then it shows start and end position of the selection.

Tooltip shows cursor position in three numeral systems of base 8, 10 and 16.

Popup menu allows selecting code type or to copy the value.

Memory Mode

Shows currently used memory mode.

Modes are:

• Delta Memory Mode
• RAM Memory Mode
• Native File Mode

Tooltip shows full name of the memory mode.

Popup menu allows switching memory mode. This will close the document and reopen it in selected mode.

Edit Mode

Following edit modes are supported:

• RO - Document is in read-only mode and cannot be edited
• INS - In insert mode edit operation inserts data to current cursor position
• OVR - In overwrite mode edit operations replaces data at the current cursor position

It's possible to switch between insert and overwrite with single click on the status bar or with INSERT key

Editing File

File is show in code area as a sequence of codes and preview characters.

You can edit numerical codes, or you can edit preview characters via keyboard or using available actions.

You can select specific range of data with using mouse while holding left button or holding SHIFT button while moving in code area.

Edit Mode

Two modes are supported:

• Insert mode
• Overwrite mode

In insert mode entering new codes or charaters inserts space at the current cursor position to insert new data. Inserting data from clipboard inserts this data at the current position (making additional space).

In overwrite mode data are replaced at the current cursor position. Inserting data from clipboards replaces data at the current position and only extends file if not enough space is available.

Undo Support

If changes you made to the file is not what you wanted to do, you can revert some number of last edit operations you performed.

• Undo action reverts one operation
• Redo action performs again previously reverted operation

Tools and Actions

Go to Position

Use this action to move cursor to specific position:

Context Menu / Go To

You can specify position relative to current position, start or end of the document.Position can be specified in octal, decimal or hexadecimal base.

Edit Selection

Use this action to specify exact selection range:

Context Menu / Edit Selection

You can specify position relative to current position, start or end of the document.Position can be specified in octal, decimal or hexadecimal base.

Find or Replace Data

Use this action to find specific text or sequence of codes:

Context Menu / Find
Context Menu / Replace

This will open quick search bar:

You can enter searched text or data and toggle match case and highlighting mode buttons.

You can switch between multiple matches if found.

Options button opens dialog with additional options:

Insert Data Action

Use this action to insert data to current position:

Context Menu / Insert Data

Data will be inserted or will replace previous data depending on the current edit mode.

On left side there is list of available operations and on right side there are additional parameters and output preview.

Convert Data Action

Use this action to convert selected data or whole content into different form:

Context Menu / Convert Data

Data will be converted and replace previous data or into clipboard / new window.

On left side there is list of available operations and on right side there are additional parameters and output preview.

Bookmarks

Bookmarks allow to save specific position / range and mark them with color.

Bookmark functionality is accessible in main edit menu and provides list of quick access bookmarks to jump to and access to bookmarks manager.

Menu / Edit / Bookmark

First 10 bookmark records are available for quick access, so that they can be set, cleared and jump to with keyboard shortcuts.

• Ctrl/Meta 0..9 - jump to bookmark's start position
• Ctrl/Meta+Alt 0..9 - replaces bookmark to current cursor position
• Ctrl/Meta+Alt+Shift 0..9 - clears bookmark

Bookmarks manager allows to edit all bookmark records:

• Set start/end position and length
• Assign color to highlight background for specific bookmark

Macro

Support for macro operations allows to execute sequence of operations with single action.

Macro functionality is accessible in main edit menu and provides list of first 10 macro records, actions to control action sequence recording and macro manager.

Menu / Edit / Macro

Macro operation is sequence of steps available from fixed set of commands.

Syntax of command is: commandname(parameter1, .. parameterX)

Currently available commands are:

• key-press(T, oN), enter-key, backspace-key, delete-key
• caret-set, caret-move(D, oN)
• clipboard-cut, clipboard-copy, clipboard-copy-as-code, clipboard-paste, clipboard-paste-from-code, clipboard-delete
• selection-set, selection-update(D, oN), selection-select-all, selection-clear
• edit-operation-change
• search-find-text(T), search-find-again

Parameters can be number, text string or direction (UP, DOWN, LEFT, RIGHT, PAGE_UP, PAGE_DOWN, ROW_START, ROW_END, DOC_START, DOC_END, SWITCH_SECTION), some parameters are optional.

Macro manager allows to edit steps of macro records.

Compare Files Action

Use this action to compare content of two files:

Context Menu / Tools / Compare Files

Clipboard Content

Tool to show available content currently stored in system clipboard.

It provides list of available data flavors (variants of data representation) and allows to show available information about content.

Drag and Drop Content

Tool to show available content transferred by drag & drop operation.

It provides list of available data flavors (variants of data representation) and allows to show available information about content.

Print Document

Not available

Debug View

Use "View as Binary" action in context popup menu in variables view in debug window or inspect view.

As the IntelliJ platform uses different handling depending on runtime environment, there are separate handlers for different values available switchable in dropdown on the top of the debug view window.

• RAW value method - Should support string types for all programming languages
• Direct access - When methods for the particular language are available
• toString - Public toString methods provides access to value in some cases - could be limited or restricted
• GUI extractor - Extracts data from GUI tree invoking method to load more nodes to tree in the debugger panel - slow and can only load data in linear fashion

JavaValue (Java)

• simple values: boolean, byte, short, int, long, float, double, char
• arrays of: boolean, byte, short, int, long, float, double, char

PyDebugValue (Python)

• bytearray, bytes (String extraction)

PhpNavigatableValue (PHP)

• array of byte range values only

Cidr (C/C++)

• array of char, short, int, long (GUI extractor)

DotNetNamedValue (.NET)

• array of bool, byte, short, int, long (GUI extractor)

DlvXValue (GO)

• array of bool, (u)int, (u)int(8,16,32,64) (GUI extractor)

VariableView (Javascript)

• (u)int(8,16,32,64)array (GUI extractor)

View Options

Some display options for code area are accessible via View menu.

View modes

• Code Matrix - Show matrix of codes representing data of the file
• Text Preview - Show textual characters representing data using currently selected encoding
• Dual - Show both code matrix and text preview next to each other (default)

Code Type

• Binary - shows data as numbers of the base 2. This mode is useful to show actual bits of the data. Values are in range 0 - 11111111
• Decimal - Shows each data byte as decimal value in the range 0 - 255 in typical form which most people are used to
• Octal - Each byte is represented as three values of the base 8, therefore in range 0 - 377. Each figure represents up to 3 bits
• Hexadecimal - Most commonly used form for technical purposes as each byte is represented as two figures of base 16. Value 10 to 15 are shown as alphabet letters A to F which can be optionally of lower or upper case. Each figure represent 4 bits of data

Position Code Type

In left side of the code area there are shown position in the file. It's possible to choose code type for this position as octal, decimal or hexadecimal.

Hex Characters Case

In hex code type codes above 10 are shown as characters A to F. You can choose if this codes will be upper or lower case.

Show Unprintable Characters

Some characters don't have visual representation in the preview section. For example characters like:

• Space characters
• Tabulator character
• Carriage return / new line characters

This provides option to display substitute characters with different color instead to better visualize this particular characters.

Code Colorization

This option provides ability to display some codes with different colors.

Currently, only single mode is available:

• Control codes: 00h to 1Fh
• Upper codes: 80h to FFh

Choose Font

You can change font used in code area.

Options / Appearance / Text Font

You can select specific family of the font, size in pixels, style parameters like bold and italic.

In preview section you can see how the selected font will look, or you can enter other text of your choice there.

Encoding

Text preview section is showing data decoded to textual characters according to currently selected encoding. Method of conversion between RAW data and characters is described in so called encoding. Java supports universal UNICODE encodings as well as various ISO and platform specific encodings often tailored for specific country/language.

Encodings can be either fixed where single numeric code is represented as single character. Some encodings like for example UTF-8 uses codes with different length of codes to represent characters. Each character in textual preview section is decoded from particular position, therefore characters longer than single byte will overlap.

User can set list of encodings available for quick switching in encodings manager dialog.

It's possible to move/reorder encodings in the list and add another encoding.

Encodings can be filtered by name and/or country code.

Active encoding can be either selected by popup menu or cycled through by single click in the status bar.

Options Dialog

Main section provides options for overall look of the application. Application supports languages switching depending appropriate language plugin is available.

It's also possible to choose visual style of the application and tweak rendering options related to antialiasing and scaling.

Code Area

Code area section allows setting various options related to code area.

Maximum bytes per row allows setting how many codes / preview characters will be visible on the page.

In default mode (16) code area always shows 16 codes per row.

Alternative mode is to use (0) in which code area will fit as many codes per page to fit visible area.

Row position length parameters allows setting of behavior of row position codes.

In default mode (0, 0) row positions will have as many digits as needed for current size of the document.

Status Bar

Section for status bar allows to set same options as available in popup menu actions in status bar.

Layout

Multiple layout profiles are supported. You can define your own or use one from templates.

Layout options specify positions of the displayed data. Primary capability is to specify size and frequency of spacing between characters.

Decorations

Multiple decoration profiles are supported. You can define your own or use one from templates.

Decoration options allow specifying additional cosmetic entities, namely lines and shapes.

Colors

Multiple color profiles are supported. You can define your own or use one from templates.

It is possible to specify colors of text, background, decorations and make it specific for areas like selection or found matches.If color is not specified, default color from current Look and Feel is used.

Help

This online manual is available when clicking on Online Help in context menu or in toolbar.

About Dialog

You can show basic information about application with:

Context Menu / About

Participate in the Development

As the project is free and open source, you can participate in the development in many ways:

• Modify this manual / wiki page
• Report an issue or suggest a feature on GitHub
• Modify source codes of the editor and provide PR on GitHub

See. https://bined.exbin.org/?participate for more details.