Reoganize Function/BasicBlock creation
[frida/frida.git] / src / core / InformationManager.hxx
index dc781285f049de01b2200f6a2e852ee3f21d9353..03cb3b866ec139b875ffad8a7556820b3733c2e1 100644 (file)
@@ -9,6 +9,7 @@
 class Disassembler;
 class Function;
 class BasicBlock;
+class Comment;
 
 class QString;
 
@@ -47,12 +48,38 @@ public:
        void dispatch(RenameFunctionEvent* event)
                { rename_function_signal(event); }
 
-       Function* getFunction(uint64_t address)
-       { return functions[address]; }
-
-       BasicBlock* getBlock(uint64_t address)
-       { return blocks[address]; }
-
+       Function* getFunction(uint64_t address);
+       BasicBlock* getBasicBlock(uint64_t address);
+
+       /* Protocoll:
+        *
+        * Users may allocate new Data containers with the new*()
+        * functions. Once they have populated the information they hand
+        * over the object to the information manager using the finish*()
+        * functions.
+        *
+        * if new*() returns NULL there already exists a function at the
+        * specified address. Users may then get the old object if they
+        * wish or (more likely) skip creating it. Uniqueness of the
+        * object is only guaranteed as compared to the finish()ed
+        * objects.
+        *
+        * Users are responsible for destroying functions iff they do not
+        * finish them using the delete*() functions. Once the objects are
+        * finished, the information manager is responsible for cleaning
+        * up the memory. If delete*() is called on a finished object, bad
+        * thingsmay happen.
+        */
+       Function* newFunction(uint64_t address);
+       BasicBlock* newBasicBlock(uint64_t address);
+       Comment* newGlobalComment(uint64_t address);
+       Comment* newLocalComment(uint64_t address, Function* f);
+       void finishFunction(Function* f);
+       void finishBasicBlock(BasicBlock* b);
+       void finnishComment(Comment* c);
+       void deleteFunction(Function* f);
+       void deleteBasicBlock(BasicBlock* b);
+       void deleteComment(Comment* c);
 private:
        boost::signals2::signal<void ()> reset_signal;
        boost::signals2::signal<void (Function*)> new_function_signal;