RSFFileFormat

From FetchWiki

Jump to: navigation, search

This page describes the format of RSF files generated by CDIF2RSF.

Contents


[edit] Entities

Entities introduce instances of model elements with their essential properties.

Module	moduleId	"moduleName"
File	fileId	"fileName"
Class	classId	"className"
Method	methodId	"methodName"
methodName
className.methodName(parameterType1, parameterType2)
Function	functionId	"functionName"
functionName
functionName(parameterType1, parameterType2)
Attribute	attributeId	"attributeName"
attributeName
className.attributeName
GlobalVar	globalVarId	"globalVariableUniqueName"
globalVariableUniqueName
namespaceName::globalVarName

[edit] Relations

Relations provide links between entities.

ModuleBelongsToModule	moduleId	moduleId
FileBelongsToModule	fileId	moduleId
ClassBelongsToFile	classId	fileId	lineNr
InheritsFrom inheritanceId	"description"	subclassId	superclassId
inheritanceId
corresponds to the ID of the InheritanceDefinition entity in the CDIF file.
description
"subclassName -> superclassName"
MethodBelongsToClass	methodDeDeclarationId	classId
InvokableEntityBelongsToFile	methodId/functionId	fileId	lineNr
methodId/functionId
an invokeable entity is either a method or a function.
AttributeBelongsToClass	attributeId	classId
DefinitionForDeclaration	methodId/functionId	methodId/functionId
DefinitionForDeclaration
introduces a definition (aka implementation, typically in a .cpp file) for a declaration (aka specifification, typically in a .h file). This entity is used for invocations and accesses.
HasType	methodId/functionId/attributeId/globalVarId	classId
methodId/functionId
for methods and functions, the type represents the return type
Invokes	invocationId	methodDefinitionId/functionDefinitionId	methodDeclarationId/functionDeclarationId
Accesses	methodDefinitionId/functionDefinitionId	attributeId/globalVarId

[edit] Properties

Properties provide more data on an entity.

Visibility	methodId/functionId	"visiblityName"
visibilityName
either of {public,private,protected}
Signature	methodId/functionId	"entityName"
entityName
entityName(parameterType1, parameterType2)
Measurement	measurementId	methodId/functionId/fileId	"measurementName"	measurementValue
LeftValueAccess	accessId

Indicates that the access with id accessId is a left value access (aka read).

Personal tools