list - Information listings from IDE

Syntax

IDE_Obj.infolist=list('type') IDE_Obj.infolist=list('type',typename)

IDEs

This function supports the following IDEs:

Green Hills MULTI
Texas Instruments Code Composer Studio v3

Description

Using list with MULTI

infolist = IDE_Obj.list(type) reads information about your the IDE project and returns it in infolist. Different types of information and return formats are possible depending on the input arguments you supply to the list function call.

Note list does not recognize or return information about variables that you declare in your code but that are not used or initialized.

The type argument specifies which information listing to return. To determine the information that list returns, use one of the entries in the following table.

type String	Description
`project`	Return information about the current project in the IDE
`variable`	Return information about one or more embedded variables
`function`	Return details about one or more functions in your project

list returns dynamic the IDE information that you can alter. Returned listings represent snapshots of the current the IDE configuration only. Be aware that earlier copies of infolist might contain stale information.

infolist = IDE_Obj.list('project') returns a vector of structures that contain project information in the format shown in the following table.

infolist Structure Element	Description
`infolist(1).name`	Project file name (with path).
`infolist(1).primary`	Configuration file used for the project. For more information, refer to `new`.
`infolist(1).compileroptions`	Compiler options string for the project.
`infolist(1).srcfiles`	Vector of structures that describes project source files. Each structure contains the name and path for each source file—`infolist(1).srcfiles.name`.
`infolist(1).type`	Shows the project type, either `project` or `projlib`. For more information, refer to `new`.
`infolist(2)....`	...
`infolist(n)....`	...

infolist = IDE_Obj.list('variable') returns a structure of structures that contains information on all local variables within scope. The list also includes information on all global variables. If a local variable has the same symbol name as a global variable, list returns the local variable information.

infolist = IDE_Obj.list('variable',varname) returns information about the specified variable varname.

infolist = IDE_Obj.list('variable',varnamelist) returns information about variables in a list specified by varnamelist. The information returned in each structure follows the format in the following table.

infolist Structure Element	Description
`infolist.varname(1).name`	Symbol name.
`infolist.varname(1).isglobal`	Indicates whether symbol is global or local.
`infolist.varname(1).location`	Information about the location of the symbol.
`infolist.varname(1).size`	Size per dimension.
`infolist.varname(1).uclass`	IDE handle class that matches the type of this symbol.
`infolist.varname(1).bitsize`	Size in bits. More information is added to the structure depending on the symbol type.
`infolist.(varname1).type`	Data type of symbol.
`infolist.varname(2)....`	...
`infolist.varname(n)....`	...

list uses the variable name as the field name to refer to the structure information for the variable.

infolist = IDE_Obj.list('globalvar') returns a structure that contains information on all global variables.

infolist = IDE_Obj.list('globalvar',varname) returns a structure that contains information on the specified global variable.

infolist = IDE_Obj.list('globalvar',varnamelist) returns a structure that contains information on global variables in the list. The returned information follows the same format as the syntax infolist = IDE_Obj.list('variable',...).

infolist = IDE_Obj.list('function') returns a structure that contains information on all functions in the embedded program.

infolist = IDE_Obj.list('function',functionname) returns a structure that contains information on the specified function functionname.

infolist = IDE_Obj.list('function',functionnamelist) returns a structure that contains information on the specified functions in functionnamelist. The returned information follows the following format when you specify option type as function.

infolist Structure Element	Description
`infolist.functionname(1).name`	Function name
`infolist.functionname(1).filename`	Name of file where function is defined
`infolist.functionname(1).address`	Relevant address information such as start address and end address
`infolist.functionname(1).funcvar`	Variables local to the function
`infolist.functionname(1).uclass`	IDE handle class that matches the type of this symbol—`function`
`infolist.functionname(1).funcdecl`	Function declaration—where information such as the function return type is contained
`infolist.functionname(1).islibfunc`	Determine if the library is a function
`infolist.functionname(1).linepos`	Start and end line positions of function
`infolist.functionname(1).funcinfo`	Miscellaneous information about the function
`infolist.functionname(2)...`	...
`infolist.functionname(n)...`	...

To refer to the function structure information, list uses the function name as the field name.

IDE_Obj.infolist = list('type') returns a structure that contains information on all defined data types in the embedded program. This method includes struct, enum and union data types and excludes typedefs. The name of a defined type is its C struct tag, enum tag or union tag. If the C tag is not defined, it is referred to by the IDE compiler as '$faken' where n is an assigned number.

IDE_Obj.infolist = list('type',typename) returns a structure that contains information on the specified defined data type.

IDE_Obj.infolist = list('type',typenamelist) returns a structure that contains information on the specified defined data types in the list. The returned information follows the following format when you specify option type as type.

infolist Structure Element	Description
`infolist.typename(1).type`	Type name.
`infolist.typename(1).size`	Size of this type.
`infolist.typename(1).uclass`	IDE handle class that matches the type of this symbol. Additional information is added depending on the type.
`infolist.typename(2)....`	...
`infolist.typename(n)....`	...

For the field name, list uses the type name to refer to the type structure information.

The following list provides important information about variable and field names:

When a variable name, type name, or function name is not a valid MATLAB structure field name, list replaces or modifies the name so it becomes valid.
In field names that contain the invalid dollar character $, list replaces the $ with DOLLAR.
Changing the MATLAB field name does not change the name of the embedded symbol or type.

Examples

This first example shows list used with a variable, providing information about the variable varname. Notice that the invalid field name _with_underscore gets changed to Q_with_underscore. To make the invalid name valid, list inserts the character Q before the name.

varname1 = '_with_underscore'; % Invalid fieldname.
IDE_Obj.list('variable',varname1);
ans =

    Q_with_underscore : [varinfo]
ans. Q_with_underscore 
ans=

       name: '_with_underscore'
   isglobal: 0
   location: [1x62 char]
       size: 1
     uclass: 'numeric'
       type: 'int' 
    bitsize: 16

To demonstrate using list with a defined C type, variable typename1 includes the type argument. Because valid field names cannot contain the $ character, list changes the $ to DOLLAR.

typename1 = '$fake3'; % Name of defined C type with no tag.
IDE_Obj.list('type',typename1);            
ans =

       DOLLARfake0 : [typeinfo]    

ans.DOLLARfake0=
                 
        type: 'struct $fake0'       
        size: 1     
      uclass: 'structure'     
      sizeof: 1    
     members: [1x1 struct]

When you request information about a project in the IDE, you see a listing like the following that includes structures containing details about your project.

projectinfo=IDE_Obj.list('project')

projectinfo = 

          name: 'D:\Work\c6711dskafxr_c6000_rtw\c6711dskafxr.pjt'
          type: 'project'
    targettype: 'TMS320C67XX'
      srcfiles: [69x1 struct]
      buildcfg: [3x1 struct]

Using list with CCS IDE

infolist = IDE_Obj.list(type) reads information about your CCS session and returns it in infolist. Different types of information and return formats apply depending on the input arguments you supply to the list function call. The type argument specifies which information listing to return. To determine the information that list returns, use one of the following as the type parameter string:

project — Tell list to return information about the current project in CCS.
variable — Tell list to return information about one or more embedded variables.
globalvar — Tell list to return information about one or more global embedded variables.
function — Tell list to return details about one or more functions in your project.

The list function returns dynamic CCS information that can be altered by the user. Returned listings represent snapshots of the current CCS configuration only. Be aware that earlier copies of infolist might contain stale information.

Also, list may report incorrect information when you make changes to variables from MATLAB software. To report variable information, list uses the CCS API, which only knows about variables in CCS. Your changes from MATLAB software do not appear through the API and list. For example, the following operations return incorrect or old data information from list.

Suppose your original prototype is

unsigned short tgtFunction7(signed short signedShortArray1[]);

After creating the function object fcnObj, perform a declare operation with this string to change the declaration:

unsigned short tgtFunction7(unsigned short signedShortArray1[]);

Now try using list to return information about signedShortArray1.

list(fcnObj,'signedShortArray1')

 address: [3442 1]
location: [1x66 char]
    size: 1
 bitsize: 16
 reftype: 'short'
  referent: [1x1 struct]
member_pts_to_same_struct: 0
      name: 'signedShortArray1'

You get this outcome because list uses the CCS API to query information about any particular variable. As far as the API is concerned, the first input variable is a short*. Changing the declaration does not change anything.

When you specify option type as project, for example infolist = IDE_Obj.list('project'), the method returns a vector of structures that contain project information in the following format.

infolist Structure Element	Description
`infolist(1).name`	Project file name (with path).
`infolist(1).type`	Project type — `project`,`projlib`, or `projext`, refer to `new`.
`infolist(1).processortype`	String description of processor CPU.
`infolist(1).srcfiles`	Vector of structures that describes project source files. Each structure contains the name and path for each source file — `infolist(1).srcfiles.name`.
`infolist(1).buildcfg`	Vector of structures that describe build configurations, each with the following entries: `infolist(1).buildcfg.name` — the build configuration name. `infolist(1).buildcfg.outpath` — the default folder for storing the build output.
`infolist(2)....`	...
`infolist(n)....`	...

infolist = IDE_Obj.list('variable') returns a structure of structures that contains information on all local variables within scope. The list also includes information on all global variables. However, that if a local variable has the same symbol name as a global variable, list returns the information about the local variable.

infolist = IDE_Obj.list('variable',varname) returns information about the specified variable varname.

infolist Structure Element	Description
`infolist.varname(1).name`	Symbol name.
`infolist.varname(1).isglobal`	Indicates whether symbol is global or local.
`infolist.varname(1).location`	Information about the location of the symbol.
`infolist.varname(1).size`	Size per dimension.
`infolist.varname(1).uclass`	`ticcs` object class that matches the type of this symbol.
`infolist.varname(1).bitsize`	Size in bits. More information is added to the structure depending on the symbol type.
`infolist.varname(2)....`	...
`infolist.varname(n)....`	...

list uses the variable name as the field name to refer to the structure information for the variable.

infolist = IDE_Obj.list('globalvar') returns a structure that contains information on all global variables.

infolist = IDE_Obj.list('globalvar',varname) returns a structure that contains information on the specified global variable.

infolist = IDE_Obj.list('function') returns a structure that contains information on all functions in the embedded program.

infolist = IDE_Obj.list('function',functionname) returns a structure that contains information on the specified function functionname.

infolist Structure Element	Description
`infolist.functionname(1).name`	Function name
`infolist.functionname(1).filename`	Name of file where function is defined
`infolist.functionname(1).address`	Relevant address information such as start address and end address
`infolist.functionname(1).funcvar`	Variables local to the function
`infolist.functionname(1).uclass`	`ticcs` object class that matches the type of this symbol — `function`
`infolist.functionname(1).funcdecl`	Function declaration — where information such as the function return type is contained
`infolist.functionname(1).islibfunc`	Determine if the library is a function
`infolist.functionname(1).linepos`	Start and end line positions of function
`infolist.functionname(1).funcinfo`	Miscellaneous information about the function
`infolist.functionname(2)...`	...
`infolist.functionname(n)...`	...

To refer to the function structure information, list uses the function name as the field name.

The following list provides important information about variable and field names:

When a variable name, type name, or function name is not a valid MATLAB software structure field name, list replaces or modifies the name so it becomes valid.
In field names that contain the invalid dollar character $, list replaces the $ with DOLLAR.
Changing the MATLAB software field name does not change the name of the embedded symbol or type.

Examples

To demonstrate using list with a defined C type, variable typename1 includes the type argument. Because valid field names cannot contain the $ character, list changes the $ to DOLLAR.

typename1 = '$fake3'; % name of defined C type with no tag 
IDE_Obj.list('type',typename1);            
ans =

       DOLLARfake0 : [typeinfo]    

ans.DOLLARfake0=
                 
        type: 'struct $fake0'       
        size: 1     
      uclass: 'structure'     
      sizeof: 1    
     members: [1x1 struct]

When you request information about a project in CCS, you see a listing like the following that includes structures containing details about your project.

projectinfo=IDE_Obj.list('project')

projectinfo = 

          name: 'D:\Work\c6711dskafxr_c6000_rtw\c6711dskafxr.pjt'
          type: 'project'
    processortype: 'TMS320C67XX'
      srcfiles: [69x1 struct]
      buildcfg: [3x1 struct]

Search MATLAB Documentation
R2012a Documentation → Embedded Coder
View documentation for other releases	Learn more about Embedded Coder

list - Information listings from IDE

Syntax

IDEs

Description

Using list with MULTI

Examples

Using list with CCS IDE

Examples

See Also

Related Products & Applications