Make RLDES passed to Register instead of a property

Author: CouleeApps

binaryninjaapi.h

@@ -19109,8 +19109,9 @@ namespace BinaryNinja {
 		/*! Register a custom Render Layer.
 
 			\param layer Render Layer to register
+			\param enableState Whether the layer should be enabled by default
 		*/
-		static void Register(RenderLayer* layer);
+		static void Register(RenderLayer* layer, BNRenderLayerDefaultEnableState enableState = DisabledByDefaultRenderLayerDefaultEnableState);
 
 		/*! Get the list of all currently registered Render Layers.
 
@@ -19137,13 +19138,6 @@ namespace BinaryNinja {
 		 */
 		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

@@ -8144,13 +8144,12 @@ extern "C"
 	BINARYNINJACOREAPI void BNFreeLineFormatterSettings(BNLineFormatterSettings* settings);
 
 	// Render Layers
-	BINARYNINJACOREAPI BNRenderLayer* BNRegisterRenderLayer(const char* name, BNRenderLayerCallbacks* callbacks);
+	BINARYNINJACOREAPI BNRenderLayer* BNRegisterRenderLayer(const char* name, BNRenderLayerCallbacks* callbacks, BNRenderLayerDefaultEnableState enableState);
 	BINARYNINJACOREAPI BNRenderLayer** BNGetRenderLayerList(size_t* count);
 	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

@@ -81,6 +81,7 @@ class StackRenderLayer: public RenderLayer
 		std::vector<DisassemblyTextLine>& lines
 	) override
 	{
+		// Break this out into a helper so we don't have to write it twice
 		ApplyToLines(block, lines);
 	}
 
@@ -89,6 +90,7 @@ class StackRenderLayer: public RenderLayer
 		std::vector<DisassemblyTextLine>& lines
 	) override
 	{
+		// Break this out into a helper so we don't have to write it twice
 		ApplyToLines(block, lines);
 	}
 };
@@ -100,8 +102,7 @@ extern "C" {
 	BINARYNINJAPLUGIN bool CorePluginInit()
 	{
 		static StackRenderLayer* layer = new StackRenderLayer();
-		RenderLayer::Register(layer);
-		layer->SetDefaultEnableState(AlwaysEnabledRenderLayerDefaultEnableState);
+		RenderLayer::Register(layer, DisabledByDefaultRenderLayerDefaultEnableState);
 		return true;
 	}
 }

python/renderlayer.py

@@ -91,8 +91,7 @@ def register(cls):
 		layer._cb.applyToFlowGraph = layer._cb.applyToFlowGraph.__class__(layer._apply_to_flow_graph)
 		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)
+		layer.handle = core.BNRegisterRenderLayer(layer.__class__.name, layer._cb, layer.default_enable_state)
 		handle_ptr = ctypes.cast(layer.handle, ctypes.c_void_p)
 		cls._registered_instances[handle_ptr.value] = layer
 

renderlayer.cpp

@@ -77,14 +77,14 @@ void RenderLayer::FreeLinesCallback(void* ctxt, BNLinearDisassemblyLine* lines,
 }
 
 
-void RenderLayer::Register(RenderLayer* layer)
+void RenderLayer::Register(RenderLayer* layer, BNRenderLayerDefaultEnableState enableState)
 {
 	BNRenderLayerCallbacks cb;
 	cb.context = (void*)layer;
 	cb.applyToFlowGraph = ApplyToFlowGraphCallback;
 	cb.applyToLinearViewObject = ApplyToLinearViewObjectCallback;
 	cb.freeLines = FreeLinesCallback;
-	layer->m_object = BNRegisterRenderLayer(layer->m_nameForRegister.c_str(), &cb);
+	layer->m_object = BNRegisterRenderLayer(layer->m_nameForRegister.c_str(), &cb, enableState);
 	g_registeredInstances[layer->m_object] = layer;
 }
 
@@ -129,12 +129,6 @@ BNRenderLayerDefaultEnableState RenderLayer::GetDefaultEnableState() const
 }
 
 
-void RenderLayer::SetDefaultEnableState(BNRenderLayerDefaultEnableState state)
-{
-	BNSetRenderLayerDefaultEnableState(m_object, state);
-}
-
-
 std::string RenderLayer::GetName() const
 {
 	char* name = BNGetRenderLayerName(m_object);

rust/src/render_layer.rs

@@ -11,10 +11,13 @@ use binaryninjacore_sys::*;
 use std::ffi::{c_char, c_void};
 use std::ptr::NonNull;
 
+pub type RenderLayerDefaultEnableState = BNRenderLayerDefaultEnableState;
+
 /// Register a [`RenderLayer`] with the API.
 pub fn register_render_layer<S: BnStrCompatible, T: RenderLayer>(
     name: S,
     render_layer: T,
+    enable_state: RenderLayerDefaultEnableState,
 ) -> (&'static mut T, CoreRenderLayer) {
     let render_layer = Box::leak(Box::new(render_layer));
     let mut callback = BNRenderLayerCallbacks {
@@ -27,6 +30,7 @@ pub fn register_render_layer<S: BnStrCompatible, T: RenderLayer>(
         BNRegisterRenderLayer(
             name.into_bytes_with_nul().as_ref().as_ptr() as *const _,
             &mut callback,
+            enable_state,
         )
     };
     let core = CoreRenderLayer::from_raw(NonNull::new(result).unwrap());
@@ -244,8 +248,6 @@ pub struct CoreRenderLayer {
     pub(crate) handle: NonNull<BNRenderLayer>,
 }
 
-pub type RenderLayerDefaultEnableState = BNRenderLayerDefaultEnableState;
-
 impl CoreRenderLayer {
     pub fn from_raw(handle: NonNull<BNRenderLayer>) -> Self {
         Self { handle }
@@ -267,10 +269,6 @@ impl CoreRenderLayer {
         unsafe { BNGetRenderLayerDefaultEnableState(self.handle.as_ptr()) }
     }
 
-    pub fn set_default_enable_state(&self, enable_state: RenderLayerDefaultEnableState) {
-        unsafe { BNSetRenderLayerDefaultEnableState(self.handle.as_ptr(), enable_state) }
-    }
-
     pub fn apply_to_flow_graph(&self, graph: &FlowGraph) {
         unsafe { BNApplyRenderLayerToFlowGraph(self.handle.as_ptr(), graph.handle) }
     }