Add dyninstAPI/BPatch_dll.h

dyninst · Apr 3, 2024 · bdb2e60 · bdb2e60
1 parent db839a3
commit bdb2e60
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 14 deletions.
diff --git a/docs/dyninstAPI/developer/API.rst b/docs/dyninstAPI/developer/API.rst
@@ -1,13 +1,13 @@
-===========
+==========
 DyninstAPI
-===========
+==========
 
 .. toctree::
   :caption: Developer API
   :name: dyninstapi-developer-api
   :hidden:
   :maxdepth: 1
-  
+
   addressSpace.h
   arch-forward-decl.h
   ast.h
@@ -18,6 +18,7 @@ DyninstAPI
   BPatch_basicBlock.h
   BPatch_basicBlockLoop.h
   BPatch_collections.h
+  BPatch_dll.h
   BPatch_libInfo.h
   BPatch_memoryAccessAdapter.h
   BPatch_private.h

diff --git a/docs/dyninstAPI/developer/BPatch_dll.h.rst b/docs/dyninstAPI/developer/BPatch_dll.h.rst
@@ -0,0 +1,37 @@
+.. _`sec-dev:BPatch_dll.h`:
+
+BPatch_dll.h
+############
+
+
+**TEMPORARY PARADYND FLOWGRAPH KLUGE**
+
+If we are building BPatch classes into paradynd we want BPATCH_DLL_EXPORT
+to be defined as the empty string (for all platforms). This currently tests
+SHM_SAMPLING because it is defined for paradynd and not for the dyninst
+dll or dyninst clients.
+
+.. code:: cpp
+
+  #ifdef SHM_SAMPLING
+  # define BPATCH_DLL_EXPORT
+  #else
+  # if defined(_MSC_VER)
+  #   ifdef BPATCH_DLL_BUILD
+        // we are building the dyninstAPI DLL
+  #     define BPATCH_DLL_EXPORT __declspec(dllexport)
+  # else
+      // we are not building the dyninstAPI DLL
+  #   define BPATCH_DLL_EXPORT __declspec(dllimport)
+  #   if _MSC_VER >= 1300
+  #     define BPATCH_DLL_IMPORT   1
+  #   endif
+  # endif
+  #else
+    // we are not building for a Windows target
+  # define BPATCH_DLL_EXPORT  __attribute__((visibility ("default")))
+  #endif
+
+.. cpp:var:: const char V_libdyninstAPI[]
+
+  Declare our version string
diff --git a/docs/dyninstAPI/public/API.rst b/docs/dyninstAPI/public/API.rst
@@ -15,7 +15,6 @@ Documentation for the DyninstAPI toolkit.
   BPatch_basicBlockLoop.h
   BPatch_binaryEdit.h
   BPatch_callbacks.h
-  BPatch_dll.h
   BPatch_edge.h
   BPatch_enums.h
   BPatch_flowGraph.h

diff --git a/docs/dyninstAPI/public/BPatch_dll.h.rst b/docs/dyninstAPI/public/BPatch_dll.h.rst
diff --git a/dyninstAPI/h/BPatch_dll.h b/dyninstAPI/h/BPatch_dll.h
@@ -31,11 +31,7 @@
 #ifndef _BPatch_dll_h_
 #define _BPatch_dll_h_
 
-// TEMPORARY PARADYND FLOWGRAPH KLUGE
-// If we are building BPatch classes into paradynd we want BPATCH_DLL_EXPORT 
-// to be defined as the empty string (for all platforms). This currently tests
-// SHM_SAMPLING because it is defined for paradynd and not for the dyninst
-// dll or dyninst clients, read '#if PARADYND'. 
+
 #ifdef SHM_SAMPLING
 #define	BPATCH_DLL_EXPORT
 #else