Denislam Valeev / Mbed OS Nucleo_rtos_basic
Embed: (wiki syntax)

« Back to documentation index

MemapParser Class Reference

MemapParser Class Reference

Public Member Functions

def reduce_depth
def generate_output
def generate_json
def generate_csv
def generate_table
def compute_report
def parse

Detailed Description

An object that represents parsed results, parses the memory map files,
and writes out different file types of memory results

Definition at line 447 of file memap.py.


Member Function Documentation

def compute_report (   self )
Generates summary of memory usage for main areas

Definition at line 622 of file memap.py.

def generate_csv (   self,
  file_desc 
)
Generate a CSV file from a memoy map

Positional arguments:
file_desc - the file to write out the final report to

Definition at line 553 of file memap.py.

def generate_json (   self,
  file_desc 
)
Generate a json file from a memory map

Positional arguments:
file_desc - the file to write out the final report to

Definition at line 543 of file memap.py.

def generate_output (   self,
  export_format,
  depth,
  file_output = None 
)
Generates summary of memory map data

Positional arguments:
export_format - the format to dump

Keyword arguments:
file_desc - descriptor (either stdout or file)
depth - directory depth on report

Returns: generated string for the 'table' format, otherwise None

Definition at line 510 of file memap.py.

def generate_table (   self,
  file_desc 
)
Generate a table from a memoy map

Returns: string of the generated table

Definition at line 579 of file memap.py.

def parse (   self,
  mapfile,
  toolchain 
)
Parse and decode map file depending on the toolchain

Positional arguments:
mapfile - the file name of the memory map file
toolchain - the toolchain used to create the file

Definition at line 651 of file memap.py.

def reduce_depth (   self,
  depth 
)
populates the short_modules attribute with a truncated module list

(1) depth = 1:
main.o
mbed-os

(2) depth = 2:
main.o
mbed-os/test.o
mbed-os/drivers

Definition at line 480 of file memap.py.