Add Checkbox input support to python api

Author: spoonmilk

binaryninjaapi.h

@@ -2049,6 +2049,16 @@ namespace BinaryNinja {
 	*/
 	bool GetDirectoryNameInput(std::string& result, const std::string& prompt, const std::string& defaultName = "");
 
+	/*! Prompts the user for a checkbox input, and returns True if the checkbox is checked, otherwise returns False.
+		\ingroup interaction
+
+		\param[out] result Reference to the bool the result will be copied to
+		\param[in] prompt Prompt for the dialog
+		\param[in] title Title for the input popup when used in UI
+		\return Whether a checkbox input was successfully received
+	*/
+	bool GetCheckboxInput(bool& result, const std::string& prompt, const std::string& title);
+
 	/*! Prompts the user for a set of inputs specified in `fields` with given title.
 		The fields parameter is a list containing FieldInputFields
 
@@ -17086,6 +17096,7 @@ namespace BinaryNinja {
 		    const std::string& defaultName = "");
 		virtual bool GetDirectoryNameInput(
 		    std::string& result, const std::string& prompt, const std::string& defaultName = "");
+		virtual bool GetCheckboxInput(bool& result, const std::string& prompt, const std::string& title);
 		virtual bool GetFormInput(std::vector<FormInputField>& fields, const std::string& title) = 0;
 
 		virtual BNMessageBoxButtonResult ShowMessageBox(const std::string& title, const std::string& text,

binaryninjacore.h

@@ -3082,6 +3082,7 @@ extern "C"
 		bool (*getSaveFileNameInput)(
 		    void* ctxt, char** result, const char* prompt, const char* ext, const char* defaultName);
 		bool (*getDirectoryNameInput)(void* ctxt, char** result, const char* prompt, const char* defaultName);
+		bool (*getCheckboxInput)(void* ctxt, bool* result, const char* prompt, const char* title);
 		bool (*getFormInput)(void* ctxt, BNFormInputField* fields, size_t count, const char* title);
 		BNMessageBoxButtonResult (*showMessageBox)(
 		    void* ctxt, const char* title, const char* text, BNMessageBoxButtonSet buttons, BNMessageBoxIcon icon);
@@ -7311,6 +7312,7 @@ extern "C"
 	BINARYNINJACOREAPI bool BNGetSaveFileNameInput(
 	    char** result, const char* prompt, const char* ext, const char* defaultName);
 	BINARYNINJACOREAPI bool BNGetDirectoryNameInput(char** result, const char* prompt, const char* defaultName);
+	BINARYNINJACOREAPI bool BNGetCheckboxInput(bool* result, const char* prompt, const char* title);
 	BINARYNINJACOREAPI bool BNGetFormInput(BNFormInputField* fields, size_t count, const char* title);
 	BINARYNINJACOREAPI void BNFreeFormInputResults(BNFormInputField* fields, size_t count);
 	BINARYNINJACOREAPI BNMessageBoxButtonResult BNShowMessageBox(

interaction.cpp

@@ -188,6 +188,12 @@ bool InteractionHandler::GetDirectoryNameInput(string& result, const string& pro
 	return GetTextLineInput(result, prompt, "Select Directory");
 }
 
+bool InteractionHandler::GetCheckboxInput(bool& result, const std::string& prompt, const std::string& title)
+{
+	return GetCheckboxInput(result, prompt, "Select an option");
+}
+
+
 
 static void ShowPlainTextReportCallback(void* ctxt, BNBinaryView* view, const char* title, const char* contents)
 {
@@ -309,6 +315,12 @@ static bool GetDirectoryNameInputCallback(void* ctxt, char** result, const char*
 	return true;
 }
 
+static bool GetCheckboxInputCallback(void* ctxt, bool* result, const char* prompt, const char* title)
+{
+	InteractionHandler* handler = (InteractionHandler*)ctxt;
+	return handler->GetCheckboxInput(*result, prompt, title);
+}
+
 
 static bool GetFormInputCallback(void* ctxt, BNFormInputField* fieldBuf, size_t count, const char* title)
 {
@@ -460,6 +472,7 @@ void BinaryNinja::RegisterInteractionHandler(InteractionHandler* handler)
 	cb.getOpenFileNameInput = GetOpenFileNameInputCallback;
 	cb.getSaveFileNameInput = GetSaveFileNameInputCallback;
 	cb.getDirectoryNameInput = GetDirectoryNameInputCallback;
+	cb.getCheckboxInput = GetCheckboxInputCallback;
 	cb.getFormInput = GetFormInputCallback;
 	cb.showMessageBox = ShowMessageBoxCallback;
 	cb.openUrl = OpenUrlCallback;
@@ -589,6 +602,15 @@ bool BinaryNinja::GetDirectoryNameInput(string& result, const string& prompt, co
 	return true;
 }
 
+bool BinaryNinja::GetCheckboxInput(bool& result, const std::string& prompt, const std::string& title)
+{
+	bool* value = nullptr;
+	if (!BNGetCheckboxInput(value, prompt.c_str(), title.c_str()))
+		return false;
+	result = value;
+	return true;
+}
+
 
 bool BinaryNinja::GetFormInput(vector<FormInputField>& fields, const string& title)
 {

python/interaction.py

@@ -485,6 +485,54 @@ def result(self):
 	def result(self, value):
 		self._result = value
 
+class CheckBoxField:
+	"""
+	``CheckBoxField`` prompts the user to choose a yes/no option in a checkbox.
+	Result is stored in self.result as a boolean value.
+
+	:param str prompt: Prompt to be presented to the user
+	:param Optional[bool]: Optional boolean value for the default setting of the checkbox. \
+						   by default set to 'false'
+	"""
+	def __init__(self, prompt, default=None):
+		self._prompt = prompt
+		self._default = default
+		self._result = None
+
+	def _fill_core_struct(self, value):
+		value.type = FormInputFieldType.CheckBoxFormField
+		value.prompt = self._prompt
+		value.hasDefault = self._default is not None
+		if self._default is not None:
+			value.boolDefault = self._default
+
+	def _fill_core_result(self, value):
+		self._boolResult = value.result
+
+	@property
+	def prompt(self):
+		return self._prompt
+
+	@prompt.setter
+	def prompt(self, value):
+		self._prompt = value
+
+	@property
+	def result(self):
+		return self._result
+
+	@result.setter
+	def result(self, value):
+		self._result = value
+
+	@property
+	def default(self):
+		return self._default
+
+	@default.setter
+	def default(self, value):
+		self._default = value
+
 
 class InteractionHandler:
 	_interaction_handler = None
@@ -505,6 +553,7 @@ def __init__(self):
 		self._cb.getOpenFileNameInput = self._cb.getOpenFileNameInput.__class__(self._get_open_filename_input)
 		self._cb.getSaveFileNameInput = self._cb.getSaveFileNameInput.__class__(self._get_save_filename_input)
 		self._cb.getDirectoryNameInput = self._cb.getDirectoryNameInput.__class__(self._get_directory_name_input)
+		self._cb.getCheckboxInput = self._cb.getCheckboxInput.__class__(self._get_checkbox_input)
 		self._cb.getFormInput = self._cb.getFormInput.__class__(self._get_form_input)
 		self._cb.showMessageBox = self._cb.showMessageBox.__class__(self._show_message_box)
 		self._cb.openUrl = self._cb.openUrl.__class__(self._open_url)
@@ -714,6 +763,12 @@ def _get_form_input(self, ctxt, fields, count, title):
 					        default=fields[i].stringDefault if fields[i].hasDefault else None
 					    )
 					)
+				elif fields[i].type == FormInputFieldType.CheckBoxFormField:
+					field_objs.append(
+					    CheckBoxField(
+					        fields[i].prompt, default=fields[i].boolDefault if fields[i].hasDefault else None
+					    )
+					)
 				else:
 					field_objs.append(LabelField(fields[i].prompt))
 			if not self.get_form_input(field_objs, title):
@@ -1361,6 +1416,19 @@ def get_directory_name_input(prompt: str, default_name: str = ""):
 	core.free_string(value)
 	return result.decode("utf-8")
 
+def get_checkbox_input(prompt: str, title: str):
+	"""
+	``get_checkbox_input`` prompts the user for a checkbox input, and returns True if the checkbox is checked, otherwise returns False.
+	:param prompt: String to prompt with
+	:param title: Title of the window when executed in the UI
+	:rtype: bool indicating the state of the checkbox
+	"""
+	value = ctypes.c_bool()
+	if not core.BNGetCheckboxInput(value, prompt, title):
+		return None
+	result = value.value
+	assert result is not None
+	return result
 
 def get_form_input(fields, title):
 	"""

rust/src/interaction/handler.rs

@@ -27,6 +27,7 @@ pub fn register_interaction_handler<R: InteractionHandler>(custom: R) {
         getOpenFileNameInput: Some(cb_get_open_file_name_input::<R>),
         getSaveFileNameInput: Some(cb_get_save_file_name_input::<R>),
         getDirectoryNameInput: Some(cb_get_directory_name_input::<R>),
+        getCheckboxInput: None,
         getFormInput: Some(cb_get_form_input::<R>),
         showMessageBox: Some(cb_show_message_box::<R>),
         openUrl: Some(cb_open_url::<R>),