< Summary - Igor Pro Universal Testing Framework

Information
Class: procedures.igortest-assertions
Assembly: procedures
File(s): /builds/mirror/igortest/procedures/igortest-assertions.ipf
Tag: 74147b3
Line coverage
12%
Covered lines: 76
Uncovered lines: 551
Coverable lines: 627
Total lines: 1185
Line coverage: 12.1%
Branch coverage
61%
Covered branches: 22
Total branches: 36
Branch coverage: 61.1%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Cyclomatic complexity Line coverage
/builds/mirror/igortest/procedures/igortest-assertions.ipf => WARN_EQUAL_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => CHECK_EQUAL_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => REQUIRE_EQUAL_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => WARN_EQUAL_UINT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => CHECK_EQUAL_UINT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => REQUIRE_EQUAL_UINT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => WARN_NEQ_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => CHECK_NEQ_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => REQUIRE_NEQ_INT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => WARN_NEQ_UINT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => CHECK_NEQ_UINT64()100%0100%
/builds/mirror/igortest/procedures/igortest-assertions.ipf => REQUIRE_NEQ_UINT64()100%0100%
PASS()100%1100%
FAIL()100%10%
SKIP_TESTCASE_EXPECT_FAILS()100%10%
SKIP_TESTCASE()100%20%
INFO()100%2366.1%
WARN()100%1100%
CHECK()100%1100%
REQUIRE()100%10%
WARN_EQUAL_VAR()100%10%
CHECK_EQUAL_VAR()100%1100%
REQUIRE_EQUAL_VAR()100%10%
WARN_LE_VAR()100%10%
CHECK_LE_VAR()100%10%
REQUIRE_LE_VAR()100%10%
WARN_LT_VAR()100%10%
CHECK_LT_VAR()100%10%
REQUIRE_LT_VAR()100%10%
WARN_GE_VAR()100%10%
CHECK_GE_VAR()100%10%
REQUIRE_GE_VAR()100%10%
WARN_GT_VAR()100%10%
CHECK_GT_VAR()100%10%
REQUIRE_GT_VAR()100%10%
WARN_NEQ_VAR()100%10%
CHECK_NEQ_VAR()100%10%
REQUIRE_NEQ_VAR()100%10%
WARN_CLOSE_VAR()100%50%
CHECK_CLOSE_VAR()100%50%
REQUIRE_CLOSE_VAR()100%50%
WARN_CLOSE_CMPLX()100%50%
CHECK_CLOSE_CMPLX()100%50%
REQUIRE_CLOSE_CMPLX()100%50%
WARN_CLOSE_INT64()100%20%
CHECK_CLOSE_INT64()100%20%
REQUIRE_CLOSE_INT64()100%20%
WARN_CLOSE_UINT64()100%20%
CHECK_CLOSE_UINT64()100%20%
REQUIRE_CLOSE_UINT64()100%20%
WARN_SMALL_VAR()100%20%
CHECK_SMALL_VAR()100%20%
REQUIRE_SMALL_VAR()100%20%
WARN_SMALL_CMPLX()100%20%
CHECK_SMALL_CMPLX()100%20%
REQUIRE_SMALL_CMPLX()100%20%
WARN_SMALL_INT64()100%20%
CHECK_SMALL_INT64()100%20%
REQUIRE_SMALL_INT64()100%20%
WARN_SMALL_UINT64()100%20%
CHECK_SMALL_UINT64()100%20%
REQUIRE_SMALL_UINT64()100%20%
WARN_EMPTY_STR()100%10%
CHECK_EMPTY_STR()100%10%
REQUIRE_EMPTY_STR()100%10%
WARN_NON_EMPTY_STR()100%10%
CHECK_NON_EMPTY_STR()100%10%
REQUIRE_NON_EMPTY_STR()100%10%
WARN_PROPER_STR()100%10%
CHECK_PROPER_STR()100%10%
REQUIRE_PROPER_STR()100%10%
WARN_NULL_STR()100%10%
CHECK_NULL_STR()100%10%
REQUIRE_NULL_STR()100%10%
WARN_NON_NULL_STR()100%10%
CHECK_NON_NULL_STR()100%10%
REQUIRE_NON_NULL_STR()100%10%
WARN_EQUAL_STR()100%20%
CHECK_EQUAL_STR()100%271.43%
REQUIRE_EQUAL_STR()100%20%
WARN_NEQ_STR()100%20%
CHECK_NEQ_STR()100%20%
REQUIRE_NEQ_STR()100%20%
WARN_WAVE()100%20%
CHECK_WAVE()100%20%
REQUIRE_WAVE()100%20%
WARN_EQUAL_WAVES()100%50%
CHECK_EQUAL_WAVES()100%50%
REQUIRE_EQUAL_WAVES()100%50%
WARN_EQUAL_TEXTWAVES()100%20%
CHECK_EQUAL_TEXTWAVES()100%20%
REQUIRE_EQUAL_TEXTWAVES()100%20%
WARN_EMPTY_FOLDER()100%10%
CHECK_EMPTY_FOLDER()100%10%
REQUIRE_EMPTY_FOLDER()100%10%
WARN_RTE()100%10%
CHECK_RTE()100%10%
REQUIRE_RTE()100%10%
WARN_ANY_RTE()100%10%
CHECK_ANY_RTE()100%10%
REQUIRE_ANY_RTE()100%10%
WARN_NO_RTE()100%10%
CHECK_NO_RTE()100%10%
REQUIRE_NO_RTE()100%10%
WARN_COMPILATION()100%40%
CHECK_COMPILATION()100%473.33%
REQUIRE_COMPILATION()100%40%
WARN_NO_COMPILATION()100%40%
CHECK_NO_COMPILATION()100%460%
REQUIRE_NO_COMPILATION()100%40%

File(s)

/builds/mirror/igortest/procedures/igortest-assertions.ipf

#LineLine coverage
 1#pragma rtGlobals=3
 2#pragma rtFunctionErrors=1
 3#pragma version=1.10
 4#pragma TextEncoding="UTF-8"
 5#pragma ModuleName=IUTF_Assertion
 6
 7/// Steps for adding new test assertions:
 8/// - Add the test you want to perform to `igortest-assertion-checks.ipf`, these
 9///   functions must return 0/1 from their input parameters. No access of globals
 10///   is allowed here.
 11/// - Add a wrapper function which also handles error
 12///   reporting to igortest-assertion-wrappers.ipf
 13/// - Document the `*_WRAPPER` function using "@class *_DOCU" without the flags parameter
 14/// - Add WARN/CHECK/REQUIRE variants in this file
 15/// - Use `copydoc *_DOCU` for copying the documentation to the test assertions
 16/// - Write tests for the check function in `igortest-assertion-checks.ipf`
 17///   and the `CHECK_*` assertion in `VTTE.ipf`
 18
 19/// @addtogroup Assertions
 20/// @{
 21
 22/// Increase the assertion counter only
 123Function PASS()
 124  IUTF_Wrapper#TRUE_WRAPPER(1, REQUIRE_MODE)
 125End
 26
 27/// Force the test case to fail
 028Function FAIL()
 029  IUTF_Wrapper#TRUE_WRAPPER(0, REQUIRE_MODE)
 030End
 31
 32/// Skips current test case
 33///
 34/// The test case is aborted.
 35/// Already failed assertions are treated as expected failure.
 36/// Any registered reentry is automatically unregistered.
 037Function SKIP_TESTCASE_EXPECT_FAILS()
 038  IUTF_Basics#SetExpectedFailure(1)
 039  WAVE/T wvTestCase = IUTF_Reporting#GetTestCaseWave()
 040  wvTestCase[%CURRENT][%STATUS] = IUTF_STATUS_SKIP
 041  SKIP_TESTCASE()
 042End
 43
 44/// Skips current test case
 45///
 46/// The test case is aborted.
 47/// Any registered reentry is automatically unregistered.
 048Function SKIP_TESTCASE()
 049  IUTF_Reporting#IUTF_PrintStatusMessage("Skipping test case")
 050  WAVE/T wvTestCase = IUTF_Reporting#GetTestCaseWave()
 051  if(!CmpStr(wvTestCase[%CURRENT][%STATUS], IUTF_STATUS_RUNNING))
 052    wvTestCase[%CURRENT][%STATUS] = IUTF_STATUS_SKIP
 053  endif
 54
 055  IUTF_Reporting#incrAssert()
 56
 057  IUTF_Reporting#ShowInfoMsg()
 058  IUTF_Reporting#CleanupInfoMsg()
 59
 060  UnRegisterIUTFMonitor()
 61
 062  IUTF_Basics#SetAbortFromSkipFlag()
 063  Abort
 064End
 65
 66/// Append information to the next assertion to print if failed
 19567Function INFO(format, [s, n, s0, s1, s2, s3, s4, n0, n1, n2, n3, n4])
 68  string format
 69  WAVE/T s
 70  WAVE   n
 71  string s0, s1, s2, s3, s4
 72  variable n0, n1, n2, n3, n4
 73
 19574  variable stringLength = 0
 19575  variable numberLength = 0
 76
 19577  if(ParamIsDefault(s))
 19578    Make/FREE/T/N=5 wv
 19579    WAVE/T s = wv
 19580    if(!ParamIsDefault(s0))
 081      s[stringLength] = s0
 082      stringLength   += 1
 19583    endif
 19584    if(!ParamIsDefault(s1))
 1585      s[stringLength] = s1
 1586      stringLength   += 1
 19587    endif
 19588    if(!ParamIsDefault(s2))
 1589      s[stringLength] = s2
 1590      stringLength   += 1
 19591    endif
 19592    if(!ParamIsDefault(s3))
 093      s[stringLength] = s3
 094      stringLength   += 1
 19595    endif
 19596    if(!ParamIsDefault(s4))
 097      s[stringLength] = s4
 098      stringLength   += 1
 19599    endif
 195100    Redimension/N=(stringLength) s
 0101  elseif(!ParamIsDefault(s0) || !ParamIsDefault(s1) || !ParamIsDefault(s2) || !ParamIsDefault(s3) || !ParamIsDefault(s4)
 0102    EvaluateResults(0, "Cannot mix single string with wave parameter", REQUIRE_MODE)
 195103  endif
 104
 195105  if(ParamIsDefault(n))
 195106    Make/FREE/N=5 numbers
 195107    WAVE n = numbers
 195108    if(!ParamIsDefault(n0))
 0109      numbers[numberLength] = n0
 0110      numberLength         += 1
 195111    endif
 195112    if(!ParamIsDefault(n1))
 0113      numbers[numberLength] = n1
 0114      numberLength         += 1
 195115    endif
 195116    if(!ParamIsDefault(n2))
 0117      numbers[numberLength] = n2
 0118      numberLength         += 1
 195119    endif
 195120    if(!ParamIsDefault(n3))
 0121      numbers[numberLength] = n3
 0122      numberLength         += 1
 195123    endif
 195124    if(!ParamIsDefault(n4))
 0125      numbers[numberLength] = n4
 0126      numberLength         += 1
 195127    endif
 195128    Redimension/N=(numberLength) numbers
 0129  elseif(!ParamIsDefault(n0) || !ParamIsDefault(n1) || !ParamIsDefault(n2) || !ParamIsDefault(n3) || !ParamIsDefault(n4)
 0130    EvaluateResults(0, "Cannot mix single number with wave parameter", REQUIRE_MODE)
 195131  endif
 132
 195133  IUTF_WRAPPER#INFO_WRAPPER(format, s, n, CHECK_MODE)
 195134End
 135
 136/// @copydoc TRUE_DOCU
 5137Function WARN(var)
 138  variable var
 139
 5140  IUTF_Wrapper#TRUE_WRAPPER(var, WARN_MODE)
 5141End
 142
 143/// @copydoc TRUE_DOCU
 15144Function CHECK(var)
 145  variable var
 146
 15147  IUTF_Wrapper#TRUE_WRAPPER(var, CHECK_MODE)
 15148End
 149
 150/// @copydoc TRUE_DOCU
 0151Function REQUIRE(var)
 152  variable var
 153
 0154  IUTF_Wrapper#TRUE_WRAPPER(var, REQUIRE_MODE)
 0155End
 156
 157/// @copydoc EQUAL_VAR_DOCU
 0158Function WARN_EQUAL_VAR(var1, var2)
 159  variable var1, var2
 160
 0161  IUTF_Wrapper#EQUAL_VAR_WRAPPER(var1, var2, WARN_MODE)
 0162End
 163
 164/// @copydoc EQUAL_VAR_DOCU
 330165Function CHECK_EQUAL_VAR(var1, var2)
 166  variable var1, var2
 167
 330168  IUTF_Wrapper#EQUAL_VAR_WRAPPER(var1, var2, CHECK_MODE)
 330169End
 170
 171/// @copydoc EQUAL_VAR_DOCU
 0172Function REQUIRE_EQUAL_VAR(var1, var2)
 173  variable var1, var2
 174
 0175  IUTF_Wrapper#EQUAL_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0176End
 177
 178/// @cond HIDDEN_SYMBOL
 179#if IgorVersion() >= 7.0
 180/// @endcond
 181
 182/// @copydoc EQUAL_INT64_DOCU
 183Function WARN_EQUAL_INT64(int64 var1, int64 var2)
 184  IUTF_Wrapper#EQUAL_INT64_WRAPPER(var1, var2, WARN_MODE)
 185End
 186
 187/// @copydoc EQUAL_INT64_DOCU
 188Function CHECK_EQUAL_INT64(int64 var1, int64 var2)
 189  IUTF_Wrapper#EQUAL_INT64_WRAPPER(var1, var2, CHECK_MODE)
 190End
 191
 192/// @copydoc EQUAL_INT64_DOCU
 193Function REQUIRE_EQUAL_INT64(int64 var1, int64 var2)
 194  IUTF_Wrapper#EQUAL_INT64_WRAPPER(var1, var2, REQUIRE_MODE)
 195End
 196
 197/// @copydoc EQUAL_UINT64_DOCU
 198Function WARN_EQUAL_UINT64(uint64 var1, uint64 var2)
 199  IUTF_Wrapper#EQUAL_UINT64_WRAPPER(var1, var2, WARN_MODE)
 200End
 201
 202/// @copydoc EQUAL_UINT64_DOCU
 203Function CHECK_EQUAL_UINT64(uint64 var1, uint64 var2)
 204  IUTF_Wrapper#EQUAL_UINT64_WRAPPER(var1, var2, CHECK_MODE)
 205End
 206
 207/// @copydoc EQUAL_UINT64_DOCU
 208Function REQUIRE_EQUAL_UINT64(uint64 var1, uint64 var2)
 209  IUTF_Wrapper#EQUAL_UINT64_WRAPPER(var1, var2, REQUIRE_MODE)
 210End
 211
 212/// @cond HIDDEN_SYMBOL
 213#endif
 214/// @endcond
 215
 216/// @copydoc LESS_EQUAL_VAR_DOCU
 0217Function WARN_LE_VAR(var1, var2)
 218  variable var1, var2
 219
 0220  IUTF_Wrapper#LESS_EQUAL_VAR_WRAPPER(var1, var2, WARN_MODE)
 0221End
 222
 223/// @copydoc LESS_EQUAL_VAR_DOCU
 0224Function CHECK_LE_VAR(var1, var2)
 225  variable var1, var2
 226
 0227  IUTF_Wrapper#LESS_EQUAL_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0228End
 229
 230/// @copydoc LESS_EQUAL_VAR_DOCU
 0231Function REQUIRE_LE_VAR(var1, var2)
 232  variable var1, var2
 233
 0234  IUTF_Wrapper#LESS_EQUAL_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0235End
 236
 237/// @copydoc LESS_THAN_VAR_DOCU
 0238Function WARN_LT_VAR(var1, var2)
 239  variable var1, var2
 240
 0241  IUTF_Wrapper#LESS_THAN_VAR_WRAPPER(var1, var2, WARN_MODE)
 0242End
 243
 244/// @copydoc LESS_THAN_VAR_DOCU
 0245Function CHECK_LT_VAR(var1, var2)
 246  variable var1, var2
 247
 0248  IUTF_Wrapper#LESS_THAN_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0249End
 250
 251/// @copydoc LESS_THAN_VAR_DOCU
 0252Function REQUIRE_LT_VAR(var1, var2)
 253  variable var1, var2
 254
 0255  IUTF_Wrapper#LESS_THAN_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0256End
 257
 258/// @copydoc GREATER_EQUAL_VAR_DOCU
 0259Function WARN_GE_VAR(var1, var2)
 260  variable var1, var2
 261
 0262  IUTF_Wrapper#GREATER_EQUAL_VAR_WRAPPER(var1, var2, WARN_MODE)
 0263End
 264
 265/// @copydoc GREATER_EQUAL_VAR_DOCU
 0266Function CHECK_GE_VAR(var1, var2)
 267  variable var1, var2
 268
 0269  IUTF_Wrapper#GREATER_EQUAL_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0270End
 271
 272/// @copydoc GREATER_EQUAL_VAR_DOCU
 0273Function REQUIRE_GE_VAR(var1, var2)
 274  variable var1, var2
 275
 0276  IUTF_Wrapper#GREATER_EQUAL_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0277End
 278
 279/// @copydoc GREATER_THAN_VAR_DOCU
 0280Function WARN_GT_VAR(var1, var2)
 281  variable var1, var2
 282
 0283  IUTF_Wrapper#GREATER_THAN_VAR_WRAPPER(var1, var2, WARN_MODE)
 0284End
 285
 286/// @copydoc GREATER_THAN_VAR_DOCU
 0287Function CHECK_GT_VAR(var1, var2)
 288  variable var1, var2
 289
 0290  IUTF_Wrapper#GREATER_THAN_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0291End
 292
 293/// @copydoc GREATER_THAN_VAR_DOCU
 0294Function REQUIRE_GT_VAR(var1, var2)
 295  variable var1, var2
 296
 0297  IUTF_Wrapper#GREATER_THAN_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0298End
 299
 300/// @copydoc NEQ_VAR_DOCU
 0301Function WARN_NEQ_VAR(var1, var2)
 302  variable var1, var2
 303
 0304  IUTF_Wrapper#NEQ_VAR_WRAPPER(var1, var2, WARN_MODE)
 0305End
 306
 307/// @copydoc NEQ_VAR_DOCU
 0308Function CHECK_NEQ_VAR(var1, var2)
 309  variable var1, var2
 310
 0311  IUTF_Wrapper#NEQ_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0312End
 313
 314/// @copydoc NEQ_VAR_DOCU
 0315Function REQUIRE_NEQ_VAR(var1, var2)
 316  variable var1, var2
 317
 0318  IUTF_Wrapper#NEQ_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0319End
 320
 321/// @cond HIDDEN_SYMBOL
 322#if IgorVersion() >= 7.0
 323/// @endcond
 324
 325/// @copydoc NEQ_INT64_DOCU
 326Function WARN_NEQ_INT64(int64 var1, int64 var2)
 327  IUTF_Wrapper#NEQ_INT64_WRAPPER(var1, var2, WARN_MODE)
 328End
 329
 330/// @copydoc NEQ_INT64_DOCU
 331Function CHECK_NEQ_INT64(int64 var1, int64 var2)
 332  IUTF_Wrapper#NEQ_INT64_WRAPPER(var1, var2, CHECK_MODE)
 333End
 334
 335/// @copydoc NEQ_INT64_DOCU
 336Function REQUIRE_NEQ_INT64(int64 var1, int64 var2)
 337  IUTF_Wrapper#NEQ_INT64_WRAPPER(var1, var2, REQUIRE_MODE)
 338End
 339
 340/// @copydoc NEQ_UINT64_DOCU
 341Function WARN_NEQ_UINT64(uint64 var1, uint64 var2)
 342  IUTF_Wrapper#NEQ_UINT64_WRAPPER(var1, var2, WARN_MODE)
 343End
 344
 345/// @copydoc NEQ_UINT64_DOCU
 346Function CHECK_NEQ_UINT64(uint64 var1, uint64 var2)
 347  IUTF_Wrapper#NEQ_UINT64_WRAPPER(var1, var2, CHECK_MODE)
 348End
 349
 350/// @copydoc NEQ_UINT64_DOCU
 351Function REQUIRE_NEQ_UINT64(uint64 var1, uint64 var2)
 352  IUTF_Wrapper#NEQ_UINT64_WRAPPER(var1, var2, REQUIRE_MODE)
 353End
 354
 355/// @cond HIDDEN_SYMBOL
 356#endif
 357/// @endcond
 358
 359/// @copydoc CLOSE_VAR_DOCU
 0360Function WARN_CLOSE_VAR(var1, var2, [tol, strong])
 361  variable var1, var2
 362  variable tol
 363  variable strong
 364
 0365  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0366    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, WARN_MODE)
 0367  elseif(ParamIsDefault(tol))
 0368    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, WARN_MODE, strong = strong)
 0369  elseif(ParamIsDefault(strong))
 0370    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, WARN_MODE, tol = tol)
 0371  else
 0372    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, WARN_MODE, tol = tol, strong = strong)
 0373  endif
 0374End
 375
 376/// @copydoc CLOSE_VAR_DOCU
 0377Function CHECK_CLOSE_VAR(var1, var2, [tol, strong])
 378  variable var1, var2
 379  variable tol
 380  variable strong
 381
 0382  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0383    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, CHECK_MODE)
 0384  elseif(ParamIsDefault(tol))
 0385    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, CHECK_MODE, strong = strong)
 0386  elseif(ParamIsDefault(strong))
 0387    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, CHECK_MODE, tol = tol)
 0388  else
 0389    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, CHECK_MODE, tol = tol, strong = strong)
 0390  endif
 0391End
 392
 393/// @copydoc CLOSE_VAR_DOCU
 0394Function REQUIRE_CLOSE_VAR(var1, var2, [tol, strong])
 395  variable var1, var2
 396  variable tol
 397  variable strong
 398
 0399  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0400    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, REQUIRE_MODE)
 0401  elseif(ParamIsDefault(tol))
 0402    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, REQUIRE_MODE, strong = strong)
 0403  elseif(ParamIsDefault(strong))
 0404    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol)
 0405  else
 0406    IUTF_Wrapper#CLOSE_VAR_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol, strong = strong)
 0407  endif
 0408End
 409
 410/// @copydoc CLOSE_CMPLX_DOCU
 0411Function WARN_CLOSE_CMPLX(var1, var2, [tol, strong])
 412  variable/C var1, var2
 413  variable tol, strong
 414
 0415  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0416    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, WARN_MODE)
 0417  elseif(ParamIsDefault(tol))
 0418    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, WARN_MODE, strong = strong)
 0419  elseif(ParamIsDefault(strong))
 0420    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, WARN_MODE, tol = tol)
 0421  else
 0422    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, WARN_MODE, tol = tol, strong = strong)
 0423  endif
 0424End
 425
 426/// @copydoc CLOSE_CMPLX_DOCU
 0427Function CHECK_CLOSE_CMPLX(var1, var2, [tol, strong])
 428  variable/C var1, var2
 429  variable tol, strong
 430
 0431  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0432    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, CHECK_MODE)
 0433  elseif(ParamIsDefault(tol))
 0434    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, CHECK_MODE, strong = strong)
 0435  elseif(ParamIsDefault(strong))
 0436    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, CHECK_MODE, tol = tol)
 0437  else
 0438    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, CHECK_MODE, tol = tol, strong = strong)
 0439  endif
 0440End
 441
 442/// @copydoc CLOSE_CMPLX_DOCU
 0443Function REQUIRE_CLOSE_CMPLX(var1, var2, [tol, strong])
 444  variable/C var1, var2
 445  variable tol, strong
 446
 0447  if(ParamIsDefault(tol) && ParamIsDefault(strong))
 0448    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, REQUIRE_MODE)
 0449  elseif(ParamIsDefault(tol))
 0450    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, REQUIRE_MODE, strong = strong)
 0451  elseif(ParamIsDefault(strong))
 0452    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol)
 0453  else
 0454    IUTF_Wrapper#CLOSE_CMPLX_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol, strong = strong)
 0455  endif
 0456End
 457
 458/// @cond HIDDEN_SYMBOL
 459#if IgorVersion() >= 7.0
 460/// @endcond
 461
 462/// @copydoc CLOSE_INT64_DOCU
 0463Function WARN_CLOSE_INT64(int64 var1, int64 var2, [int64 tol])
 0464  if(ParamIsDefault(tol))
 0465    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, WARN_MODE)
 0466  else
 0467    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, WARN_MODE, tol = tol)
 0468  endif
 0469End
 470
 471/// @copydoc CLOSE_INT64_DOCU
 0472Function CHECK_CLOSE_INT64(int64 var1, int64 var2, [int64 tol])
 0473  if(ParamIsDefault(tol))
 0474    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, CHECK_MODE)
 0475  else
 0476    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, CHECK_MODE, tol = tol)
 0477  endif
 0478End
 479
 480/// @copydoc CLOSE_INT64_DOCU
 0481Function REQUIRE_CLOSE_INT64(int64 var1, int64 var2, [int64 tol])
 0482  if(ParamIsDefault(tol))
 0483    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, REQUIRE_MODE)
 0484  else
 0485    IUTF_Wrapper#CLOSE_INT64_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol)
 0486  endif
 0487End
 488
 489/// @copydoc CLOSE_UINT64_DOCU
 0490Function WARN_CLOSE_UINT64(uint64 var1, uint64 var2, [uint64 tol])
 0491  if(ParamIsDefault(tol))
 0492    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, WARN_MODE)
 0493  else
 0494    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, WARN_MODE, tol = tol)
 0495  endif
 0496End
 497
 498/// @copydoc CLOSE_UINT64_DOCU
 0499Function CHECK_CLOSE_UINT64(uint64 var1, uint64 var2, [uint64 tol])
 0500  if(ParamIsDefault(tol))
 0501    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, CHECK_MODE)
 0502  else
 0503    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, CHECK_MODE, tol = tol)
 0504  endif
 0505End
 506
 507/// @copydoc CLOSE_UINT64_DOCU
 0508Function REQUIRE_CLOSE_UINT64(uint64 var1, uint64 var2, [uint64 tol])
 0509  if(ParamIsDefault(tol))
 0510    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, REQUIRE_MODE)
 0511  else
 0512    IUTF_Wrapper#CLOSE_UINT64_WRAPPER(var1, var2, REQUIRE_MODE, tol = tol)
 0513  endif
 0514End
 515
 516/// @cond HIDDEN_SYMBOL
 517#endif
 518/// @endcond
 519
 520/// @copydoc SMALL_VAR_DOCU
 0521Function WARN_SMALL_VAR(var, [tol])
 522  variable var
 523  variable tol
 524
 0525  if(ParamIsDefault(tol))
 0526    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, WARN_MODE)
 0527  else
 0528    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, WARN_MODE, tol = tol)
 0529  endif
 0530End
 531
 532/// @copydoc SMALL_VAR_DOCU
 0533Function CHECK_SMALL_VAR(var, [tol])
 534  variable var
 535  variable tol
 536
 0537  if(ParamIsDefault(tol))
 0538    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, CHECK_MODE)
 0539  else
 0540    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, CHECK_MODE, tol = tol)
 0541  endif
 0542End
 543
 544/// @copydoc SMALL_VAR_DOCU
 0545Function REQUIRE_SMALL_VAR(var, [tol])
 546  variable var
 547  variable tol
 548
 0549  if(ParamIsDefault(tol))
 0550    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, REQUIRE_MODE)
 0551  else
 0552    IUTF_Wrapper#SMALL_VAR_WRAPPER(var, REQUIRE_MODE, tol = tol)
 0553  endif
 0554End
 555
 556/// @copydoc SMALL_CMPLX_DOCU
 0557Function WARN_SMALL_CMPLX(var, [tol])
 558  variable/C var
 559  variable   tol
 560
 0561  if(ParamIsDefault(tol))
 0562    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, WARN_MODE)
 0563  else
 0564    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, WARN_MODE, tol = tol)
 0565  endif
 0566End
 567
 568/// @copydoc SMALL_CMPLX_DOCU
 0569Function CHECK_SMALL_CMPLX(var, [tol])
 570  variable/C var
 571  variable   tol
 572
 0573  if(ParamIsDefault(tol))
 0574    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, CHECK_MODE)
 0575  else
 0576    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, CHECK_MODE, tol = tol)
 0577  endif
 0578End
 579
 580/// @copydoc SMALL_CMPLX_DOCU
 0581Function REQUIRE_SMALL_CMPLX(var, [tol])
 582  variable/C var
 583  variable   tol
 584
 0585  if(ParamIsDefault(tol))
 0586    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, REQUIRE_MODE)
 0587  else
 0588    IUTF_Wrapper#SMALL_CMPLX_WRAPPER(var, REQUIRE_MODE, tol = tol)
 0589  endif
 0590End
 591
 592/// @cond HIDDEN_SYMBOL
 593#if IgorVersion() >= 7.0
 594/// @endcond
 595
 596/// @copydoc SMALL_INT64_DOCU
 0597Function WARN_SMALL_INT64(int64 var, [int64 tol])
 0598  if(ParamIsDefault(tol))
 0599    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, WARN_MODE)
 0600  else
 0601    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, WARN_MODE, tol = tol)
 0602  endif
 0603End
 604
 605/// @copydoc SMALL_INT64_DOCU
 0606Function CHECK_SMALL_INT64(int64 var, [int64 tol])
 0607  if(ParamIsDefault(tol))
 0608    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, CHECK_MODE)
 0609  else
 0610    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, CHECK_MODE, tol = tol)
 0611  endif
 0612End
 613
 614/// @copydoc SMALL_INT64_DOCU
 0615Function REQUIRE_SMALL_INT64(int64 var, [int64 tol])
 0616  if(ParamIsDefault(tol))
 0617    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, REQUIRE_MODE)
 0618  else
 0619    IUTF_Wrapper#SMALL_INT64_WRAPPER(var, REQUIRE_MODE, tol = tol)
 0620  endif
 0621End
 622
 623/// @copydoc SMALL_UINT64_DOCU
 0624Function WARN_SMALL_UINT64(uint64 var, [uint64 tol])
 0625  if(ParamIsDefault(tol))
 0626    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, WARN_MODE)
 0627  else
 0628    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, WARN_MODE, tol = tol)
 0629  endif
 0630End
 631
 632/// @copydoc SMALL_UINT64_DOCU
 0633Function CHECK_SMALL_UINT64(uint64 var, [uint64 tol])
 0634  if(ParamIsDefault(tol))
 0635    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, CHECK_MODE)
 0636  else
 0637    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, CHECK_MODE, tol = tol)
 0638  endif
 0639End
 640
 641/// @copydoc SMALL_UINT64_DOCU
 0642Function REQUIRE_SMALL_UINT64(uint64 var, [uint64 tol])
 0643  if(ParamIsDefault(tol))
 0644    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, REQUIRE_MODE)
 0645  else
 0646    IUTF_Wrapper#SMALL_UINT64_WRAPPER(var, REQUIRE_MODE, tol = tol)
 0647  endif
 0648End
 649
 650/// @cond HIDDEN_SYMBOL
 651#endif
 652/// @endcond
 653
 654/// @copydoc EMPTY_STR_DOCU
 0655Function WARN_EMPTY_STR(str)
 656  string &str
 657
 0658  IUTF_Wrapper#EMPTY_STR_WRAPPER(str, WARN_MODE)
 0659End
 660
 661/// @copydoc EMPTY_STR_DOCU
 0662Function CHECK_EMPTY_STR(str)
 663  string &str
 664
 0665  IUTF_Wrapper#EMPTY_STR_WRAPPER(str, CHECK_MODE)
 0666End
 667
 668/// @copydoc EMPTY_STR_DOCU
 0669Function REQUIRE_EMPTY_STR(str)
 670  string &str
 671
 0672  IUTF_Wrapper#EMPTY_STR_WRAPPER(str, REQUIRE_MODE)
 0673End
 674
 675/// @copydoc NON_EMPTY_STR_DOCU
 0676Function WARN_NON_EMPTY_STR(str)
 677  string &str
 678
 0679  IUTF_Wrapper#NON_EMPTY_STR_WRAPPER(str, WARN_MODE)
 0680End
 681
 682/// @copydoc NON_EMPTY_STR_DOCU
 0683Function CHECK_NON_EMPTY_STR(str)
 684  string &str
 685
 0686  IUTF_Wrapper#NON_EMPTY_STR_WRAPPER(str, CHECK_MODE)
 0687End
 688
 689/// @copydoc NON_EMPTY_STR_DOCU
 0690Function REQUIRE_NON_EMPTY_STR(str)
 691  string &str
 692
 0693  IUTF_Wrapper#NON_EMPTY_STR_WRAPPER(str, REQUIRE_MODE)
 0694End
 695
 696/// @copydoc PROPER_STR_DOCU
 0697Function WARN_PROPER_STR(str)
 698  string &str
 699
 0700  IUTF_Wrapper#PROPER_STR_WRAPPER(str, WARN_MODE)
 0701End
 702
 703/// @copydoc PROPER_STR_DOCU
 0704Function CHECK_PROPER_STR(str)
 705  string &str
 706
 0707  IUTF_Wrapper#PROPER_STR_WRAPPER(str, CHECK_MODE)
 0708End
 709
 710/// @copydoc PROPER_STR_DOCU
 0711Function REQUIRE_PROPER_STR(str)
 712  string &str
 713
 0714  IUTF_Wrapper#PROPER_STR_WRAPPER(str, REQUIRE_MODE)
 0715End
 716
 717/// @copydoc NULL_STR_DOCU
 0718Function WARN_NULL_STR(str)
 719  string &str
 720
 0721  IUTF_Wrapper#NULL_STR_WRAPPER(str, WARN_MODE)
 0722End
 723
 724/// @copydoc NULL_STR_DOCU
 0725Function CHECK_NULL_STR(str)
 726  string &str
 727
 0728  IUTF_Wrapper#NULL_STR_WRAPPER(str, CHECK_MODE)
 0729End
 730
 731/// @copydoc NULL_STR_DOCU
 0732Function REQUIRE_NULL_STR(str)
 733  string &str
 734
 0735  IUTF_Wrapper#NULL_STR_WRAPPER(str, REQUIRE_MODE)
 0736End
 737
 738/// @copydoc NON_NULL_STR_DOCU
 0739Function WARN_NON_NULL_STR(str)
 740  string &str
 741
 0742  IUTF_Wrapper#NON_NULL_STR_WRAPPER(str, WARN_MODE)
 0743End
 744
 745/// @copydoc NON_NULL_STR_DOCU
 0746Function CHECK_NON_NULL_STR(str)
 747  string &str
 748
 0749  IUTF_Wrapper#NON_NULL_STR_WRAPPER(str, CHECK_MODE)
 0750End
 751
 752/// @copydoc NON_NULL_STR_DOCU
 0753Function REQUIRE_NON_NULL_STR(str)
 754  string &str
 755
 0756  IUTF_Wrapper#NON_NULL_STR_WRAPPER(str, REQUIRE_MODE)
 0757End
 758
 759/// @copydoc EQUAL_STR_DOCU
 0760Function WARN_EQUAL_STR(str1, str2, [case_sensitive])
 761  string str1, str2
 762  variable case_sensitive
 763
 0764  if(ParamIsDefault(case_sensitive))
 0765    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, WARN_MODE)
 0766  else
 0767    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, WARN_MODE, case_sensitive = case_sensitive)
 0768  endif
 0769End
 770
 771/// @copydoc EQUAL_STR_DOCU
 160772Function CHECK_EQUAL_STR(str1, str2, [case_sensitive])
 773  string str1, str2
 774  variable case_sensitive
 775
 160776  if(ParamIsDefault(case_sensitive))
 160777    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, CHECK_MODE)
 0778  else
 0779    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, CHECK_MODE, case_sensitive = case_sensitive)
 160780  endif
 160781End
 782
 783/// @copydoc EQUAL_STR_DOCU
 0784Function REQUIRE_EQUAL_STR(str1, str2, [case_sensitive])
 785  string str1, str2
 786  variable case_sensitive
 787
 0788  if(ParamIsDefault(case_sensitive))
 0789    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, REQUIRE_MODE)
 0790  else
 0791    IUTF_Wrapper#EQUAL_STR_WRAPPER(str1, str2, REQUIRE_MODE, case_sensitive = case_sensitive)
 0792  endif
 0793End
 794
 795/// @copydoc NEQ_STR_DOCU
 0796Function WARN_NEQ_STR(str1, str2, [case_sensitive])
 797  string str1, str2
 798  variable case_sensitive
 799
 0800  if(ParamIsDefault(case_sensitive))
 0801    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, WARN_MODE)
 0802  else
 0803    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, WARN_MODE, case_sensitive = case_sensitive)
 0804  endif
 0805End
 806
 807/// @copydoc NEQ_STR_DOCU
 0808Function CHECK_NEQ_STR(str1, str2, [case_sensitive])
 809  string str1, str2
 810  variable case_sensitive
 811
 0812  if(ParamIsDefault(case_sensitive))
 0813    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, CHECK_MODE)
 0814  else
 0815    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, CHECK_MODE, case_sensitive = case_sensitive)
 0816  endif
 0817End
 818
 819/// @copydoc NEQ_STR_DOCU
 0820Function REQUIRE_NEQ_STR(str1, str2, [case_sensitive])
 821  string str1, str2
 822  variable case_sensitive
 823
 0824  if(ParamIsDefault(case_sensitive))
 0825    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, REQUIRE_MODE)
 0826  else
 0827    IUTF_Wrapper#NEQ_STR_WRAPPER(str1, str2, REQUIRE_MODE, case_sensitive = case_sensitive)
 0828  endif
 0829End
 830
 831/// @copydoc WAVE_DOCU
 0832Function WARN_WAVE(wv, majorType, [minorType])
 833  WAVE/Z wv
 834  variable majorType, minorType
 835
 0836  if(ParamIsDefault(minorType))
 0837    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, WARN_MODE)
 0838  else
 0839    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, WARN_MODE, minorType = minorType)
 0840  endif
 0841End
 842
 843/// @copydoc WAVE_DOCU
 0844Function CHECK_WAVE(wv, majorType, [minorType])
 845  WAVE/Z wv
 846  variable majorType, minorType
 847
 0848  if(ParamIsDefault(minorType))
 0849    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, CHECK_MODE)
 0850  else
 0851    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, CHECK_MODE, minorType = minorType)
 0852  endif
 0853End
 854
 855/// @copydoc WAVE_DOCU
 0856Function REQUIRE_WAVE(wv, majorType, [minorType])
 857  WAVE/Z wv
 858  variable majorType, minorType
 859
 0860  if(ParamIsDefault(minorType))
 0861    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, REQUIRE_MODE)
 0862  else
 0863    IUTF_Wrapper#TEST_WAVE_WRAPPER(wv, majorType, REQUIRE_MODE, minorType = minorType)
 0864  endif
 0865End
 866
 867/// @copydoc EQUAL_WAVE_DOCU
 0868Function WARN_EQUAL_WAVES(wv1, wv2, [mode, tol])
 869  WAVE/Z wv1, wv2
 870  variable mode, tol
 871
 0872  if(ParamIsDefault(mode) && ParamIsDefault(tol))
 0873    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE)
 0874  elseif(ParamIsDefault(tol))
 0875    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE, mode = mode)
 0876  elseif(ParamIsDefault(mode))
 0877    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE, tol = tol)
 0878  else
 0879    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE, tol = tol, mode = mode)
 0880  endif
 0881End
 882
 883/// @copydoc EQUAL_WAVE_DOCU
 0884Function CHECK_EQUAL_WAVES(wv1, wv2, [mode, tol])
 885  WAVE/Z wv1, wv2
 886  variable mode, tol
 887
 0888  if(ParamIsDefault(mode) && ParamIsDefault(tol))
 0889    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE)
 0890  elseif(ParamIsDefault(tol))
 0891    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE, mode = mode)
 0892  elseif(ParamIsDefault(mode))
 0893    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE, tol = tol)
 0894  else
 0895    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE, tol = tol, mode = mode)
 0896  endif
 0897End
 898
 899/// @copydoc EQUAL_WAVE_DOCU
 0900Function REQUIRE_EQUAL_WAVES(wv1, wv2, [mode, tol])
 901  WAVE/Z wv1, wv2
 902  variable mode, tol
 903
 0904  if(ParamIsDefault(mode) && ParamIsDefault(tol))
 0905    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE)
 0906  elseif(ParamIsDefault(tol))
 0907    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE, mode = mode)
 0908  elseif(ParamIsDefault(mode))
 0909    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE, tol = tol)
 0910  else
 0911    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE, tol = tol, mode = mode)
 0912  endif
 0913End
 914
 915#if (IgorVersion() >= 7.00)
 916
 0917Function WARN_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 918  WAVE/Z/T wv1, wv2
 919  variable mode
 920
 0921  if(ParamIsDefault(mode))
 0922    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE)
 0923  else
 0924    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE, mode = mode)
 0925  endif
 0926End
 927
 0928Function CHECK_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 929  WAVE/Z/T wv1, wv2
 930  variable mode
 931
 0932  if(ParamIsDefault(mode))
 0933    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE)
 0934  else
 0935    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE, mode = mode)
 0936  endif
 0937End
 938
 0939Function REQUIRE_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 940  WAVE/Z/T wv1, wv2
 941  variable mode
 942
 0943  if(ParamIsDefault(mode))
 0944    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE)
 0945  else
 0946    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE, mode = mode)
 0947  endif
 0948End
 949
 950#else
 951
 952/// @class TEXT_WAVE_EQUAL_DOCU
 953/// Tests two text waves for equality
 954///
 955/// @param wv1    first text wave, can be invalid for Igor Pro 7 or later
 956/// @param wv2    second text wave, can be invalid for Igor Pro 7 or later
 957/// @param mode   (optional) features of the waves to compare, defaults to all modes
 958///
 959/// @verbatim embed:rst:leading-slashes
 960/// See also :ref:`flags_testwave`.
 961/// @endverbatim
 962///
 963
 964/// @copydoc TEXT_WAVE_EQUAL_DOCU
 965Function WARN_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 966  WAVE/T wv1, wv2
 967  variable mode
 968
 969  if(ParamIsDefault(mode))
 970    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE)
 971  else
 972    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, WARN_MODE, mode = mode)
 973  endif
 974End
 975
 976/// @copydoc TEXT_WAVE_EQUAL_DOCU
 977Function CHECK_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 978  WAVE/T wv1, wv2
 979  variable mode
 980
 981  if(ParamIsDefault(mode))
 982    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE)
 983  else
 984    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, CHECK_MODE, mode = mode)
 985  endif
 986End
 987
 988/// @copydoc TEXT_WAVE_EQUAL_DOCU
 989Function REQUIRE_EQUAL_TEXTWAVES(wv1, wv2, [mode])
 990  WAVE/T wv1, wv2
 991  variable mode
 992
 993  if(ParamIsDefault(mode))
 994    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE)
 995  else
 996    IUTF_Wrapper#EQUAL_WAVE_WRAPPER(wv1, wv2, REQUIRE_MODE, mode = mode)
 997  endif
 998End
 999
 1000#endif
 1001
 1002/// @copydoc CDF_EMPTY_DOCU
 01003Function WARN_EMPTY_FOLDER()
 01004  IUTF_Wrapper#CDF_EMPTY_WRAPPER(WARN_MODE)
 01005End
 1006
 1007/// @copydoc CDF_EMPTY_DOCU
 01008Function CHECK_EMPTY_FOLDER()
 01009  IUTF_Wrapper#CDF_EMPTY_WRAPPER(CHECK_MODE)
 01010End
 1011
 1012/// @copydoc CDF_EMPTY_DOCU
 01013Function REQUIRE_EMPTY_FOLDER()
 01014  IUTF_Wrapper#CDF_EMPTY_WRAPPER(REQUIRE_MODE)
 01015End
 1016
 1017/// @copydoc RTE_DOCU
 01018Function WARN_RTE(code)
 1019  variable code
 01020  IUTF_Wrapper#RTE_WRAPPER(code, WARN_MODE)
 01021End
 1022
 1023/// @copydoc RTE_DOCU
 01024Function CHECK_RTE(code)
 1025  variable code
 01026  IUTF_Wrapper#RTE_WRAPPER(code, CHECK_MODE)
 01027End
 1028
 1029/// @copydoc RTE_DOCU
 01030Function REQUIRE_RTE(code)
 1031  variable code
 01032  IUTF_Wrapper#RTE_WRAPPER(code, REQUIRE_MODE)
 01033End
 1034
 1035/// @copydoc ANY_RTE_DOCU
 01036Function WARN_ANY_RTE()
 01037  IUTF_Wrapper#ANY_RTE_WRAPPER(WARN_MODE)
 01038End
 1039
 1040/// @copydoc ANY_RTE_DOCU
 01041Function CHECK_ANY_RTE()
 01042  IUTF_Wrapper#ANY_RTE_WRAPPER(CHECK_MODE)
 01043End
 1044
 1045/// @copydoc ANY_RTE_DOCU
 01046Function REQUIRE_ANY_RTE()
 01047  IUTF_Wrapper#ANY_RTE_WRAPPER(REQUIRE_MODE)
 01048End
 1049
 1050/// @copydoc NO_RTE_DOCU
 01051Function WARN_NO_RTE()
 01052  IUTF_Wrapper#NO_RTE_WRAPPER(WARN_MODE)
 01053End
 1054
 1055/// @copydoc NO_RTE_DOCU
 01056Function CHECK_NO_RTE()
 01057  IUTF_Wrapper#NO_RTE_WRAPPER(CHECK_MODE)
 01058End
 1059
 1060/// @copydoc NO_RTE_DOCU
 01061Function REQUIRE_NO_RTE()
 01062  IUTF_Wrapper#NO_RTE_WRAPPER(REQUIRE_MODE)
 01063End
 1064
 1065/// @copydoc COMPILATION_DOCU
 01066Function WARN_COMPILATION(file, [defines, reentry])
 1067  string file, reentry
 1068  WAVE/Z/T defines
 1069
 01070  if(ParamIsDefault(defines))
 01071    if(ParamIsDefault(reentry))
 01072      IUTF_Wrapper#COMPILATION_WRAPPER(file, WARN_MODE)
 01073    else
 01074      IUTF_Wrapper#COMPILATION_WRAPPER(file, WARN_MODE, reentry = reentry)
 01075    endif
 01076  else
 01077    if(ParamIsDefault(reentry))
 01078      IUTF_Wrapper#COMPILATION_WRAPPER(file, WARN_MODE, defines = defines)
 01079    else
 01080      IUTF_Wrapper#COMPILATION_WRAPPER(file, WARN_MODE, defines = defines, reentry = reentry)
 01081    endif
 01082  endif
 01083End
 1084
 1085/// @copydoc COMPILATION_DOCU
 21086Function CHECK_COMPILATION(file, [defines, reentry])
 1087  string file, reentry
 1088  WAVE/Z/T defines
 1089
 21090  if(ParamIsDefault(defines))
 11091    if(ParamIsDefault(reentry))
 11092      IUTF_Wrapper#COMPILATION_WRAPPER(file, CHECK_MODE)
 01093    else
 01094      IUTF_Wrapper#COMPILATION_WRAPPER(file, CHECK_MODE, reentry = reentry)
 11095    endif
 11096  else
 11097    if(ParamIsDefault(reentry))
 11098      IUTF_Wrapper#COMPILATION_WRAPPER(file, CHECK_MODE, defines = defines)
 01099    else
 01100      IUTF_Wrapper#COMPILATION_WRAPPER(file, CHECK_MODE, defines = defines, reentry = reentry)
 11101    endif
 21102  endif
 21103End
 1104
 1105/// @copydoc COMPILATION_DOCU
 01106Function REQUIRE_COMPILATION(file, [defines, reentry])
 1107  string file, reentry
 1108  WAVE/Z/T defines
 1109
 01110  if(ParamIsDefault(defines))
 01111    if(ParamIsDefault(reentry))
 01112      IUTF_Wrapper#COMPILATION_WRAPPER(file, REQUIRE_MODE)
 01113    else
 01114      IUTF_Wrapper#COMPILATION_WRAPPER(file, REQUIRE_MODE, reentry = reentry)
 01115    endif
 01116  else
 01117    if(ParamIsDefault(reentry))
 01118      IUTF_Wrapper#COMPILATION_WRAPPER(file, REQUIRE_MODE, defines = defines)
 01119    else
 01120      IUTF_Wrapper#COMPILATION_WRAPPER(file, REQUIRE_MODE, defines = defines, reentry = reentry)
 01121    endif
 01122  endif
 01123End
 1124
 1125/// @copydoc NO_COMPILATION_DOCU
 01126Function WARN_NO_COMPILATION(file, [defines, reentry])
 1127  string file, reentry
 1128  WAVE/Z/T defines
 1129
 01130  if(ParamIsDefault(defines))
 01131    if(ParamIsDefault(reentry))
 01132      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, WARN_MODE)
 01133    else
 01134      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, WARN_MODE, reentry = reentry)
 01135    endif
 01136  else
 01137    if(ParamIsDefault(reentry))
 01138      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, WARN_MODE, defines = defines)
 01139    else
 01140      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, WARN_MODE, defines = defines, reentry = reentry)
 01141    endif
 01142  endif
 01143End
 1144
 1145/// @copydoc NO_COMPILATION_DOCU
 21146Function CHECK_NO_COMPILATION(file, [defines, reentry])
 1147  string file, reentry
 1148  WAVE/Z/T defines
 1149
 21150  if(ParamIsDefault(defines))
 21151    if(ParamIsDefault(reentry))
 11152      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, CHECK_MODE)
 11153    else
 11154      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, CHECK_MODE, reentry = reentry)
 21155    endif
 01156  else
 01157    if(ParamIsDefault(reentry))
 01158      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, CHECK_MODE, defines = defines)
 01159    else
 01160      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, CHECK_MODE, defines = defines, reentry = reentry)
 01161    endif
 21162  endif
 21163End
 1164
 1165/// @copydoc NO_COMPILATION_DOCU
 01166Function REQUIRE_NO_COMPILATION(file, [defines, reentry])
 1167  string file, reentry
 1168  WAVE/Z/T defines
 1169
 01170  if(ParamIsDefault(defines))
 01171    if(ParamIsDefault(reentry))
 01172      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, REQUIRE_MODE)
 01173    else
 01174      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, REQUIRE_MODE, reentry = reentry)
 01175    endif
 01176  else
 01177    if(ParamIsDefault(reentry))
 01178      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, REQUIRE_MODE, defines = defines)
 01179    else
 01180      IUTF_Wrapper#NO_COMPILATION_WRAPPER(file, REQUIRE_MODE, defines = defines, reentry = reentry)
 01181    endif
 01182  endif
 01183End
 1184
 1185///@}
Generated by: ReportGenerator 5.1.17.0
06/01/2025 - 18:50:51
GitHub | reportgenerator.io

Methods/Properties

PASS()
FAIL()
SKIP_TESTCASE_EXPECT_FAILS()
SKIP_TESTCASE()
INFO()
WARN()
CHECK()
REQUIRE()
WARN_EQUAL_VAR()
CHECK_EQUAL_VAR()
REQUIRE_EQUAL_VAR()
WARN_LE_VAR()
CHECK_LE_VAR()
REQUIRE_LE_VAR()
WARN_LT_VAR()
CHECK_LT_VAR()
REQUIRE_LT_VAR()
WARN_GE_VAR()
CHECK_GE_VAR()
REQUIRE_GE_VAR()
WARN_GT_VAR()
CHECK_GT_VAR()
REQUIRE_GT_VAR()
WARN_NEQ_VAR()
CHECK_NEQ_VAR()
REQUIRE_NEQ_VAR()
WARN_CLOSE_VAR()
CHECK_CLOSE_VAR()
REQUIRE_CLOSE_VAR()
WARN_CLOSE_CMPLX()
CHECK_CLOSE_CMPLX()
REQUIRE_CLOSE_CMPLX()
WARN_CLOSE_INT64()
CHECK_CLOSE_INT64()
REQUIRE_CLOSE_INT64()
WARN_CLOSE_UINT64()
CHECK_CLOSE_UINT64()
REQUIRE_CLOSE_UINT64()
WARN_SMALL_VAR()
CHECK_SMALL_VAR()
REQUIRE_SMALL_VAR()
WARN_SMALL_CMPLX()
CHECK_SMALL_CMPLX()
REQUIRE_SMALL_CMPLX()
WARN_SMALL_INT64()
CHECK_SMALL_INT64()
REQUIRE_SMALL_INT64()
WARN_SMALL_UINT64()
CHECK_SMALL_UINT64()
REQUIRE_SMALL_UINT64()
WARN_EMPTY_STR()
CHECK_EMPTY_STR()
REQUIRE_EMPTY_STR()
WARN_NON_EMPTY_STR()
CHECK_NON_EMPTY_STR()
REQUIRE_NON_EMPTY_STR()
WARN_PROPER_STR()
CHECK_PROPER_STR()
REQUIRE_PROPER_STR()
WARN_NULL_STR()
CHECK_NULL_STR()
REQUIRE_NULL_STR()
WARN_NON_NULL_STR()
CHECK_NON_NULL_STR()
REQUIRE_NON_NULL_STR()
WARN_EQUAL_STR()
CHECK_EQUAL_STR()
REQUIRE_EQUAL_STR()
WARN_NEQ_STR()
CHECK_NEQ_STR()
REQUIRE_NEQ_STR()
WARN_WAVE()
CHECK_WAVE()
REQUIRE_WAVE()
WARN_EQUAL_WAVES()
CHECK_EQUAL_WAVES()
REQUIRE_EQUAL_WAVES()
WARN_EQUAL_TEXTWAVES()
CHECK_EQUAL_TEXTWAVES()
REQUIRE_EQUAL_TEXTWAVES()
WARN_EMPTY_FOLDER()
CHECK_EMPTY_FOLDER()
REQUIRE_EMPTY_FOLDER()
WARN_RTE()
CHECK_RTE()
REQUIRE_RTE()
WARN_ANY_RTE()
CHECK_ANY_RTE()
REQUIRE_ANY_RTE()
WARN_NO_RTE()
CHECK_NO_RTE()
REQUIRE_NO_RTE()
WARN_COMPILATION()
CHECK_COMPILATION()
REQUIRE_COMPILATION()
WARN_NO_COMPILATION()
CHECK_NO_COMPILATION()
REQUIRE_NO_COMPILATION()