1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # The abstract concept of model and related common things
20 # The container class of a Nit object-oriented model.
21 # A model knows modules, classes and properties and can retrieve them.
26 # A named and possibly documented entity in the model.
27 # This class is useful to generalize presentation of entities to the human.
28 abstract class MEntity
29 # The short (unqualified) name of this model entity.
31 # The short-name is based from the identifiers used to declare or denote the entity.
32 # It is usually globally ambiguous but is often enough in a precise local context.
34 # It is suitable to use the short-name in message to the user.
35 # However, special care must be used in case of potential ambiguities or name conflict.
36 fun name
: String is abstract
38 # A fully-qualified name of this model entity.
40 # The full-name is based on the short name and is usually prefixed by the name of an outer entity.
41 # Usually the quad (`::`) is used to separate the different names.
43 # The full-name is expected to be unique and unambiguous in lawful Nit models for the same kind of entity.
45 # It is often suitable to use it in message to the user.
46 # However, some full-name could be long and verbose,
48 # See the specific implementation in subclasses for details.
49 fun full_name
: String is abstract
51 # A fully-qualified C-like identifier of this model entity.
53 # The C-name is a name that respects the rule of identifiers in the C language:
54 # it is only made of alphanumeric characters and starts with a letter (or a underscore).
56 # The C-name can be seen as a mangled version of the `full_name`.
57 # Therefore, it is expected to be unique and unambiguous in lawful Nit models for the same kind of entity.
59 # The C-name is used by tools that need some identifiers in generated files to designate the
62 # Is is not suitable to use it directly with the user (e.g. in message) and
63 # indirect use should be restricted (e.g. to name a web-page)
64 fun c_name
: String is abstract
66 # A Model Entity has a direct link to its model
67 fun model
: Model is abstract
69 # The indication that the entity did not pass some semantic verifications.
71 # This simple flag is set by a given analysis to say that the entity is broken and unusable in
73 # When an entity status is set to broken, it is usually associated with a error message.
75 # If it is safe to do so, clients of the model SHOULD just skip broken entities in their processing.
76 # Clients that do not care about the executability (e.g. metrics) MAY still process the entity or
77 # perform specific checks to determinate the validity of the entity.
79 # Note that the broken status is not propagated to enclosing and enclosed entities.
80 # e.g. a broken method does not make the whole module broken.
81 var is_broken
= false is writable
84 # Something that represents a concern
85 abstract class MConcern
87 # The concern that contains `self` or null if `self` is the root of the concern hierarchy
88 fun parent_concern
: nullable MConcern is abstract
91 # A visibility (for modules, class and properties)
92 # Valid visibility are:
94 # * `intrude_visibility`
95 # * `public_visibility`
96 # * `protected_visibility`
98 # * `private_visiblity`
100 # Note this class is basically an enum.
101 # FIXME: use a real enum once user-defined enums are available
104 redef type OTHER: MVisibility
106 redef var to_s
: String
108 private var level
: Int
110 # TODO: private init because enumeration.
112 # Is self give less visibility than other
113 # none < private < protected < public < intrude
116 return self.level
< other
.level
120 # A `Comparator` to sort mentities by their names.
121 class MEntityNameSorter
124 redef type COMPARED: MEntity
126 # Returns `a.name <=> b.name`.
127 redef fun compare
(a
, b
) do return a
.name
<=> b
.name
130 # The visibility level `intrude`
131 fun intrude_visibility
: MVisibility do return once
new MVisibility("intrude", 5)
132 # The visibility level `public`
133 fun public_visibility
: MVisibility do return once
new MVisibility("public", 4)
134 # The visibility level `protected`
135 fun protected_visibility
: MVisibility do return once
new MVisibility("protected", 3)
136 # The visibility level `private`
137 fun private_visibility
: MVisibility do return once
new MVisibility("private", 2)
138 # The visibility level `none` (no visibility)
139 fun none_visibility
: MVisibility do return once
new MVisibility("none", 1)