DBO: Expose GetChild/GetChildNames/FindChild

Author: CouleeApps

binaryninjaapi.h

@@ -22410,6 +22410,9 @@ namespace BinaryNinja {
 		Ref<Metadata> GetMetadata() const;
 		Ref<DatabaseObject> GetParent() const;
 		std::unordered_map<std::string, Ref<DatabaseObject>> GetChildren();
+		std::vector<std::string> GetChildNames();
+		std::optional<Ref<DatabaseObject>> GetChild(const std::string& key);
+		std::optional<Ref<DatabaseObject>> FindChild(const std::vector<std::string>& path);
 		std::vector<std::string> GetDependencies() const;
 	};
 

binaryninjacore.h

@@ -9131,6 +9131,9 @@ extern "C"
 	BINARYNINJACOREAPI BNMetadata* BNGetDatabaseObjectMetadata(BNDatabaseObject* object);
 	BINARYNINJACOREAPI BNDatabaseObject* BNGetDatabaseObjectParent(BNDatabaseObject* object);
 	BINARYNINJACOREAPI size_t BNGetDatabaseObjectChildren(BNDatabaseObject* object, char*** names, BNDatabaseObject*** objects);
+	BINARYNINJACOREAPI char** BNGetDatabaseObjectChildNames(BNDatabaseObject* object, size_t* count);
+	BINARYNINJACOREAPI BNDatabaseObject* BNGetDatabaseObjectChild(BNDatabaseObject* object, const char* key);
+	BINARYNINJACOREAPI BNDatabaseObject* BNFindDatabaseObjectChild(BNDatabaseObject* object, const char** path, size_t pathLength);
 	BINARYNINJACOREAPI char** BNGetDatabaseObjectDependencies(BNDatabaseObject* object, size_t* count);
 
 	BINARYNINJACOREAPI BNDiffState* BNNewDiffStateReference(BNDiffState* state);

merge.cpp

@@ -87,7 +87,43 @@ std::unordered_map<std::string, Ref<DatabaseObject>> DatabaseObject::GetChildren
 }
 
 
-// todo: expose GetChild() and friends
+std::vector<std::string> DatabaseObject::GetChildNames()
+{
+	size_t count = 0;
+	char** names = BNGetDatabaseObjectChildNames(m_object, &count);
+	std::vector<std::string> result = ParseStringList(names, count);
+	BNFreeStringList(names, count);
+	return result;
+}
+
+
+std::optional<Ref<DatabaseObject>> DatabaseObject::GetChild(const std::string& key)
+{
+	BNDatabaseObject* child = BNGetDatabaseObjectChild(m_object, key.c_str());
+	if (child)
+	{
+		return new DatabaseObject(child);
+	}
+	return std::nullopt;
+}
+
+
+std::optional<Ref<DatabaseObject>> DatabaseObject::FindChild(const std::vector<std::string>& path)
+{
+	std::vector<const char*> pathCStrs;
+	pathCStrs.reserve(path.size());
+	for (const auto& item : path)
+	{
+		pathCStrs.push_back(item.c_str());
+	}
+
+	BNDatabaseObject* child = BNFindDatabaseObjectChild(m_object, pathCStrs.data(), pathCStrs.size());
+	if (child)
+	{
+		return new DatabaseObject(child);
+	}
+	return std::nullopt;
+}
 
 
 std::vector<std::string> DatabaseObject::GetDependencies() const

python/database.py

@@ -431,6 +431,37 @@ def _generate_children(self) -> Dict[str, 'DatabaseObject']:
 			core.BNFreeDatabaseObjectList(objects, count)
 			core.BNFreeStringList(names, count)
 
+	@property
+	def child_names(self) -> List[str]:
+		"""Get list of child object names (read-only)"""
+		count = ctypes.c_size_t()
+		names = core.BNGetDatabaseObjectChildNames(self.handle, ctypes.byref(count))
+		try:
+			result = []
+			for i in range(0, count.value):
+				result.append(core.pyNativeStr(names[i]))
+			return result
+		finally:
+			core.BNFreeStringList(names, count.value)
+
+	def get_child(self, key: str) -> Optional['DatabaseObject']:
+		"""Get a single child object by key"""
+		handle = core.BNGetDatabaseObjectChild(self.handle, key)
+		if handle is None:
+			return None
+		return DatabaseObject(handle=handle)
+
+	def find_child(self, path: List[str]) -> Optional['DatabaseObject']:
+		"""Find a child object by following a path"""
+		path_array = (ctypes.c_char_p * len(path))()
+		for i, item in enumerate(path):
+			path_array[i] = item.encode('utf-8')
+
+		handle = core.BNFindDatabaseObjectChild(self.handle, path_array, len(path))
+		if handle is None:
+			return None
+		return DatabaseObject(handle=handle)
+
 	@property
 	def dependencies(self) -> List[str]:
 		"""Get list of dependencies for this database object (read-only)"""