Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "MoDisco/CSharp"
(→Model, Package, AbstractTypeDeclaration) |
(→NamedElement & notion of Proxy) |
||
| Line 25: | Line 25: | ||
=== NamedElement & notion of Proxy === | === NamedElement & notion of Proxy === | ||
| − | A lot of | + | A lot of csharp elements are "named", and this name could be considered as an identifier : methods, packages, types, variables, fields, ... |
So all of corresponding meta classes inherit from NamedElement meta class. It will be usefull to resolve references in binding, see [[#NamedElementRef|NamedElementRef]] meta class. | So all of corresponding meta classes inherit from NamedElement meta class. It will be usefull to resolve references in binding, see [[#NamedElementRef|NamedElementRef]] meta class. | ||
| − | And an other goal of this meta class is to indicate which element is a part of the current | + | And an other goal of this meta class is to indicate which element is a part of the current csharp application or not (element from an external library of from .Net). Then external elements are tagged as proxy through dedicated attribute and could be easily filtered. |
| − | For example, instruction "System.out.println" has been decomposed in three named elements (one class, one variable and one method) which defintion are not part of current | + | For example, instruction "System.out.println" has been decomposed in three named elements (one class, one variable and one method) which defintion are not part of current csharp application. So attribute "proxy" of these elements has been initialized as true. |
| − | [[Image:MoDisco- | + | [[Image:MoDisco-CSharp metaclass NamedElement and its hierarchy.jpg|frame|center|NamedElement and its hierarchy]] |
=== NamedElementRef === | === NamedElementRef === | ||
Revision as of 10:25, 17 February 2009
The CSharp meta model : it is the reflect of C# language, as it has been defined in version 2.0 of "C# Language Specification" from Microsoft Corporation.
J2SE5 meta model contains 81 meta classes. To better understand it, this page will introduce main features (meta classes and links).
You could also browse definition model, csharp.ecore available in sources (see install section).
Contents
Main meta classes
ASTNode
Every meta classes (without meta class Fragment) inherit from ASTNode. As its name indicate it, ASTNode represent a graph node. ASTNode has a reference to Comment meta class because almost every csharp element could be associated to a comment (bloc or line comment). More details in "Comment" section.
Assembly, Namespace, Type
Root element of each CSharp model in an instance of "Assembly" meta class. It is a translation of csharp application concept, so it contains namespace declarations (instances of Namespace meta class). And namespace declarations contain type declarations (instances compatible with Type meta class), and so on ...
NamedElement & notion of Proxy
A lot of csharp elements are "named", and this name could be considered as an identifier : methods, packages, types, variables, fields, ... So all of corresponding meta classes inherit from NamedElement meta class. It will be usefull to resolve references in binding, see NamedElementRef meta class.
And an other goal of this meta class is to indicate which element is a part of the current csharp application or not (element from an external library of from .Net). Then external elements are tagged as proxy through dedicated attribute and could be easily filtered. For example, instruction "System.out.println" has been decomposed in three named elements (one class, one variable and one method) which defintion are not part of current csharp application. So attribute "proxy" of these elements has been initialized as true.
NamedElementRef
To represent links between java elements, as java AST defines only string references, meta class NamedElementRef initially contained only this information. But an important addition was to resolve binding between elements, so is is actually possible to navigate directly in elements graph. It has been represented through a relationship from a NamedElementRef to a NamedElement (proxy or not).
BodyDeclaration
A type declaration has different kinds of contents : fields, methods, static block, initialization block or other type declarations. All of these elements are of type BodyDeclaration meta class.
Expressions
Like in many languages, concept of expression exists in Java : it is a portion of code, without declarations, and its evaluation returns a value, numerical or boolean or other ...
For example,++iAll types of expressions shall inherit from Expression meta class.
Statements
An "instruction" in Java is represented by Statement meta class. A block of code (Block meta class) contains a collection of statements, an a block of code may be contained by a method.
Some example of statements in java :if, while, for, do, ...
All of their definitions use concept of expression to separate value from instruction keyword.
Zoom on comments
There is three kinds of comments : line comments (//), block comments (/* */) and javadoc (/** */). Every comments contains text fragments, but we could have more informations on javadoc (Javadoc meta class), it could contain javadoc tags that are identified and collected through instances of TagElement meta class.
Zoom on annotations
Official usage of annotations has been introduced in version 5 of JDK. To handle it, annotation declarations are managed as type declarations (AnnotationTypeDeclaration meta class) with specific attributes (AnnotationTypeMemberDeclaration meta class). And annotation usages are translated in instances of Annotation meta class, which reference corresponding annotation declarations. And parameters are translated in instances of MemberValuePair meta class.
Zoom on generics
Version 5 of JDK introduces also concept of "generics". Generic types of methods declarations are translated respectively in instances of TypeDeclaration of MethodDeclaration meta class with arguments as instances of TypeParameter meta class. Usage of these generics are translated in instances of ParameterizedType meta class which reference concret elements (type and types arguments).
Specific case of type argument is "wildcard" (for example <? extends X>. There is a specific meta class to handle it : WildCardType.
Requirements
To use the plug-in you need:
- JDK 1.5 or above
- a version of Eclipse 3.3 or above with the following set of plugins installed
- EMF 2.3.0 or higher
Install
You will find a version of this plug-in attached in following bug.
As IP review of this plugin is not finished, here is installation instructions :
- Extract archive file in your Eclipse workspace, then use "import" menu to import this project.
- Use "export" menu to export this project as a plugin (Deployable plugins and fragments) in your Eclipse installation. Don't forget to choose "Package plug-ins as individual jar archives" option.
- re-start your Eclipse to take in account this plug-in