[vc_row][vc_column width=”1/1″ animate=”false” effect=”fade” margin_b=”true” text_align=”left” pl=”40″ pr=”40″ pt=”0″ pb=”0″][vc_column_text pl=”0″ pr=”0″ pt=”0″ pb=”0″]

Lack of multiple-inclusion protection in header files

 

[/vc_column_text][nz_btn text=”Software Resiliency” link=”http://casthighlight.wpengine.com/category/product/indicators-methodology/code-insights/software-resiliency/” target=”_self” animate=”false” animation_type=”ghost” color=”pink” size=”small” shape=”rounded” type=”normal” hover_normal=”fill” hover_ghost=”fill”][nz_btn text=”Programming Best Practices” link=”http://casthighlight.wpengine.com/category/product/indicators-methodology/code-insights/software-resiliency/programming-best-practices/” target=”_self” animate=”false” animation_type=”ghost” color=”black” size=”small” shape=”rounded” type=”ghost” hover_normal=”fill” hover_ghost=”fill”][vc_empty_space height=”32px”][vc_separator color=”grey” align=”align_center”][vc_column_text pl=”0″ pr=”0″ pt=”0″ pb=”0″]

This code insight verifies in C++ applications that header files (.h) are protected against multiple inclusion. If a header file is not using the appropriate syntax, Highlight counts an occurrence.

[/vc_column_text][vc_separator color=”grey” align=”align_center”][vc_column_text pl=”0″ pr=”0″ pt=”0″ pb=”0″]

Why you should care

The basic use of header files is to provide symbol declarations for functions and globals. Because multiple declarations of a given symbol in a single translation unit are a syntax error, you have to defensively structure your header files to not redefine anything in case they are included multiple times.[/vc_column_text][vc_separator color=”grey” align=”align_center”][vc_column_text pl=”0″ pr=”0″ pt=”0″ pb=”0″]

CAST recommendations

As Julio Merino advised in his excellent blog article on this topic, just follow this pattern and encapsulate the whole contents of the whole header file within a guard:

#if !defined(PROJECT_MODULE_H)
#define PROJECT_MODULE_H

... all header file contents go here ...

#endif  /* !defined(PROJECT_MODULE_H) */

 

References

http://julio.meroh.net/2013/11/header-files-multiple-inclusion.html

 

[vc_separator color=”grey” align=”align_center” style=”” border_width=”” el_width=””][vc_column_text pl=”0″ pr=”0″ pt=”0″ pb=”0″]

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.[/vc_column_text][nz_btn text=”How it works” link=”http://casthighlight.wpengine.com/how-it-works/” target=”_self” animate=”true” animation_type=”ghost” color=”black” size=”small” shape=”rounded” type=”normal” hover_normal=”fill” hover_ghost=”fill” icon=”icon-cog”][nz_btn text=”Features & Analytics” link=”http://casthighlight.wpengine.com/outputs-analytics/” target=”_self” animate=”true” animation_type=”ghost” color=”pink” size=”small” shape=”rounded” type=”ghost” hover_normal=”fill” hover_ghost=”fill” icon=”icon-stats”][/vc_column][/vc_row]