debug_info.h

//Copyright 2019 Hust.
//Author: HYL
//Descriptor:
/* This file contains information about debug.
 */

#include <unordered_map>
#include <vector>
#include <iostream>

#ifndef _DEBUG_INFO_H_
#define _DEBUG_INFO_H_

using namespace::std;

/* DebugInfoStruct is struct of recording the debug infomation.
 */
struct InnerAddrDebugStruct{
  string inner_elem_name;
  string inner_elem_type;
  string inner_elem_size;
  vector<string> inner_elem_addr;
};

struct AddrDebugInfoElem {
  string IR_name;
  string var_type;
  vector<string> inner_elem_type;
  vector<string> allocated_addr;
  int number_addr;
  //for 2 dimension array
  int two_dimension_array_first;
  int two_dimension_array_second;

  //  vector<InnerAddrDebugStruct> inner_elem;
};

struct InstrDebugInfoElem {
  string Instr_name;
  vector<string> after_trance_instr_vector;
  int number_instr;
};

//for debug info. Link the trance instr and the c code
struct CCodeLinkInstr {
  string file_name;
  string fun_name;
  unordered_map<string, string> ccode_and_instr_elem_map;
};

struct VarCInfoStruct {
  //the variable name in .ll file
  string IR_name;
  //the variable anme in .c file
  string C_name;
  //the variable type in .c file
  string C_type;
  //the variable scope in .c file
  string C_scope;
};

class DebugInfo {
 public:
  //for debug info of ccode and instr
  static string ccode_instr_file_fun_name;
 
  //Creat a addr debug info record in addr debug map
  void CreateAAddrDebugRecord(string, string);
  void CreateAAddrDebugRecord(string, string, const vector<string>&);
  //add addr info into exited record via var_name(first parameter)
  void AddAddrDebugInfoToRecord(string, string);
  //since 2DArray need to deal with array size and elem size(ex: 2 x 3)
  void AddAddrDebugInfoToRecord_2DArray(string, int, int);

  void AddAdditionalDebugInfoToRecord(string, string);
  //Create a instr debug info record in instr debug map
  void CreateAInstrDebugRecord(string, string);
  //add info into exited record
  void AddInstrDebugInfoToRecord(string, string);
  
  void CreateCodeLink(string);

  string GetInfoFromCodeLink(string, string);

  void AddInfoToCodeLink(string, string, string);

  void PrintAddrDebugInfo(string);
  
  void PrintInstrDebugInfo(string);
  
  void AddVarCInfoInMap(string, VarCInfoStruct);
  
  VarCInfoStruct GetVarCInfoFromMap(string);

  unordered_map<string, VarCInfoStruct>* GetVarCInfoMap() { return &var_c_info_map; }

 private:

  /* When we allocated addr for a var, we should record the map info
 * into the addr_debug_info.
 */
  static vector<AddrDebugInfoElem> addr_debug_info_vec;

  static vector<InstrDebugInfoElem> instr_debug_info_vec;

  static unordered_map<string, CCodeLinkInstr> ccode_and_instr_map;
  //the map store infomation that come from c file
  static unordered_map<string, VarCInfoStruct> var_c_info_map;
};

#endif