203

I just saw a picture today and think I'd appreciate explanations. So here is the picture:

some c code

Transcription: "C isn't that hard:void (*(*f[])())() definesf as an array of unspecified size, of pointers to functions that return pointers to functions that returnvoid."

I found this confusing and wondered if such code is ever practical. I googled the picture and found another picture inthis reddit entry, and here is that picture:

some interesting explanation

Transcription: "So the symbols can be read:f [] * () * () void.f is an array of pointers that take no argument and return a pointer that takes no argument and returnsvoid".

So this "reading spirally" is something valid? Is this how C compilers parse?
It'd be great if there are simpler explanations for this weird code.
Apart from all, can this kind of code be useful? If so, where and when?

There isa question about "spiral rule", but I'm not just asking about how it's applied or how expressions are read with that rule. I'm questioning usage of such expressions and spiral rule's validity as well. Regarding these, some nice answers are already posted.

starball's user avatar
starball
60.5k54 gold badges329 silver badges1.1k bronze badges
askedDec 31, 2015 at 16:01
Motun's user avatar
21
  • 9
    How could the explanation be simpler? It covers all aspects of the definition of f w/ a couple of words for each key point.CommentedDec 31, 2015 at 16:07
  • 32
    Maybe C is hard? That actually declaresf as an array of pointers to functions that could take any argument .. if it werevoid (*(*f[])(void))(void);, then yes, it would be functions that take no arguments ...CommentedDec 31, 2015 at 16:13
  • 20
    In practice, don't code such obscure code.Use typedef for signaturesCommentedDec 31, 2015 at 18:21
  • 4
    any declaration involving function pointers can be hard. That doesn't mean that normal C or C++ is hard in that same way. Other languages solve this in different ways including not having function pointers, which can be a significant omission in some casesCommentedDec 31, 2015 at 18:22
  • 24
    If you squint your eyes, it looks like LISP.CommentedDec 31, 2015 at 19:47

13 Answers13

118

There is a rule called the"Clockwise/Spiral Rule" to help find the meaning of a complex declaration.

Fromc-faq:

There are three simple steps to follow:

  1. Starting with the unknown element, move in a spiral/clockwise direction; when ecountering the following elements replace them with the corresponding english statements:

    [X] or[]
    => Array X size of... or Array undefined size of...

    (type1, type2)
    => function passing type1 and type2 returning...

    *
    => pointer(s) to...

  2. Keep doing this in a spiral/clockwise direction until all tokens have been covered.

  3. Always resolve anything in parenthesis first!

You can check the link above for examples.

Also note that to help you there is also a website called:

http://www.cdecl.org

You can enter a C declaration and it will give its english meaning. For

void (*(*f[])())()

it outputs:

declare f as array of pointer to function returning pointer to function returning void

EDIT:

As pointed out in the comments byRandom832, the spiral rule does not address array of arrays and will lead to a wrong result in (most of) those declarations. For example forint **x[1][2]; the spiral rule ignores the fact that[] has higher precedence over*.

When in front of array of arrays, one can first add explicit parentheses before applying the spiral rule. For example:int **x[1][2]; is the same asint **(x[1][2]); (also valid C) due to precedence and the spiral rule then correctly reads it as "x is an array 1 of array 2 of pointer to pointer to int" which is the correct english declaration.

Note that this issue has also been covered in thisanswer byJames Kanze (pointed out byhaccks in the comments).

answeredDec 31, 2015 at 16:07
ouah's user avatar
Sign up to request clarification or add additional context in comments.

8 Comments

I wish cdecl.org was better
There is no "spiral rule"... "int ***foo[][][]" defines an array of arrays of arrays of pointers to pointers to pointers. The "spiral" only comes from the fact that this declaration happened to group things in parentheses in a way that caused them to alternate. It's everything on the right, then left, within each set of parentheses.
@Random832 There is a "spiral rule", and it covers the case you just mentioned, i.e. talks about how to deal with parenthesis/arrays etc. Of course is not a Standard C rule, but a good mnemonic for figuring out how to deal with complicated declarations. IMHO, it is extremely useful and saves you when in trouble or whencdecl.org cannot parse the declaration. Of course one shouldn't abuse such declarations, but it's good to know how they are parsed.
@vsoftco But it's not "moving in a spiral/clockwise direction" if you only turn around when you reach the parentheses.
ouah, you should mention thatspiral rule is not universal.
|
116

The "spiral" rule kind of falls out of the following precedence rules:

T *a[]    -- a is an array of pointer to TT (*a)[]  -- a is a pointer to an array of TT *f()    -- f is a function returning a pointer to TT (*f)()  -- f is a pointer to a function returning T

The subscript[] and function call() operators have higher precedence than unary*, so*f() is parsed as*(f()) and*a[] is parsed as*(a[]).

So if you want a pointer to an array or a pointer to a function, then you need to explicitly group the* with the identifier, as in(*a)[] or(*f)().

Then you realize thata andf can be more complicated expressions than just identifiers; inT (*a)[N],a could be a simple identifier, or it could be a function call like(*f())[N] (a ->f()), or it could be an array like(*p[M])[N], (a ->p[M]), or it could be an array of pointers to functions like(*(*p[M])())[N] (a ->(*p[M])()), etc.

It would be nice if the indirection operator* was postfix instead of unary, which would make declarations somewhat easier to read from left to right (void f[]*()*(); definitely flows better thanvoid (*(*f[])())()), but it's not.

When you come across a hairy declaration like that, start by finding theleftmost identifier and apply the precedence rules above, recursively applying them to any function parameters:

         f              -- f         f[]            -- is an array        *f[]            -- of pointers  ([] has higher precedence than *)       (*f[])()         -- to functions      *(*f[])()         -- returning pointers     (*(*f[])())()      -- to functionsvoid (*(*f[])())();     -- returning void

Thesignal function in the standard library is probably the type specimen for this kind of insanity:

       signal                                       -- signal       signal(                          )           -- is a function with parameters       signal(    sig,                  )           --    sig       signal(int sig,                  )           --    which is an int and       signal(int sig,        func      )           --    func       signal(int sig,       *func      )           --    which is a pointer       signal(int sig,      (*func)(int))           --    to a function taking an int                                                  signal(int sig, void (*func)(int))           --    returning void      *signal(int sig, void (*func)(int))           -- returning a pointer     (*signal(int sig, void (*func)(int)))(int)     -- to a function taking an intvoid (*signal(int sig, void (*func)(int)))(int);    -- and returning void

At this point most people say "use typedefs", which is certainly an option:

typedef void outerfunc(void);typedef outerfunc *innerfunc(void);innerfunc *f[N];

But...

How would youusef in an expression? You know it's an array of pointers, but how do you use it to execute the correct function? You have to go over the typedefs and puzzle out the correct syntax. By contrast, the "naked" version is pretty eyestabby, but it tells you exactly how tousef in an expression (namely,(*(*f[i])())();, assuming neither function takes arguments).

answeredDec 31, 2015 at 17:11
John Bode's user avatar

4 Comments

Thanks for giving the example of 'signal', showing that these kinds of things do appear in the wild.
I liked yourf deceleration tree, explaining the precedence...for some reason I always get a kick out of ASCII-art, especially when it comes to explaining things :)
assuming neither function takes arguments: then you have to usevoid in functions parenthesis, otherwise it can take any arguments.
@haccks: for the declaration, yes; I was talking about the function call.
66

In C, declaration mirrors usage—that’s how it’s defined in the standard. The declaration:

void (*(*f[])())()

Is an assertion that the expression(*(*f[i])())() produces a result of typevoid. Which means:

  • f must be an array, since you can index it:

    f[i]
  • The elements off must be pointers, since you can dereference them:

    *f[i]
  • Those pointers must be pointers to functions taking no arguments, since you can call them:

    (*f[i])()
  • The results of those functions must also be pointers, since you can dereference them:

    *(*f[i])()
  • Those pointers mustalso be pointers to functions taking no arguments, since you can call them:

    (*(*f[i])())()
  • Those function pointers must returnvoid

The “spiral rule” is just a mnemonic that provides a different way of understanding the same thing.

answeredJan 1, 2016 at 1:27
Jon Purdy's user avatar

6 Comments

Great way of looking at it that I've never seen before. +1
Nice. Seen this way, itreally is simple. Actually rather easier than something likevector< function<function<void()>()>* > f, especially if you add in thestd::s. (But well, the exampleis contrived... evenf :: [IORef (IO (IO ()))] looks weird.)
@TimoDenk: The declarationa[x] indicates that the expressiona[i] is valid wheni >= 0 && i < x. Whereas,a[] leaves the size unspecified, and is therefore identical to*a: it indicates that the expressiona[i] (or equivalently*(a + i)) is valid forsome range ofi.
This is by far the easiest way to think about C types, thanks for this
I love this! Much easier to reason about than silly spirals.(*f[])() is a type you can index, then dereference, then call, so it's an array of pointers to functions.
|
42

So this "reading spirally" is something valid?

Applying spiral rule or usingcdecl are not valid always. Both fails in some cases. Spiral rule works for many cases, butit is not universal.

To decipher complex declarations remember these two simple rules:

  • Always read declarations from inside out: Start from innermost, if any, parenthesis. Locate the identifier that's being declared, and start deciphering the declaration from there.

  • When there is a choice, always favour[] and() over*: If* precedes the identifier and[] follows it, the identifier represents an array, not a pointer. Likewise, if* precedes the identifier and() follows it, the identifier represents a function, not a pointer. (Parentheses can always be used to override the normal priority of[] and() over*.)

This rule actually involveszigzagging from one side of the identifier to the other.

Now deciphering a simple declaration

int *a[10];

Applying rule:

int *a[10];      "a is"       ^  int *a[10];      "a is an array"        ^^^^ int *a[10];      "a is an array of pointers"    ^int *a[10];      "a is an array of pointers to `int`".  ^^^

Let's decipher the complex declaration like

void ( *(*f[]) () ) ();

by applying the above rules:

void ( *(*f[]) () ) ();        "f is"            ^  void ( *(*f[]) () ) ();        "f is an array"             ^^ void ( *(*f[]) () ) ();        "f is an array of pointers"          ^    void ( *(*f[]) () ) ();        "f is an array of pointers to function"                  ^^     void ( *(*f[]) () ) ();        "f is an array of pointers to function returning pointer"       ^   void ( *(*f[]) () ) ();        "f is an array of pointers to function returning pointer to function"                     ^^    void ( *(*f[]) () ) ();        "f is an array of pointers to function returning pointer to function returning `void`"  ^^^^

Here is a GIF demonstrating how you go (click on image for larger view):

enter image description here


The rules mentioned here is taken from the bookC Programming A Modern Approach by K.N KING.

answeredJan 1, 2016 at 21:55
haccks's user avatar

4 Comments

This is just like the standard's approach i.e. "declaration mirrors usage". I'd like to ask something else at this point though: Do you suggest K. N. King's book? I'm seeing lots of nice reviews about the book.
Yeah. I do suggest that book. I started programming from that book. Good texts and problems in there.
Can you provide an example of cdecl failing to understand a declaration? I thought cdecl used the same parsing rules as compilers, and as far as I can tell it always works.
@FabioTurati; A function can't return arrays or function.char (x())[5] should result in syntax error but, cdecl parse it as:declarex as function returning array 5 ofchar.
12

It's only a "spiral" because there happens to be, in this declaration, only one operator on each side within each level of parentheses. Claiming that you proceed "in a spiral" generally would suggest you alternate between arrays and pointers in the declarationint ***foo[][][] when in reality all of the array levels come before any of the pointer levels.

answeredJan 1, 2016 at 1:46
Random832's user avatar

1 Comment

Well, in the "spiral approach", you go as far right as you can, then as far left as you can, etc. But it's often explained erroneously...
7

As a random trivia factoid, you might find it amusing to know that there's an actual word in English to describe how C declarations are read:Boustrophedonically, that is, alternating right-to-left with left-to-right.

Reference:Van der Linden, 1994 -Page 76

answeredJan 1, 2016 at 20:59
asamarin's user avatar

1 Comment

That word doesn't indicatewithin as in nested by parens or on a single line. It describes a "snake" pattern, with an LTR line followed by an RTL line.
6

I doubt constructions like this can have any use in real life. I even detest them as interview questions for the regular developers (likely OK for compiler writers). typedefs should be used instead.

answeredDec 31, 2015 at 16:11
SergeyA's user avatar

9 Comments

Nonetheless, it's important to know how to parse it, even if only to know how to parse the typedef!
@inetknght, the way you do it with typedefs is to have them simple enough so that no parsing would be required.
People who ask these types of questions during interviews only do it to stroke their Egos.
@JohnBode, and you would do yourself a favor by typedefing return value of the function.
@JohnBode, i find it a matter of personal choice not worth debating. I see your preference, I still have mine.
|
5

Regarding the usefulness of this, when working with shellcode you see this construct a lot:

int (*ret)() = (int(*)())code;ret();

While not quite as syntactically complicated, this particular pattern comes up a lot.

More complete example inthis SO question.

So while the usefulness to the extent in the original picture is questionable (I would suggest that any production code should be drastically simplified), there are some syntactical constructs that do come up quite a bit.

Motun's user avatar
Motun
2,1694 gold badges17 silver badges24 bronze badges
answeredDec 31, 2015 at 16:45

Comments

5

The declaration

void (*(*f[])())()

is just an obscure way of saying

Function f[]

with

typedef void (*ResultFunction)();typedef ResultFunction (*Function)();

In practice, more descriptive names will be needed instead ofResultFunction andFunction. If possible I would also specify the parameter lists asvoid.

answeredJan 3, 2016 at 10:21
August Karlstrom's user avatar

Comments

5

I happen to be the original author of the spiral rule that I wrote oh so many years ago (when I had a lot of hair :) and was honored when it was added to the cfaq.

I wrote the spiral rule as a way to make it easier for my students and colleagues to read the C declarations "in their head"; i.e., without having to use software tools like cdecl.org, etc. It was never my intent to declare that the spiral rule be the canonical way to parse C expressions. I am though, delighted to see that the rule has helped literally thousands of C programming students and practitioners over the years!

For the record,

It has been "correctly" identified numerous times on many sites, including by Linus Torvalds (someone whom I respect immensely), that there are situations where my spiral rule "breaks down". The most common being:

char *ar[10][10];

As pointed out by others in this thread, the rule could be updated to say that when you encounter arrays, simply consume all the indexesas if written like:

char *(ar[10][10]);

Now, following the spiral rule, I would get:

"ar is a 10x10 two-dimensional array of pointers to char"

I hope the spiral rule carries on its usefulness in learning C!

P.S.:

I love the "C isn't hard" image :)

answeredJun 23, 2017 at 1:51
David Anderson's user avatar

Comments

4

I found method described by Bruce Eckel to be helpful and easy to follow:

Defining a function pointer

To define a pointer to a function that has no arguments and no return value, you say:

void (*funcPtr)();

When you are looking at a complex definition like this, the best way to attack it is to start in the middle and work your way out. “Starting in the middle” means starting at the variable name, which is funcPtr. “Working your way out” means looking to the right for the nearest item (nothing in this case; the right parenthesis stops you short), then looking to the left (a pointer denoted by the asterisk), then looking to the right (an empty argument list indicating a function that takes no arguments), then looking to the left (void, which indicates the function has no return value). This right-left-right motion works with most declarations.

To review, “start in the middle” (“funcPtr is a ...”), go to the right (nothing there – you're stopped by the right parenthesis), go to the left and find the ‘*’ (“... pointer to a ...”), go to the right and find the empty argument list (“... function that takes no arguments ... ”), go to the left and find the void (“funcPtr is a pointer to a function that takes no arguments and returns void”).

You may wonder why *funcPtr requires parentheses. If you didn't use them, the compiler would see:

void *funcPtr();

You would be declaring a function (that returns a void*) rather than defining a variable. You can think of the compiler as going through the same process you do when it figures out what a declaration or definition is supposed to be. It needs those parentheses to “bump up against” so it goes back to the left and finds the ‘*’, instead of continuing to the right and finding the empty argument list.

Complicated declarations & definitions

As an aside, once you figure out how the C and C++ declaration syntax works you can create much more complicated items. For instance:

//: C03:ComplicatedDefinitions.cpp/* 1. */     void * (*(*fp1)(int))[10];/* 2. */     float (*(*fp2)(int,int,float))(int);/* 3. */     typedef double (*(*(*fp3)())[10])();             fp3 a;/* 4. */     int (*(*f4())[10])();int main() {} ///:~

Walk through each one and use the right-left guideline to figure it out.Number 1 says “fp1 is a pointer to a function that takes an integer argument and returns a pointer to an array of 10 void pointers.”

Number 2 says “fp2 is a pointer to a function that takes three arguments (int, int, and float) and returns a pointer to a function that takes an integer argument and returns a float.”

If you are creating a lot of complicated definitions, you might want to use a typedef.Number 3 shows how a typedef saves typing the complicated description every time. It says “An fp3 is a pointer to a function that takes no arguments and returns a pointer to an array of 10 pointers to functions that take no arguments and return doubles.” Then it says “a is one of these fp3 types.” typedef is generally useful for building complicated descriptions from simple ones.

Number 4 is a function declaration instead of a variable definition. It says “f4 is a function that returns a pointer to an array of 10 pointers to functions that return integers.”

You will rarely if ever need such complicated declarations and definitions as these. However, if you go through the exercise of figuring them out you will not even be mildly disturbed with the slightly complicated ones you may encounter in real life.

Taken from: Thinking in C++ Volume 1, second edition, chapter 3, section "Function Addresses" by Bruce Eckel.

answeredJan 3, 2016 at 1:18
user3496846's user avatar

Comments

4

Remember these rules for C declares
And precedence never will be in doubt:
Start with the suffix, proceed with the prefix,
And read both sets from the inside, out.
-- me, mid-1980's

Except as modified by parentheses, of course. And note that the syntax for declaring these exactly mirrors the syntax for using that variable to get an instance of the base class.

Seriously, this isn't hard to learn to do at a glance; you just have to be willing to spend some time practising the skill. If you're going to maintain or adapt C code written by other people, it'sdefinitely worth investing that time. It's also a fun party trick for freaking out other programmers who haven't learned it.

For your own code: as always, the fact that somethingcan be written as a one-liner does't mean it should be, unless it is an extremely common pattern that has become a standard idiom (such as the string-copy loop). You, and those who follow you, will bemuch happier if you build complex types out of layered typedefs and step-by-step dereferences rather than relying on your ability to generate and parse these "at one swell foop." Performance will be just as good, and code readability and maintainability will be tremendously better.

It could be worse, you know. There was a legal PL/I statement that started with something like:

if if if = then then then = else else else = if then ...
answeredJan 1, 2016 at 0:51
keshlam's user avatar

2 Comments

The PL/I statement wasIF IF = THEN THEN THEN = ELSE ELSE ELSE = ENDIF ENDIF and is parsed asif (IF == THEN) then (THEN = ELSE) else (ELSE = ENDIF).
Ithink there was a version which took it one step farther by using a conditional IF/THEN/ ELSE expression (equivalent to C's ?:), which got the third set into the mix... but it's been a few decades and may have depended upon a particular dialect of the language. Point remains that any language has at least one pathological form.
3
  • void(*(*f[]) ()) ()

Resolvingvoid >>

  • (*(*f[]) ()) () = void

Resoiving() >>

  • (*(*f[]) ()) = function returning (void)

Resolving* >>

  • (*f[]) () = pointer to (function returning (void) )

Resolving() >>

  • (*f[]) = function returning (pointer to (function returning (void) ))

Resolving* >>

  • f[] = pointer to (function returning (pointer to (function returning(void) )))

Resolving[ ] >>

  • f = array of (pointer to (function returning (pointer to (functionreturning (void) ))))
answeredJan 6, 2016 at 16:33
Shubham's user avatar

Comments

Your Answer

Sign up orlog in

Sign up using Google
Sign up using Email and Password

Post as a guest

Required, but never shown

By clicking “Post Your Answer”, you agree to ourterms of service and acknowledge you have read ourprivacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.