Changes related to display as/type toggling.

Author: fuzyll

binaryninjacore.h

@@ -1097,6 +1097,8 @@ extern "C"
 		DoubleDisplayType,
 		EnumerationDisplayType,
 		InvertedCharacterConstantDisplayType,
+		UnsignedComplementDecimalDisplayType,
+		UnsignedComplementHexadecimalDisplayType,
 	};
 
 	BN_ENUM(uint8_t, BNFlowGraphOption)

docs/guide/migration/migrationguideida.md

@@ -44,6 +44,7 @@ Some major exceptions are:
     - `T` for Types
     - `H` to toggle to/from Hex View
     - `[TAB]` to toggle to/from disassembly
+- IDA's `H` hotkey toggles integer display between hexadecimal and decimal. In Binary Ninja, `H` opens the Hex View and `0` toggles integer display between hexadecimal and decimal.
 
 ## Cross-References
 

docs/guide/types/type.md

@@ -9,6 +9,8 @@ The simplest way to directly manipulate types in disassembly is by viewing an ex
  - `1`, `2`, `4`, `8`: The number hotkeys will create a data variable at the current location if none exists, and then change the size of the variable to an integer in the size of bytes specified in the hotkey.
  - `d`: If you want to cycle through the different integer sizes, repeatedly pressing `d` has the same effect as pressing the numbers in order.
  - `-`: To quickly toggle integers between signed and unsigned integers, you can use the `-` hotkey.
+ - `0`: To quickly toggle integer display between hexadecimal and decimal, you can use the `0` hotkey.
+ - `~`: To quickly toggle integer display between normal and bitwise complement, you can use the `~` hotkey.
  - `a`: This hotkey sets or creates the current variable to a character array up until and including the next null byte.
  - `o`: `o` will set or create the current variable to be a pointer reference.
  - `*`: If you have a selection of identical variables, `*` will convert them into an array of elements. If you have no selection, the "Create Array" dialog will be shown allowing you to create an array of specific type and count at the current location.

python/function.py

@@ -4181,6 +4181,17 @@ def add_stack_var_reference_tokens(
 	def is_integer_token(token: 'InstructionTextToken') -> bool:
 		return core.BNIsIntegerToken(token.type)
 
+	@staticmethod
+	def get_display_string_for_integer(
+	    binary_view: Optional['binaryview.BinaryView'], display_type: IntegerDisplayType, value: int, input_width: int,
+	    is_signed: bool = True
+	) -> str:
+		if isinstance(display_type, str):
+			display_type = IntegerDisplayType[display_type]
+		return core.BNGetDisplayStringForInteger(
+			binary_view.handle if binary_view is not None else None, display_type, value, input_width, is_signed
+		)
+
 	def add_integer_token(
 	    self, tokens: List['InstructionTextToken'], int_token: 'InstructionTextToken', addr: int,
 	    arch: Optional['architecture.Architecture'] = None

python/types.py

@@ -32,7 +32,7 @@
 	TypeReferenceType, MemberAccess, MemberScope, TypeDefinitionLineType,
 	TokenEscapingType,
 	NameType, PointerSuffix, PointerBaseType,
-	Endianness
+	Endianness, IntegerDisplayType
 )
 from . import callingconvention
 from . import function as _function
@@ -903,6 +903,15 @@ def signed(self, value: BoolWithConfidenceType) -> None:
 		_value = BoolWithConfidence.get_core_struct(value)
 		core.BNTypeBuilderSetSigned(self._handle, _value)
 
+	@property
+	def display_type(self) -> IntegerDisplayType:
+		"""Integer display type for this type."""
+		return core.BNGetIntegerTypeDisplayType(self.immutable_copy().handle)
+
+	@display_type.setter
+	def display_type(self, value: IntegerDisplayType) -> None:
+		core.BNSetIntegerTypeDisplayType(self._handle, value)
+
 	@property
 	def children(self) -> List['TypeBuilder']:
 		return []
@@ -2145,6 +2154,11 @@ def attributes(self) -> Dict[str, str]:
 		core.BNFreeTypeAttributeList(attributes, count.value)
 		return result
 
+	@property
+	def display_type(self) -> IntegerDisplayType:
+		"""Integer display type for this type."""
+		return core.BNGetIntegerTypeDisplayType(self._handle)
+
 	def _to_core_struct(self) -> core.BNTypeWithConfidence:
 		type_conf = core.BNTypeWithConfidence()
 		type_conf.type = self._handle

rust/src/types.rs

@@ -171,6 +171,11 @@ impl TypeBuilder {
         self
     }
 
+    pub fn set_integer_display_type(&self, display_type: IntegerDisplayType) -> &Self {
+        unsafe { BNSetIntegerTypeDisplayType(self.handle, display_type) };
+        self
+    }
+
     // Readable properties
 
     pub fn type_class(&self) -> TypeClass {
@@ -689,6 +694,10 @@ impl Type {
         unsafe { BNIsTypeSigned(self.handle).into() }
     }
 
+    pub fn integer_display_type(&self) -> IntegerDisplayType {
+        unsafe { BNGetIntegerTypeDisplayType(self.handle) }
+    }
+
     pub fn is_const(&self) -> Conf<bool> {
         unsafe { BNIsTypeConst(self.handle).into() }
     }

ui/linearview.h

@@ -399,6 +399,7 @@ private Q_SLOTS:
 	void makeString(size_t charSize = 1);
 	void changeType(const UIActionContext& context);
 	void undefineInRange();
+	BNIntegerDisplayType getCurrentDisplayAs(const UIActionContext& context) override;
 	void displayAs(const UIActionContext& context, BNIntegerDisplayType displayType) override;
 	void createStructOrInferStructureType();
 	bool autoCreateArray();

ui/tokenizedtextview.h

@@ -150,6 +150,7 @@ class BINARYNINJAUIAPI TokenizedTextView :
 	virtual BinaryNinja::Ref<HistoryEntry> getHistoryEntry() override;
 	void populateDefaultHistoryEntry(TokenizedTextViewHistoryEntry* entry);
 	virtual void navigateToHistoryEntry(BinaryNinja::Ref<HistoryEntry> entry) override;
+	virtual bool canDisplayAs(const UIActionContext& context, const BNIntegerDisplayType displayType) override;
 
 	virtual void OnBinaryDataWritten(BinaryNinja::BinaryView* data, uint64_t offset, size_t len) override;
 	virtual void OnBinaryDataInserted(BinaryNinja::BinaryView* data, uint64_t offset, size_t len) override;

ui/util.h

@@ -22,7 +22,13 @@ std::string BINARYNINJAUIAPI getStringForRegisterValue(ArchitectureRef arch, Bin
 std::string BINARYNINJAUIAPI getPossibleValueSetStateName(BNRegisterValueType state);
 std::string BINARYNINJAUIAPI getStringForIntegerValue(int64_t value);
 std::string BINARYNINJAUIAPI getStringForUIntegerValue(uint64_t value);
+bool BINARYNINJAUIAPI canDisplayIntegerTokenAs(const HighlightTokenState& token, BNIntegerDisplayType displayType);
 BNIntegerDisplayType BINARYNINJAUIAPI getInvertedIntegerDisplayType(BNIntegerDisplayType displayType, const std::string& text);
+BNIntegerDisplayType BINARYNINJAUIAPI getToggledIntegerRadixDisplayType(BNIntegerDisplayType displayType, const std::string& text);
+BNIntegerDisplayType BINARYNINJAUIAPI getToggledIntegerComplementDisplayType(BNIntegerDisplayType displayType, const std::string& text);
+TypeRef BINARYNINJAUIAPI getIntegerTypePreservingDisplay(TypeRef type, size_t width, BinaryNinja::Confidence<bool> isSigned);
+TypeRef BINARYNINJAUIAPI getIntegerTypeWithWidthPreservingAttributes(TypeRef type, size_t width);
+TypeRef BINARYNINJAUIAPI getIntegerTypeWithSignPreservingAttributes(TypeRef type, BinaryNinja::Confidence<bool> isSigned);
 std::string BINARYNINJAUIAPI getStringForPossibleValueSet(ArchitectureRef arch, const BinaryNinja::PossibleValueSet& values, bool pretty = true);
 std::string BINARYNINJAUIAPI getStringForInstructionDataflowDetails(BinaryViewRef data, ArchitectureRef arch, FunctionRef func, uint64_t address);
 std::optional<BinaryNinja::PossibleValueSet> BINARYNINJAUIAPI getPossibleValueSetForToken(View* view, BinaryViewRef data, ArchitectureRef arch,

ui/viewframe.h

@@ -210,6 +210,7 @@ class BINARYNINJAUIAPI View
 	virtual void writeData(const BinaryNinja::DataBuffer& data, uint64_t addr);
 
 	virtual bool canDisplayAs(const UIActionContext& context, const BNIntegerDisplayType);
+	virtual BNIntegerDisplayType getCurrentDisplayAs(const UIActionContext& context);
 	virtual void displayAs(const UIActionContext& context, BNIntegerDisplayType type);
 
 	virtual BinaryNinja::Ref<HistoryEntry> getHistoryEntry();