Make os_types.h private (#167)

* add ENABLE_ESI_PARSER compile options

Author: nicolas71640

CMakeLists.txt

@@ -8,6 +8,7 @@ list(APPEND CMAKE_FIND_ROOT_PATH ${CMAKE_BINARY_DIR})
 include(Config)
 include(debug)
 
+option(ENABLE_ESI_PARSER "Enable Esi Parser" ON)
 add_subdirectory(lib)
 
 option(BUILD_UNIT_TESTS "Build unit tests" OFF)
@@ -84,3 +85,5 @@ if (BUILD_TOOLS)
     add_subdirectory(tools)
   endif()
 endif()
+
+

conanfile.py

@@ -0,0 +1,66 @@
+from conan import ConanFile
+from conan.tools.cmake import CMakeToolchain, CMake, cmake_layout, CMakeDeps
+from conan.tools.files import get, copy
+import os
+
+required_conan_version = ">=1.55"
+
+class KickCATRecipe(ConanFile):
+    name = "kickcat"
+    url = "https://github.com/conan-io/conan-center-index"
+    homepage = "https://github.com/Siviuze/KickCAT"
+    description = "Thin EtherCAT stack designed to be embedded in a more complex software and with efficiency in mind"
+    license = "CeCILL-C"
+    topics = ("ethercat")
+    settings = "os", "compiler", "build_type", "arch"
+    options = {"shared": [True, False], "fPIC": [True, False], "with_esi_parser": [True, False]}
+    default_options = {"shared": False, "fPIC": True, "with_esi_parser": False}
+
+    # Sources are located in the same place as this recipe, copy them to the recipe
+    exports_sources = "CMakeLists.txt", "lib/*", "examples/*", "cmake/*"
+
+    # def source(self):
+    #     get(self, **self.conan_data["sources"][self.version])
+
+    def config_options(self):
+        if self.settings.os == "Windows":
+            del self.options.fPIC
+
+    def layout(self):
+        cmake_layout(self)
+
+    def generate(self):
+        tc = CMakeToolchain(self)
+        tc.variables["ENABLE_ESI_PARSER"] = bool(self.options.with_esi_parser)
+        tc.generate()
+
+        deps = CMakeDeps(self)
+        deps.generate()
+
+    def requirements(self):
+        if self.options.with_esi_parser:
+            self.requires("tinyxml2/10.0.0")
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure(variables={"BUILD_UNIT_TESTS": "OFF",
+                                   "BUILD_EXAMPLES": "OFF",
+                                   "BUILD_SIMULATION": "OFF",
+                                   "BUILD_TOOLS": "OFF"})
+        cmake.build()
+
+    def package(self):
+        src_folders = ["lib/include", "lib/slave/include", "lib/slave/driver/include", "lib/master/include"]
+        for folder in src_folders:
+            copy(self, "*.h", os.path.join(self.source_folder, folder),
+                os.path.join(self.package_folder, "include"))
+
+        copy(self, "*.a", self.build_folder,
+             os.path.join(self.package_folder, "lib"), keep_path=False)
+        copy(self, "*.so", self.build_folder,
+             os.path.join(self.package_folder, "lib"), keep_path=False)
+
+    def package_info(self):
+        self.cpp_info.libs = ["kickcat"]
+
+

examples/master/load_esi/CMakeLists.txt

@@ -1,5 +1,4 @@
-get_property(OK_TO_BUILD GLOBAL PROPERTY ESI_AVAILABLE)
-if (OK_TO_BUILD)
+if (ENABLE_ESI_PARSER)
     add_executable(load_esi load_esi.cc ${OS_SRCS})
     target_include_directories(load_esi PUBLIC  ${CMAKE_CURRENT_SOURCE_DIR}/include)
     target_link_libraries(load_esi common kickcat)

lib/CMakeLists.txt

@@ -14,18 +14,12 @@ set(KICKCAT_SOURCES
   ${CMAKE_CURRENT_SOURCE_DIR}/src/CoE/mailbox/response.cc
 )
 
-find_package(tinyxml2 CONFIG QUIET)
-if (tinyxml2_FOUND)
-  list(APPEND KICKCAT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/CoE/EsiParser.cc)
-  set_property(GLOBAL PROPERTY ESI_AVAILABLE True)
-endif()
 
 if (NUTTX)
   set(OS_LIB_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/src/OS/Linux/Time.cc
   )
   set(OS_LIBRARIES )
-  set(OS_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include/kickcat/OS/Linux/types)
 elseif(PIKEOS)
   set(OS_LIB_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/src/OS/PikeOS/Socket.cc
@@ -34,8 +28,8 @@ elseif(PIKEOS)
   )
 
   set(OS_LIBRARIES )
-  set(OS_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include/kickcat/OS/PikeOS/types)
 elseif (UNIX)
+
   set(OS_LIB_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/src/OS/Linux/Socket.cc
     ${CMAKE_CURRENT_SOURCE_DIR}/src/OS/Linux/Time.cc
@@ -45,17 +39,22 @@ elseif (UNIX)
     ${CMAKE_CURRENT_SOURCE_DIR}/src/OS/Linux/ConditionVariable.cc
   )
   set(OS_LIBRARIES pthread rt)
-  set(OS_INCLUDE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/include/kickcat/OS/Linux/types)
+
+  if (ENABLE_ESI_PARSER)
+    find_package(tinyxml2 CONFIG REQUIRED)
+    list(APPEND KICKCAT_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/CoE/EsiParser.cc)
+    list(APPEND OS_LIBRARIES tinyxml2::tinyxml2)
+  endif()
+
 endif()
 
 add_library(kickcat ${KICKCAT_SOURCES} ${OS_LIB_SOURCES})
 target_include_directories(kickcat
-  PUBLIC  ${CMAKE_CURRENT_SOURCE_DIR}/include ${OS_INCLUDE_DIR}
+  PUBLIC  ${CMAKE_CURRENT_SOURCE_DIR}/include
   PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include/kickcat)
+
 target_link_libraries(kickcat ${OS_LIBRARIES})
-if (tinyxml2_FOUND)
-  target_link_libraries(kickcat tinyxml2::tinyxml2)
-endif()
+
 set_kickcat_properties(kickcat)
 
 add_subdirectory(master)

lib/include/kickcat/OS/Mutex.h

@@ -1,7 +1,7 @@
 #ifndef KICKCAT_OS_LINUX_MUTEX_H
 #define KICKCAT_OS_LINUX_MUTEX_H
 
-#include "os_types.h"
+#include "kickcat/types.h"
 
 namespace kickcat
 {

lib/include/kickcat/OS/SharedMemory.h

@@ -3,7 +3,7 @@
 
 #include <string>
 
-#include "os_types.h"
+#include "kickcat/types.h"
 
 namespace kickcat
 {

lib/include/kickcat/OS/Linux/types/os_types.h renamed to lib/include/kickcat/OS/Unix/types/os_types.h

@@ -756,8 +756,8 @@ namespace kickcat
     /// extract a position or node address
     constexpr std::tuple<uint16_t, uint16_t> extractAddress(uint32_t address)
     {
-        uint16_t offset   = address >> 16;
-        uint16_t position = address & 0xFFFF;
+        uint16_t offset   = static_cast<uint16_t>(address >> 16);
+        uint16_t position = static_cast<uint16_t>(address & 0xFFFF);
         return std::make_tuple(position, offset);
     }
 

lib/include/kickcat/protocol.h

@@ -0,0 +1,10 @@
+#ifndef KICKCAT_TYPES_H
+#define KICKCAT_TYPES_H
+
+#if defined(__unix__) || defined(__NuttX__)
+#include "OS/Unix/types/os_types.h"
+#elif __PikeOS__
+#include "OS/PikeOS/types/os_types.h"
+#endif
+
+#endif

lib/include/kickcat/types.h

@@ -10,8 +10,10 @@ add_executable(eeprom eeprom.cc)
 target_link_libraries(eeprom kickcat)
 set_kickcat_properties(eeprom)
 
-add_executable(od_generator od_generator.cc)
-target_link_libraries(od_generator kickcat)
+if (ENABLE_ESI_PARSER)
+    add_executable(od_generator od_generator.cc)
+    target_link_libraries(od_generator kickcat)
+endif()
 
 
 if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux")