src/frontend/explain_assert_api.nit

   1 # This file is part of NIT ( http://www.nitlanguage.org ).
   2 #
   3 # Licensed under the Apache License, Version 2.0 (the "License");
   4 # you may not use this file except in compliance with the License.
   5 # You may obtain a copy of the License at
   6 #
   7 #     http://www.apache.org/licenses/LICENSE-2.0
   8 #
   9 # Unless required by applicable law or agreed to in writing, software
  10 # distributed under the License is distributed on an "AS IS" BASIS,
  11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 # See the License for the specific language governing permissions and
  13 # limitations under the License.
  14
  15 # Explain failed assert to the console (service declaration only)
  16 #
  17 # The only service `assert_expr_str` is implemented by the
  18 # `explain_assert` module.
  19 module explain_assert_api
  20
  21 import parser
  22
  23 redef class AAssertExpr
  24         # Superstring explaining `self` if the assert fails
  25         #
  26         # Engines should print out this superstring.
  27         fun explain_assert_str: nullable ASuperstringExpr do return null
  28 end