tags:

views:

195

answers:

4

It seems I often spend way too much time trying to get a #define macro to do exactly what i want. I'll post my current dilemma below and any help is appreciated. But really the bigger question is whether there is any utility someone could recommend, to quickly display what a macro is actually doing? It seems like even the slow trial and error process would go much faster if I could see what is wrong.

Currently, I'm dynamically loading a long list of functions from a DLL I made. The way I've set things up, the function pointers have the same nanes as the exported functions, and the typedef(s) used to prototype them have the same names, but with a prepended underscore. So I want to use a define to simplify assignments of a long long list of function pointers.

For example, In the code statement below, 'hexdump' is the name of a typedef'd function point, and is also the name of the function, while _hexdump is the name of the typedef. If GetProcAddress() fails, a failure counter in incremented.

if (!(hexdump = (_hexdump)GetProcAddress(h, "hexdump"))) --iFail;

So lets say I'd like to replace each line like the above with a macro, like this...

GETADDR_FOR(hexdump )

Well this is the best I've come up with so far. It doesn't work (my // comment is just to prevent text formatting in the message)...

// #define GETADDR_FOR(a) if (!(a = (#_#a)GetProcAddress(h, "/""#a"/""))) --iFail; 

And again, while I'd APPRECIATE an insight into what silly mistake I've made, it would make my day to have a utility that would show me the error of my ways, by simply plugging in my macro

+1  A: 

You can just run your code through the preprocessor, which will show you what it will be expanded into (or spit out errors as necessary):

$ cat a.c
#define GETADDR_FOR(a) if (!(a = (#_#a)GetProcAddress(h, "/""#a"/""))) 
GETADDR_FOR(hexdump)

$ gcc -E a.c
# 1 "a.c"
# 1 "<built-in>"
# 1 "<command-line>"
# 1 "a.c"
a.c:1:36: error: '#' is not followed by a macro parameter

GETADDR_FOR(hexdump)

In GCC, it's gcc -E foo.c to only preprocess the file.

Visual Studio uses the /P argument.

Mark Rushakoff
Thanks. I guuss I'll look into GCC. I suppos I was hoping for something that would just do an "expand as best it can" on my macro so i could see what it did visually. But I suppose just like errant C code, if my macro is total garbage, the pre-processor likely couldn't expand it at all. ;-). I guess I just need to read better documentation on the subject. But it still would be nice to have something that dumped the result of a sucessful expansion, because what is far worse than an error message, is an expansion that works, but doesn't generate the expected code! Will GCC /P do that?
Randy
@Randy: Actually, Boost Wave, which Jerry Coffin recommended, has a "replacement trace" feature where it outputs a file showing the steps it took during macro replacement. It's very verbose, because there are often a lot more steps than we usually think about, but it can be very useful, especially for complex or long macro definitions.
James McNellis
@Randy: I'm sort of the opinion that if your macro is complicated enough to need a sophisticated debugging tool that you're doing something wrong. :-)
Omnifarious
Omni,Then again, just about all our human efforts as programmers start out with a simple premise, but end up shooting all possible interpretations of Occam's razor to hell. ;-)
Randy
A: 

You might want to take a look at Boost Wave. Like most of Boost, it's really more a library than a utility, but it does have a driver to act as a complete preprocessor.

Jerry Coffin
I don't know why this was downvoted... Wave does have a preprocessor implementation (though, it's not quite complete; there are several obscure aspects of macro replacement that it doesn't support).
James McNellis
@James: Yes, "complete" was probably the wrong word -- I just meant that it has driver code so you can compile and link it as a complete, executable program. If (for example) you want macro substitution *without* file inclusion, it's about the best starting point I know of though (and you *frequently* don't want file inclusion, as it can/will produce a lot of bulk to scan through to find what you care about).
Jerry Coffin
+1  A: 

You appear to be confused about what the exact syntax is for stringifying or token pasting in C preprocessor macros.

You might find this page about C preprocessor macros in general helpful.

In particular, I think this macro should read like this:

#define GETADDR_FOR(a) if (!(a = (_##a)GetProcAddress(h, #a))) --iFail

The trailing ; should be skipped because you will likely be typing this as GETADDR_FOR(hexdump);, and if you don't it will look very strange in your C code and confuse many syntax highlighters.

And as someone else mentioned gcc -E will run the preprocessor and skip the other compilation steps. This is useful for debugging preprocessor problems.

Omnifarious
Ah thank you! I certainly had a poor concept of proper use of the stringizer #. But it's usage and the concatination usage! Much appreciated! And thanks for the article link. That looks a lot more comprehensive than the breif notes I found in the MSDN!
Randy
A: 

You might try:

#define GETADDR_FOR(a) if (!(a = (_ ## a)GetProcAddress(h, #a))) --iFail;

The ## operator is used to concatenate two tokens to form a single token; this is what you need to turn hexdump into _hexdump. The # operator is used to get a string representation of an argument (note that its operand must be a parameter name; it can't be some other token). This is what you need to turn hexdump into "hexdump".

As for a good way to test preprocessing, as others have mentioned, both gcc and Visual C++ will allow you to preprocess a source file to an intermediary file. You might also consider using mcpp, which is a standalone implementation of the preprocessor.

James McNellis
OK... and so in this case ## works to join the previous "_" to the stringized 'hexdump', even though the "_" is NOT a token or argument! I'd have never guessed. Thanks! Guess I have some reading to do!
Randy
@Randy: Nope; in `_ ## a`, the `a` is not stringized. The `_` is an identifier token and the `a` is a parameter. The `a` gets replaced by its corresponding argument (`hexdump`), which leaves you with `_ ## hexdump`. The two tokens are then concatenated (giving you `_hexdump`). Only the `#` operator stringizes. The `##` operator concatenates.
James McNellis