scopy2 main: get Scopy2 from the dev branch on main

.clang-format

@@ -0,0 +1,120 @@
+---
+BasedOnStyle: LLVM
+---
+Language: Cpp
+AccessModifierOffset: -8
+AlignAfterOpenBracket: true
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   false
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Mozilla
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: true
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerIndentWidth: 8
+ContinuationIndentWidth: 8
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^"boost'
+    Priority:        6
+  - Regex:           '^<boost'
+    Priority:        6
+  - Regex:           '^"ui_'
+    Priority:        2
+  - Regex:           '^"*"'
+    Priority:        1
+  - Regex:           '^<iio.h'
+    Priority:        3
+  - Regex:           '^<gnuradio'
+    Priority:        4   
+  - Regex:           '^<Q'
+    Priority:        5
+  - Regex:           '^<*'
+    Priority:        6
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth:     8
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 8
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    false
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Always
+...

.cmake-format

@@ -0,0 +1,12 @@
+bullet_char: '*'
+dangle_parens: True
+enum_char: .
+line_ending: unix
+line_width: 120
+max_pargs_hwrap: 4
+max_subgroups_hwrap: 3
+separate_ctrl_name_with_space: false
+separate_fn_name_with_space: false
+tab_size: 8
+use_tabchars: True
+first_comment_is_literal: true

.github/contributing/coding-guidelines.md

@@ -0,0 +1,27 @@
+# Scopy C++ coding guidelines
+
+- Member variables should be prefixed with `m_`
+- Getters and setters should be like in the following example:
+```c++
+bool m_enable;
+bool enabled() const { return m_enable; }
+void setEnabled(bool en) { m_enable = en; }
+```
+- `Variables` are `camelCase` (start with lowercase, and each word after that is uppercase)
+- `Class names` always start with an `uppercase` letter.
+- File names should be in full lowercase (header and source files)
+- The class name should match the file name (case-insensitive)
+- Always use explicit Qt macros (e.g. use `Q_SLOTS`, do not use slots)
+- When naming classes, refrain from using Manager/Controller too much - https://stackoverflow.com/questions/1866794/naming-classes-how-to-avoid-calling-everything-a-whatevermanager and https://gist.github.com/hurricane-voronin/9ceccace0fd530bbf17c83b059c86eb7
+- When implementing design patterns keep naming consistent so everyone is on the same page
+  - Strategy pattern example - https://github.com/analogdevicesinc/scopy/tree/dev/plugins/regmap/src/readwrite
+  - Singleton pattern example - https://github.com/analogdevicesinc/scopy/blob/dev/pluginbase/include/pluginbase/preferences.h
+  - Factory pattern example - https://github.com/analogdevicesinc/scopy/blob/dev/core/include/core/devicefactory.h
+    - Are factories singleton?
+    - Or are they static classes?
+    - Do they have QObject parents?
+  - Resources for design patterns:
+    - https://refactoring.guru/
+    - https://www.youtube.com/watch?v=v9ejT8FO-7I&list=PLrhzvIcii6GNjpARdnO4ueTUAVR9eMBpc
+    - Design Patterns: Elements of Reusable Object-Oriented Software Design patterns – Gang of Four
+- Be aware of code smells - https://refactoring.guru/refactoring/smells , while not errors in the common sense, these "signs" suggest a deeper problem in design/architecture.

.github/contributing/project-structure.md

@@ -0,0 +1,108 @@
+# Git Process
+
+### Some resources
+
+- https://opensource.com/article/18/6/anatomy-perfect-pull-request
+
+#### When working on a new feature:
+- Move to the starting point
+- Resynchronize tree with remote
+- Create new branch from starting branch
+
+#### Example:
+
+```bash
+git checkout dev
+git pull
+git checkout -b <new_branch_name>
+```
+
+> [!NOTE]
+> Prefixing branch name:
+> - dev_ for branches starting from dev
+> - ci_ for ci work
+> - exp_ for experimental work – will never be merged back
+> - v<x.xx.xx> - for releases and release candidates
+>
+> Example:
+> ```bash
+> git checkout -b dev_cursor_refactor origin/dev
+> ```
+
+- Implement feature – commit and push work as needed – refer to commit message structure
+- Apply code styling - (usually done by running `./tools/format.sh`)
+- Run license header completion - (usually done by running `./tools/license.sh`)
+- Resynchronize with latest changes to starting point and push again. Example
+```bash
+git fetch
+git rebase origin/dev
+git push
+```
+- Create pull request
+- Make sure CI tests pass. Assign reviewers.
+- Discuss review, and implement changes as needed. Try to refrain from force pushing at this point as it makes everyones job a little harder. When finished, all the commits can be squashed/reorganized as needed
+- Make sure PR is synchronized with starting point. Test feature before merge.
+- Close PR - use only `Rebase and merge` or `Squash and merge`. Do not use Create merge commit
+
+# Git commit message structure
+
+Some resources:
+- https://cbea.ms/git-commit/
+- https://github.blog/2022-06-30-write-better-commits-build-better-projects/
+- https://dhwthompson.com/2019/my-favourite-git-commit
+
+A commit message should have the following structure:
+
+```text
+prefix/subprefix: short description (max 80 char)
+
+longer description that explains why the change is needed as well as some
+subtleties of the change. Can refer to other commit SHA as well as github
+issues
+
+Signed-off by: author.name <[email protected]>
+```
+
+Refer to project specific documentation for module names and description
+
+Some possible prefixes:
+
+| Module name | Description                                                                                               |
+|-------------|-----------------------------------------------------------------------------------------------------------|
+| project     | A change in project structure – nonfunctional changes                                                     |
+| tree        | Change that applies to many files in the project – such as styling, addressing a warning, etc             |
+| cmake       | Changes related to general project cmake or cmake modules. (assuming cmake is the project config tool)    |
+| ci          | CI and deployment                                                                                         |
+| doc         | Add documentation or documentation infrastructure                                                         |
+| tests       | Add tests or testing infrastructure                                                                       |
+| toolsTools  | related to the project                                                                                    |
+| general     | A change that affects multiple parts of Scopy – should not be used unless other module names do not apply |
+| \<module>   | Project specific module                                                                                   |
+
+
+# Default Branches
+
+| Branch name        | Description                                                                                                        |
+|--------------------|--------------------------------------------------------------------------------------------------------------------|
+| dev                | Contains next major features of the project – contains multiple features bundled together. Will be merged to main. |
+| main               | main branch – used to integrate changes and create releases. Locked – history cannot be overwritten                |
+| maint-1.5          | maintenance branch for the projectv1.5 – bug fixes for scopy 1.5 are created here. Used to create v1.5.x releases  |
+| v<x.xx.xx>[-rc<x>] | Version branch of the project. Versioned releases and release candidates. Locked.                                  |
+
+# Review process
+After creating a pull request, the developer should ask reviewers to review their code. Ideally the pull request
+should contain only one feature/bug which can be easily understood by the reviewer.
+
+When reviewing keep a few things in mind
+
+- Does the pull request pass automated tests/ styling checks/ etc. ?
+- Is the intent clear ?
+- Is the solution directly addressing the problem ?
+- Is the solution clear ?
+- Is the code implementing the solution clear ? Can it be simplified ?
+- Does the code introduce any maintenance effort ?
+- Are there any side effects to the solution ?
+- Can the solution be tested ?
+- Can the solution be automatically tested ? Is the automatic test implemented ?
+- Are code commits structured nicely ? Commits shouldn't be too big, each commit should address a single change in the code. There should be no "
+

.github/workflows/android-build

@@ -0,0 +1,46 @@
+name: android-apk build
+
+on: [push, pull_request]
+
+env:
+  BUILD_HOST: ubuntu-latest
+  USERNAME: github-actions
+
+jobs:
+
+  make-apk:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Pull the Docker Image
+      run: docker pull analogdevices/scopy-build:1.4.1-android
+    - name: Run Docker Image
+      run: |
+            $GITHUB_WORKSPACE/CI/appveyor/gen_ci_envs.sh > $GITHUB_WORKSPACE/CI/appveyor/gh-actions.envs
+            docker run --privileged --net=host \
+                -v `pwd`:$GITHUB_WORKSPACE:rw \
+                -e "BRANCH=${GITHUB_REF#refs/heads/}" \
+                --env-file $GITHUB_WORKSPACE/CI/appveyor/gh-actions.envs \
+                analogdevices/scopy-build:1.4.1-android /bin/bash -xe $GITHUB_WORKSPACE/CI/appveyor/build_scopy_apk.sh
+    - uses: actions/upload-artifact@v2
+      with:
+        name: scopy-android
+        path: |
+         ${{ github.workspace }}/*.apk
+         ${{ github.workspace }}/*.aab
+         ${{ github.workspace }}/scopy*android-native-symbols.zip
+
+
+    - name: Upload master apk and aab builds to continous prerelease
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+      run: |
+        ARTIFACTS_ARCHIVE=scopy-${GITHUB_SHA::7}-android.zip
+        zip ${ARTIFACTS_ARCHIVE} *.apk *.aab
+
+        wget https://github.com/tcnksm/ghr/releases/download/v0.13.0/ghr_v0.13.0_linux_amd64.tar.gz
+        tar xvf ghr_v0.13.0_linux_amd64.tar.gz
+
+        ghr_v0.13.0_linux_amd64/ghr -u ${{ github.repository_owner }} -r scopy -name "Continuous build" -b "Latest succesful master build " -prerelease -debug -replace continous ${ARTIFACTS_ARCHIVE}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}