Inadvertent use of = instead of ==

Question

It seems that

if (x=y) { .... }

instead of

if (x==y) { ... }

is a root of many evils.

Why don't all compilers mark it as error instead of a configurable warning?

I'm interested in finding out cases where the construct if (x=y) is useful.

Answer 1

one useful construct is for example:

char *pBuffer;
if (pBuffer = malloc(100))
{
    //continue to work here
}

edit:
as mentioned before, and downvoted several times now, I might add this is not specially good style, but seen often enough to say it's useful. I've also seen this with new, but it makes more pain in my chest.

another example, less controversial, might be:

while (pointer = getNextElement(context))
{
    //go for it, use the pointer to the new segment of data
}

which implies that the function getNextElement() returns NULL when there is no next element so that the loop is exited.

Answer 2

Because it's not illegal (in C or C++ anyway) and sometimes useful...

if ( (x = read(blah)) > 0)
{
    // now you know how many bits/bytes/whatever were read
    // and can use that info. Esp. if you know, say 30 bytes
    // are coming but only got 10
}

Most compilers kick up a real stink if you don't put parenthesis around the assignment anyway, which I like.

Answer 3

Many compiler will detect this and warn you, but only if you the warning level is set high enough.

For example:

 ~> gcc -c -Wall foo.c
foo.c: In function ‘foo’:
foo.c:5: warning: suggest parentheses around assignment used as truth value

Answer 4

you can use

if (0=x)

instead, which will cause a compilation error.

Answer 5

Most of the time, compilers try very hard to remain backward compatible.

Changing their behavior in this matter to throw errors will break existing legit code, and even starting to throw warnings about it will cause problems with automatic systems that keep track of code by automatically compiling it and checking for errors and warnings.

This is an evil we're pretty much stuck with atm, but there are ways to circumvent and reduce the dangers of it.

Example:

   void *ptr = calloc(1, sizeof(array));
   if (NULL = ptr) {
       // some error
   }

This causes a compilation error.

Answer 6

It depends on the language.Java flags it as an error as only boolean expressions can be used inside the if parenthesis (and unless the two variables are boolean, in which case the assignment is also a boolean).

In C it is a quite common idiom for testing pointers returned by malloc or if after a fork we are in the parent or child process:

if ( x = (X*) malloc( sizeof(X) ) {
   // malloc worked, pointer != 0

if ( pid = fork() ) {
   // parent process as pid != 0

C/C++ compilers will warn with a high enough warning level if you ask for it, but it cannot be considered an error as the language allows it. Unless, then again, you ask the compiler to treat warnings as errors.

Whenever comparing with constants, some authors suggest using the test constant == variable so that the compiler will detect if the user forgets the second equality sign.

if ( 0 == variable ) {
   // the compiler will complaint if you mistakenly 
   // write =, as you cannot assign to a constant

Anyway, you should try to compile with the highest possible warning settings.

Answer 7

That's why it's better to write:

0 == CurrentItem

Instead of:

CurrentItem == 0

so that the compiler warns you if you type = instead of ==.

Answer 8

Is this really such a common error? I learned about it when I learned C myself, and as a teacher I have occasionally warned my students and told them that it is a common error, but I have rarely seen it in real code, even from beginners. Certainly not more often than other operator mistakes, such as for example writing "&&" instead of "||".

So the reason that compilers don't mark it as an error (except for it being perfectly valid code) is perhaps that it isn't the root of very many evils.

Answer 9

Simple answer: An assignment operation, such as x=y, has a value, which is the same as the newly assigned value in x. You can use this directly in a comparison, so instead of

x = y; if (x) ...

you can write

if (x = y) ...

It is less code to write(and read), which is sometimes a good thing, but nowadays most people agree that it should be written in some other way to increase readability. For example like this:

if ((x = y) != 0) ...

Here is a realistic example. Assume you want to allocate some memory with malloc, and see if it worked. It can be written step by step like this:

p = malloc(4711); if (p != NULL) printf("Ok!");

The comparison to NULL is redundant, so you can rewrite it like this:

p = malloc(4711); if (p) printf("Ok!");

But since the assignment operation has a value, which can be used, you could put the entire assignment in the if condition:

if (p = malloc(4711)) printf("Ok!");

This does the same thing, but is more concise.

Answer 10

You asked why it was useful, but keep questioning examples people are providing. It's useful because it's concise.

Yes, all the examples which use it can be re-written - as longer pieces of code.

Answer 11

There are several tactics to help spot this .. one is ugly, the other is typically a macro. It really depends on how you read your spoken language (left to right, right to left).

For instance:

if ((fp = fopen("foo.txt", "r") == NULL))

Vs:

if (NULL == (fp = fopen(...)))

Sometimes it can be easier to read/write (first) what your testing for, which makes it easier to spot an assignment vs a test. Then bring in most comp.lang.c folks that hate this style with a passion.

So, we bring in assert():

#include <assert.h>

...
fp = fopen("foo.txt", "r");
assert(fp != NULL);
...

when your at the midst, or end of a convoluted set of conditionals, assert() is your friend. In this case, if FP == NULL, an abort() is raised and the line/file of the offending code is conveyed.

So if you oops:

if (i = foo)

insted of

if (i == foo)

followed by

assert (i > foo + 1)

... you'll quickly spot such mistakes.

Hope this helps :)

In short, reversing arguments sometimes helps when debugging .. assert() is your long life friend and can be turned off in compiler flags in production releases.

Answer 12

Standard C idiom for iterating:

list_elem* curr;
while ( (curr = next_item(list)) != null ) {
  /* ... */
}

Answer 13

The 'if(0 = x)' idiom is next to useless because it doesn't help when both sides are variables ('if(x = y)') and most (all?) of the time you should be using constant variables rather than magic numbers.

Two other reasons I never use this idiom, IMHO it makes code less readable and to be honest I find the single '='to be the root of very little evil. If you test your code thouroughly (which we all do, obviously) this sort of syntax error turns up very quickly.

Answer 14

It is very common with "low level" loop constructs in C/C++, such as with copies:

void my_strcpy(char *dst, const char *src)
{
    while((*dst++ = *src++) != '\0') { // Note the use of extra parentheses, and the explicit compare.
        /* DO NOTHING */
    }
}

Of course, assignments are very common with for loops:

int i;
for(i = 0; i < 42; ++i) {
    printf("%d\n", i);
}

I do believe it is easier to read assignments when they are outside of if statements:

char *newstring = malloc(strlen(src) * sizeof(char));
if(newstring == NULL) {
    fprintf(stderr, "Out of memory, d00d!  Bailing!\n");
    exit(2);
}

// Versus:

if((newstring = malloc(strlen(src) * sizeof(char))) == NULL) // ew...

Make sure the assignment is obvious, thuogh (as with the first two examples). Don't hide it.

As for accidental uses ... that doesn't happen to me much. A common safeguard is to put your variable (lvalues) on the right hand side of the comparison, but that doesn't work well with things like:

if(*src == *dst)

because both oprands to == are lvalues!

As for compilers ... who can blame 'em? Writing compilers is difficult, and you should be writing perfect programs for the compiler anyway (remember GIGO?). Some compilers (the most well-known for sure) provide built-in lint-style checking, but that certainly isn't required. Some browsers don't validate every byte of HTML and Javascript it's thrown, so why would compilers?

Answer 15

Try viewing

if( life_is_good() )
    enjoy_yourself();

as

if( tmp = life_is_good() )
    enjoy_yourself();

Answer 16

In practice I don't do it, but a good tip is to do :

if ( true == $x )

In the case that you leave out an equals, assigning $x to true will obviously return an error.

Answer 17

I think the C and C++ language designers noticed there is no real use in forbidding it because

• Compilers can warn about it if they want anyway
• Disallowing it would add special cases to the language, and would remove a possible feature.

There isn't complexity involved in allowing it. C++ just says that an expression implicitly convertible to bool is required. In C, there are useful cases detailed by other answers. In C++, they go one step further and allowed this one in addition:

if(type * t = get_pointer()) {
    // ....
}

Which actually limits the scope of t to only the if and its bodies.

Answer 18

I have only had this typo ONCE in my 15 years of development. I would not say it is on the top of my list of things to look out for. I also avoid that construct anyway.

Note also that some compilers (the one I use) issues a warning on that code. Warnings can be treated as errors for any compiler worth its salt. They can also be ignored.

Answer 19

Placing the constant on the left side of a comparison is defensive programming. Sure YOU would never make the silly mistake of forgetting that extra '=' but who knows about the OTHER guy.

Answer 20

The D programming language does flag this as an error. To avoid the problem with wanting to use the value later it allows declarations sort of like C++ allows with for loops.

if(int i = some_fn())
{
   another_fn(i);
}

Answer 21

Consider augmenting your compiler with static analysis tools that detect such "evil" code, e.g. lint.

Answer 22

As pointed out in other answers, there are cases where using assignment within a condition offers a brief-but-readable piece of code that does what you want. Also, a lot of up-to-date compilers will warn you if they see an assignment where they expect a condition. (If you're a fan of the zero-warnings approach to development, you'll have seen these.)

One habit I've developed that keeps me from getting bitten by this (at least in C-ish languages) is that if one of the two values I'm comparing is a constant (or otherwise not a legal lvalue), I put it on the left-hand side of the comparator: if (5 == x) { whatever(); } Then, if I should accidentally type if (5 = x), the code won't compile.

Answer 23

Part of it has to do with personal style and habits. I am agnostic to reading either if (kConst == x) or if (x == kConst). I don't use the constant on the left because historically I don't make that error and I write code as I would say it or would like to read it. I see this as a personal decision as part of a personal responsibility to being a self-aware, improving engineer. For example, I started analyzing the types of bugs that I was creating and started to re-engineer my habits so as not to make them - similar to constant on the left, just with other things.

That said, compiler warnings, historically, are pretty crappy and even though this problem has been well known for years, I didn't see it in a production compiler until the late 80's. I also found that working on projects that were portable helped clean up my C a great deal, as different compilers and different tastes (ie, warnings) and different subtle semantic differences.

Answer 24

There's a lot of great uses of the assignment operator in a conditional statement, and it'd be a royal pain in the ass to see warnings about each one all the time. What would be nice would be a function in your IDE that let you highlight all the places where assignment has been used instead of an equality check - or - after you write something like this:

if (x = y) {

then that line blinks a couple of times. Enough to let you know that you've done something not exactly standard, but not so much that it's annoying.

Answer 25

I, personally, consider this the most useful example.

Say that you have a function read() that returns the number of bytes read, and you need to use this in a loop. It's a lot simpler to use

while((count = read(foo)) > 0) {
    //Do stuff
}

than to try and get the assignment out of the loop head, which would result in things like

while(1) {
    count = read(foo);
    if(!(count > 0))
        break;
    //...
}

or

count = read(foo);
while(count > 0) {
    //...
    count = read(foo);
}

The first construct feels awkward, and the second repeats code in an unpleasant way.

Unless, of course, I've missed some brilliant idiom for this...

Answer 26

About the valid uses of if(i = 0)

The problem is that you're taking the problem upside down. The "if" notation is not about comparing two values like in some other languages.

The C/C++ "if" instruction waits for any expression that will evaluate to either a boolean, or a null/non-null value. This expression can include two values comparison, and/or can be much more complex.

For example, you can have:

if(i >> 3)
{
   std::cout << "i is less than 8" << std::endl
}

Which proves that, in C/C++, the if expression is not limited to == and =. Anything will do, as long as it can be evaluated as true or false (C++), or zero non-zero (C/C++).

Another C++ valid use:

if(MyObject * pObject = dynamic_cast<MyInterface *>(pInterface))
{
   pObject->doSomething() ;
}

And these are simple uses of the if expression (note that this can be used, too, in the for loop declaration line). More complex uses do exist.

About advanced uses of if(i = 0) in C++ [Quoted from myself]

After discovering a duplicate of this question at http://stackoverflow.com/questions/3122284/, I decided to complete this answer with an additional bonus, that is, variable injection into a scope, which is possible in C++ because if will evaluate its expression, including a variable declaration, instead of limiting itself to compare two operands like it is done in other languages:

So, quoting from myself:

Another use would be to use what is called C++ Variable Injection. In Java, there is this cool keyword:

synchronized(p)
{
   // Now, the Java code is synchronized using p as a mutex
}

In C++, you can do it, too. I don't have the exact code in mind (nor the exact DDJ's article where I discovered it), but this simple define should be enough for demonstration purposes:

#define synchronized(lock) \
   if (auto_lock lock_##__LINE__(lock))

synchronized(p)
{
   // Now, the C++ code is synchronized using p as a mutex
}

This is the same way, mixing injection with if and for declaration, you can declare a primitive foreach macro (if you want an industrial-strength foreach, use boost's).

See the following articles for a less naive, more complete and more robust implementation:

• http://www.drdobbs.com/184401723?pgno=6
• http://www.drdobbs.com/184401728
• http://www.drdobbs.com/184401752

How many errors of this kind really happens?

Rarely. In fact, I have yet to remember one, and I am professional since 8 years. I guess it happened, but then, in 8 years, I did produce a sizeable quantity of bugs. It's just that this kind of bugs did not happen enough to have me remember them in frustration.

In C, you'll have more bugs because of buffer overruns, like :

void doSomething(char * p)
{
   strcpy(p, "Hello World, how are you \?\n") ;
}

void doSomethingElse()
{
   char buffer[16] ;
   doSomething(buffer) ;
}

In fact, Microsoft was burned so hard because of that they added a warning in Visual C++ 2008 deprecating strcpy !!!

How can you avoid most errors?

The very first "protection" against this error is to "turn around" the expression: As you can't assign a value to a constant, this :

if(0 = p) // ERROR : It should have been if(0 == p). WON'T COMPILE !

Won't compile.

But I find this quite a poor solution, because it tries to hide behind style what should be a general programming practice, that is : Any variable that is not supposed to change should be constant.

For example, instead of :

void doSomething(char * p)
{
   if(p == NULL) // POSSIBLE TYPO ERROR
      return ;

   size_t length = strlen(p) ;

   if(length == 0) // POSSIBLE TYPO ERROR
      printf("\"%s\" length is %i\n", p, length) ;
   else
      printf("the string is empty\n") ;
}

Trying to "const" as much variables as possible will make you avoid most typo errors, including those not inside "if" expressions :

void doSomething(const char * const p) // CONST ADDED HERE
{
   if(p == NULL) // NO TYPO POSSIBLE
      return ;

   const size_t length = strlen(p) ; // CONST ADDED HERE

   if(length == 0) // NO TYPO POSSIBLE
      printf("\"%s\" length is %i\n", p, length) ;
   else
      printf("the string is empty\n") ;
}

Of course, it is not always possible (as some variables do need to change), but I found than most of the variables I use are constants (I keep initializing them once, and then, only reading them).

Conclusion

Usually, I see code using the if(0 == p) notation, but without the const-notation.

To me, it's like having a trash can for recyclables, and another for non-recyclable, and theni n the end, throw them together in the same container.

So, do not parrot a easy style habit hoping it will make your code a lot better. It won't. Use the language constructs as much as possible, which means, in this case, using both the if(0 == p) notation when available, and using of the const keyword as much as possible.

Answer 27

The assignment as conditional is legal C and C++, and any compiler that doesn't permit it isn't a real C or C++ compiler. I would hope that any modern language not designed to be explicitly compatible with C (as C++ was) would consider it an error.

There are cases where this allows concise expressions, such as the idiomatic while (*dest++ = *src++); to copy a string in C, but overall it's not very useful, and I consider it a mistake in language design. It is, in my experience, easy to make this mistake, and hard to spot when the compiler doesn't issue a warning.

Answer 28

The compiler won't flag it as an error because it is valid C/C++. But what you can do (at least with Visual C++) is turn up the warning level so that it flags it as a warning and then tell the compiler to treat warnings as errors. This is a good practice anyway so that developers don't ignore warnings.

If you had actually meant = instead of == then you need to be more explicit about it. e.g.

if ((x = y) != 0)

Theoretically, you're supposed to be able to do this:

if ((x = y))

to override the warning, but that doesn't seem to always work.

Answer 29

 if ((k==1) || (k==2)) is a conditional
 if ((k=1)  || (k=2) ) is BOTH a conditional AND an assignment statement

• Here's the explanation *

Like most languages, C works inner-most to outermost in order by operator precedence.

First it tries to set k to 1, and succeeds.

Result: k = 1 and Boolean = 'true'

Next: it sets k to 2, and succeeds.

Result: k = 2 and Boolean = 'true'

Next: it evaluates (true || true)

Result: k still = 2, and Boolean = true

Finally, it then resolves the conditional: If (true)

  Result: k = 2 and the program takes the first branch.

In nearly 30 years of programming I have not seen a valid reason for using this construct, though if one exists it probably has to do with a need to deliberately obfuscate your code.

When one of our new people has a problem, this is one of the things I look for, right along with not sticking a terminator on a string, and copying a debug statement from one place to another and not changing the '%i to '%s' to match the new field they are dumping.

This is fairly common in our shop because we constantly switch between C and Oracle PL/SQL; if( k = 1) IS the correct syntax in PL/SQL.

Answer 30

You may use Yoda Conditionals:

However, they are considered, by many, an ugly and unreadable way, because it violates the "global scope to local scope rule", considered beneficial to a human parser.

Answer 31

RegEx sample

RegEx r;

if(((r = new RegEx("\w*)).IsMatch()) {
   // ... do something here
}
else if((r = new RegEx("\d*")).IsMatch()) {
   // ... do something here
}

asign a value test

int i = 0;
if((i = 1) == 1) {
   // 1 is equal to i that was assigned to a int value 1
}
else {
   // ?
}