jvm.h e object.h

Author: GiordanoSM

Project.dev

@@ -19,16 +19,16 @@ ObjectOutput=
 LogOutput=
 LogOutputEnabled=0
 OverrideOutput=0
-OverrideOutputName=Project1.exe
+OverrideOutputName=Project.exe
 HostApplication=
 UseCustomMakefile=1
-CustomMakefile=classreader\Makefile
-CommandLine=
+CustomMakefile=MakefileWin
+CommandLine=Harmonic
 Folders=
 IncludeVersionInfo=0
 SupportXPThemes=0
 CompilerSet=0
-CompilerSettings=1000000000000000001000000
+CompilerSettings=0000000000000000000000000
 UnitCount=19
 
 [VersionInfo]

Project.layout

@@ -1,5 +1,5 @@
 [Editors]
-Order=9,2
+Order=
 Focused=2
 [Editor_2]
 CursorCol=17

constant_info.h

@@ -1,3 +1,11 @@
+/**
+ * @file constant_info.h
+ * @brief Constants definitions
+ * File containing the definitions for each type of constant
+ * and the structures with the information of the .class file main components.
+ *
+ */
+
 #pragma once
 #include <stdint.h>
 #include <stdio.h>
@@ -22,6 +30,11 @@
   assert(ptr);                          \
   assert(fp);                           \
 
+/**
+ * @brief Info of type class.
+ *
+ * Structure that stores specific information about a constant of type Class (id 7)
+ */
 /* id 7 */
 typedef struct {
   uint16_t name_index;

jvm.h

@@ -1,3 +1,9 @@
+/**
+ * @file jvm.h
+ * @brief Interpreter
+ * File containing the main implementation of the interpreter.
+ *
+ */
 #pragma once
 
 #include <stdio.h>
@@ -14,31 +20,41 @@
 #define MAXHEAP     256
 #define MAXSTATICS  256
 
+/**
+ * @brief Static attribute.
+ *
+ * Structure to store a static attribute of a class.
+ */
 typedef struct Static {
-  char *class;
-  char *name;
-  char *type;
-  ObjectField value;
+  char *class; /**< Class name */
+  char *name; /**< Attribute name */
+  char *type; /**< Attribute type name */
+  ObjectField value; /**< Attribute value */
 } Static;
 
+/**
+ * @brief Interpreter structure.
+ *
+ * Structure that stores the information utilized by the JVM interpreter and defines it.
+ */
 typedef struct JVM {
-  uint32_t pc;
-  Frame *frames[MAX_FRAMES];
-  int32_t frame_index;    /* top of frame stack index */
+  uint32_t pc; /**< Program counter */
+  Frame *frames[MAX_FRAMES]; /**< Pointer to frame stack */
+  int32_t frame_index;    /**< Top index of frame stack */
   /* uint8_t *heap; */
-  MethodArea *method_area;
+  MethodArea *method_area; /**< Pointer to method area */
   /* NativeMethodArea nma; */
-  int32_t current_class_index;
+  int32_t current_class_index; 
   int32_t current_method_index;
-  bool jmp;
-  bool ret;
-  uint64_t retval;
+  bool jmp; /**< If will ocurr a jump */
+  bool ret; /**< If will return */
+  uint64_t retval; /**< Value that will be returned */
 
-  void *heap[MAXHEAP];
-  int32_t heap_index;
+  void *heap[MAXHEAP]; /**< Pointer to heap area */
+  int32_t heap_index; /**< Top index of heap */
 
-  Static *statics[MAXSTATICS];
-  int32_t static_index;
+  Static *statics[MAXSTATICS]; /**< Pointer to static objects stack*/
+  int32_t static_index; /**< Top index of static stack*/
 } JVM;
 
 /**

main.c

@@ -4,6 +4,25 @@
 #include "classfile.h"
 #include "jvm.h"
 
+/** \mainpage JVM implementation - 2019/2 - G6
+ *
+ * \section intro_sec Introduction
+ *
+ * This is the introduction.
+ *
+ * \section install_sec How to execute:
+ *
+ * \subsection step1 Step 1: Make
+ *
+ * \section students_sec Students
+ *
+ * \subsection name1 Giordano S. Monteiro
+ * \subsection name2 Breno
+ * \subsection name3 Filipi
+ * \subsection name4 Igor Bispo
+ * 
+ */
+
 int main(int argc, char *argv[]) {
   if (argc != 2 && argc != 3) {
     printf("Usage: %s [class file] [i/le]\n", argv[0]);

object.h

@@ -1,7 +1,18 @@
+/**
+ * @file object.h
+ * @brief Object definitions
+ * File containing the definitions necessary to create a object.
+ *
+ */
 #pragma once
 
 #include <stdint.h>
 
+/**
+ * @brief Field or Attribute of an Object.
+ *
+ * Union to store generically attributes values.
+ */
 typedef union {
   uint8_t boolfield;
   int8_t bytefield;
@@ -14,7 +25,12 @@ typedef union {
   void *ptrfield;
 } ObjectField;
 
+/**
+ * @brief Object.
+ *
+ * Structure to store a object from a class.
+ */
 typedef struct Object {
   int size;
-  ObjectField *fields;
+  ObjectField *fields; /**<Attributes */
 } Object;