Handle exceptions in C bindings

[MandelbrotInferno]

Describe your changes

All of the C bindings for libf3d now handle exceptions inside of them and log the relevant warning/error message. Where necessary, I have also added the necessary descriptions in the C binding comments.

Issue ticket number and link if any

#2763

Checklist for finalizing the PR

• I have performed a self-review of my code
• I have added tests for new features and bugfixes
• I have added documentation for new features
• If it is a modifying the libf3d API, I have updated bindings
• If it is a modifying the .github/workflows/versions.json, I have updated docker_timestamp

Continuous integration

\ci fast

[mwestphal]

Please request a review whenever you need by using github review mechanism (top right).

[MandelbrotInferno]

Please request a review whenever you need by using github review mechanism (top right).

Ah yes. I forgot to request that. Thanks for the heads up:)

[mwestphal]

Please request a review whenever you need by using github review mechanism (top right).

Ah yes. I forgot to request that. Thanks for the heads up:)

No worries, I'm just explaining the process as usual :)

[mwestphal]

please document that behavior

[mwestphal]

is that for the new ? im not sure we want to catch that. wdyt @Meakk @AoGao-Kedoka ?

[AoGao-Kedoka]

i also think it's unnecessary. If memory is full, the program is already in a critical state. The catch wouldn't help anyways.

[Meakk]

I'd say we should catch f3d specific exceptions, and fallback on a generic std::exception to catch the rest of them, so bad_alloc is too specific.

[mwestphal]

I dont think we should catch all exceptions in all methods ?

At least thats not what we have been doing in other c bindings.

[Meakk]

As you see fit. I agree we should be consistent.

[mwestphal]

lets not catch everthing, but only what we throw ( or can throw by our usages in the C binding)

[mwestphal]

catch specific exceptions, not everything

[mwestphal]

catch specific exceptions, not everything

[mwestphal]

I've only reviewed utils for now, to make sure we are on the same page regarding what is expected here.

[MandelbrotInferno]

I've only reviewed utils for now, to make sure we are on the same page regarding what is expected here.

Thanks! Will try to fix the mentioned issues. I did however notice that in some of the C bindings that exception handling was written for we handled everything eg:

f3d_engine_t* f3d_engine_create(int offscreen)
{
  try
  {
    f3d::engine* eng = new f3d::engine(f3d::engine::create(offscreen != 0));
    return reinterpret_cast<f3d_engine_t*>(eng);
  }
  catch (std::exception& e)
  {
    f3d::log::error("Failed to create engine: ", e.what());
    return nullptr;
  }
}

The above is in the engine_c_api.cxx file for example. Should I go ahead and modify those too in order to ensure only the required specific exceptions are handled?

[AoGao-Kedoka]

I've only reviewed utils for now, to make sure we are on the same page regarding what is expected here.

Thanks! Will try to fix the mentioned issues. I did however notice that in some of the C bindings that exception handling was written for we handled everything eg:

f3d_engine_t* f3d_engine_create(int offscreen)
{
  try
  {
    f3d::engine* eng = new f3d::engine(f3d::engine::create(offscreen != 0));
    return reinterpret_cast<f3d_engine_t*>(eng);
  }
  catch (std::exception& e)
  {
    f3d::log::error("Failed to create engine: ", e.what());
    return nullptr;
  }
}

The above is in the engine_c_api.cxx file for example. Should I go ahead and modify those too in order to ensure only the required specific exceptions are handled?

Engine is where everything getting initialized and it would be quite amount of work to be specific here. But I defer to @mwestphal

[mwestphal]

I've only reviewed utils for now, to make sure we are on the same page regarding what is expected here.

Thanks! Will try to fix the mentioned issues. I did however notice that in some of the C bindings that exception handling was written for we handled everything eg:

f3d_engine_t* f3d_engine_create(int offscreen)
{
  try
  {
    f3d::engine* eng = new f3d::engine(f3d::engine::create(offscreen != 0));
    return reinterpret_cast<f3d_engine_t*>(eng);
  }
  catch (std::exception& e)
  {
    f3d::log::error("Failed to create engine: ", e.what());
    return nullptr;
  }
}

The above is in the engine_c_api.cxx file for example. Should I go ahead and modify those too in order to ensure only the required specific exceptions are handled?

Engine is where everything getting initialized and it would be quite amount of work to be specific here. But I defer to @mwestphal

Indeed, in that specific case, for the sake of simplicty and brevity we decided to catch everything, but its better to be specific when possible.