adacl-assert-discrete.ads

1--------------------------------------------------------------- {{{1 ----------
2--: Copyright © 2007 … 2023 Martin Krischik «krischik@users.sourceforge.net»
3-------------------------------------------------------------------------------
4--: Ada_Demo is free software: you can redistribute it and/or modify it under
5--: the terms of the GNU General Public License as published by the Free
6--: Software Foundation, either version 3 of the License, or (at your option)
7--: any later version.
8--:
9--: Ada_Demo is distributed in the hope that it will be useful, but WITHOUT
10--: ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11--: FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12--: more details.
13--:
14--: You should have received a copy of the GNU General Public License along
15--: with Ada_Demo. If not, see <http://www.gnu.org/licenses/>.
16--------------------------------------------------------------- }}}1 ----------
17
18pragma License (Modified_Gpl);
19pragma Ada_2022;
20
21with GNAT.Source_Info;
22
23---
24-- @summary
25-- Assertions for discreete values
26--
27-- @description
28-- Additional Asserts which produce more detailed diagnostic messages Diagnostics will be reported via the
29-- Report_Assertion function. The Report function is passed as a generic ot avoid dependence to AUnit.
30--
31generic
32
33 type Discrete_Type is (<>);
34
35package AdaCL.Assert.Discrete is
36 ---
37 -- Assert that a discrete value is equal a given value
38 --
39 --: @param Actual Actual value
40 --: @param Expected Expected value
41 --: @param Name Name of variable or function restlt.
42 --: @param Source Source code
43 --: @param Line Line number
44 procedure Equal
45 (Actual : Discrete_Type;
46 Expected : Discrete_Type;
47 Name : String;
48 Source : String := GNAT.Source_Info.File;
49 Line : Natural := GNAT.Source_Info.Line);
50
51 ---
52 -- Assert that a discrete value is not equal a given value
53 --
54 --: @param Actual Actual value
55 --: @param Expected Expected value
56 --: @param Name Name of variable or function restlt.
57 --: @param Source Source code
58 --: @param Line Line number
59 procedure Not_Equal
60 (Actual : Discrete_Type;
61 Expected : Discrete_Type;
62 Name : String;
63 Source : String := GNAT.Source_Info.File;
64 Line : Natural := GNAT.Source_Info.Line);
65
66 ---
67 -- Assert that a discrete value is greater a given value
68 --
69 --: @param Actual Actual value
70 --: @param Expected Expected value
71 --: @param Name Name of variable or function restlt.
72 --: @param Source Source code
73 --: @param Line Line number
74 procedure Greater
75 (Actual : Discrete_Type;
76 Expected : Discrete_Type;
77 Name : String;
78 Source : String := GNAT.Source_Info.File;
79 Line : Natural := GNAT.Source_Info.Line);
80
81 ---
82 -- Assert that a discrete value is greater or equal a given value
83 --
84 --: @param Actual Actual value
85 --: @param Expected Expected value
86 --: @param Name Name of variable or function restlt.
87 --: @param Source Source code
88 --: @param Line Line number
89 procedure Greater_Equal
90 (Actual : Discrete_Type;
91 Expected : Discrete_Type;
92 Name : String;
93 Source : String := GNAT.Source_Info.File;
94 Line : Natural := GNAT.Source_Info.Line);
95
96 ---
97 -- Assert that a discrete value is less a given value
98 --
99 --: @param Actual Actual value
100 --: @param Expected Expected value
101 --: @param Name Name of variable or function restlt.
102 --: @param Source Source code
103 --: @param Line Line number
104 procedure Less
105 (Actual : Discrete_Type;
106 Expected : Discrete_Type;
107 Name : String;
108 Source : String := GNAT.Source_Info.File;
109 Line : Natural := GNAT.Source_Info.Line);
110
111 ---
112 -- Assert that a discrete value is less or equal a given value
113 --
114 --: @param Actual Actual value
115 --: @param Expected Expected value
116 --: @param Name Name of variable or function restlt.
117 --: @param Source Source code
118 --: @param Line Line number
119 procedure Less_Equal
120 (Actual : Discrete_Type;
121 Expected : Discrete_Type;
122 Name : String;
123 Source : String := GNAT.Source_Info.File;
124 Line : Natural := GNAT.Source_Info.Line);
125
126 ---
127 -- Assert that an discrete value is inside range
128 --
129 --: @param Actual Actual value
130 --: @param First Expected minimum value
131 --: @param Last Expected maximum value
132 --: @param Name Name of variable or function restlt.
133 --: @param Source Source code
134 --: @param Line Line number
135 procedure In_Range
136 (Actual : Discrete_Type;
137 First : Discrete_Type;
138 Last : Discrete_Type;
139 Name : String;
140 Source : String := GNAT.Source_Info.File;
141 Line : Natural := GNAT.Source_Info.Line);
142
143end AdaCL.Assert.Discrete;
144
145---------------------------------------------------------------- {{{ ----------
146--: vim: set textwidth=0 nowrap tabstop=8 shiftwidth=3 softtabstop=3 expandtab :
147--: vim: set filetype=ada fileencoding=utf-8 fileformat=unix foldmethod=marker :
148--: vim: set spell spelllang=en_gb