iox-#846 Remove 'interface' undef from platform correction

elBoberido · elBoberido · commit 34f7c36a2496 · 2025-01-09T00:35:17.000+01:00
diff --git a/iceoryx_platform/win/include/iceoryx_platform/platform_correction.hpp b/iceoryx_platform/win/include/iceoryx_platform/platform_correction.hpp
@@ -37,4 +37,3 @@
 
 #undef max
 #undef min
-#undef interface
diff --git a/iceoryx_posh/include/iceoryx_posh/capro/service_description.hpp b/iceoryx_posh/include/iceoryx_posh/capro/service_description.hpp
@@ -108,7 +108,7 @@ class ServiceDescription
                        const IdString_t& instance,
                        const IdString_t& event,
                        ClassHash m_classHash = {0U, 0U, 0U, 0U},
-                       Interfaces interfaceSource = Interfaces::INTERNAL) noexcept;
+                       Interfaces commInterface = Interfaces::INTERNAL) noexcept;
 
     /// @brief compare operator.
     bool operator==(const ServiceDescription& rhs) const noexcept;
diff --git a/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp b/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp
@@ -90,7 +90,7 @@ class GatewayGeneric : public gateway_t
     uint64_t getNumberOfChannels() const noexcept;
 
   protected:
-    GatewayGeneric(capro::Interfaces interface,
+    GatewayGeneric(capro::Interfaces commInterface,
                    units::Duration discoveryPeriod = 1000_ms,
                    units::Duration forwardingPeriod = 50_ms) noexcept;
 
diff --git a/iceoryx_posh/include/iceoryx_posh/internal/gateway/gateway_generic.inl b/iceoryx_posh/include/iceoryx_posh/internal/gateway/gateway_generic.inl
@@ -64,10 +64,10 @@ inline uint64_t GatewayGeneric<channel_t, gateway_t>::getNumberOfChannels() cons
 // ================================================== Protected ================================================== //
 
 template <typename channel_t, typename gateway_t>
-inline GatewayGeneric<channel_t, gateway_t>::GatewayGeneric(capro::Interfaces interface,
+inline GatewayGeneric<channel_t, gateway_t>::GatewayGeneric(capro::Interfaces commInterface,
                                                             units::Duration discoveryPeriod,
                                                             units::Duration forwardingPeriod) noexcept
-    : gateway_t(interface)
+    : gateway_t(commInterface)
     , m_discoveryPeriod(discoveryPeriod)
     , m_forwardingPeriod(forwardingPeriod)
 {
diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/interface_port_data.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/interface_port_data.hpp
@@ -30,7 +30,7 @@ struct InterfacePortData : public BasePortData
 {
     InterfacePortData(const RuntimeName_t& runtimeName,
                       const roudi::UniqueRouDiId uniqueRoudiId,
-                      const capro::Interfaces interface) noexcept;
+                      const capro::Interfaces commInterface) noexcept;
 
     concurrent::SpscFifo<capro::CaproMessage, MAX_INTERFACE_CAPRO_FIFO_SIZE> m_caproMessageFiFo;
     bool m_doInitialOfferForward{true};
diff --git a/iceoryx_posh/include/iceoryx_posh/internal/roudi/port_manager.hpp b/iceoryx_posh/include/iceoryx_posh/internal/roudi/port_manager.hpp
@@ -109,7 +109,7 @@ class PortManager
                           mepoo::MemoryManager* const payloadDataSegmentMemoryManager,
                           const PortConfigInfo& portConfigInfo) noexcept;
 
-    popo::InterfacePortData* acquireInterfacePortData(capro::Interfaces interface,
+    popo::InterfacePortData* acquireInterfacePortData(capro::Interfaces commInterface,
                                                       const RuntimeName_t& runtimeName) noexcept;
 
     expected<popo::ConditionVariableData*, PortPoolError>
diff --git a/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp b/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp
@@ -108,7 +108,7 @@ class ProcessManager : public ProcessManagerInterface
     /// @brief Tries to gracefully terminate all registered processes
     void requestShutdownOfAllProcesses() noexcept;
 
-    void addInterfaceForProcess(const RuntimeName_t& name, capro::Interfaces interface) noexcept;
+    void addInterfaceForProcess(const RuntimeName_t& name, capro::Interfaces commInterface) noexcept;
 
     void addSubscriberForProcess(const RuntimeName_t& name,
                                  const capro::ServiceDescription& service,
diff --git a/iceoryx_posh/include/iceoryx_posh/internal/runtime/posh_runtime_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/runtime/posh_runtime_impl.hpp
@@ -76,7 +76,7 @@ class PoshRuntimeImpl : public PoshRuntime
                         const PortConfigInfo& portConfigInfo = PortConfigInfo()) noexcept override;
 
     /// @copydoc PoshRuntime::getMiddlewareInterface
-    popo::InterfacePortData* getMiddlewareInterface(const capro::Interfaces interface,
+    popo::InterfacePortData* getMiddlewareInterface(const capro::Interfaces commInterface,
                                                     const NodeName_t& nodeName = {""}) noexcept override;
 
     /// @copydoc PoshRuntime::getMiddlewareConditionVariable
diff --git a/iceoryx_posh/include/iceoryx_posh/roudi/port_pool.hpp b/iceoryx_posh/include/iceoryx_posh/roudi/port_pool.hpp
@@ -124,7 +124,7 @@ class PortPool
                   const mepoo::MemoryInfo& memoryInfo = mepoo::MemoryInfo()) noexcept;
 
     expected<popo::InterfacePortData*, PortPoolError> addInterfacePort(const RuntimeName_t& runtimeName,
-                                                                       const capro::Interfaces interface) noexcept;
+                                                                       const capro::Interfaces commInterface) noexcept;
 
     expected<popo::ConditionVariableData*, PortPoolError>
     addConditionVariableData(const RuntimeName_t& runtimeName) noexcept;
diff --git a/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp b/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp
@@ -132,10 +132,10 @@ class PoshRuntime
                         const PortConfigInfo& portConfigInfo = PortConfigInfo()) noexcept = 0;
 
     /// @brief request the RouDi daemon to create an interface port
-    /// @param[in] interface interface to create
+    /// @param[in] commInterface of the interface to create
     /// @param[in] nodeName name of the node where the interface should belong to
     /// @return pointer to a created interface port data
-    virtual popo::InterfacePortData* getMiddlewareInterface(const capro::Interfaces interface,
+    virtual popo::InterfacePortData* getMiddlewareInterface(const capro::Interfaces commInterface,
                                                             const NodeName_t& nodeName = {}) noexcept = 0;
 
     /// @brief request the RouDi daemon to create a condition variable
diff --git a/iceoryx_posh/source/capro/service_description.cpp b/iceoryx_posh/source/capro/service_description.cpp
@@ -80,12 +80,12 @@ ServiceDescription::ServiceDescription(const IdString_t& service,
                                        const IdString_t& instance,
                                        const IdString_t& event,
                                        ClassHash classHash,
-                                       Interfaces interfaceSource) noexcept
+                                       Interfaces commInterface) noexcept
     : m_serviceString{service}
     , m_instanceString{instance}
     , m_eventString{event}
     , m_classHash(classHash)
-    , m_interfaceSource(interfaceSource)
+    , m_interfaceSource(commInterface)
 {
 }
 
@@ -139,7 +139,7 @@ bool ServiceDescription::operator<(const ServiceDescription& rhs) const noexcept
 ServiceDescription::operator Serialization() const noexcept
 {
     std::underlying_type<Scope>::type scope = static_cast<std::underlying_type<Scope>::type>(m_scope);
-    std::underlying_type<Interfaces>::type interface =
+    std::underlying_type<Interfaces>::type commInterface =
         static_cast<std::underlying_type<Interfaces>::type>(m_interfaceSource);
     return Serialization::create(m_serviceString,
                                  m_instanceString,
@@ -149,7 +149,7 @@ ServiceDescription::operator Serialization() const noexcept
                                  m_classHash[2U],
                                  m_classHash[3U],
                                  scope,
-                                 interface);
+                                 commInterface);
 }
 
 expected<ServiceDescription, Serialization::Error>
@@ -161,7 +161,7 @@ ServiceDescription::deserialize(const Serialization& serialized) noexcept
     using InterfaceUnderlyingType = std::underlying_type<Interfaces>::type;
 
     ScopeUnderlyingType scope{0};
-    InterfaceUnderlyingType interfaceSource{0};
+    InterfaceUnderlyingType commInterface{0};
 
     auto deserializationSuccessful = serialized.extract(deserializedObject.m_serviceString,
                                                         deserializedObject.m_instanceString,
@@ -171,15 +171,15 @@ ServiceDescription::deserialize(const Serialization& serialized) noexcept
                                                         deserializedObject.m_classHash[2U],
                                                         deserializedObject.m_classHash[3U],
                                                         scope,
-                                                        interfaceSource);
+                                                        commInterface);
     if (!deserializationSuccessful || scope >= static_cast<ScopeUnderlyingType>(Scope::INVALID)
-        || interfaceSource >= static_cast<InterfaceUnderlyingType>(Interfaces::INTERFACE_END))
+        || commInterface >= static_cast<InterfaceUnderlyingType>(Interfaces::INTERFACE_END))
     {
         return err(Serialization::Error::DESERIALIZATION_FAILED);
     }
 
     deserializedObject.m_scope = static_cast<Scope>(scope);
-    deserializedObject.m_interfaceSource = static_cast<Interfaces>(interfaceSource);
+    deserializedObject.m_interfaceSource = static_cast<Interfaces>(commInterface);
 
     return ok(deserializedObject);
 }
diff --git a/iceoryx_posh/source/popo/ports/interface_port_data.cpp b/iceoryx_posh/source/popo/ports/interface_port_data.cpp
@@ -23,8 +23,8 @@ namespace popo
 {
 InterfacePortData::InterfacePortData(const RuntimeName_t& runtimeName,
                                      const roudi::UniqueRouDiId uniqueRoudiId,
-                                     const capro::Interfaces interface) noexcept
-    : BasePortData(capro::ServiceDescription("", "", "", {0, 0, 0, 0}, interface), runtimeName, uniqueRoudiId)
+                                     const capro::Interfaces commInterface) noexcept
+    : BasePortData(capro::ServiceDescription("", "", "", {0, 0, 0, 0}, commInterface), runtimeName, uniqueRoudiId)
 {
 }
 } // namespace popo
diff --git a/iceoryx_posh/source/roudi/port_manager.cpp b/iceoryx_posh/source/roudi/port_manager.cpp
@@ -805,13 +805,13 @@ void PortManager::deletePortsOfProcess(const RuntimeName_t& runtimeName) noexcep
         }
     }
 
-    auto& interfacePorts = m_portPool->getInterfacePortDataList();
-    auto interfacePort = interfacePorts.begin();
-    while (interfacePort != interfacePorts.end())
+    auto& interfacePortDataPool = m_portPool->getInterfacePortDataList();
+    auto interfacePortData = interfacePortDataPool.begin();
+    while (interfacePortData != interfacePortDataPool.end())
     {
-        auto currentPort = interfacePort++;
-        popo::InterfacePort interface(currentPort.to_ptr());
-        if (runtimeName == interface.getRuntimeName())
+        auto currentPort = interfacePortData++;
+        popo::InterfacePort interfacePort(currentPort.to_ptr());
+        if (runtimeName == interfacePort.getRuntimeName())
         {
             IOX_LOG(Debug, "Deleted Interface of application " << runtimeName);
             m_portPool->removeInterfacePort(currentPort.to_ptr());
@@ -1073,10 +1073,10 @@ PortManager::acquireServerPortData(const capro::ServiceDescription& service,
 }
 
 /// @todo iox-#518 return a expected
-popo::InterfacePortData* PortManager::acquireInterfacePortData(capro::Interfaces interface,
+popo::InterfacePortData* PortManager::acquireInterfacePortData(capro::Interfaces commInterface,
                                                                const RuntimeName_t& runtimeName) noexcept
 {
-    auto result = m_portPool->addInterfacePort(runtimeName, interface);
+    auto result = m_portPool->addInterfacePort(runtimeName, commInterface);
     if (result.has_value())
     {
         return result.value();
diff --git a/iceoryx_posh/source/roudi/port_pool.cpp b/iceoryx_posh/source/roudi/port_pool.cpp
@@ -38,11 +38,11 @@ PortPoolData::CondVarContainer& PortPool::getConditionVariableDataList() noexcep
     return m_portPoolData->m_conditionVariableMembers;
 }
 
-expected<popo::InterfacePortData*, PortPoolError> PortPool::addInterfacePort(const RuntimeName_t& runtimeName,
-                                                                             const capro::Interfaces interface) noexcept
+expected<popo::InterfacePortData*, PortPoolError>
+PortPool::addInterfacePort(const RuntimeName_t& runtimeName, const capro::Interfaces commInterface) noexcept
 {
     auto interfacePortData =
-        getInterfacePortDataList().emplace(runtimeName, m_portPoolData->m_uniqueRouDiId, interface);
+        getInterfacePortDataList().emplace(runtimeName, m_portPoolData->m_uniqueRouDiId, commInterface);
     if (interfacePortData == getInterfacePortDataList().end())
     {
         IOX_LOG(Warn, "Out of interface ports! Requested by runtime '" << runtimeName << "'");
diff --git a/iceoryx_posh/source/roudi/process_manager.cpp b/iceoryx_posh/source/roudi/process_manager.cpp
@@ -380,12 +380,12 @@ bool ProcessManager::removeProcessAndDeleteRespectiveSharedMemoryObjects(Process
     return false;
 }
 
-void ProcessManager::addInterfaceForProcess(const RuntimeName_t& name, capro::Interfaces interface) noexcept
+void ProcessManager::addInterfaceForProcess(const RuntimeName_t& name, capro::Interfaces commInterface) noexcept
 {
     findProcess(name)
         .and_then([&](auto& process) {
             // create a ReceiverPort
-            popo::InterfacePortData* port = m_portManager.acquireInterfacePortData(interface, name);
+            popo::InterfacePortData* port = m_portManager.acquireInterfacePortData(commInterface, name);
 
             // send ReceiverPort to app as a serialized relative pointer
             auto offset = UntypedRelativePointer::getOffset(segment_id_t{m_mgmtSegmentId}, port);
diff --git a/iceoryx_posh/source/roudi/roudi.cpp b/iceoryx_posh/source/roudi/roudi.cpp
@@ -509,10 +509,10 @@ void RouDi::processMessage(const runtime::IpcMessage& message,
         }
         else
         {
-            capro::Interfaces interface =
+            capro::Interfaces commInterface =
                 StringToCaProInterface(into<lossy<capro::IdString_t>>(message.getElementAtIndex(2)));
 
-            m_prcMgr->addInterfaceForProcess(runtimeName, interface);
+            m_prcMgr->addInterfaceForProcess(runtimeName, commInterface);
         }
         break;
     }
diff --git a/iceoryx_posh/source/runtime/posh_runtime_impl.cpp b/iceoryx_posh/source/runtime/posh_runtime_impl.cpp
@@ -609,12 +609,12 @@ PoshRuntimeImpl::requestServerFromRoudi(const IpcMessage& sendBuffer) noexcept
     return err(IpcMessageErrorType::REQUEST_SERVER_WRONG_IPC_MESSAGE_RESPONSE);
 }
 
-popo::InterfacePortData* PoshRuntimeImpl::getMiddlewareInterface(const capro::Interfaces interface,
+popo::InterfacePortData* PoshRuntimeImpl::getMiddlewareInterface(const capro::Interfaces commInterface,
                                                                  const NodeName_t& nodeName) noexcept
 {
     IpcMessage sendBuffer;
     sendBuffer << IpcMessageTypeToString(IpcMessageType::CREATE_INTERFACE) << m_appName
-               << static_cast<uint32_t>(interface) << nodeName;
+               << static_cast<uint32_t>(commInterface) << nodeName;
 
     IpcMessage receiveBuffer;
 
diff --git a/iceoryx_posh/test/integrationtests/test_publisher_subscriber_communication.cpp b/iceoryx_posh/test/integrationtests/test_publisher_subscriber_communication.cpp
@@ -83,7 +83,7 @@ class PublisherSubscriberCommunication_test : public RouDi_GTest
     template <typename T>
     std::unique_ptr<iox::popo::Publisher<T>>
     createPublisher(const ConsumerTooSlowPolicy policy = ConsumerTooSlowPolicy::DISCARD_OLDEST_DATA,
-                    const capro::Interfaces interface = capro::Interfaces::INTERNAL)
+                    const capro::Interfaces commInterface = capro::Interfaces::INTERNAL)
     {
         iox::popo::PublisherOptions options;
         options.subscriberTooSlowPolicy = policy;
@@ -92,7 +92,7 @@ class PublisherSubscriberCommunication_test : public RouDi_GTest
                                       m_serviceDescription.getInstanceIDString(),
                                       m_serviceDescription.getEventIDString(),
                                       {0U, 0U, 0U, 0U},
-                                      interface},
+                                      commInterface},
             options);
     }
 
@@ -115,7 +115,7 @@ class PublisherSubscriberCommunication_test : public RouDi_GTest
     std::unique_ptr<iox::popo::Subscriber<T>>
     createSubscriber(const QueueFullPolicy policy = QueueFullPolicy::DISCARD_OLDEST_DATA,
                      const uint64_t queueCapacity = SubscriberPortData::ChunkQueueData_t::MAX_CAPACITY,
-                     const capro::Interfaces interface = capro::Interfaces::INTERNAL)
+                     const capro::Interfaces commInterface = capro::Interfaces::INTERNAL)
     {
         iox::popo::SubscriberOptions options;
         options.queueFullPolicy = policy;
@@ -125,7 +125,7 @@ class PublisherSubscriberCommunication_test : public RouDi_GTest
                                       m_serviceDescription.getInstanceIDString(),
                                       m_serviceDescription.getEventIDString(),
                                       {0U, 0U, 0U, 0U},
-                                      interface},
+                                      commInterface},
             options);
     }
 
@@ -199,11 +199,12 @@ TEST_F(PublisherSubscriberCommunication_test, AllSubscriberInterfacesCanBeSubscr
     auto publisher = createPublisher<int>();
 
     std::vector<std::unique_ptr<iox::popo::Subscriber<int>>> subscribers;
-    for (uint16_t interface = 0U; interface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END); ++interface)
+    for (uint16_t commInterface = 0U; commInterface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END);
+         ++commInterface)
     {
         subscribers.emplace_back(createSubscriber<int>(QueueFullPolicy::DISCARD_OLDEST_DATA,
                                                        SubscriberPortData::ChunkQueueData_t::MAX_CAPACITY,
-                                                       static_cast<capro::Interfaces>(interface)));
+                                                       static_cast<capro::Interfaces>(commInterface)));
     }
 
     constexpr int TRANSMISSION_DATA = 1337;
diff --git a/iceoryx_posh/test/moduletests/test_popo_interface_port.cpp b/iceoryx_posh/test/moduletests/test_popo_interface_port.cpp
@@ -36,9 +36,9 @@ class InterfacePort_test : public Test
     {
     }
 
-    capro::CaproMessage generateMessage(const capro::Interfaces interface) noexcept
+    capro::CaproMessage generateMessage(const capro::Interfaces commInterface) noexcept
     {
-        return {capro::CaproMessageType::ACK, {"Cheri", "Cheri", "Hypnotoad", {0U, 0U, 0U, 0U}, interface}};
+        return {capro::CaproMessageType::ACK, {"Cheri", "Cheri", "Hypnotoad", {0U, 0U, 0U, 0U}, commInterface}};
     }
 };
 
@@ -48,9 +48,10 @@ TEST_F(InterfacePort_test, EveryMessageCanBeDispatchedWhenInterfacePortIsInterna
     ::testing::Test::RecordProperty("TEST_ID", "a9700e7f-20cb-4cbe-baeb-c38701ce9ec4");
     InterfacePortData interfacePortData("", roudi::DEFAULT_UNIQUE_ROUDI_ID, capro::Interfaces::INTERNAL);
 
-    for (uint16_t interface = 0; interface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END); ++interface)
+    for (uint16_t commInterface = 0; commInterface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END);
+         ++commInterface)
     {
-        auto message = generateMessage(static_cast<capro::Interfaces>(interface));
+        auto message = generateMessage(static_cast<capro::Interfaces>(commInterface));
         InterfacePort(&interfacePortData).dispatchCaProMessage(message);
 
         auto maybeMessage = InterfacePort(&interfacePortData).tryGetCaProMessage();
@@ -72,11 +73,12 @@ TEST_F(InterfacePort_test, MessageDispatchedIfInterfacesDifferWhenInterfacePortI
         InterfacePortData interfacePortData(
             "", roudi::DEFAULT_UNIQUE_ROUDI_ID, static_cast<capro::Interfaces>(myInterface));
 
-        for (uint16_t interface = 0; interface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END); ++interface)
+        for (uint16_t otherInterface = 0; otherInterface < static_cast<uint16_t>(capro::Interfaces::INTERFACE_END);
+             ++otherInterface)
         {
-            if (interface != myInterface)
+            if (otherInterface != myInterface)
             {
-                auto message = generateMessage(static_cast<capro::Interfaces>(interface));
+                auto message = generateMessage(static_cast<capro::Interfaces>(otherInterface));
                 InterfacePort(&interfacePortData).dispatchCaProMessage(message);
 
                 auto maybeMessage = InterfacePort(&interfacePortData).tryGetCaProMessage();

Original file line number	Diff line number	Diff line change
`@@ -37,4 +37,3 @@`
`37`	`37`
`38`	`38`	`#undef max`
`39`	`39`	`#undef min`
`40`		`-#undef interface`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ struct InterfacePortData : public BasePortData`
`30`	`30`	`{`
`31`	`31`	`InterfacePortData(const RuntimeName_t& runtimeName,`
`32`	`32`	`const roudi::UniqueRouDiId uniqueRoudiId,`
`33`		`- const capro::Interfaces interface) noexcept;`
	`33`	`+ const capro::Interfaces commInterface) noexcept;`
`34`	`34`
`35`	`35`	`concurrent::SpscFifo<capro::CaproMessage, MAX_INTERFACE_CAPRO_FIFO_SIZE> m_caproMessageFiFo;`
`36`	`36`	`bool m_doInitialOfferForward{true};`