adacl_5.15.1_e7c1515b/src/adacl-assert.ads

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
--------------------------------------------------------------- {{{1 ----------
--: Copyright © 2007 … 2023 Martin Krischik «krischik@users.sourceforge.net»
-------------------------------------------------------------------------------
--: Ada_Demo is free software: you can redistribute it and/or modify it under
--: the terms of the GNU General Public License as published by the Free
--: Software Foundation, either version 3 of the License, or (at your option)
--: any later version.
--:
--: Ada_Demo is distributed in the hope that it will be useful, but WITHOUT
--: ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
--: FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
--: more details.
--:
--: You should have received a copy of the GNU General Public License along
--: with Ada_Demo. If not, see <http://www.gnu.org/licenses/>.
--------------------------------------------------------------- }}}1-----------

pragma License (Modified_Gpl);
pragma Ada_2022;

with Ada.Strings.Unbounded;
with Ada.Strings.Wide_Unbounded;
with Ada.Strings.Wide_Wide_Unbounded;
with GNAT.Source_Info;

---
--  @summary
--  Enhanced assertions
--
--  @description
--  Additional Asserts which produce more detailed diagnostic messages Diagnostics will be reported via the
--  Report_Assertion function. The Report function is passed as a generic ot avoid dependence to AUnit.
--
generic

   with procedure Report_Assertion
      (Condition : Boolean := False;
       Message   : String;
       Source    : String;
       Line      : Natural) is <>;

package AdaCL.Assert is

   ---------- Unbounded_String -------------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : Ada.Strings.Unbounded.Unbounded_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Unbounded.Unbounded_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Wide_Unbounded_String --------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Wide_Unbounded.Unbounded_Wide_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Wide_Wide_Unbounded_String --------------------------- {{{1 ----------

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Wide_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a unbounded string is equal a given value
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Equal
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that a string is of given length
   --
   --: @param Actual     Actual value
   --: @param Expected   Expected value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Lenght
      (Actual   : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
       Expected : Natural;
       Name     : String;
       Source   : String  := GNAT.Source_Info.File;
       Line     : Natural := GNAT.Source_Info.Line);

   ---------- Boolean ----------------------------------------- {{{1 ----------

   ---
   --  Assert that Boolean is true
   --
   --: @param Actual     Actual value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Is_True
      (Actual : Boolean;
       Name   : String;
       Source : String  := GNAT.Source_Info.File;
       Line   : Natural := GNAT.Source_Info.Line);

   ---
   --  Assert that Boolean is false
   --
   --: @param Actual     Actual value
   --: @param Name       Name of variable or function restlt.
   --: @param Source     Source code
   --: @param Line       Line number
   procedure Is_False
      (Actual : Boolean;
       Name   : String;
       Source : String  := GNAT.Source_Info.File;
       Line   : Natural := GNAT.Source_Info.Line);

      ----------------------------------------------------------- }}}1 ----------

end AdaCL.Assert;

---------------------------------------------------------------- {{{ ----------
--: vim: set textwidth=0 nowrap tabstop=8 shiftwidth=3 softtabstop=3 expandtab :
--: vim: set filetype=ada fileencoding=utf-8 fileformat=unix foldmethod=marker :
--: vim: set spell spelllang=en_gb