src/model/model_base.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Copyright 2012 Jean Privat <jean@pryen.org>
   4 #
   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
   8 #
   9 #     http://www.apache.org/licenses/LICENSE-2.0
  10 #
  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.
  16
  17 # The abstract concept of model and related common things
  18 module model_base
  19
  20 # The container class of a Nit object-oriented model.
  21 # A model knows modules, classes and properties and can retrieve them.
  22 class Model
  23 end
  24
  25 # A named and possibly documented entity in the model.
  26 # This class is usefull to generalize presentation of entities to the human.
  27 abstract class MEntity
  28         # The short (unqualified) name of this model entity
  29         fun name: String is abstract
  30 end
  31
  32 # A visibility (for modules, class and properties)
  33 # Valid visibility are:
  34 #
  35 #  * `intrude_visibility`
  36 #  * `public_visibility`
  37 #  * `protected_visibility`
  38 #  * `none_visibility`
  39 #
  40 # Note this class is basically an enum.
  41 # FIXME: use a real enum once user-defined enums are available
  42 class MVisibility
  43         super Comparable
  44         redef type OTHER: MVisibility
  45
  46         redef var to_s: String
  47
  48         private var level: Int
  49
  50         private init(s: String, level: Int)
  51         do
  52                 self.to_s = s
  53                 self.level = level
  54         end
  55
  56         # Is self give less visibility than other
  57         # none < private < protected < public < intrude
  58         redef fun <(other)
  59         do
  60                 return self.level < other.level
  61         end
  62 end
  63
  64 fun intrude_visibility: MVisibility do return once new MVisibility("intrude", 5)
  65 fun public_visibility: MVisibility do return once new MVisibility("public", 4)
  66 fun protected_visibility: MVisibility do return once new MVisibility("protected", 3)
  67 fun private_visibility: MVisibility do return once new MVisibility("private", 2)
  68 fun none_visibility: MVisibility do return once new MVisibility("none", 1)