Dr. Dobb's is part of the Informa Tech Division of Informa PLC

This site is operated by a business or businesses owned by Informa PLC and all copyright resides with them. Informa PLC's registered office is 5 Howick Place, London SW1P 1WG. Registered in England and Wales. Number 8860726.


Channels ▼
RSS

Tools

Code Quality Improvement


C/C++ Coding Standards

The Mobile project uses a set of project-specific coding standards derived from general Samsung coding standards. The Mobile project standards could be rewritten by taking into account the language variances and other development constraints. For example, some compilers used in the Mobile project do not support exception handling. Therefore, it is impossible to detect resource allocation failures while an object's constructors are called. The Mobile project solves this problem by employing the well-known two-phase object construction technique described in the Mobile project coding standards: Divide an object initialization into the object allocation phase and the resource allocation phase to return the exception as a value (see Listing One).

    class ResourceManager
    {
       ResourceManager(); // allocate only object
       result Construct(); // allocate resources
                        // 'result' contains error code 
    };
    int main()
    {
       // Two phase construction
    ResourceManager aObject; 
    if (aObject.Construct() == FAIL) 
    printf("Resource allocation is failed");
    }
Listing One

Additionally, the Mobile project requires rigid conformance to coding standards. This project mainly targets a software framework to be used by other developers; it must be consistent and well organized to facilitate software development on this framework. The more project constraints there are, the greater the necessity for an automated tool. That's why the Mobile project adopted a coding standards checker.

C++test from Parasoft (www.parasoft.com) provides automated C/C++ unit testing, as well as automated coding standards checking. We chose C++test as our coding standards checker because it was the most effective solution for the majority of our considerations.

One of C++test's distinct features is its GUI-based rules. Figure 1 shows the GUI rule description for the rule "Each global variable must be initialized." Whenever a "global variable" is found while parsing the source code, the rule evaluates logic components. A violation is reported if any of the following conditions are not met:

  • The detected global variable is an external declaration.
  • It does not have an initializer.
  • Its type is not an array or a class.

Figure 1: The GUI-based coding standard rules in Parasoft C++test.

The GUI interface simplifies rule creation. Most C++ code checkers require scripting for rule creation; this is difficult and requires more C++ programming knowledge.

GUI-based rules can be easily understood and implemented because the available conditions are shown graphically. Having GUI-based rules could compromise extensibility because only predefined nodes and condition sets can be selected in a GUI. However, C++test provides Python scripting support to ensure extensibility.


Related Reading


More Insights






Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

 
Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.