Skip to content

Allow testByteBuffer.cpp to test deprecated function getArray() without causing compiler warnings. #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow testByteBuffer.cpp to test deprecated function getArray() without causing compiler warnings. #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions testApp/misc/testByteBuffer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
#include <cstring>
#include <memory>

// allow to test deprecated functions without causing compiler warnings
#include <compilerSpecific.h>
#undef EPICS_DEPRECATED
Copy link
Member

@mdavidsaver mdavidsaver Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anjohnson Do we support including compilerSpecific.h directly?

An alternative might be:

#include <compilerDependencies.h>
#undef EPICS_DEPRECATED
#define EPICS_DEPRECATED

Copy link
Member

@anjohnson anjohnson Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our compilerDependencies.h immediately includes compilerSpecific.h so there must be a version of that file for every target compiler. Some of the those implementations might not define all of the macros, in which case compilerDependencies.h provides an empty macro for the missing definitions.

Here testByteBuffer.cpp doesn't include any other EPICS headers before this conditional, so the headers that do get included lower down that use our compiler macros must be including compilerDependencies.h anyway. As a result I think Dirk's version should be safe as given.

Future edits to his version that added an inclusion of compilerDependencies.h above these lines though would leave the compilerDependencies.h include-guard defined but EPICS_DEPRECATED undefined, so the later includes wouldn't define EPICS_DEPRECATED at all, and would break the build. The author of such changes should notice the break so it seems unlikely to cause problems, but this does look brittle and increases the coupling between the implementations of compilerDependencies.h and testByteBuffer.cpp.

Copy link
Contributor Author

@dirk-zimoch dirk-zimoch Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest to spend more effort on removing the use of deprecated functions and less on the implementation details of the workaround.

Copy link
Contributor Author

@dirk-zimoch dirk-zimoch Nov 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even with the alternative, future edits must make sure that the removal of EPICS_DEPRECATED happens before the header file containing the deprecated function is included.


#include <testMain.h>

#include <pv/pvUnitTest.h>
Expand Down
Loading