show_type_hierarchy.py

# This script is licensed under BSD License, see file LICENSE.txt.
#
# (c) TASKING Germany GmbH, 2023
 
import isystem.connect as ic
 
winidea_id = ''
 
 
class CVariable:
    """
    This class contains type information of C variable.
    """
 
    def __init__(self, ivar : ic.IVariable):
        # Variable name without any decoration (module, partition, ...),
        # for example 'iCounter'.
        self.name = ivar.Name()
        # Variable qualified name.
        self.qName = ivar.QualifiedName()
        self.typeName = ivar.TypeName()
        # Variable type, as enumeration type IVariable::EType.
        self.ctype = ivar.Type()
        # Array dimension for arrays, 0 for all other variables. 
        self.arrayDim = ivar.ArrayDimension()
        # Index of the module, where the variable is located. 
        self.moduleIdx = ivar.Module()
        # Variable scope - e.g. class name. 
        self.scope = ivar.Scope()
        self.memArea = ivar.MemArea()
        self.address = ivar.Address()
        self.size = ivar.Size()
        itype = ivar.GetIType().Type()
        # Type of variable, see SType::EType for possible values.
        self.stype = itype.m_byType
        # Size of variable in bits, for primitive types only.
        self.bitSize = itype.m_byBitSize
 
        self.children = []
 
        
    def addChild(self, cvar):
        self.children.append(cvar)
 
        
    def toString(self, indent: int):
 
        istr = ' ' * indent
        
        return   istr + '- Name: ' + self.name + \
          '\n' + istr + '  QualifiedName: ' + self.qName + \
          '\n' + istr + '  TypeName: ' + self.typeName + \
          '\n' + istr + '  Type: ' + str(self.ctype) + \
          '\n' + istr + '  rArrayDimension: ' + str(self.arrayDim) + \
          '\n' + istr + '  Module: ' + str(self.moduleIdx) + \
          '\n' + istr + '  Scope: ' + self.scope + \
          '\n' + istr + '  MemArea: ' + str(self.memArea) + \
          '\n' + istr + '  Address: ' + hex(self.address) + \
          '\n' + istr + '  Size: ' + str(self.size) + \
          '\n' + istr + '  SType: ' + str(self.stype) + \
          '\n' + istr + '  BitSize: ' + str(self.bitSize)
 
    
def getTypeInfo(dataCtrl2 : ic.CDataController2,
                expressionOrVarName : str,                
                maxArrayLen : int):
    """
    Returns type information for the given string as hierarchical data
    structure.
    """
    typeInfo = dataCtrl2.getExpressionType(0, expressionOrVarName)
 
    exprInfo = CVariable(typeInfo.Expression())
    children = typeInfo.Children()
 
    numArrayElements = min(exprInfo.arrayDim, maxArrayLen); 
 
    # add struct children
    numChildren = children.size()
    for childIdx in range(numChildren):
        ivarChild = children.at(childIdx)
        child = getTypeInfo(dataCtrl2, ivarChild.QualifiedName(), maxArrayLen)
        exprInfo.addChild(child)
        
    # add array elements
    for idx in range(numArrayElements):
 
        elementType = exprInfo.typeName;
        endOfNameIdx = elementType.find('[');
        elementType = elementType[:endOfNameIdx].strip();
        elementIdx = "[" + str(idx) + "]";
 
        child = getTypeInfo(dataCtrl2, exprInfo.name + elementIdx, maxArrayLen);
        exprInfo.addChild(child)
 
    dataCtrl2.release(typeInfo)
    
    return exprInfo;
    
        
def printTree(cvar : CVariable, dataCtrl2, indent = 0):
    """
    Prints the given cvar and all of its children. If dataCtrl2 != None,
    values of primtive variables are also printed.
    """
 
    print(cvar.toString(indent))
 
    if dataCtrl2 and cvar.ctype == ic.IVariable.tSimple:
        cval = dataCtrl2.evaluate(ic.IConnectDebug.fMonitor, cvar.qName)
        print(' ' * indent + '  Value: ' + cval.getResult())
    
 
    for child in cvar.children:
        printTree(child, dataCtrl2, indent + 2)
        
 
        
print('isystem.connect version: ' + ic.getModuleVersion())
 
cmgr = ic.ConnectionMgr()
cmgr.connect(ic.CConnectionConfig().instanceId(winidea_id))
 
dataCtrl2 = ic.CDataController2(cmgr)
 
info = getTypeInfo(dataCtrl2, 'g_complexStruct', 100)
 
printTree(info, dataCtrl2)