I am working on code that takes as input a ton of ascii text defined by specific protocol. The original author interpreted "string(1)" datatypes in the original protocol as chars in the code.
There have been a lot subtle bugs in corner cases where you have code such as:
char theChar = whatever();
if(theChar == 7) {...}
where was was really meant was:
if(theChar == '7') {...}
In order to attempt to catch all of these at once, is there a way to disable the implicit casting to 'char'? If not, what is the best way to go about tracking all of these down?
You should be able to write a trivial replacement class for char (which holds a char as its data, and provides a few cast operators to allow it to be used as if it were a char) that doesn't allow implicit casts to/from ints, and then do a search and replace of 'char' with the 'mychar'. This will throw up compiler errors that you can fix, and then if you wish you can revert the code to using char again, or stick with your class.
This is a good example of a place where temporary use of macros is so useful in c++...
My suggestion to find existing errors such as the one described is to use Visual Studio to perform a search across the entire solution (Ctrl+Shift+F) using regular expressions.
I think that this will list all occurrences of a literal number in the source code. You can then glance through the search results to see if any of them require further investigation.
You can further narrow down the search results by focusing on a specific type of problem. For instance, to find the code in the provided example, you could adjust the expression to the following: ==( |\t|\r|\n)*[0-9]+[^0-9]
I can't offer any good suggestion to avoid this problem other than to try to avoid "magic" values in code.
Assuming that this code is being used in some kind of menu selection logic, I feel like perhaps the code should be something like this:
static class MenuSelection
{
public const char Open = '1';
public const char Edit = '2';
public const char Save = '3';
// ...
public const char Close = '7';
}
And then MenuSelection should be used in the if statement as shown below:
char theChar = whatever();
if(theChar == MenuSelection.Close) {...}
This doesn't really address the problem of the implicit conversion from UInt32 to char, but hopefully the person writing the code for the constants in the MenuSelection class will be less likely to forget the quotes.
EDIT: Oh, after giving it a try, it seems like this does kind of address the implicit conversion issue, because public const char Close = 7;
produces a compile error.
Unfortunately, it doesn't help your immediate problem: a lot of existing code containing these kinds of bugs.
As a "fix once" solution I think James Michael Hare's FxCop solution is the easiest.
To keep it from being a problem in the future refactoring to use a custom datatype instead of char so you can define the exact operations you want available may be a good idea.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With