Call functions numerically with pointers

I agree with PaulS that you hardly need to use PROGMEM here, but in case you were envisaging a much larger array, this works:

typedef void (* myFunction) ();

PROGMEM myFunction Farr []  = {func1, func2, func3};

volatile int foo = 3;

void setup(){
  Serial.begin(115200);
  for(int i = 0; i < foo; i++) 
    {
    myFunction f = (myFunction) pgm_read_word (&Farr [i]);
    f ();
    }
}//setup()

void loop(){}//loop()

void func1(){
  Serial.println(F("function1"));
}//func1()

void func2(){
  Serial.println(F("function2"));
}//func2()

void func3(){
  Serial.println(F("function3"));
}//func3()

A little strange. When trying nicks example i get this:

sketch_dec13a.ino:3: warning: only initialized variables can be placed into program memory area

When running this code:

void (*Farr[])() PROGMEM  = {FuncA, FuncB, FuncC};

volatile int foo = 3;

void setup(){
  union {
  void (*p)();
  int i;
  }cv;
  Serial.begin(115200);
  for(int i = 0; i < foo; i++){
    cv.p = Farr[i];
    Serial.println(cv.i);
  }
}//setup()

void loop(){}

void FuncA(){
  Serial.println("Function A");
}

void FuncB(){
  Serial.println("Function B");
}

void FuncC(){
  Serial.println("Function C");
}

i get this output:

0
514
514

This leads me to believe that despite that the addresses of the functions should be known at compile time the array is not initialized. Why??

nilton61, I used 9600 because I've known the serial monitor to crash when it receives large volumes of data. Your last example isn't using pgm_read_word, perhaps this is the problem.

Nick, accessing the compiled code is useful, how do you do that? Seems the optimiser is overstepping its responsibilities if it makes code work that would otherwise fail! Your code compiled fine for me. Packaging it into a macro and implementing it in my example gives the following, which now also works!

typedef void (* myFunction) ();
PROGMEM myFunction FunctionArray[] = {FuncA, FuncB, FuncC};
#define CallF(Num) ((myFunction) pgm_read_word (&FunctionArray [Num])) ()

byte Global;

void setup(){
  Serial.begin(115200);
  
  Global = 1;
  byte Local = 1;
  // Local = Global; // THIS NO LONGER SCREWS EVERYTHING UP
  
  // Global and Local display as expected:
  Serial.print("Global = ");
  Serial.println(Global);
  Serial.print("Local = ");
  Serial.println(Local);
  
  // These work fine:
  CallF(0);
  CallF(1);
  CallF(2);
  
  // These now work too!
  CallF(Local); // Calls FuncB
  CallF(Global); // Calls FuncB
  
  // For good measure so does this:
  for(byte a = 0; a <= 2; a++)
  {
    CallF(a);
  }
}

void loop(){}

void FuncA(){
  Serial.println("Function A");
}

void FuncB(){
  Serial.println("Function B");
}

void FuncC(){
  Serial.println("Function C");
}

Thanks for the advice!

As an aside, yes I'm using PROGMEM because I want the potential to handle much larger arrays of functions, and because storing constants in RAM just seems wrong to me!

paulrd:
Nick, accessing the compiled code is useful, how do you do that?

So everything allocated with the PROGMEM macro must be retrieved with pgm_read_xxxxx()?

I read this:

GCC has a special keyword, attribute that is used to attach different attributes to things such as function declarations, variables, and types. This keyword is followed by an attribute specification in double parentheses. In AVR GCC, there is a special attribute called progmem. This attribute is use on data declarations, and tells the compiler to place the data in the Program Memory (Flash).

AVR-Libc provides a simple macro PROGMEM that is defined as the attribute syntax of GCC with the progmem attribute. This macro was created as a convenience to the end user, as we will see below. The PROGMEM macro is defined in the <avr/pgmspace.h> system header file.

here:http://www.atmel.no/webdoc/AVRLibcReferenceManual/pgmspace_1pgmspace_introduction.html

A few pages down it says this:

Now that your data resides in the Program Space, your code to access (read) the data will no longer work. The code that gets generated will retrieve the data that is located at the address of the mydata array, plus offsets indexed by the i and j variables. However, the final address that is calculated where to the retrieve the data points to the Data Space! Not the Program Space where the data is actually located. It is likely that you will be retrieving some garbage. The problem is that AVR GCC does not intrinsically know that the data resides in the Program Space.

http://www.atmel.no/webdoc/AVRLibcReferenceManual/pgmspace_1pgmspace_data.html

Any reason why the compiler isnt aware of its own attribute keyword?

I believe C++ can distinguish types but not attributes.

nilton61:
So everything allocated with the PROGMEM macro must be retrieved with pgm_read_xxxxx()?

It is in a different memory space, so, yes.

I suspect in this case the attribute is applied by the linker rather than the compiler, in which case it would be reasonable for the compiler to be ignorant of its implications.

Thanks for the help everyone.

Part of what I'm hoping to do with this code is to move the functionality out of my Arduino projects and into an external '.h' include file. More on this here:
http://forum.arduino.cc/index.php?topic=201954.msg1488368#msg1488368

However when I try and move this line into my include file:

PROGMEM myFunction FunctionArray[] = {FuncA, FuncB, FuncC};

The compiler complains:

error: 'PROGMEM' does not name a type

Anyone know what might be causing this? My guess is that it's caused be a difference in the way Arduino code and C are handled, but I don't know how to 'translate' the above line to make it C-friendly.

Post code that demonstrates this. For example, zip up the whole project and attach that to a post.

your progmen.h file should look like this:

#include <arduino.h>
typedef void (* myFunction) ();
void FuncA(void);
void FuncB(void);
void FuncC(void);
PROGMEM myFunction Farr[] PROGMEM  = {FuncA, FuncB, FuncC};

Here's a zip file that demonstrates the problem. If you unzip it at the root of your C drive it should work. The main file is this:

//------------------------------------------------------------
// Option A: Set up locally: WORKS
typedef void (* myFunction) ();
PROGMEM myFunction Farr[] = {FuncA, FuncB, FuncC};
#define CallF(Num) ((myFunction) pgm_read_word (&Farr [Num])) ()

// Option B: Set up using external include - DOESN'T WORK
//#include "C:\Arduino\IncludeTest\Includes\Include.h"
//------------------------------------------------------------

byte Global;

void setup(){
  Serial.begin(115200);
  
  Global = 1;
  byte Local = 1;
  
  // Global and Local display as expected:
  Serial.print("Global = ");
  Serial.println(Global);
  Serial.print("Local = ");
  Serial.println(Local);
  
  // These work fine:
  CallF(0);
  CallF(1);
  CallF(2);
  
  // These now work too!
  CallF(Local); // Calls FuncB
  CallF(Global); // Calls FuncB
  
  // For good measure so does this:
  for(byte a = 0; a <= 2; a++)
  {
    CallF(a);
  }
}

void loop(){}

void FuncA(){
  Serial.println("Function A");
}

void FuncB(){
  Serial.println("Function B");
}

void FuncC(){
  Serial.println("Function C");
}

And the include file is this:

#include <arduino.h>

typedef void (* myFunction) ();

void FuncA(void);
void FuncB(void);
void FuncC(void);

PROGMEM myFunction Farr[] PROGMEM  = {FuncA, FuncB, FuncC};

If you comment out the lines under 'option A' and uncomment 'option B', it won't compile. This is the problem I'm trying to solve.

Arduino.zip (1.13 KB)

Why the lengthy path to the include? Put the Include.h file in the same folder as the .ino file. Then this compiles:

#define CallF(Num) ((myFunction) pgm_read_word (&Farr [Num])) ()
#include "Include.h"

...

I wanted to avoid that if possible. If it's in the same folder as the rest of the Arduino code, the IDE will open it, ignore changes to it, and save over it. It's a similar problem to the one discussed in the other thread I mentioned.

The best solution there was to use an alternate editor, with only some of the files open. But if there's a way to keep compatibility with the Arduino IDE and compile it in its current location, that would be even better.

Make a library then.

Or edit the .h file in the IDE. What's the big deal with that?

I'm working on a program to automatically generate code, to support the code written in the IDE. It will be a huge time saver if it works, but it needs a method for including files without the IDE disrupting them.

paulrd:
it needs a method for including files without the IDE disrupting them.

The IDE only mucks about with the .INO source files. If you generate .CPP files the IDE leaves them alone and compiles them as they are. You need to have a .INO file of the same name as the sketch, but there's no restriction on how much or how little code it has in it and you can add as many separate .c, .cpp and .h files to the sketch as you want.

That would be great, but my experience is that the IDE opens all 3 of these file types in tabs when the project is opened, ignores changes to the original files, compiling instead the version that is open in the IDE, and then saves over the top of them when you save the project.

Am I missing something? Can you provide an example that allows an include file to be modified behind the scenes without the problems listed above?