SlideShare ist ein Scribd-Unternehmen logo
1 von 7
Downloaden Sie, um offline zu lesen
How to make fewer errors at the stage of
code writing. Part N2.
Author: Andrey Karpov

Date: 29.03.2011


Abstract
This is the second article on avoiding certain errors at the early stage of code writing. In the previous
post, we have already advised you to avoid a large number of calculations in one expression. However,
we should investigate this question in detail. Let's see what's dangerous about complex expressions and
                                                                        ous
how we can avoid many logical errors
                                 errors.


Introduction




You may read the previous post here. This time we'll take error samples from various famous projects to
                                       .
stress their prevalence. The errors I'm going to demonstrate here were found with the help of the PVS-
                        .
Studio analyzer during a relatively large term. I have informed developers of almost all the projects
about the errors, so I hope they will fix the defects in new code revisions. I'm writing this in introduct
                                                                           .                     introduction
because I always receive letters after publishing articles with a request "please inform the project's
developers about the errors you've found
                                      found".


1. Do not use the ternary operation '?:' in compound expressions
A ternary conditional operation is written in C/C++ code with the '?:' operator This is an operation that
                                                                       operator.
returns its second or third operand depending on the value of the logical expression defined by the fifirst
operand. For example:

int minValue = A < B ? A : B;

A ternary operation has a very low priority (see the table). Programmers often forget about it and that is
why the ternary operation is quite dange
                                   dangerous.
Figure 1 - C/C++ operations arranged in priority descending order

Note that the '?:' operation has a lower priority than addition, multiplication, bitwise OR operator and
so on. Consider this code:

int Z = X + (A == B) ? 1 : 2;

It works differently than it might seem at first sight. Most likely, the programmer intended to add the X
value to number 1 or 2 depending on the (A == B) condition. But actually it is the "X + (A == B)"
expression which is the condition. In fact, it is this code written in the project:

int Z = (X + (A == B)) ? 1 : 2;

While the programmer wanted this to be:
int Z = X + (A == B ? 1 : 2);

What occurs to you first is that you just should know the priorities of operations. Well, programmers do
know them but too insidious is this ternary operation! Not only novices make mistakes with it but
experienced programmers as well. You may easily find them even in the most quality code. Here are a
couple of examples.




V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a
lower priority than the '*' operator. physics dgminkowskiconv.cpp 1061

dgInt32 CalculateConvexShapeIntersection (...)

{

    ...

 den = dgFloat32 (1.0e-24f) *

             (den > dgFloat32 (0.0f)) ?

                  dgFloat32 (1.0f) : dgFloat32 (-1.0f);

    ...

}




V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a
lower priority than the '-' operator. views custom_frame_view.cc 400

static const int kClientEdgeThickness;

int height() const;

bool ShouldShowClientEdge() const;
void CustomFrameView::PaintMaximizedFrameBorder(gfx::Canvas* canvas) {

    ...

    int edge_height = titlebar_bottom->height() -

                               ShouldShowClientEdge() ? kClientEdgeThickness : 0;

    ...

}




V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a
lower priority than the '|' operator. vm vm_file_win.c 393

#define FILE_ATTRIBUTE_NORMAL                      0x00000080

#define FILE_FLAG_NO_BUFFERING                      0x20000000

vm_file* vm_file_fopen(...)

{

    ...

    mds[3] = FILE_ATTRIBUTE_NORMAL |

                 (islog == 0) ? 0 : FILE_FLAG_NO_BUFFERING;

    ...

}

As you may see, errors of this type deserve consideration. That is why I've made a separate paragraph to
describe them. They are quite widely-spread. I could give you some more examples but they all are
similar.

You can avoid such errors if you give up trying to place several operations into a single line of code. Or if
you still want to do that, do not be greedy to add parentheses. I will speak of parentheses a bit later.
Now let's try to avoid potential errors when using '?:'.

Of course the '?:' operator is certainly a syntactic sugar and you can replace it with if in most cases.
Among rare exceptions are such tasks as reference initialization:

MyObject &ref = X ? A : B;
Certainly there are no problems with it either, but creation of a reference to A or B without '?:' operator
takes more lines of code to implement:

MyObject *tmpPtr;

If (X)

   tmpPtr = &A;

else

   tmpPtr = &B;

MyObject &ref = *tmpPtr;

So, we should not refuse to use the '?:' operator. But you might easily make a mistake using it. So I have
made up a rule for myself: the '?:' operator's result must be immediately stored somewhere and it
should not be combined together with any other actions. That is, there must be an assignment
operation to the left of the '?:' operator's condition. Let's return to the original sample:

int Z = X + (A == B) ? 1 : 2;

I suggest that this code should be written this way:

int Z = X;

Z += A == B ? 1 : 2;

In case of an IPP Samples code sample, I would write it so:

mds[3] = FILE_ATTRIBUTE_NORMAL;

mds[3] |= (islog == 0) ? 0 : FILE_FLAG_NO_BUFFERING;

You may disagree with this recommendation and I will not defend it. For instance, I myself do not like
having two lines or more instead of one line. Another nice alternative is the obligatory enclosure of the
'?:' operator inside parentheses. The main task for me is to show you error patterns, but it depends on
programmer's preference what pattern of error protection to choose.


2. Do not feel shy to use parentheses
It has become a custom for some reason that using additional parentheses in C/C++ programming is
considered something shameful. Perhaps it is because the question about operations' priorities is often
asked at interview and people subconsciously start trying to use the priority mechanism to the full
extent all the time - if he makes additional parentheses, they will think he's a novice and not a true Jedi.

I even came across a discussion on the Internet where some man was too dogmatic saying that using
additional parentheses is a bad form and that if somebody is not sure about the way an expression will
be calculated, he must study instead of writing programs. Unfortunately, I've failed to find this
discussion but I do not agree with such opinions. Of course, you must know priorities but if you use
heterogeneous operations in an expression, you'd better use parentheses to secure yourself from
errors. This will not only protect you from potential errors but make code readable for other developers.
Not only novice programmers but also skillful ones make mistakes caused by confusion of priorities. An
expression does not necessarily need to be quite complicated and long; you may make a mistake in
relatively simple expressions. Let's consider some examples.




V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or
intended to use the '&&' operator. game g_client.c 1534

#define SVF_CASTAI 0x00000010

char *ClientConnect(...) {

    ...

    if ( !ent->r.svFlags & SVF_CASTAI ) {

    ...

}




V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or
intended to use the '&&' operator. dosbox sdlmain.cpp 519

static SDL_Surface * GFX_SetupSurfaceScaled(Bit32u sdl_flags,

                                                                Bit32u bpp) {

    ...

    if (!sdl.blit.surface || (!sdl.blit.surface->flags&SDL_HWSURFACE)) {

    ...

}
And one more sample from Chromium:

V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or
intended to use the '&&' operator. base platform_file_win.cc 216

#define FILE_ATTRIBUTE_DIRECTORY 0x00000010

bool GetPlatformFileInfo(PlatformFile file, PlatformFileInfo* info) {

    ...

    info->is_directory =

      file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY != 0;

    ...

}

The expressions are simple. The developers are attaboys. Still there are errors. So, using parentheses in
slippery fragments will not be superfluous.

I think the following is the best way: when operations are simple and usual, you don't need additional
parentheses. For example:

if (A == B && X != Y)

if (A - B < Foo() * 2)

But if you use rarer operators (~, ^, &, |, <<, >>, ?:), you'd better add explicit parentheses. They will both
make code clearer and secure you from a potential error. For example:

If ( ! (A & B))

x = A | B | (z < 1 ? 2 : 3);

Exploiting parentheses when using rare operations will also help you with the "?:" operator discussed
above. How we should handle "?:" is a matter of taste. Personally I like the method of simplification.


Summary
Write simple and clear code. Splitting long and complex expressions into several strings you get longer
code. But this code is much clearer to read and comprehend. It is less probable that you will make a
mistake in such code. Do not be afraid to create an additional variable - the compiler will optimize the
code well.

Do not be greedy about using parentheses in expressions where rare operators are used or where bit
and logical operations are mixed.

A programmer who will read your code with brackets in future will only be grateful to you for it.

Weitere Àhnliche Inhalte

Andere mochten auch

Lesson 11. Pattern 3. Shift operations
Lesson 11. Pattern 3. Shift operationsLesson 11. Pattern 3. Shift operations
Lesson 11. Pattern 3. Shift operationsPVS-Studio
 
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...PVS-Studio
 
Interview with Issam Lahlali, one of the CppDepend tool creators
Interview with Issam Lahlali, one of the CppDepend tool creatorsInterview with Issam Lahlali, one of the CppDepend tool creators
Interview with Issam Lahlali, one of the CppDepend tool creatorsPVS-Studio
 
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...PVS-Studio
 
Driver Development for Windows 64-bit
Driver Development for Windows 64-bitDriver Development for Windows 64-bit
Driver Development for Windows 64-bitPVS-Studio
 
Comparison of analyzers' diagnostic possibilities at checking 64-bit code
Comparison of analyzers' diagnostic possibilities at checking 64-bit codeComparison of analyzers' diagnostic possibilities at checking 64-bit code
Comparison of analyzers' diagnostic possibilities at checking 64-bit codePVS-Studio
 
32 OpenMP Traps For C++ Developers
32 OpenMP Traps For C++ Developers32 OpenMP Traps For C++ Developers
32 OpenMP Traps For C++ DevelopersPVS-Studio
 
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government Agencies
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government AgenciesMobile CRM Webinar: 6 Steps to Mobile ROI for Government Agencies
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government AgenciesWaterfall Mobile
 
VivaMP - a tool for OpenMP
VivaMP - a tool for OpenMPVivaMP - a tool for OpenMP
VivaMP - a tool for OpenMPPVS-Studio
 
How VivaCore library appeared
How VivaCore library appearedHow VivaCore library appeared
How VivaCore library appearedPVS-Studio
 
PVS-Studio, a solution for developers of modern resource-intensive applications
PVS-Studio, a solution for developers of modern resource-intensive applicationsPVS-Studio, a solution for developers of modern resource-intensive applications
PVS-Studio, a solution for developers of modern resource-intensive applicationsPVS-Studio
 
In what way can C++0x standard help you eliminate 64-bit errors
In what way can C++0x standard help you eliminate 64-bit  errorsIn what way can C++0x standard help you eliminate 64-bit  errors
In what way can C++0x standard help you eliminate 64-bit errorsPVS-Studio
 
Lesson 6. Errors in 64-bit code
Lesson 6. Errors in 64-bit codeLesson 6. Errors in 64-bit code
Lesson 6. Errors in 64-bit codePVS-Studio
 
Intel IPP Samples for Windows - error correction
Intel IPP Samples for Windows - error correctionIntel IPP Samples for Windows - error correction
Intel IPP Samples for Windows - error correctionPVS-Studio
 
Static code analysis for verification of the 64-bit applications
Static code analysis for verification of the 64-bit applicationsStatic code analysis for verification of the 64-bit applications
Static code analysis for verification of the 64-bit applicationsPVS-Studio
 
Analysis of the Ultimate Toolbox project
Analysis of the Ultimate Toolbox projectAnalysis of the Ultimate Toolbox project
Analysis of the Ultimate Toolbox projectPVS-Studio
 
Changes in programmer tools' infrastructure
Changes in programmer tools' infrastructureChanges in programmer tools' infrastructure
Changes in programmer tools' infrastructurePVS-Studio
 
Building of systems of automatic C/C++ code logging
Building of systems of automatic C/C++ code loggingBuilding of systems of automatic C/C++ code logging
Building of systems of automatic C/C++ code loggingPVS-Studio
 

Andere mochten auch (18)

Lesson 11. Pattern 3. Shift operations
Lesson 11. Pattern 3. Shift operationsLesson 11. Pattern 3. Shift operations
Lesson 11. Pattern 3. Shift operations
 
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...
Case Study: Porting a set of point cloud and triangle mesh processing C++ lib...
 
Interview with Issam Lahlali, one of the CppDepend tool creators
Interview with Issam Lahlali, one of the CppDepend tool creatorsInterview with Issam Lahlali, one of the CppDepend tool creators
Interview with Issam Lahlali, one of the CppDepend tool creators
 
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...
Comparing the general static analysis in Visual Studio 2010 and PVS-Studio by...
 
Driver Development for Windows 64-bit
Driver Development for Windows 64-bitDriver Development for Windows 64-bit
Driver Development for Windows 64-bit
 
Comparison of analyzers' diagnostic possibilities at checking 64-bit code
Comparison of analyzers' diagnostic possibilities at checking 64-bit codeComparison of analyzers' diagnostic possibilities at checking 64-bit code
Comparison of analyzers' diagnostic possibilities at checking 64-bit code
 
32 OpenMP Traps For C++ Developers
32 OpenMP Traps For C++ Developers32 OpenMP Traps For C++ Developers
32 OpenMP Traps For C++ Developers
 
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government Agencies
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government AgenciesMobile CRM Webinar: 6 Steps to Mobile ROI for Government Agencies
Mobile CRM Webinar: 6 Steps to Mobile ROI for Government Agencies
 
VivaMP - a tool for OpenMP
VivaMP - a tool for OpenMPVivaMP - a tool for OpenMP
VivaMP - a tool for OpenMP
 
How VivaCore library appeared
How VivaCore library appearedHow VivaCore library appeared
How VivaCore library appeared
 
PVS-Studio, a solution for developers of modern resource-intensive applications
PVS-Studio, a solution for developers of modern resource-intensive applicationsPVS-Studio, a solution for developers of modern resource-intensive applications
PVS-Studio, a solution for developers of modern resource-intensive applications
 
In what way can C++0x standard help you eliminate 64-bit errors
In what way can C++0x standard help you eliminate 64-bit  errorsIn what way can C++0x standard help you eliminate 64-bit  errors
In what way can C++0x standard help you eliminate 64-bit errors
 
Lesson 6. Errors in 64-bit code
Lesson 6. Errors in 64-bit codeLesson 6. Errors in 64-bit code
Lesson 6. Errors in 64-bit code
 
Intel IPP Samples for Windows - error correction
Intel IPP Samples for Windows - error correctionIntel IPP Samples for Windows - error correction
Intel IPP Samples for Windows - error correction
 
Static code analysis for verification of the 64-bit applications
Static code analysis for verification of the 64-bit applicationsStatic code analysis for verification of the 64-bit applications
Static code analysis for verification of the 64-bit applications
 
Analysis of the Ultimate Toolbox project
Analysis of the Ultimate Toolbox projectAnalysis of the Ultimate Toolbox project
Analysis of the Ultimate Toolbox project
 
Changes in programmer tools' infrastructure
Changes in programmer tools' infrastructureChanges in programmer tools' infrastructure
Changes in programmer tools' infrastructure
 
Building of systems of automatic C/C++ code logging
Building of systems of automatic C/C++ code loggingBuilding of systems of automatic C/C++ code logging
Building of systems of automatic C/C++ code logging
 

KĂŒrzlich hochgeladen

🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘RTylerCroy
 
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking MenDelhi Call girls
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Servicegiselly40
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerThousandEyes
 
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationFrom Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationSafe Software
 
Google AI Hackathon: LLM based Evaluator for RAG
Google AI Hackathon: LLM based Evaluator for RAGGoogle AI Hackathon: LLM based Evaluator for RAG
Google AI Hackathon: LLM based Evaluator for RAGSujit Pal
 
Swan(sea) Song – personal research during my six years at Swansea ... and bey...
Swan(sea) Song – personal research during my six years at Swansea ... and bey...Swan(sea) Song – personal research during my six years at Swansea ... and bey...
Swan(sea) Song – personal research during my six years at Swansea ... and bey...Alan Dix
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountPuma Security, LLC
 
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...gurkirankumar98700
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationRidwan Fadjar
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)Gabriella Davis
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024The Digital Insurer
 
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...shyamraj55
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slidevu2urc
 
A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024Results
 
Presentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreterPresentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreternaman860154
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationRadu Cotescu
 
Handwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsHandwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsMaria Levchenko
 
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024BookNet Canada
 
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...HostedbyConfluent
 

KĂŒrzlich hochgeladen (20)

🐬 The future of MySQL is Postgres 🐘
🐬  The future of MySQL is Postgres   🐘🐬  The future of MySQL is Postgres   🐘
🐬 The future of MySQL is Postgres 🐘
 
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
 
CNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of ServiceCNv6 Instructor Chapter 6 Quality of Service
CNv6 Instructor Chapter 6 Quality of Service
 
How to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected WorkerHow to Troubleshoot Apps for the Modern Connected Worker
How to Troubleshoot Apps for the Modern Connected Worker
 
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time AutomationFrom Event to Action: Accelerate Your Decision Making with Real-Time Automation
From Event to Action: Accelerate Your Decision Making with Real-Time Automation
 
Google AI Hackathon: LLM based Evaluator for RAG
Google AI Hackathon: LLM based Evaluator for RAGGoogle AI Hackathon: LLM based Evaluator for RAG
Google AI Hackathon: LLM based Evaluator for RAG
 
Swan(sea) Song – personal research during my six years at Swansea ... and bey...
Swan(sea) Song – personal research during my six years at Swansea ... and bey...Swan(sea) Song – personal research during my six years at Swansea ... and bey...
Swan(sea) Song – personal research during my six years at Swansea ... and bey...
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path Mount
 
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...
Kalyanpur ) Call Girls in Lucknow Finest Escorts Service 🍾 8923113531 🎰 Avail...
 
My Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 PresentationMy Hashitalk Indonesia April 2024 Presentation
My Hashitalk Indonesia April 2024 Presentation
 
A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)A Domino Admins Adventures (Engage 2024)
A Domino Admins Adventures (Engage 2024)
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024
 
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
 
Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 
A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024A Call to Action for Generative AI in 2024
A Call to Action for Generative AI in 2024
 
Presentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreterPresentation on how to chat with PDF using ChatGPT code interpreter
Presentation on how to chat with PDF using ChatGPT code interpreter
 
Scaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organizationScaling API-first – The story of a global engineering organization
Scaling API-first – The story of a global engineering organization
 
Handwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed textsHandwritten Text Recognition for manuscripts and early printed texts
Handwritten Text Recognition for manuscripts and early printed texts
 
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
#StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
 
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...
Transforming Data Streams with Kafka Connect: An Introduction to Single Messa...
 

How to make fewer errors at the stage of code writing. Part N2.

  • 1. How to make fewer errors at the stage of code writing. Part N2. Author: Andrey Karpov Date: 29.03.2011 Abstract This is the second article on avoiding certain errors at the early stage of code writing. In the previous post, we have already advised you to avoid a large number of calculations in one expression. However, we should investigate this question in detail. Let's see what's dangerous about complex expressions and ous how we can avoid many logical errors errors. Introduction You may read the previous post here. This time we'll take error samples from various famous projects to . stress their prevalence. The errors I'm going to demonstrate here were found with the help of the PVS- . Studio analyzer during a relatively large term. I have informed developers of almost all the projects about the errors, so I hope they will fix the defects in new code revisions. I'm writing this in introduct . introduction because I always receive letters after publishing articles with a request "please inform the project's developers about the errors you've found found". 1. Do not use the ternary operation '?:' in compound expressions A ternary conditional operation is written in C/C++ code with the '?:' operator This is an operation that operator. returns its second or third operand depending on the value of the logical expression defined by the fifirst operand. For example: int minValue = A < B ? A : B; A ternary operation has a very low priority (see the table). Programmers often forget about it and that is why the ternary operation is quite dange dangerous.
  • 2. Figure 1 - C/C++ operations arranged in priority descending order Note that the '?:' operation has a lower priority than addition, multiplication, bitwise OR operator and so on. Consider this code: int Z = X + (A == B) ? 1 : 2; It works differently than it might seem at first sight. Most likely, the programmer intended to add the X value to number 1 or 2 depending on the (A == B) condition. But actually it is the "X + (A == B)" expression which is the condition. In fact, it is this code written in the project: int Z = (X + (A == B)) ? 1 : 2; While the programmer wanted this to be:
  • 3. int Z = X + (A == B ? 1 : 2); What occurs to you first is that you just should know the priorities of operations. Well, programmers do know them but too insidious is this ternary operation! Not only novices make mistakes with it but experienced programmers as well. You may easily find them even in the most quality code. Here are a couple of examples. V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a lower priority than the '*' operator. physics dgminkowskiconv.cpp 1061 dgInt32 CalculateConvexShapeIntersection (...) { ... den = dgFloat32 (1.0e-24f) * (den > dgFloat32 (0.0f)) ? dgFloat32 (1.0f) : dgFloat32 (-1.0f); ... } V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a lower priority than the '-' operator. views custom_frame_view.cc 400 static const int kClientEdgeThickness; int height() const; bool ShouldShowClientEdge() const;
  • 4. void CustomFrameView::PaintMaximizedFrameBorder(gfx::Canvas* canvas) { ... int edge_height = titlebar_bottom->height() - ShouldShowClientEdge() ? kClientEdgeThickness : 0; ... } V502 Perhaps the '?:' operator works in a different way than it was expected. The '?:' operator has a lower priority than the '|' operator. vm vm_file_win.c 393 #define FILE_ATTRIBUTE_NORMAL 0x00000080 #define FILE_FLAG_NO_BUFFERING 0x20000000 vm_file* vm_file_fopen(...) { ... mds[3] = FILE_ATTRIBUTE_NORMAL | (islog == 0) ? 0 : FILE_FLAG_NO_BUFFERING; ... } As you may see, errors of this type deserve consideration. That is why I've made a separate paragraph to describe them. They are quite widely-spread. I could give you some more examples but they all are similar. You can avoid such errors if you give up trying to place several operations into a single line of code. Or if you still want to do that, do not be greedy to add parentheses. I will speak of parentheses a bit later. Now let's try to avoid potential errors when using '?:'. Of course the '?:' operator is certainly a syntactic sugar and you can replace it with if in most cases. Among rare exceptions are such tasks as reference initialization: MyObject &ref = X ? A : B;
  • 5. Certainly there are no problems with it either, but creation of a reference to A or B without '?:' operator takes more lines of code to implement: MyObject *tmpPtr; If (X) tmpPtr = &A; else tmpPtr = &B; MyObject &ref = *tmpPtr; So, we should not refuse to use the '?:' operator. But you might easily make a mistake using it. So I have made up a rule for myself: the '?:' operator's result must be immediately stored somewhere and it should not be combined together with any other actions. That is, there must be an assignment operation to the left of the '?:' operator's condition. Let's return to the original sample: int Z = X + (A == B) ? 1 : 2; I suggest that this code should be written this way: int Z = X; Z += A == B ? 1 : 2; In case of an IPP Samples code sample, I would write it so: mds[3] = FILE_ATTRIBUTE_NORMAL; mds[3] |= (islog == 0) ? 0 : FILE_FLAG_NO_BUFFERING; You may disagree with this recommendation and I will not defend it. For instance, I myself do not like having two lines or more instead of one line. Another nice alternative is the obligatory enclosure of the '?:' operator inside parentheses. The main task for me is to show you error patterns, but it depends on programmer's preference what pattern of error protection to choose. 2. Do not feel shy to use parentheses It has become a custom for some reason that using additional parentheses in C/C++ programming is considered something shameful. Perhaps it is because the question about operations' priorities is often asked at interview and people subconsciously start trying to use the priority mechanism to the full extent all the time - if he makes additional parentheses, they will think he's a novice and not a true Jedi. I even came across a discussion on the Internet where some man was too dogmatic saying that using additional parentheses is a bad form and that if somebody is not sure about the way an expression will be calculated, he must study instead of writing programs. Unfortunately, I've failed to find this discussion but I do not agree with such opinions. Of course, you must know priorities but if you use heterogeneous operations in an expression, you'd better use parentheses to secure yourself from errors. This will not only protect you from potential errors but make code readable for other developers.
  • 6. Not only novice programmers but also skillful ones make mistakes caused by confusion of priorities. An expression does not necessarily need to be quite complicated and long; you may make a mistake in relatively simple expressions. Let's consider some examples. V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or intended to use the '&&' operator. game g_client.c 1534 #define SVF_CASTAI 0x00000010 char *ClientConnect(...) { ... if ( !ent->r.svFlags & SVF_CASTAI ) { ... } V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or intended to use the '&&' operator. dosbox sdlmain.cpp 519 static SDL_Surface * GFX_SetupSurfaceScaled(Bit32u sdl_flags, Bit32u bpp) { ... if (!sdl.blit.surface || (!sdl.blit.surface->flags&SDL_HWSURFACE)) { ... }
  • 7. And one more sample from Chromium: V564 The '&' operator is applied to bool type value. You've probably forgotten to include parentheses or intended to use the '&&' operator. base platform_file_win.cc 216 #define FILE_ATTRIBUTE_DIRECTORY 0x00000010 bool GetPlatformFileInfo(PlatformFile file, PlatformFileInfo* info) { ... info->is_directory = file_info.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY != 0; ... } The expressions are simple. The developers are attaboys. Still there are errors. So, using parentheses in slippery fragments will not be superfluous. I think the following is the best way: when operations are simple and usual, you don't need additional parentheses. For example: if (A == B && X != Y) if (A - B < Foo() * 2) But if you use rarer operators (~, ^, &, |, <<, >>, ?:), you'd better add explicit parentheses. They will both make code clearer and secure you from a potential error. For example: If ( ! (A & B)) x = A | B | (z < 1 ? 2 : 3); Exploiting parentheses when using rare operations will also help you with the "?:" operator discussed above. How we should handle "?:" is a matter of taste. Personally I like the method of simplification. Summary Write simple and clear code. Splitting long and complex expressions into several strings you get longer code. But this code is much clearer to read and comprehend. It is less probable that you will make a mistake in such code. Do not be afraid to create an additional variable - the compiler will optimize the code well. Do not be greedy about using parentheses in expressions where rare operators are used or where bit and logical operations are mixed. A programmer who will read your code with brackets in future will only be grateful to you for it.