Include all EIPScanner files based on library-path

.gitignore

@@ -1,5 +1,7 @@
 /cmake-*
 /build
+build/
+examples/build/
 .idea
 docs/build/
 docs/source/doxyoutput/

CMakeLists.txt

@@ -26,9 +26,23 @@ if (WIN32)
 	endif()
 endif()
 
-add_subdirectory(src)
+# Setup the include structure so that every file is based off of the root of the project
+include_directories(src)
+
+# Actually add the source files for the project
+add_subdirectory(src/${CMAKE_PROJECT_NAME})
+
 if (EXAMPLE_ENABLED)
-    add_subdirectory(examples)
+    set(EXAMPLES_DIR ${CMAKE_CURRENT_SOURCE_DIR}/examples)
+
+    # Create the build directory if it doesn't exist
+    file(MAKE_DIRECTORY ${EXAMPLES_DIR}/build)
+
+    # Run the other CMakeLists.txt file without any dependencies on this file
+    execute_process(COMMAND ${CMAKE_COMMAND} ${EXAMPLES_DIR} WORKING_DIRECTORY ${EXAMPLES_DIR}/build)
+
+    # Execute code during a `cmake --build` command
+    add_custom_target(EXAMPLES_TARGETS ALL COMMAND ${CMAKE_COMMAND} --build ${EXAMPLES_DIR}/build WORKING_DIRECTORY ${EXAMPLES_DIR}/build COMMENT "Building the examples sub-project")
 endif()
 
 if (TEST_ENABLED)
@@ -38,5 +52,4 @@ endif()
 
 configure_file(EIPScanner.pc.in EIPScanner.pc @ONLY)
 
-install(FILES ${CMAKE_BINARY_DIR}/EIPScanner.pc
-        DESTINATION lib/pkgconfig)
+install(FILES ${CMAKE_BINARY_DIR}/EIPScanner.pc DESTINATION lib/pkgconfig)

EIPScanner.pc.in

@@ -7,5 +7,5 @@ Name: @CMAKE_PROJECT_NAME@
 Description: @CMAKE_PROJECT_DESCRIPTION@
 URL: @CMAKE_PROJECT_HOMEPAGE_URL@
 Version: @EIPSCANNER_FULL_VERSION@
-Cflags: -I"${includedir}" -I"${includedir}/@CMAKE_PROJECT_NAME@"
+Cflags: -I"${includedir}"
 Libs: -L"${libdir}" -l@CMAKE_PROJECT_NAME@

examples/CMakeLists.txt

@@ -1,25 +1,29 @@
-include_directories("${PROJECT_SOURCE_DIR}/src")
+cmake_minimum_required(VERSION 3.5)
+
+# Remember to update the LIBRARY_PATH and LD_LIBRARY_PATH environment variables
+#   * export LIBRARY_PATH=/usr/local/include/
+#   * export LD_LIBRARY_PATH=/usr/local/lib/
 
 add_executable(explicit_messaging ExplicitMessagingExample.cpp)
-target_link_libraries(explicit_messaging EIPScanner)
+target_link_libraries(explicit_messaging PUBLIC EIPScanner)
 
 add_executable(file_object_example FileObjectExample.cpp)
-target_link_libraries(file_object_example EIPScanner)
+target_link_libraries(file_object_example PUBLIC EIPScanner)
 
 add_executable(identity_object_example IdentityObjectExample.cpp)
-target_link_libraries(identity_object_example EIPScanner)
+target_link_libraries(identity_object_example PUBLIC EIPScanner)
 
 add_executable(implicit_messaging ImplicitMessagingExample.cpp)
-target_link_libraries(implicit_messaging EIPScanner)
+target_link_libraries(implicit_messaging PUBLIC EIPScanner)
 
 add_executable(parameter_object_example ParameterObjectExample.cpp)
-target_link_libraries(parameter_object_example EIPScanner)
+target_link_libraries(parameter_object_example PUBLIC EIPScanner)
 
 add_executable(discovery_example DiscoveryManagerExample.cpp)
-target_link_libraries(discovery_example EIPScanner)
+target_link_libraries(discovery_example PUBLIC EIPScanner)
 
 add_executable(yaskawa_assembly_object_example vendors/yaskawa/mp3300iec/Yaskawa_AssemblyObjectExample.cpp)
-target_link_libraries(yaskawa_assembly_object_example EIPScanner)
+target_link_libraries(yaskawa_assembly_object_example PUBLIC EIPScanner)
 
 if(WIN32)
   target_link_libraries(explicit_messaging ws2_32)

examples/DiscoveryManagerExample.cpp

@@ -7,8 +7,8 @@
 #define OS_Windows (1)
 #endif
 
-#include <DiscoveryManager.h>
-#include <utils/Logger.h>
+#include <EIPScanner/DiscoveryManager.h>
+#include <EIPScanner/utils/Logger.h>
 
 using eipScanner::DiscoveryManager;
 using eipScanner::utils::Logger;

examples/ExplicitMessagingExample.cpp

@@ -9,12 +9,12 @@
 
 #include <cstdlib>
 #include <sstream>
-#include <cip/connectionManager/NetworkConnectionParams.h>
-#include "SessionInfo.h"
-#include "MessageRouter.h"
-#include "ConnectionManager.h"
-#include "utils/Logger.h"
-#include "utils/Buffer.h"
+#include <EIPScanner/cip/connectionManager/NetworkConnectionParams.h>
+#include <EIPScanner/SessionInfo.h>
+#include <EIPScanner/MessageRouter.h>
+#include <EIPScanner/ConnectionManager.h>
+#include <EIPScanner/utils/Logger.h>
+#include <EIPScanner/utils/Buffer.h>
 
 using namespace eipScanner::cip;
 using eipScanner::SessionInfo;

examples/FileObjectExample.cpp

@@ -8,9 +8,9 @@
 #endif
 
 #include <fstream>
-#include "FileObject.h"
-#include "utils/Logger.h"
-#include "fileObject/FileObjectState.h"
+#include <EIPScanner/FileObject.h>
+#include <EIPScanner/utils/Logger.h>
+#include <EIPScanner/fileObject/FileObjectState.h>
 
 using namespace eipScanner::cip;
 using eipScanner::SessionInfo;

examples/IdentityObjectExample.cpp

@@ -7,8 +7,8 @@
 #define OS_Windows (1)
 #endif
 
-#include "IdentityObject.h"
-#include "utils/Logger.h"
+#include <EIPScanner/IdentityObject.h>
+#include <EIPScanner/utils/Logger.h>
 
 using eipScanner::IdentityObject;
 using eipScanner::SessionInfo;

examples/ImplicitMessagingExample.cpp

@@ -8,11 +8,11 @@
 #endif
 
 #include <sstream>
-#include <cip/connectionManager/NetworkConnectionParams.h>
-#include "SessionInfo.h"
-#include "ConnectionManager.h"
-#include "utils/Logger.h"
-#include "utils/Buffer.h"
+#include <EIPScanner/cip/connectionManager/NetworkConnectionParams.h>
+#include <EIPScanner/SessionInfo.h>
+#include <EIPScanner/ConnectionManager.h>
+#include <EIPScanner/utils/Logger.h>
+#include <EIPScanner/utils/Buffer.h>
 
 using namespace eipScanner::cip;
 using eipScanner::SessionInfo;

examples/ParameterObjectExample.cpp

@@ -7,9 +7,9 @@
 #define OS_Windows (1)
 #endif
 
-#include "ParameterObject.h"
-#include "utils/Logger.h"
-#include "utils/Buffer.h"
+#include <EIPScanner/ParameterObject.h>
+#include <EIPScanner/utils/Logger.h>
+#include <EIPScanner/utils/Buffer.h>
 
 using namespace eipScanner::cip;
 using eipScanner::SessionInfo;

examples/README.md

@@ -0,0 +1,6 @@
+# Examples
+
+These examples use the installed library.
+
+Therefore the paths are `<EIPScanner/...>` rather than `"EIPScanner/..."`
+* * The source files are linked in the `/usr/local/lib` shared object file

examples/vendors/yaskawa/mp3300iec/Yaskawa_AssemblyObjectExample.cpp

@@ -3,25 +3,26 @@
 #define OS_Windows (1)
 #endif
 
-#include "cip/Types.h"
 #include <functional>
 #include <sstream>
 #include <fstream>
-#include <cip/connectionManager/NetworkConnectionParams.h>
-#include "ConnectionManager.h"
-#include <DiscoveryManager.h>
-#include "FileObject.h"
-#include "fileObject/FileObjectState.h"
-#include "IdentityObject.h"
-#include "IOConnection.h"
-#include "ParameterObject.h"
-#include "SessionInfo.h"
-#include "utils/Logger.h"
-#include "utils/Buffer.h"
-
-#include "vendor/yaskawa/mp3300iec/Yaskawa_EPath.h"
-#include "vendor/yaskawa/mp3300iec/Yaskawa_MessageRouter.h"
-#include "vendor/yaskawa/mp3300iec/Yaskawa_MessageRouterRequest.h"
+#include <EIPScanner/cip/connectionManager/NetworkConnectionParams.h>
+#include <EIPScanner/ConnectionManager.h>
+#include <EIPScanner/DiscoveryManager.h>
+
+#include <EIPScanner/cip/Types.h>
+#include <EIPScanner/FileObject.h>
+#include <EIPScanner/fileObject/FileObjectState.h>
+#include <EIPScanner/IdentityObject.h>
+#include <EIPScanner/IOConnection.h>
+#include <EIPScanner/ParameterObject.h>
+#include <EIPScanner/SessionInfo.h>
+#include <EIPScanner/utils/Logger.h>
+#include <EIPScanner/utils/Buffer.h>
+
+#include <EIPScanner/vendor/yaskawa/mp3300iec/Yaskawa_EPath.h>
+#include <EIPScanner/vendor/yaskawa/mp3300iec/Yaskawa_MessageRouter.h>
+#include <EIPScanner/vendor/yaskawa/mp3300iec/Yaskawa_MessageRouterRequest.h>
 
 using namespace eipScanner::cip;
 using eipScanner::ConnectionManager;

src/BaseObject.h → src/EIPScanner/BaseObject.h

@@ -5,7 +5,7 @@
 #ifndef EIPSCANNER_BASEOBJECT_H
 #define EIPSCANNER_BASEOBJECT_H
 
-#include "cip/Types.h"
+#include "EIPScanner/cip/Types.h"
 
 namespace eipScanner {
 	/**

src/EIPScanner/CMakeLists.txt

@@ -0,0 +1,51 @@
+# Add library target for common source files
+set(SOURCE_FILES 
+        BaseObject.cpp
+        ConnectionManager.cpp
+        DiscoveryManager.cpp
+        FileObject.cpp
+        IdentityObject.cpp
+        IOConnection.cpp
+        MessageRouter.cpp
+        ParameterObject.cpp
+        SessionInfo.cpp)
+
+add_library(EIPScanner SHARED ${SOURCE_FILES})
+add_library(EIPScannerS STATIC ${SOURCE_FILES})
+
+
+add_subdirectory(cip)
+add_subdirectory(eip)
+add_subdirectory(fileObject)
+add_subdirectory(sockets)
+add_subdirectory(utils)
+
+
+# if vendor scripts are enabled
+if(ENABLE_VENDOR_SRC)
+        add_subdirectory(vendor/ra)
+        add_subdirectory(vendor/yaskawa)
+endif()
+
+
+if(WIN32)
+	target_link_libraries(EIPScanner ws2_32)
+	target_link_libraries(EIPScannerS ws2_32)
+endif()
+
+
+set_target_properties(
+        EIPScanner
+        PROPERTIES
+        VERSION ${EIPSCANNER_FULL_VERSION}
+        SOVERSION ${EIPSCANNER_MAJOR_VERSION})
+
+install(TARGETS EIPScanner EIPScannerS
+        LIBRARY
+            DESTINATION lib
+        ARCHIVE
+            DESTINATION lib)
+
+install(DIRECTORY ${PROJECT_SOURCE_DIR}/src/
+        DESTINATION include
+        FILES_MATCHING PATTERN "*.h*")

src/ConnectionManager.cpp → src/EIPScanner/ConnectionManager.cpp

@@ -6,16 +6,16 @@
 #include <cstdlib>
 #include <random>
 
-#include "ConnectionManager.h"
-#include "eip/CommonPacket.h"
-#include "cip/connectionManager/ForwardOpenRequest.h"
-#include "cip/connectionManager/ForwardCloseRequest.h"
-#include "cip/connectionManager/LargeForwardOpenRequest.h"
-#include "cip/connectionManager/ForwardOpenResponse.h"
-#include "cip/connectionManager/NetworkConnectionParams.h"
-#include "cip/connectionManager/NetworkConnectionParametersBuilder.h"
-#include "utils/Logger.h"
-#include "utils/Buffer.h"
+#include "EIPScanner/ConnectionManager.h"
+#include "EIPScanner/eip/CommonPacket.h"
+#include "EIPScanner/cip/connectionManager/ForwardOpenRequest.h"
+#include "EIPScanner/cip/connectionManager/ForwardCloseRequest.h"
+#include "EIPScanner/cip/connectionManager/LargeForwardOpenRequest.h"
+#include "EIPScanner/cip/connectionManager/ForwardOpenResponse.h"
+#include "EIPScanner/cip/connectionManager/NetworkConnectionParams.h"
+#include "EIPScanner/cip/connectionManager/NetworkConnectionParametersBuilder.h"
+#include "EIPScanner/utils/Logger.h"
+#include "EIPScanner/utils/Buffer.h"
 
 namespace eipScanner {
 	using namespace cip::connectionManager;