@@@ fltfmt mess
[mLib] / test / tvec-adhoc.3.in
CommitLineData
d056fbdf 1.\" -*-nroff-*-
c4ccbbf9
MW
2.\"
3.\" Manual for ad-hoc testing with the test vector framework
4.\"
5.\" (c) 2024 Straylight/Edgeware
6.\"
7.
8.\"----- Licensing notice ---------------------------------------------------
9.\"
10.\" This file is part of the mLib utilities library.
11.\"
12.\" mLib is free software: you can redistribute it and/or modify it under
13.\" the terms of the GNU Library General Public License as published by
14.\" the Free Software Foundation; either version 2 of the License, or (at
15.\" your option) any later version.
16.\"
17.\" mLib is distributed in the hope that it will be useful, but WITHOUT
18.\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19.\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
20.\" License for more details.
21.\"
22.\" You should have received a copy of the GNU Library General Public
23.\" License along with mLib. If not, write to the Free Software
24.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
25.\" USA.
26.
27.\"--------------------------------------------------------------------------
28.so ../defs.man \" @@@PRE@@@
29.
30.\"--------------------------------------------------------------------------
31.TH tvec-adhoc 3mLib "11 March 2024" "Straylight/Edgeware" "mLib utilities library"
d056fbdf
MW
32.\" @tvec_adhocconfig
33.\" @tvec_adhoc
34.
35.\" @tvec_begingroup
36.\" @TVEC_BEGINGROUP
37.\" @tvec_endgroup
38.\" @TVEC_TESTGROUP
39.\" @TVEC_TESTGROUP_TAG
40.\" @tvec_begintest
41.\" @TVEC_BEGINTEST
42.\" @tvec_endtest
43.\" @TVEC_TEST
44.\" @TVEC_TEST_TAG
45.
46.\" @tvec_claim
47.\" @TVEC_CLAIM
48.\" @tvec_claim_eq
49.
c4ccbbf9
MW
50.\"--------------------------------------------------------------------------
51.SH NAME
52tvec-adhoc \- ad-hoc testing with the test vector framework
53.
54.\"--------------------------------------------------------------------------
d056fbdf 55.SH SYNOPSIS
c4ccbbf9 56.
d056fbdf 57.nf
b1a20bee 58.B "#include <mLib/tvec-adhoc.h>"
d056fbdf
MW
59.PP
60.BI "const struct tvec_config tvec_adhocconfig;"
61.BI "void tvec_adhoc(struct tvec_state *" tv ", struct tvec_test *" t );
62.PP
63.ta \w'\fBvoid tvec_begingroup('u
64.BI "void tvec_begingroup(struct tvec_state *" tv ", const char *" name ,
65.BI " const char *" file ", unsigned " lno );
66.BI "void TVEC_BEGINGROUP(struct tvec_state *" tv ", const char *" name );
67.BI "void tvec_endgroup(struct tvec_state *" tv );
68.BI "TVEC_TESTGROUP(" tv ", " name ") " body
69.BI "TVEC_TESTGROUP_TAG(" tag ", " tv ", " name ") " body
70.ta \w'\fBvoid tvec_begintest('u
71.BI "void tvec_begintest(struct tvec_state *" tv ,
72.BI " const char *" file ", unsigned " lno );
73.BI "void TVEC_BEGINTEST(struct tvec_state *" tv );
74.BI "void tvec_endtest(struct tvec_state *" tv );
75.BI "TVEC_TEST(" tv ") " body
76.BI "TVEC_TEST_TAG(" tag ", " tv ") " body
77.PP
78.ta \w'\fBint tvec_claim('u
79.BI "int tvec_claim(struct tvec_state *" tv ", int " ok ,
80.BI " const char *" file ", unsigned " lno ,
81.BI " const char *" msg ", ...);"
82.ta \w'\fBint tvec_claim_v('u
83.BI "int tvec_claim_v(struct tvec_state *" tv ", int " ok ,
84.BI " const char *" file ", unsigned " lno ,
85.BI " const char *" msg ", va_list *" ap );
86.BI "int TVEC_CLAIM(struct tvec_state *" tv ", int " cond );
87.ta \w'\fBint tvec_claim_eq('u
88.BI "int tvec_claim_eq(struct tvec_state *" tv ,
89.BI " const struct tvec_regty *" ty ,
90.BI " const union tvec_misc *" arg ,
91.BI " const char *" file ", unsigned " lno ,
92.BI " const char *" expr );
93.fi