Fix checkbox support in form API

Author: spoonmilk

binaryninjaapi.h

@@ -2049,15 +2049,21 @@ 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.
+	/*! Prompts the user for a checkbox input
 		\ingroup interaction
 
-		\param[out] result Reference to the bool the result will be copied to
+		\param[out] result Reference to the integer 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
+		\param[in] defaultChoice Default checkbox state (0 == unchecked, 1 == checked)
 		\return Whether a checkbox input was successfully received
 	*/
-	bool GetCheckboxInput(bool& result, const std::string& prompt, const std::string& title);
+	bool GetCheckboxInput(
+		int64_t& result,
+		const std::string& prompt,
+		const std::string& title,
+		const int64_t& defaultChoice
+	);
 
 	/*! Prompts the user for a set of inputs specified in `fields` with given title.
 		The fields parameter is a list containing FieldInputFields
@@ -17037,6 +17043,7 @@ namespace BinaryNinja {
 		static FormInputField SaveFileName(
 		    const std::string& prompt, const std::string& ext, const std::string& defaultName = "");
 		static FormInputField DirectoryName(const std::string& prompt, const std::string& defaultName = "");
+		static FormInputField Checkbox(const std::string& prompt, const bool& defaultChoice = false);
 	};
 
 	/*!
@@ -17096,7 +17103,13 @@ 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 GetCheckboxInput(
+			int64_t& result,
+			const std::string& prompt,
+			const std::string& title,
+			const int64_t
+			& defaultChoice = 0
+		);
 		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

@@ -3036,7 +3036,8 @@ extern "C"
 		ChoiceFormField,
 		OpenFileNameFormField,
 		SaveFileNameFormField,
-		DirectoryNameFormField
+		DirectoryNameFormField,
+		CheckboxFormField
 	} BNFormInputFieldType;
 
 	typedef struct BNFormInputField
@@ -3082,7 +3083,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 (*getCheckboxInput)(void* ctxt, int64_t* result, const char* prompt, const char* title, const int64_t* defaultChoice);
 		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);
@@ -7312,7 +7313,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 BNGetCheckboxInput(int64_t* result, const char* prompt, const char* title, const int64_t* defaultChoice);
 	BINARYNINJACOREAPI bool BNGetFormInput(BNFormInputField* fields, size_t count, const char* title);
 	BINARYNINJACOREAPI void BNFreeFormInputResults(BNFormInputField* fields, size_t count);
 	BINARYNINJACOREAPI BNMessageBoxButtonResult BNShowMessageBox(

interaction.cpp

@@ -111,6 +111,16 @@ FormInputField FormInputField::DirectoryName(const string& prompt, const string&
 	return result;
 }
 
+FormInputField FormInputField::Checkbox(const string& prompt, const bool& defaultChoice)
+{
+	FormInputField result;
+	result.type = CheckboxFormField;
+	result.prompt = prompt;
+	result.intDefault = defaultChoice;
+	result.hasDefault = true;
+	return result;
+}
+
 
 void InteractionHandler::ShowMarkdownReport(
     Ref<BinaryView> view, const string& title, const string& contents, const string& plainText)
@@ -188,9 +198,9 @@ 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)
+bool InteractionHandler::GetCheckboxInput(int64_t& result, const std::string& prompt, const std::string& title, const int64_t& defaultChoice)
 {
-	return GetCheckboxInput(result, prompt, "Select an option");
+	return BinaryNinja::GetCheckboxInput(result, prompt, "Select an option", defaultChoice);
 }
 
 
@@ -315,10 +325,10 @@ static bool GetDirectoryNameInputCallback(void* ctxt, char** result, const char*
 	return true;
 }
 
-static bool GetCheckboxInputCallback(void* ctxt, bool* result, const char* prompt, const char* title)
+static bool GetCheckboxInputCallback(void* ctxt, int64_t* result, const char* prompt, const char* title, const int64_t* defaultChoice)
 {
 	InteractionHandler* handler = (InteractionHandler*)ctxt;
-	return handler->GetCheckboxInput(*result, prompt, title);
+	return handler->GetCheckboxInput(*result, prompt, title, *defaultChoice);
 }
 
 
@@ -365,6 +375,9 @@ static bool GetFormInputCallback(void* ctxt, BNFormInputField* fieldBuf, size_t
 		case DirectoryNameFormField:
 			fields.push_back(FormInputField::DirectoryName(fieldBuf[i].prompt, fieldBuf[i].defaultName));
 			break;
+		case CheckboxFormField:
+			fields.push_back(FormInputField::Checkbox(fieldBuf[i].prompt, fieldBuf[i].intDefault));
+			break;
 		default:
 			fields.push_back(FormInputField::Label(fieldBuf[i].prompt));
 			break;
@@ -381,6 +394,7 @@ static bool GetFormInputCallback(void* ctxt, BNFormInputField* fieldBuf, size_t
 			case DirectoryNameFormField:
 				fields.back().stringDefault = fieldBuf[i].stringDefault;
 				break;
+			case CheckboxFormField:
 			case IntegerFormField:
 				fields.back().intDefault = fieldBuf[i].intDefault;
 				break;
@@ -411,6 +425,7 @@ static bool GetFormInputCallback(void* ctxt, BNFormInputField* fieldBuf, size_t
 		case DirectoryNameFormField:
 			fieldBuf[i].stringResult = BNAllocString(fields[i].stringResult.c_str());
 			break;
+		case CheckboxFormField:
 		case IntegerFormField:
 			fieldBuf[i].intResult = fields[i].intResult;
 			break;
@@ -602,13 +617,9 @@ 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 BinaryNinja::GetCheckboxInput(int64_t& result, const std::string& prompt, const std::string& title, const int64_t& defaultChoice)
 {
-	bool* value = nullptr;
-	if (!BNGetCheckboxInput(value, prompt.c_str(), title.c_str()))
-		return false;
-	result = value;
-	return true;
+	return BNGetCheckboxInput(&result, prompt.c_str(), title.c_str(), &defaultChoice);
 }
 
 
@@ -657,6 +668,8 @@ bool BinaryNinja::GetFormInput(vector<FormInputField>& fields, const string& tit
 			case DirectoryNameFormField:
 				fieldBuf[i].stringDefault = fields[i].stringDefault.c_str();
 				break;
+			case CheckboxFormField:
+				fieldBuf[i].intDefault = fields[i].intDefault;
 			case IntegerFormField:
 				fieldBuf[i].intDefault = fields[i].intDefault;
 				break;
@@ -700,6 +713,7 @@ bool BinaryNinja::GetFormInput(vector<FormInputField>& fields, const string& tit
 		case DirectoryNameFormField:
 			fields[i].stringResult = fieldBuf[i].stringResult;
 			break;
+		case CheckboxFormField:
 		case IntegerFormField:
 			fields[i].intResult = fieldBuf[i].intResult;
 			break;

python/interaction.py

@@ -485,29 +485,30 @@ def result(self):
 	def result(self, value):
 		self._result = value
 
-class CheckBoxField:
+class CheckboxField:
 	"""
-	``CheckBoxField`` prompts the user to choose a yes/no option in a checkbox.
+	``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'
+	:param bool default: Default state of the checkbox (False == unchecked, True == checked)
 	"""
-	def __init__(self, prompt, default=None):
+	def __init__(self, prompt, default):
 		self._prompt = prompt
-		self._default = default
 		self._result = None
+		self._default = default
 
 	def _fill_core_struct(self, value):
-		value.type = FormInputFieldType.CheckBoxFormField
+		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
+		value.hasDefault = True
+		value.intDefault = 1 if self._default else 0
 
 	def _fill_core_result(self, value):
-		self._boolResult = value.result
+		value.intResult = 1 if self.result else 0
+
+	def _get_result(self, value):
+		self._result = value.intResult != 0
 
 	@property
 	def prompt(self):
@@ -699,6 +700,16 @@ def _get_directory_name_input(self, ctxt, result, prompt, default_name):
 		except:
 			log_error(traceback.format_exc())
 
+	def _get_checkbox_input(self, ctxt, result, prompt, default_choice):
+		try:
+			value = self.get_checkbox_input(prompt, default_choice)
+			if value is None:
+				return False
+			result[0] = value
+			return True
+		except:
+			log_error(traceback.format_exc())
+
 	def _get_form_input(self, ctxt, fields, count, title):
 		try:
 			field_objs = []
@@ -763,10 +774,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:
+				elif fields[i].type == FormInputFieldType.CheckboxFormField:
+					log_error(fields[i].hasDefault)
 					field_objs.append(
-					    CheckBoxField(
-					        fields[i].prompt, default=fields[i].boolDefault if fields[i].hasDefault else None
+					    CheckboxField(
+					        fields[i].prompt,
+							default=fields[i].intDefault != 0 if fields[i].hasDefault else None
 					    )
 					)
 				else:
@@ -850,6 +863,9 @@ def get_save_filename_input(self, prompt, ext, default_name):
 	def get_directory_name_input(self, prompt, default_name):
 		return get_text_line_input(prompt, "Select Directory")
 
+	def get_checkbox_input(self, prompt, default_choice):
+		return get_checkbox_input(prompt, "Choose Option(s)", default_choice)
+
 	def get_form_input(self, fields, title):
 		return False
 
@@ -1416,19 +1432,22 @@ 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):
+def get_checkbox_input(prompt: str, title: str, default: bool = False):
 	"""
-	``get_checkbox_input`` prompts the user for a checkbox input, and returns True if the checkbox is checked, otherwise returns False.
+	``get_checkbox_input`` prompts the user for a checkbox input
 	:param prompt: String to prompt with
 	:param title: Title of the window when executed in the UI
+	:param default: Optional default state for the checkbox (false == unchecked, true == checked), False if not set.
 	:rtype: bool indicating the state of the checkbox
 	"""
-	value = ctypes.c_bool()
-	if not core.BNGetCheckboxInput(value, prompt, title):
+	default_state = ctypes.c_int64()
+	default_state.value = 1 if default else 0
+	value = ctypes.c_int64()
+	if not core.BNGetCheckboxInput(value, prompt, title, default_state):
 		return None
 	result = value.value
 	assert result is not None
-	return result
+	return result != 0
 
 def get_form_input(fields, title):
 	"""
@@ -1450,6 +1469,7 @@ def get_form_input(fields, title):
 	OpenFileNameField     Prompt for file to open
 	SaveFileNameField     Prompt for file to save to
 	DirectoryNameField    Prompt for directory name
+	CheckboxFormField     Prompt for a checkbox
 	===================== ===================================================
 
 	This API is flexible and works both in the UI via a pop-up dialog and on the command-line.

rust/src/interaction/form.rs

@@ -112,6 +112,11 @@ pub enum FormInputField {
         default: Option<String>,
         value: Option<String>,
     },
+    Checkbox {
+        prompt: String,
+        default: Option<bool>,
+        value: bool,
+    },
 }
 
 impl FormInputField {
@@ -130,6 +135,7 @@ impl FormInputField {
         let int_default = value.hasDefault.then_some(value.intDefault);
         let address_default = value.hasDefault.then_some(value.addressDefault);
         let index_default = value.hasDefault.then_some(value.indexDefault);
+        let bool_default = value.hasDefault.then_some(value.intResult != 0);
         let extension = raw_to_string(value.ext);
         let current_address = value.currentAddress;
         let string_result = raw_to_string(value.stringResult);
@@ -186,6 +192,11 @@ impl FormInputField {
                 default: string_default,
                 value: string_result,
             },
+            BNFormInputFieldType::CheckboxFormField => Self::Checkbox {
+                prompt,
+                default: bool_default,
+                value: value.intResult != 0,
+            },
         }
     }
 
@@ -258,6 +269,7 @@ impl FormInputField {
             FormInputField::OpenFileName { .. } => BNFormInputFieldType::OpenFileNameFormField,
             FormInputField::SaveFileName { .. } => BNFormInputFieldType::SaveFileNameFormField,
             FormInputField::DirectoryName { .. } => BNFormInputFieldType::DirectoryNameFormField,
+            FormInputField::Checkbox { .. } => BNFormInputFieldType::CheckboxFormField,
         }
     }
 
@@ -274,6 +286,7 @@ impl FormInputField {
             FormInputField::OpenFileName { prompt, .. } => Some(prompt.clone()),
             FormInputField::SaveFileName { prompt, .. } => Some(prompt.clone()),
             FormInputField::DirectoryName { prompt, .. } => Some(prompt.clone()),
+            FormInputField::Checkbox { prompt, .. } => Some(prompt.clone()),
         }
     }
 
@@ -325,6 +338,7 @@ impl FormInputField {
             FormInputField::OpenFileName { default, .. } => Some(default.is_some()),
             FormInputField::SaveFileName { default, .. } => Some(default.is_some()),
             FormInputField::DirectoryName { default, .. } => Some(default.is_some()),
+            FormInputField::Checkbox { default, .. } => Some(default.is_some()),
         }
     }