You can use four macros liberally in your code to verify assumptions and to alert you when problems arise in your application. These macros are executed only with Debug builds of your applications. When you make Release builds, these macros are removed.
New Term: Macro
A macro in C++ (also in the predecessor C programming language) is a pseudo-function created using the #define pre-compiler directive. Prior to compiling, the macro is replaced by all code used in the macro definition to define the macro functionality. One benefit of using macros is it allows the designers of MFC to define one implementation of a particular macro for Debug builds, and another for Release builds.
C++ Sidebar: Pre-Compiler Directives
In the C and C++ programming languages, all source code files are passed through a pre-compiler before compiling the code. The pre-compiler processes some specific directives, expanding the code to be compiled significantly. All pre-compiler directives are recognizable because they start with the pound symbol (#) as the very first character in the line, prior to any character other than white-space. The primary pre-compiler directives are listed in Table 2.1.
Table 2.1 C/C++ Pre-Compiler Directives
This directive instructs the pre-compiler to insert the contents of the specified file at this location. If the file name is enclosed with the less-than/greater-than brackets (<>), the configured directories are searched for the file specified. If quotes ("") are used, the path specified with the file name is used to find the file. The path can be either a relative path (from the project directory), or an absolute path (including the drive letter).
#define CONSTANT value
This directive is used to define a constant value. The constant is normally declared in all uppercase. The pre-compiler replaces every occurrence of the constant with the value prior to compiling.
This directive is used to define a macro. The macro is normally declared in all upper-case. The pre-compiler replaces every occurrence of the macro with the definition of the macro prior to compiling. When the pre-compiler processes the macro, it goes through the definition and replaces all occurrences of the parameters with the actual variables or values that are supplied in each use of the macro.
This directive tells the pre-compiler to include the following section of code only if the specified constant has already been defined.
This directive tells the pre-compiler to include the following section of code only if the specified constant has not been defined.
This directive is used with the prior two directives, marking the next section to be included depending on whether the condition was met for including the prior section.
This directive is used to mark the end of the sections to be conditionally included or excluded from the code to be compiled.
This directive is used to specify some compiler or machine specific option. There are many options available for use with the #pragma directive with most C/C++ compilers. To determine which #pragma options are available with a specific compiler, you need to reference the compiler's documentation (we'll look at some of the #pragma options available in Visual C++ from time to time as we make our way through this book).
Start working with pre-compiler directives slowly. You should start by using only the #include directive to include needed header files, and the #define directive to define constants. Leave the other directives until you have a bit of experience under your belt; using them can result in confusing and unexpected results if you don't thoroughly think through how and when to use them.
There are four macros that you can use in your code to test various assumptions that you make while designing and building your applications. These are a series of variations on the first one of these macros, called ASSERT. The syntax for this macro is as follows:
The parameter that is passed into this macro is any Boolean expression that should always evaluate to TRUE. For example, if you have a function with a parameter a that should always be positive in value, you can test it with an ASSERT as follows:
ASSERT(a >= 0);
If ever this function is called with a negative value passed in the a parameter, ASSERT will pop-up a warning like that shown in Figure 2.2, pointing you to the specific ASSERT that failed.
Figure 2.2 An ASSERT alerting you to a problem in your application.
Never place necessary functionality in the parameter being passed to the ASSERT macro.
One thing to keep in mind when using ASSERT is that when you create a Release build of your application, all uses of ASSERT are removed from the application. If you have used any program logic in the parameter being passed to this macro, it too will be removed from the application.
There are two variations on ASSERT that can be used to test classes and objects in your code. The first of these, ASSERT_VALID, is used as such:
This version is used to test objects being used in your application to verify that they are valid objects, and that there are no problems with the internal state of the object. The one parameter passed into this macro is an instantiated C++ object.The ASSERT_VALID macro does not work on all C++ objects. The object must be inherited from the CObject base class, and must have overridden the AssertValid member function. For most standard MFC classes, these criteria are met. For testing your own classes, you'll need to keep these requirements in mind when designing the classes.
The second variation on ASSERT is the ASSERT_KINDOF macro, which is used as follows:
This macro validates that an object is a specific class, or is derived from that specific class. The first parameter is the class name that the second parameter needs to be an instance of.This function can only be used to verify the class of classes that meet other specific criteria, such as it has to be a descendent of the CObject class, and must have one of two other macros used in the class declaration. This is getting well ahead of ourselves if you don't already know the C++ programming language. You might have to look back at this note once you have a more thorough understanding of C++ and the MFC class library. The two macros that the class must have used one of in its declaration are DECLARE_DYNAMIC or DECLARE_SERIAL.
Like the ASSERT macro, both variations are completely removed from Release builds of applications, so don't use these in place of necessary logic. You want to use these macros only for verifying assumptions in your code.
There is one last variation on the ASSERT macro that is uniquely different, yet the same. This is the VERIFY macro. It is used just like the ASSERT macro, as follows:
One key difference between the VERIFY and ASSERT macro is that any logic passed as the parameter to the VERIFY macro remains in the application when a Release build is made. This means that you can put actual program logic in the parameter to the VERIFY macro, and that logic will not be removed when you make a Release build. However, just like the ASSERT macro, the VERIFY macro will only test the expression and alert you if it's FALSE in Debug builds of your applications.