Default enable state setting

Author: CouleeApps

binaryninjaapi.h

@@ -19131,6 +19131,19 @@ namespace BinaryNinja {
 		*/
 		std::string GetName() const;
 
+		/*! Get whether the Render Layer is enabled by default
+
+			\return Default enable state
+		 */
+		BNRenderLayerDefaultEnableState GetDefaultEnableState() const;
+
+		/*! Set whether the Render Layer is enabled by default.
+			Defaults to Disabled by Default
+
+			\param state New default enable state
+		 */
+		void SetDefaultEnableState(BNRenderLayerDefaultEnableState state);
+
 		/*! Apply this Render Layer to a single Basic Block of Disassembly lines.
 			Subclasses should modify the input `lines` list to make modifications to
 			the presentation of the block.

binaryninjacore.h

@@ -37,7 +37,7 @@
 // Current ABI version for linking to the core. This is incremented any time
 // there are changes to the API that affect linking, including new functions,
 // new types, or modifications to existing functions or types.
-#define BN_CURRENT_CORE_ABI_VERSION 89
+#define BN_CURRENT_CORE_ABI_VERSION 90
 
 // Minimum ABI version that is supported for loading of plugins. Plugins that
 // are linked to an ABI version less than this will not be able to load and
@@ -3580,6 +3580,13 @@ extern "C"
 		void (*freeLines)(void* ctxt, BNLinearDisassemblyLine* lines, size_t count);
 	} BNRenderLayerCallbacks;
 
+	typedef enum BNRenderLayerDefaultEnableState
+	{
+		DisabledByDefaultRenderLayerDefaultEnableState,
+		EnabledByDefaultRenderLayerDefaultEnableState,
+		AlwaysEnabledRenderLayerDefaultEnableState,
+	} BNRenderLayerDefaultEnableState;
+
 	BINARYNINJACOREAPI char* BNAllocString(const char* contents);
 	BINARYNINJACOREAPI char* BNAllocStringWithLength(const char* contents, size_t len);
 	BINARYNINJACOREAPI void BNFreeString(char* str);
@@ -8142,6 +8149,8 @@ extern "C"
 	BINARYNINJACOREAPI void BNFreeRenderLayerList(BNRenderLayer** renderLayers);
 	BINARYNINJACOREAPI BNRenderLayer* BNGetRenderLayerByName(const char* name);
 	BINARYNINJACOREAPI char* BNGetRenderLayerName(BNRenderLayer* renderLayer);
+	BINARYNINJACOREAPI BNRenderLayerDefaultEnableState BNGetRenderLayerDefaultEnableState(BNRenderLayer* renderLayer);
+	BINARYNINJACOREAPI void BNSetRenderLayerDefaultEnableState(BNRenderLayer* renderLayer, BNRenderLayerDefaultEnableState state);
 
 	BINARYNINJACOREAPI void BNApplyRenderLayerToFlowGraph(BNRenderLayer* renderLayer, BNFlowGraph* graph);
 	BINARYNINJACOREAPI void BNApplyRenderLayerToLinearViewObject(

plugins/stack_render_layer/plugin.cpp

@@ -101,6 +101,7 @@ extern "C" {
 	{
 		static StackRenderLayer* layer = new StackRenderLayer();
 		RenderLayer::Register(layer);
+		layer->SetDefaultEnableState(AlwaysEnabledRenderLayerDefaultEnableState);
 		return true;
 	}
 }

python/examples/args_render_layer.py

@@ -6,7 +6,7 @@
     MediumLevelILCallSsa, MediumLevelILVarSsa, MediumLevelILConstBase, \
     MediumLevelILInstruction, MediumLevelILTailcallSsa, MediumLevelILOperation, \
     MediumLevelILVarPhi, log_debug, RenderLayer, BasicBlock, InstructionTextTokenType, FlowGraph, \
-    LinearViewObject, LinearDisassemblyLine
+    LinearViewObject, LinearDisassemblyLine, RenderLayerDefaultEnableState
 
 """
 Render Layer that shows you where the arguments to calls are set.
@@ -167,6 +167,7 @@ def apply_to_lines(lines, get_instr, renderer):
                         comment = f"Tailcall at {llil_instr.address:#x}"
                     else:
                         comment = f"Call at {llil_instr.address:#x}"
+                    # Creating comments is a bit unwieldy at the moment
                     renderer.wrap_comment(new_lines, line, comment, False, "  ", "")
                     for j, token in enumerate(line.tokens):
                         if token.type == InstructionTextTokenType.AddressSeparatorToken:
@@ -184,12 +185,14 @@ def apply_to_lines(lines, get_instr, renderer):
 
 class ArgumentsRenderLayer(RenderLayer):
     name = "Annotate Call Parameters"
+    default_enable_state = RenderLayerDefaultEnableState.EnabledByDefaultRenderLayerDefaultEnableState
 
     def apply_to_disassembly_block(
             self,
             block: BasicBlock,
             lines: List['DisassemblyTextLine']
     ):
+        # Break this out into a helper so we don't have to write it twice
         renderer = DisassemblyTextRenderer(block.function)
         return apply_to_lines(lines, lambda line: block.function.get_llil_at(line.address), renderer)
 
@@ -198,6 +201,7 @@ def apply_to_low_level_il_block(
             block: BasicBlock,
             lines: List['DisassemblyTextLine']
     ):
+        # Break this out into a helper so we don't have to write it twice
         renderer = DisassemblyTextRenderer(block.function)
         return apply_to_lines(lines, lambda line: line.il_instruction, renderer)
 

python/renderlayer.py

@@ -24,7 +24,7 @@
 # Binary Ninja components
 import binaryninja
 from . import _binaryninjacore as core, LinearDisassemblyLine
-from .enums import LinearDisassemblyLineType
+from .enums import LinearDisassemblyLineType, RenderLayerDefaultEnableState
 from . import binaryview
 from . import types
 from .log import log_error
@@ -64,13 +64,15 @@ class RenderLayer(metaclass=_RenderLayerMetaclass):
 	"""
 
 	name = None
+	default_enable_state = RenderLayerDefaultEnableState.DisabledByDefaultRenderLayerDefaultEnableState
 	_registered_instances = {}
 	_pending_lines = {}
 
 	def __init__(self, handle=None):
 		if handle is not None:
 			self.handle = core.handle_of_type(handle, core.BNRenderLayer)
 			self.__dict__["name"] = core.BNGetRenderLayerName(handle)
+			self.__dict__["default_enable_state"] = core.BNGetRenderLayerDefaultEnableState(handle)
 		else:
 			self.handle = None
 
@@ -90,6 +92,7 @@ def register(cls):
 		layer._cb.applyToLinearViewObject = layer._cb.applyToLinearViewObject.__class__(layer._apply_to_linear_view_object)
 		layer._cb.freeLines = layer._cb.freeLines.__class__(layer._free_lines)
 		layer.handle = core.BNRegisterRenderLayer(layer.__class__.name, layer._cb)
+		core.BNSetRenderLayerDefaultEnableState(layer.handle, layer.default_enable_state)
 		handle_ptr = ctypes.cast(layer.handle, ctypes.c_void_p)
 		cls._registered_instances[handle_ptr.value] = layer
 

renderlayer.cpp

@@ -123,6 +123,18 @@ Ref<RenderLayer> RenderLayer::GetByName(const std::string& name)
 }
 
 
+BNRenderLayerDefaultEnableState RenderLayer::GetDefaultEnableState() const
+{
+	return BNGetRenderLayerDefaultEnableState(m_object);
+}
+
+
+void RenderLayer::SetDefaultEnableState(BNRenderLayerDefaultEnableState state)
+{
+	BNSetRenderLayerDefaultEnableState(m_object, state);
+}
+
+
 std::string RenderLayer::GetName() const
 {
 	char* name = BNGetRenderLayerName(m_object);