views:

1311

answers:

12

If, like me, you shiver at the site of a While (True) loop, then you too must have thought long and hard about the best way to refactor it away. I've seen several different implementations, none really better than any other, such as the timer & delegate combination.

So what's the best way you've come up with or seen to refactor the dreaded While (True) loop?

Edit: As some comments mentioned, my intent was for this question to be an "infinite loop" refactoring, such as running a Windows style service where the only stop conditions would be OnStop or a fatal exception.

+19  A: 

What's so dreaded about it? Try finding a common break condition and refactor it to be the head of the loop. If that's not possible – fine.

Konrad Rudolph
Yup, yust my idea ;-).
Gamecat
Or refactor so it is at the end and take advantage of "do while".
Torlack
@Torlack - harhar!
Jeff Schumacher
+11  A: 

Replace True with the condition you were going to use to break out of the loop.

In the case of a service or background thread, you might use:

volatile bool m_shutdown = false;
void Run()
{
    while (!m_shutdown)
    { ... }
}
Jon B
Sometimes people do this for services, where execution is meant to continue indefinitely and is only broken OnStop or an exception. So there IS no condition.
Grank
I think the question is more targeted at the semi common pracitice of infinite looping when you are actually intending to do it a finite amount of times (ignoring things like threads etc) its just perhaps the end condition is complicated.
Keith Nicholas
In forth, there is the "BEGIN X WHILE Y REPEAT" where the condition is in the middle of the loop. This type of loop construct isn't easily converted to a more traditional "while{}" or "do {} while" loop.
Torlack
@Grank - Exactly.
Jeff Schumacher
Grank
@Grank - Yes! I need to edit this question to be more specific.
Jeff Schumacher
+2  A: 

errr, to be a refactoring.....

  • Replace Infinite Loop with Infinite Recursion :-)

well, if you have a language that supports Tail calls....

Keith Nicholas
+10  A: 

When I encounter a while(true) loop, that tells me either

  1. the break condition is not easily tested at the top (or bottom) of the loop,
  2. there are multiple break conditions,
  3. or the prior programmer was too lazy to factor the loop properly.

1 and 2 means you might as well stick with while(true). (I use for(;;), but that's a style thing in my opinion.) I'm with another poster, why dread this? I dread tortored loops that jump through hoops to get the loop rolled "properly".

Jim Nelson
The answer is normally 3!
DaveF
+2  A: 

If you want it to continue indefinitely until a total abortion of program flow, I don't see anything wrong with while (true). I encountered it recently in a .NET data collection service that combined while (true) with thread.sleep to wake up every minute and poll the third-party data service for new reports. I considered refactoring it with a timer and a delegate, but ultimately decided that this was the simplest and easiest-to-read method. 9 times out of 10 it's a clear code smell, but when there's no exit condition, why make things more difficult?

Grank
+5  A: 

The "running forever" situation is sometimes part of a larger state machine. Many embedded devices (with run-forever loops) don't really run forever. They often have several operating modes and will sequence among those modes.

When we built heat-pump controllers, there was a power-on-self-test (POST) mode that ran for a little while. Then there was a preliminary environmental gathering mode that ran until we figured out all the zones and thermostats and what-not.

Some engineers claimed that what came next was the "run-forever" loop. It wasn't really that simple. It was actually several operating modes that flipped and flopped. There was heating, and defrosting, and cooling, and idling, and other stuff.

My preference is to treat a "forever" loop as really just one operating mode -- there may be others at some point in the future.

someMode= True
while someMode:
    try:
        ... do stuff ...
    except SomeException, e:
        log.exception( e )
        # will keep running
    except OtherException, e:
        log.info( "stopping now" )
        someMode= False

Under some circumstances, nothing we've seen so far sets someMode to False. But I like to pretend that there'll be a mode change in some future version.

S.Lott
+8  A: 

Why refactor? And what is so "dreadful" about this construct? It is widely used, and well understood.

If it ain't broke, don't fix it.

Ken Ray
+1  A: 

I don't mind it when the infinite loop is contained within a window, and dies with the window.

Think of the Hasselhoff Recursion.

chris
+2  A: 
#define ever 1
for (;ever;)

?

Meh, just leave it how it is, while (true) is probably as legible as you're going to get..

Andrew Coleson
I hate abuse of "for" loops like that.There is a semantic for which the "for" loop was designed, (essentially a from - to semantic) and I think we should stick to that. What you're doing here is forcing a "while" semantic into the "for" keyword. At least the #define makes it marginally tolerable.
chris
if we're to go that ugly, why not "#define FOREVER while(1)" or something like that :)
utku_karatas
+16  A: 

My preference would be

start:

   // code goes here

goto start;

This most clearly expresses the intent. Good luck getting it past your coding standards nazis. (Wonder how much karma this is going to cost me).

fizzer
I had to vote that up just because it gave me a good laugh!
Jeff Schumacher
I voted it up, because sometimes goto *is* acceptable!
Brian Knoblauch
I voted it up cause I program in Assembly
Nathan Fellman
How does this better express your intent than a `while(true)` loop? On the other hand you didn't mention the drawbacks of your solution. So yes, all in all, this is a pretty crappy code.
Konrad Rudolph
The intent is an unconditional branch to start. 'goto' is specifically for that purpose. 'While' supports conditional branches. By calling it with a degenerate always-true condition, and relying on the compiler to optimize it away, you are an extra step removed from expressing what you mean.
fizzer
As for drawbacks, there are no technical ones. If you need a scope, put some braces in. If you don't, don't. (Assumes C or C++ - OP doesn't specify a language).
fizzer
I voted it up because that seemed like the thing to do. for (;;) says conditionless loop to me.
Tom Hawtin - tackline
I voted it up because I loathe coding standards nazis.
Michael Krelin - hacker
You're gonna need another `goto` to break out of the loop... getting complex?
Amarghosh
@Amarghosh: If you need to break out of the loop, then it's not really an infinite loop; if you are using `while (true)` for such things you are doing something wrong.
Dan Moulding
+10  A: 

Do we really need to refactor while(true) loops? Sometimes it's a coding standard and most of the developers has got used to this structure. If you have to think hard on how to refactor this code, are you sure it's a good idea to refactor it?

Goto used to be a black sheep in coding standards. I've met algorithms where goto made the code much more readable and shorter. Sometimes it doesn't worth to refactor (or better to use goto).

On the other hand you can avoid while(true) most of the time.

artur02
A: 

All great answers.

Personally, I've never liked how the While (True) felt, it has always seemed messy to me. But, if McConnell says it's cool in Code Complete, then I guess it's cool. ;)

Jeff Schumacher