Merge pull request #2 from forssea-robotics/feature/ROB-378-sonar-rov…

…-integration

Feature/rob 378 sonar rov integration

.clang-format

@@ -0,0 +1,35 @@
+---
+BasedOnStyle:  Google
+
+AccessModifierOffset: -2
+AlignAfterOpenBracket: DontAlign
+AlignOperands: AlignAfterOperator
+AlignTrailingComments: false
+# AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: Never
+BinPackParameters: false
+ColumnLimit: 130
+ConstructorInitializerIndentWidth: 2
+DerivePointerAlignment: false
+IncludeCategories:
+  - Regex: '<[^\/]+\.h>'
+    Priority: 1
+  - Regex: '<.*\.h>'
+    Priority: 2
+  - Regex: '<[^\/\.]+\/[^\.]+>'
+    Priority: 3
+  - Regex: '<[^\/\.]+>'
+    Priority: 4
+  - Regex: '<.*\.hpp>'
+    Priority: 5
+  - Regex: '"[^\/]+\.h"'
+    Priority: 6
+  - Regex: '".*\.h"'
+    Priority: 7
+  - Regex: '".*\.hpp"'
+    Priority: 8
+SeparateDefinitionBlocks: Always
+Standard: c++17
+TabWidth: 2
+...

.clang-tidy

@@ -0,0 +1,179 @@
+Checks: >
+  -*,
+  bugprone-argument-comment,
+  bugprone-assert-side-effect,
+  bugprone-bad-signal-to-kill-thread,
+  bugprone-branch-clone,
+  bugprone-copy-constructor-init,
+  bugprone-dangling-handle,
+  bugprone-dynamic-static-initializers,
+  bugprone-fold-init-type,
+  bugprone-forward-declaration-namespace,
+  bugprone-forwarding-reference-overload,
+  bugprone-inaccurate-erase,
+  bugprone-incorrect-roundings,
+  bugprone-integer-division,
+  bugprone-lambda-function-name,
+  bugprone-macro-parentheses,
+  bugprone-macro-repeated-side-effects,
+  bugprone-misplaced-operator-in-strlen-in-alloc,
+  bugprone-misplaced-pointer-arithmetic-in-alloc,
+  bugprone-misplaced-widening-cast,
+  bugprone-move-forwarding-reference,
+  bugprone-multiple-statement-macro,
+  bugprone-narrowing-conversions,
+  bugprone-no-escape,
+  bugprone-not-null-terminated-result,
+  bugprone-parent-virtual-call,
+  bugprone-posix-return,
+  bugprone-reserved-identifier,
+  bugprone-sizeof-container,
+  bugprone-sizeof-expression,
+  bugprone-string-constructor,
+  bugprone-string-integer-assignment,
+  bugprone-string-literal-with-embedded-nul,
+  bugprone-suspicious-enum-usage,
+  bugprone-suspicious-include,
+  bugprone-suspicious-memory-comparison,
+  bugprone-suspicious-memset-usage,
+  bugprone-suspicious-missing-comma,
+  bugprone-suspicious-semicolon,
+  bugprone-suspicious-string-compare,
+  bugprone-swapped-arguments,
+  bugprone-terminating-continue,
+  bugprone-throw-keyword-missing,
+  bugprone-too-small-loop-variable,
+  bugprone-undefined-memory-manipulation,
+  bugprone-undelegated-constructor,
+  bugprone-unhandled-self-assignment,
+  bugprone-unused-raii,
+  bugprone-unused-return-value,
+  bugprone-use-after-move,
+  bugprone-virtual-near-miss,
+  boost-use-to-string,
+  cert-dcl03-c,
+  cert-dcl21-cpp,
+  cert-dcl58-cpp,
+  cert-err34-c,
+  cert-err52-cpp,
+  cert-err58-cpp,
+  cert-err60-cpp,
+  cert-flp30-c,
+  cert-msc50-cpp,
+  cert-msc51-cpp,
+  cert-oop54-cpp,
+  cert-str34-c,
+  cppcoreguidelines-interfaces-global-init,
+  cppcoreguidelines-narrowing-conversions,
+  cppcoreguidelines-pro-type-member-init,
+  cppcoreguidelines-pro-type-static-cast-downcast,
+  cppcoreguidelines-slicing,
+  google-default-arguments,
+  google-explicit-constructor,
+  google-runtime-operator,
+  hicpp-exception-baseclass,
+  hicpp-multiway-paths-covered,
+  hicpp-signed-bitwise,
+  misc-misplaced-const,
+  misc-new-delete-overloads,
+  misc-no-recursion,
+  misc-non-copyable-objects,
+  misc-redundant-expression,
+  misc-static-assert,
+  misc-throw-by-value-catch-by-reference,
+  misc-unconventional-assign-operator,
+  misc-uniqueptr-reset-release,
+  modernize-avoid-bind,
+  modernize-concat-nested-namespaces,
+  modernize-deprecated-headers,
+  modernize-deprecated-ios-base-aliases,
+  modernize-loop-convert,
+  modernize-make-shared,
+  modernize-make-unique,
+  modernize-pass-by-value,
+  modernize-raw-string-literal,
+  modernize-redundant-void-arg,
+  modernize-replace-auto-ptr,
+  modernize-replace-disallow-copy-and-assign-macro,
+  modernize-replace-random-shuffle,
+  modernize-return-braced-init-list,
+  modernize-shrink-to-fit,
+  modernize-unary-static-assert,
+  modernize-use-auto,
+  modernize-use-bool-literals,
+  modernize-use-emplace,
+  modernize-use-equals-default,
+  modernize-use-equals-delete,
+  modernize-use-nodiscard,
+  modernize-use-noexcept,
+  modernize-use-nullptr,
+  modernize-use-override,
+  modernize-use-transparent-functors,
+  modernize-use-uncaught-exceptions,
+  mpi-buffer-deref,
+  mpi-type-mismatch,
+  openmp-use-default-none,
+  performance-faster-string-find,
+  performance-for-range-copy,
+  performance-implicit-conversion-in-loop,
+  performance-inefficient-algorithm,
+  performance-inefficient-string-concatenation,
+  performance-inefficient-vector-operation,
+  performance-move-const-arg,
+  performance-move-constructor-init,
+  performance-no-automatic-move,
+  performance-noexcept-move-constructor,
+  performance-trivially-destructible,
+  performance-type-promotion-in-math-fn,
+  performance-unnecessary-copy-initialization,
+  performance-unnecessary-value-param,
+  portability-simd-intrinsics,
+  readability-avoid-const-params-in-decls,
+  readability-const-return-type,
+  readability-container-size-empty,
+  readability-convert-member-functions-to-static,
+  readability-delete-null-pointer,
+  readability-deleted-default,
+  readability-identifier-naming,
+  readability-inconsistent-declaration-parameter-name,
+  readability-magic-numbers,
+  readability-make-member-function-const,
+  readability-misleading-indentation,
+  readability-misplaced-array-index,
+  readability-non-const-parameter,
+  readability-redundant-control-flow,
+  readability-redundant-declaration,
+  readability-redundant-function-ptr-dereference,
+  readability-redundant-smartptr-get,
+  readability-redundant-string-cstr,
+  readability-redundant-string-init,
+  readability-simplify-subscript-expr,
+  readability-static-accessed-through-instance,
+  readability-static-definition-in-anonymous-namespace,
+  readability-string-compare,
+  readability-uniqueptr-delete-release,
+  readability-use-anyofallof
+
+WarningsAsErrors: >
+  readability-magic-numbers,
+  readability-identifier-naming
+
+CheckOptions:
+  - { key: readability-identifier-naming.NamespaceCase,                   value: aNy_CasE }
+  - { key: readability-identifier-naming.ClassCase,                       value: CamelCase  }
+  - { key: readability-identifier-naming.StructCase,                      value: CamelCase  }
+  - { key: readability-identifier-naming.EnumCase,                        value: CamelCase  }
+  - { key: readability-identifier-naming.TemplateParameterCase,           value: CamelCase  }
+  - { key: readability-identifier-naming.UnionCase,                       value: CamelCase  }
+  - { key: readability-identifier-naming.FunctionCase,                    value: camelBack  }
+  - { key: readability-identifier-naming.MethodCase,                      value: camelBack  }
+  - { key: readability-identifier-naming.VariableCase,                    value: lower_case }
+  - { key: readability-identifier-naming.ClassMemberCase,                 value: lower_case }
+  - { key: readability-identifier-naming.PrivateMemberSuffix,             value: _          }
+  - { key: readability-identifier-naming.ProtectedMemberSuffix,           value: _          }
+  - { key: readability-identifier-naming.EnumConstantCase,                value: UPPER_CASE }
+  - { key: readability-identifier-naming.ConstexprVariableCase,           value: UPPER_CASE }
+  - { key: readability-identifier-naming.GlobalConstantCase,              value: UPPER_CASE }
+  - { key: readability-identifier-naming.MemberConstantCase,              value: UPPER_CASE }
+  - { key: readability-identifier-naming.StaticConstantCase,              value: UPPER_CASE }
+  - { key: readability-magic-numbers.IgnoredIntegerValues,                value: '1;2;3;4;5;6' }

.codespell_words

@@ -0,0 +1,18 @@
+forssea
+frs
+FRS
+oculus
+ros
+ros2
+rosgraph
+rostopic
+rosservice
+rosnode
+rosaction
+ros2action
+ros2bag
+rosbag
+ros2node
+ros2topic
+sim
+hmi

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "oculus_driver/oculus_driver"]
+	path = oculus_driver/oculus_driver
+	url = https://github.com/forssea-robotics/oculus_driver.git
+	branch = feature/ROB-378/oculus_sonar # TODO(abourgois, branch to handle)

.pre-commit-config.yaml

@@ -0,0 +1,80 @@
+repos:
+  # Standard hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-json
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: check-ast
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: destroyed-symlinks
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        entry: mixed-line-ending --fix=lf
+      - id: pretty-format-json
+        entry: pretty-format-json --autofix --indent 2
+      - id: trailing-whitespace
+      - id: fix-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+
+  - repo: local
+    hooks:
+      - id: clang-format
+        name: clang-format
+        description: Format files with ClangFormat.
+        entry: clang-format -fallback-style=none -i
+        language: system
+        files: \.(c|cc|cxx|cpp|frag|glsl|h|hpp|hxx|ih|ispc|ipp|java|js|m|proto|vert)$
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.0.0
+    hooks:
+      - id: codespell
+        args: ['--write-changes', '--ignore-words=.codespell_words']
+        exclude: CHANGELOG.rst
+
+  - repo: local
+    hooks:
+      - id: ament_cppcheck
+        name: ament_cppcheck
+        description: Static code analysis of C/C++ files.
+        stages: [commit]
+        entry: /usr/bin/bash -c 'source /opt/ros/humble/setup.bash && env AMENT_CPPCHECK_ALLOW_SLOW_VERSIONS=1 ament_cppcheck'
+        language: system
+        files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
+
+  # Maybe use https://github.com/cpplint/cpplint instead
+  - repo: local
+    hooks:
+      - id: ament_cpplint
+        name: ament_cpplint
+        description: Static code analysis of C/C++ files.
+        stages: [commit]
+        entry: /usr/bin/bash -c 'source /opt/ros/humble/setup.bash && ament_cpplint --linelength=140 --filter=-whitespace/newline'
+        language: system
+        files: \.(h\+\+|h|hh|hxx|hpp|cuh|c|cc|cpp|cu|c\+\+|cxx|tpp|txx)$
+
+  # Cmake hooks
+  - repo: local
+    hooks:
+      - id: ament_lint_cmake
+        name: ament_lint_cmake
+        description: Check format of CMakeLists.txt files.
+        stages: [commit]
+        entry: /usr/bin/bash -c 'source /opt/ros/humble/setup.bash && ament_lint_cmake'
+        language: system
+        files: CMakeLists\.txt$

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+Any contribution that you make to this repository
+will be under the BSD 3-Clause License Copyright
+(c) 2022, ENSTA-Bretagne.