From 3d3b803d18f0d61b5e36367c9eb660b234cdc66e Mon Sep 17 00:00:00 2001
From: Peter LaFosse <peter@vector35.com>
Date: Wed, 12 Jul 2017 16:04:28 -0400
Subject: Metadata enhancements. Metadata objects are now serialized to the DB

---
 python/binaryview.py | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)

(limited to 'python/binaryview.py')

diff --git a/python/binaryview.py b/python/binaryview.py
index ad583966..d04dca86 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -26,7 +26,8 @@ import threading
 
 # Binary Ninja components
 import _binaryninjacore as core
-from enums import AnalysisState, SymbolType, InstructionTextTokenType, Endianness, ModificationStatus, StringType, SegmentFlag
+from enums import (AnalysisState, SymbolType, InstructionTextTokenType,
+	Endianness, ModificationStatus, StringType, SegmentFlag, MetadataType)
 import function
 import startup
 import architecture
@@ -39,6 +40,7 @@ import databuffer
 import basicblock
 import types
 import lineardisassembly
+import metadata
 
 
 class BinaryDataNotification(object):
@@ -1689,11 +1691,25 @@ class BinaryView(object):
 		return core.BNSaveToFilename(self.handle, str(dest))
 
 	def register_notification(self, notify):
+		"""
+		`register_notification` provides a mechanism for receiving callbacks for various analysis events. A full
+		list of callbacks can be seen in :py:Class:`BinaryDataNotification`.
+
+		:param BinaryDataNotification notify: notify is a subclassed instance of :py:Class:`BinaryDataNotification`.
+		:rtype: None
+		"""
 		cb = BinaryDataNotificationCallbacks(self, notify)
 		cb._register()
 		self.notifications[notify] = cb
 
 	def unregister_notification(self, notify):
+		"""
+		`unregister_notification` unregisters the :py:Class:`BinaryDataNotification` object passed to
+		`register_notification`
+
+		:param BinaryDataNotification notify: notify is a subclassed instance of :py:Class:`BinaryDataNotification`.
+		:rtype: None
+		"""
 		if notify in self.notifications:
 			self.notifications[notify]._unregister()
 			del self.notifications[notify]
@@ -1827,6 +1843,7 @@ class BinaryView(object):
 		event = AnalysisCompletionEvent(self, lambda: wait.complete())
 		core.BNUpdateAnalysis(self.handle)
 		wait.wait()
+		del event  # Get rid of unused variable warning
 
 	def abort_analysis(self):
 		"""
@@ -3247,6 +3264,54 @@ class BinaryView(object):
 		core.BNFreeStringList(outgoing_names, len(name_list))
 		return result
 
+	def query_metadata(self, key):
+		"""
+		`query_metadata` retrieves a Metadata object stored in the current BinaryView.
+
+		:param string key: key to query
+		:rtype: Metadata object
+		:Example:
+
+			>>> bv.store_metadata("integer", Metadata(1337))
+			>>> int(bv.query_metadata("integer"))
+			1337L
+			>>> bv.store_metadata("list", Metadata([1,2,3]))
+			>>> map(int, list(bv.query_metadata("list")))
+			[1L, 2L, 3L]
+			>>> bv.store_metadata("string", Metadata("my_data"))
+			>>> str(bv.query_metadata("string"))
+			'my_data'
+		"""
+		md_handle = core.BNBinaryViewQueryMetadata(self.handle, key)
+		if md_handle is None:
+			raise KeyError(key)
+		return metadata.Metadata(handle=md_handle)
+
+	def store_metadata(self, key, md):
+		"""
+		`store_metadata` stores a Metadata object for the given key in the current BinaryView.
+		Metadata objects stored using this `store_metadata` are stored in the database and can be retrieved when
+		the database is reopend.
+
+		:param string key: key value to associate the Metadata object with
+		:param Metadata md: Metadata object to store
+		:rtype: None
+		:Example:
+
+			>>> bv.store_metadata("integer", Metadata(1337))
+			>>> int(bv.query_metadata("integer"))
+			1337L
+			>>> bv.store_metadata("list", Metadata([1,2,3]))
+			>>> map(int, list(bv.query_metadata("list")))
+			[1L, 2L, 3L]
+			>>> bv.store_metadata("string", Metadata("my_data"))
+			>>> str(bv.query_metadata("string"))
+			'my_data'
+		"""
+		if not isinstance(md, metadata.Metadata):
+			raise ValueError("metadata argument must be of type Metadata")
+		core.BNBinaryViewStoreMetadata(self.handle, key, md.handle)
+
 	def __setattr__(self, name, value):
 		try:
 			object.__setattr__(self, name, value)
-- 
cgit v1.3.1