Tech Tip: Using assertions to produce error free code

PRODUCT: 4D | VERSION: 11 | PLATFORM: Mac & Win

Published On: July 9, 2009

An assertion is a statement in many programming languages such as C, C++, Java, etc., that enables you to test your assumptions about your program. For example, if you write a method that calculates the speed of a particle, you might assert that the calculated speed is less than the speed of light.

Each assertion contains a boolean expression that you believe will be true when the assertion executes. If it is not true, the system will throw an error. By verifying that the boolean expression is indeed true, the assertion confirms your assumptions about the behavior of your program, increasing your confidence that the program is free of errors.

Experience has shown that writing assertions while programming is one of the quickest and most effective ways to detect and correct bugs. As an added benefit, assertions serve to document the inner workings of your program, enhancing maintainability.

For more information on assertions see Assertion (Computing) on Wikipedia.

This Tech Tip explores a way to use assertions in 4D language and help you develop error free code faster.

In other languages, assertions (assert) is a language "macro". Language macros, such as "assert", exist in the source code then depending on a "pragma directive" at compilation time, the assertion code may or may not be compiled ito the executable. Those types to language extension, macros and pragma directives, are not a feature of the 4D language.

Given that, the "Assert" method below tests for whether or not the 4D application is compiled. If it is compiled the method simply returns true. The assumption of the method is that sufficient testing has been done in interpreted mode.

The Assert method simply takes a boolean expression and asserts its truth. If the expression is true, execution continues without any noticeable interruption. However, if the assertion is false, it halts code execution immediately by displaying an alert that displays the name of the affected method and the message that was stipulated in the third parameter. It also gives the opportunity to drop into the degugger by holding down the Shift key when dismissing the alert.

Use Assert as follows: Assert($Condition;$CallingMethod;$AlertMsg)

One example is shown here:

If (Assert ($Divider>0;$MethodName_T;"Divide by zero condition!"))
`Do Something
end if

The Assert method follows:

C_BOOLEAN($0;$Condition;$1)
C_TEXT($Caller;$2)
C_TEXT($AlertMsg;$3)

If (Is compiled mode)
  `If compiled the assumption is the calling method has already passed this test
  $0:=True
Else
  If (Count parameters#3)
    ALERT(Current method name+": Assert called with incorrect # of parameters (3).")
    $Condition:=False
  Else
    $Condition:=$1
    If (Not($Condition))
      $Caller:=$2
      $AlertMsg:=$3
      ALERT($Caller+": "+$AlertMsg)

      If(Shift down)
        Trace
      End if
    End if
  End if

  $0:=$Condition

End if

Commented by Atanas Atanassov on July 9, 2009 at 3:27 PM

Great tech tip and my comment is for those who want to use it to check for "Divide by zero conditon". The first parameter of Assert method- $Divider should be either $Divider#0 or Abs($Divider)>0. In this way we will include dividers less than 0. As I said, very useful tech tip, just a little bit math nuance!