Add symtab/symutil.h

dyninst · Apr 3, 2024 · c55118d · c55118d
1 parent 31202fe
commit c55118d
Show file tree

Hide file tree

Showing 2 changed files with 83 additions and 16 deletions.
diff --git a/docs/symtabAPI/public/symutil.h.rst b/docs/symtabAPI/public/symutil.h.rst
@@ -3,17 +3,86 @@ symutil.h
 
 .. cpp:namespace:: Dyninst::SymtabAPI
 
-.. container:: center
-
-   ============================== ==============================
-   supportedLanguages             Meaning
-   ============================== ==============================
-   lang_Unknown                   Unknown source language
-   lang_Assembly                  Raw assembly code
-   lang_C                         C source code
-   lang_CPlusPlus                 C++ source code
-   lang_GnuCPlusPlus              C++ with GNU extensions
-   lang_Fortran                   Fortran source code
-   lang_Fortran_with_pretty_debug Fortran with debug annotations
-   lang_CMFortran                 Fortran with CM extensions
-   ============================== ==============================
+.. cpp:function:: const char *supportedLanguages2Str(supportedLanguages s)
+
+.. cpp:enum:: NameType
+
+  .. cpp:enumerator:: mangledName = 1
+  .. cpp:enumerator:: prettyName = 2
+  .. cpp:enumerator:: typedName = 4
+  .. cpp:enumerator:: anyName = 7
+
+
+.. cpp:enum:: supportedLanguages 
+
+  .. cpp:enumerator:: lang_Unknown
+
+    Unknown source language
+
+  .. cpp:enumerator:: lang_Assembly
+
+    Raw assembly code
+
+  .. cpp:enumerator:: lang_C
+
+    C source code
+
+  .. cpp:enumerator:: lang_CPlusPlus
+
+    C++ source code
+
+  .. cpp:enumerator:: lang_GnuCPlusPlus
+
+    C++ with GNU extensions
+
+  .. cpp:enumerator:: lang_Fortran
+
+    Fortran source code
+
+  .. cpp:enumerator:: lang_Fortran_with_pretty_debug
+
+    Fortran with debug annotations
+
+  .. cpp:enumerator:: lang_CMFortran
+
+    Fortran with CM extensions
+
+
+.. cpp:enum:: ObjectType
+
+  .. cpp:enumerator:: obj_Unknown
+  .. cpp:enumerator:: obj_SharedLib
+  .. cpp:enumerator:: obj_Executable
+  .. cpp:enumerator:: obj_RelocatableFile
+
+
+.. cpp:enum:: SymtabError
+
+  .. cpp:enumerator:: Obj_Parsing = 0
+  .. cpp:enumerator:: Syms_To_Functions
+  .. cpp:enumerator:: Build_Function_Lists
+  .. cpp:enumerator:: No_Such_Function
+  .. cpp:enumerator:: No_Such_Variable
+  .. cpp:enumerator:: No_Such_Module
+  .. cpp:enumerator:: No_Such_Region
+  .. cpp:enumerator:: No_Such_Symbol
+  .. cpp:enumerator:: No_Such_Member
+  .. cpp:enumerator:: Not_A_File
+  .. cpp:enumerator:: Not_An_Archive
+  .. cpp:enumerator:: Duplicate_Symbol
+  .. cpp:enumerator:: Export_Error
+  .. cpp:enumerator:: Emit_Error
+  .. cpp:enumerator:: Invalid_Flags
+  .. cpp:enumerator:: Bad_Frame_Data
+  .. cpp:enumerator:: No_Frame_Entry
+  .. cpp:enumerator:: Frame_Read_Error
+  .. cpp:enumerator:: Multiple_Region_Matches
+  .. cpp:enumerator:: No_Error
+
+.. cpp:struct:: Segment
+
+  .. cpp:member:: void *data
+  .. cpp:member:: Offset loadaddr
+  .. cpp:member:: unsigned long size
+  .. cpp:member:: std::string name
+  .. cpp:member:: unsigned segFlags
diff --git a/symtabAPI/h/symutil.h b/symtabAPI/h/symutil.h
@@ -28,8 +28,6 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-//Hashing function for std::unordered_mapes
-
 #if !defined(_symtab_util_h_)
 #define _symtab_util_h_