Using HP Code Advisor in Application Builds: [HP Code Advisor] White Paper

ManualsBrandsHP ManualsSoftwareHP General Developer Tools Software

Abstract.............................................................................................................................................. 2

Intended audience ............................................................................................................................... 2

Prerequisites........................................................................................................................................ 2

Terms and definitions ........................................................................................................................... 2

Related information.............................................................................................................................. 2

Introduction......................................................................................................................................... 3

Using cadvise with the builds ................................................................................................................ 3

Method 1: Controlling use of cadvise through makefile variables........................................................... 4

Method 2: Introducing a cadvise-specific target................................................................................... 6

Method 3: Using compiler wrappers .................................................................................................. 9

For more information............................................................................................................................ 9

Using HP Code Advisor in Application

Builds: [HP Code Advisor] White Paper

Summary of content (9 pages)

PAGE 1
Using HP Code Advisor in Application Builds: [HP Code Advisor] White Paper Abstract.............................................................................................................................................. 2 Intended audience ............................................................................................................................... 2 Prerequisites..........................................................................................................................
PAGE 2
Abstract This document describes methods for using HP Code Advisor in the build environment of your application. Intended audience This document is intended for C/C++ developers who want to integrate HP Code Advisor in their application build process. The application is assumed to span over multiple source files and organized to manage the build by one or more makefiles.
PAGE 3
Introduction HP Code Advisor (cadvise), is a static analysis tool for C and C++ programs. It reports various coding errors in the source code. Cadvise analyses the source code using the same language mode, defines, header files etc. as used by your compiler. Therefore, cadvise requires an entire build line as the input. This is achieved by prefixing cadvise to the regular build line.
PAGE 4
• The application in consideration has two .c files and a .h file. • The makefile uses conventionally named variables, CC and LD, to define the compiler and linker. • The makefile has two target definitions as listed below: – A default target called YourApplication, which is used to build the application. – A clean target, which is used to remove objects generated during the build. • Building using this makefile results in the following output: $ make aCC -c -Ae -O -I. source1.c source2.c source1.
PAGE 5
You can build your application using cadvise by overriding the cadvise corresponding variables from the command line, as shown below: $ CADVISE=”cadvise” CADVISE_OPTS="-pdb YourApplication.pdb" make cadvise -pdb YourApplication.pdb aCC -c -Ae -O -I. source1.c source2.c source1.c: source2.c: cadvise -pdb YourApplication.pdb aCC -o YourApplication source1.o source2.
PAGE 6
Figure 3: Creating a command-line switch # This is a sample Makefile # This is used to illustrate how Cadvise can be incorporated into # application builds # List of source code files SOURCES = source1.c source2.c # Create a list of the object files using macro substitutions OBJECTS = $(SOURCES:.c=.o) # Conditional switch option ifeq ($(USE_CADVISE),yes) CADVISE=cadvise CADVISE_OPTS= -pdb YourApplication.
PAGE 7
Figure 4: Introducing a target to invoke the build through cadvise # This is a sample Makefile # This is used to illustrate how Cadvise can be incorporated into # application builds # List of source code files SOURCES = source1.c source2.c # Create a list of the object files using macro substitutions OBJECTS = $(SOURCES:.c=.o) # Build tools and options # Use aCC as the default C compiler CC = aCC # Flags CFLAGS = -c -Ae -O -I.
PAGE 8
Figure 5: Implementing custom actions to check code quality # This is a sample Makefile # This is used to illustrate how Cadvise can be incorporated into # application builds # List of source code files SOURCES = source1.c source2.c # Create a list of the object files using macro substitutions OBJECTS = $(SOURCES:.c=.o) # Build tools and options # Use aCC as the default C compiler CC = aCC # Flags CFLAGS = -c -Ae -O -I.
PAGE 9
Method 3: Using compiler wrappers It is common in several build environments for compilers to be invoked through wrappers. Since cadvise will not be able to recognize this wrapper as a supported compiler, you need to use the – compiler to specify the name of the actual compiler being used from within the wrapper.