fix matlab regexp parser issue (#135)

* fix matlab regexp parser issue Signed-off-by: Andrey Parfenov <[email protected]>
brainflow-dev · Mar 27, 2020 · 4e246c1 · 4e246c1
1 parent 6bc107e
commit 4e246c1
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 32 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -239,6 +239,7 @@ add_library (
 target_include_directories (
     ${BRAINFLOW_CPP_BINDING_NAME} PRIVATE
     ${CMAKE_HOME_DIRECTORY}/src/board_controller/inc
+    ${CMAKE_HOME_DIRECTORY}/src/utils/inc
     ${CMAKE_HOME_DIRECTORY}/src/data_handler/inc
     ${CMAKE_HOME_DIRECTORY}/cpp-package/src/inc
     ${CMAKE_HOME_DIRECTORY}/third_party/json
@@ -261,6 +262,7 @@ if (MSVC)
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/board_controller.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/board_controller.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/board_info_getter.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/board_info_getter.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_constants.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/brainflow_constants.h"
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/utils/inc/shared_export_matlab.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/shared_export.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/third_party/neurosdk/lib/${NEUROSDK_LIB_NAME}.dll" "${CMAKE_HOME_DIRECTORY}/csharp-package/brainflow/brainflow/lib/${NEUROSDK_LIB_NAME}.dll"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/third_party/neurosdk/lib/${NEUROSDK_LIB_NAME}.dll" "${CMAKE_HOME_DIRECTORY}/python-package/brainflow/lib/${NEUROSDK_LIB_NAME}.dll"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/third_party/neurosdk/lib/${NEUROSDK_LIB_NAME}.dll" "${CMAKE_HOME_DIRECTORY}/java-package/brainflow/src/main/resources/${NEUROSDK_LIB_NAME}.dll"
@@ -274,6 +276,7 @@ if (MSVC)
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/compiled/$<CONFIG>/${DATA_HANDLER_COMPILED_NAME}" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/lib/${DATA_HANDLER_COMPILED_NAME}"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_constants.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/brainflow_constants.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/data_handler/inc/data_handler.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/data_handler.h"
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/utils/inc/shared_export_matlab.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/shared_export.h"
     )
 endif (MSVC)
 if (UNIX)
@@ -284,6 +287,7 @@ if (UNIX)
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/compiled/${BOARD_CONTROLLER_COMPILED_NAME}" "${CMAKE_HOME_DIRECTORY}/csharp-package/brainflow/brainflow/${BOARD_CONTROLLER_COMPILED_NAME}"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/board_controller.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/board_controller.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/board_info_getter.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/board_info_getter.h"
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/utils/inc/shared_export_matlab.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/shared_export.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_constants.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/brainflow_constants.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/compiled/${BOARD_CONTROLLER_COMPILED_NAME}" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/lib/${BOARD_CONTROLLER_COMPILED_NAME}"
     )
@@ -294,6 +298,7 @@ if (UNIX)
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/compiled/${DATA_HANDLER_COMPILED_NAME}" "${CMAKE_HOME_DIRECTORY}/csharp-package/brainflow/brainflow/lib/${DATA_HANDLER_COMPILED_NAME}"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_constants.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/brainflow_constants.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/data_handler/inc/data_handler.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/data_handler.h"
+        COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/src/utils/inc/shared_export_matlab.h" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/inc/shared_export.h"
         COMMAND "${CMAKE_COMMAND}" -E copy_if_different "${CMAKE_HOME_DIRECTORY}/compiled/${DATA_HANDLER_COMPILED_NAME}" "${CMAKE_HOME_DIRECTORY}/matlab-package/brainflow/lib/${DATA_HANDLER_COMPILED_NAME}"
     )
 endif (UNIX)
@@ -343,6 +348,7 @@ install (
     ${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_constants.h
     ${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/board_info_getter.h
     ${CMAKE_HOME_DIRECTORY}/src/board_controller/inc/brainflow_input_params.h
+    ${CMAKE_HOME_DIRECTORY}/src/utils/inc/shared_export.h
     ${CMAKE_HOME_DIRECTORY}/src/data_handler/inc/data_handler.h
     ${CMAKE_HOME_DIRECTORY}/cpp-package/src/inc/data_filter.h
     ${CMAKE_HOME_DIRECTORY}/cpp-package/src/inc/board_shim.h

diff --git a/docs/BuildBrainFlow.rst b/docs/BuildBrainFlow.rst
@@ -62,10 +62,14 @@ You are able to download jar files directly from `release page <https://github.c
 Matlab
 --------
 
-To use Matlab binding you HAVE to build core module first.
-After compilation of core module you will be able to open brainflow/matlab-package/brainflow folder in Matlab IDE, add examples folder to Matlab's path and run them.
+Steps to setup Matlab binding for BrainFlow:
 
-Compilation of Core module and C++ binding
+- Compile Core Module, using instructions below
+- Open Matlab IDE and open brainflow/matlab-package/brainflow folder there
+- Add folders lib and inc to Matlab path
+- If you want to run Matlab scripts from folders different than brainflow/matlab-package/brainflow you need to add it to your Matlab path too
+
+Compilation of Core Module and C++ Binding
 -------------------------------------------
 
 Windows

diff --git a/docs/UserAPI.rst b/docs/UserAPI.rst
@@ -118,3 +118,9 @@ Matlab API Reference
 ----------------------
 
 Matlab binding calls C\C++ code as any other binding, it's not compatible with Octave. Use our code samples as a reference for Matlab API.
+
+A few general rules to keep in mind:
+
+- Use char arrays instead strings to work with BrainFlow API, it means 'my_string' instead "my_string", otherwise you will get calllib error
+- Use int32 values intead enums, it means int32 (BoardIDs.SYNTHETIC_BOARD) instead BoardIDs.SYNTHETIC_BOARD, the same is true for all enums in BrainFlow API
+
diff --git a/matlab-package/brainflow/BoardShim.m b/matlab-package/brainflow/BoardShim.m
@@ -10,17 +10,17 @@
         function lib_name = load_lib ()
             if ispc
                 if not (libisloaded ('BoardController'))
-                    loadlibrary ('./lib/BoardController.dll', './inc/board_controller.h', 'includepath', './inc', 'addheader', 'board_info_getter');
+                    loadlibrary ('BoardController.dll', 'board_controller.h', 'addheader', 'board_info_getter');
                 end
                 lib_name = 'BoardController';
             elseif ismac
                 if not (libisloaded ('libBoardController'))
-                    loadlibrary ('./lib/libBoardController.dylib', './inc/board_controller.h', 'includepath', './inc', 'addheader', 'board_info_getter');
+                    loadlibrary ('libBoardController.dylib', 'board_controller.h', 'addheader', 'board_info_getter');
                 end
                 lib_name = 'libBoardController';
             elseif isunix
                 if not (libisloaded ('libBoardController'))
-                    loadlibrary ('./liblibBoardController.so', './inc/board_controller.h', 'includepath', './inc', 'addheader', 'board_info_getter');
+                    loadlibrary ('libBoardController.so', 'board_controller.h', 'addheader', 'board_info_getter');
                 end
                 lib_name = 'libBoardController';
             else

diff --git a/matlab-package/brainflow/DataFilter.m b/matlab-package/brainflow/DataFilter.m
@@ -5,17 +5,17 @@
         function lib_name = load_lib ()
             if ispc
                 if not (libisloaded ('DataHandler'))
-                    loadlibrary ('./lib/DataHandler.dll', './inc/data_handler.h', 'includepath', './inc');
+                    loadlibrary ('DataHandler.dll', 'data_handler.h');
                 end
                 lib_name = 'DataHandler';
             elseif ismac
                 if not (libisloaded ('libDataHandler'))
-                    loadlibrary ('./lib/libDataHandler.dylib', './inc/data_handler.h', 'includepath', './inc');
+                    loadlibrary ('libDataHandler.dylib', 'data_handler.h');
                 end
                 lib_name = 'libDataHandler';
             elseif isunix
                 if not (libisloaded ('libDataHandler'))
-                    loadlibrary ('./lib/libDataHandler.so', './inc/data_handler.h', 'includepath', './inc');
+                    loadlibrary ('libDataHandler.so', 'data_handler.h');
                 end
                 lib_name = 'libDataHandler';
             else

diff --git a/src/board_controller/inc/board_controller.h b/src/board_controller/inc/board_controller.h
@@ -1,15 +1,8 @@
 #pragma once
 
-#ifdef _WIN32
-#define SHARED_EXPORT __declspec(dllexport)
-#define CALLING_CONVENTION __cdecl
-#else
-#define SHARED_EXPORT __attribute__ ((visibility ("default")))
-#define CALLING_CONVENTION
-#endif
-
 #include "board_info_getter.h"
 #include "brainflow_constants.h"
+#include "shared_export.h"
 
 
 #ifdef __cplusplus

diff --git a/src/board_controller/inc/board_info_getter.h b/src/board_controller/inc/board_info_getter.h
@@ -1,12 +1,6 @@
 #pragma once
 
-#ifdef _WIN32
-#define SHARED_EXPORT __declspec(dllexport)
-#define CALLING_CONVENTION __cdecl
-#else
-#define SHARED_EXPORT __attribute__ ((visibility ("default")))
-#define CALLING_CONVENTION
-#endif
+#include "shared_export.h"
 
 #ifdef __cplusplus
 extern "C"

diff --git a/src/data_handler/inc/data_handler.h b/src/data_handler/inc/data_handler.h
@@ -1,14 +1,7 @@
 #pragma once
 
-#ifdef _WIN32
-#define SHARED_EXPORT __declspec(dllexport)
-#define CALLING_CONVENTION __cdecl
-#else
-#define SHARED_EXPORT __attribute__ ((visibility ("default")))
-#define CALLING_CONVENTION
-#endif
-
 #include "brainflow_constants.h"
+#include "shared_export.h"
 
 #define MAX_FILTER_ORDER 8 // define it here to show in the docs
 

diff --git a/src/utils/inc/shared_export.h b/src/utils/inc/shared_export.h
@@ -0,0 +1,9 @@
+#pragma once
+
+#ifdef _WIN32
+#define SHARED_EXPORT __declspec(dllexport)
+#define CALLING_CONVENTION __cdecl
+#else
+#define SHARED_EXPORT __attribute__ ((visibility ("default")))
+#define CALLING_CONVENTION
+#endif
diff --git a/src/utils/inc/shared_export_matlab.h b/src/utils/inc/shared_export_matlab.h
@@ -0,0 +1,12 @@
+#pragma once
+
+// matlab uses regexp to parse headers and find function declarations
+// this regexp doesnt work with __attribute__ ((visibility ("default"))), solution - build all code
+// using shared_export.h but copypaste this file to matlab headers parser instead shared_export.h
+#ifdef _WIN32
+#define SHARED_EXPORT __declspec(dllexport)
+#define CALLING_CONVENTION __cdecl
+#else
+#define SHARED_EXPORT
+#define CALLING_CONVENTION
+#endif