QAT v. 0.1 (#1230)

Author: troels-im

.gitignore

@@ -306,6 +306,9 @@ paket-files/
 __pycache__/
 *.pyc
 
+# Python Virtual environments
+*__venv/ 
+
 # Cake - Uncomment if you are using it
 # tools/**
 # !tools/packages.config

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "src/Passes/vendors/googletest"]
+	path = src/Passes/vendors/googletest
+	url = https://github.com/google/googletest.git
+	shallow = true

build/ci.yml

@@ -26,15 +26,27 @@ schedules:
     - main
   always: true
 
-pool:
-  vmImage: windows-latest
 
 jobs:
 - job: Build
   steps:
   - template: init.yml
   - template: steps.yml
   - template: wrap-up.yml
+  pool:
+    vmImage: windows-latest
+
+- job: LinuxBuild
+  steps:
+  - template: passes-linux.yml
+  pool:
+    vmImage: ubuntu-20.04
+
+- job: MacOSBuild
+  steps:
+  - template: passes-mac.yml
+  pool:
+    vmImage: macOS-latest
 
 - job: Style
   steps:
@@ -43,3 +55,5 @@ jobs:
 
   - script: dotnet tool run fantomas -- --check --recurse .
     displayName: Fantomas
+  pool:
+    vmImage: windows-latest

build/passes-linux.yml

@@ -0,0 +1,24 @@
+
+steps:
+- script: |
+      export DEBIAN_FRONTEND=noninteractive
+      sudo apt-get update -y
+      sudo apt-get install -y 
+      sudo apt-get remove -y llvm-12
+      sudo apt-get install -y curl pkg-config findutils  wget
+      sudo apt install -y clang-11 cmake clang-format-11 clang-tidy-11 
+      sudo apt-get install -y llvm-11 lldb-11 llvm-11-dev libllvm11 llvm-11-runtime
+      sudo apt install -y python3 python3-pip 
+      sudo apt-get remove -y llvm-10
+      sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 0
+      git submodule update --init --recursive
+      cd src/Passes/
+      pip install -r requirements.txt  
+      chmod +x manage
+      export PYTHONUNBUFFERED=1
+      export PYTHON_BIN_PATH=/usr/bin/python3
+      export CC=clang-11
+      export CXX=clang++-11
+      ./manage runci
+          
+  displayName: Linux build and CI for passes      

build/passes-mac.yml

@@ -0,0 +1,22 @@
+
+steps:
+- script: |
+      rm '/usr/local/bin/2to3'
+      brew install llvm@11
+      brew install cmake
+      brew install [email protected]
+      brew unlink [email protected]
+      brew link [email protected]
+
+      # Updating paths
+      export PATH="/usr/local/opt/python/libexec/bin:$PATH"
+      export PATH="/usr/local/opt/llvm@11/bin:$PATH"
+      export LDFLAGS="${LDFLAGS} -L/usr/local/opt/llvm@11/lib"
+      export CPPFLAGS="${CPPFLAGS} -I/usr/local/opt/llvm@11/include"
+      
+      git submodule update --init --recursive
+      cd src/Passes/
+      pip3 install --user -r requirements.txt      
+      chmod +x manage
+      ./manage --loglevel info runci
+

build/steps.yml

@@ -1,4 +1,5 @@
 steps:
+
 - pwsh: ./build.ps1
   displayName: "Build all"
   workingDirectory: $(System.DefaultWorkingDirectory)/build

build/test.ps1

@@ -38,6 +38,7 @@ function Test-One {
     }
 }
 
+
 Test-One '../QsCompiler.sln'
 Test-One '../QsFmt.sln'
 

src/Passes/.clang-format

@@ -0,0 +1,69 @@
+# https://clang.llvm.org/docs/ClangFormatStyleOptions.html
+
+---
+Language: Cpp
+BasedOnStyle: Microsoft
+
+# page width
+ColumnLimit: 120
+ReflowComments: true
+
+# tabs and indents
+UseTab: Never
+IndentWidth: 4
+TabWidth: 4
+AccessModifierOffset: -2
+NamespaceIndentation: Inner
+
+# line and statements layout
+BreakBeforeBraces: Allman
+BinPackParameters: false
+AlignAfterOpenBracket: AlwaysBreak
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortFunctionsOnASingleLine: Empty
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeComma
+
+# misc
+Cpp11BracedListStyle: true
+FixNamespaceComments: true
+IncludeBlocks: Preserve
+SpaceBeforeInheritanceColon : true
+SpaceBeforeParens: ControlStatements
+DerivePointerAlignment: false
+PointerAlignment: Left
+
+# Suggestions
+Standard: Cpp11
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignTrailingComments: true
+
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 2
+
+IndentCaseLabels: false
+# NamespaceIndentation: None
+
+# Ensures include compleness
+IncludeBlocks: Regroup
+IncludeCategories: 
+  - Regex: '.*\.\..*'
+    Priority: 1
+  - Regex: '^<.*\.h.*>$'
+    Priority: 5
+  - Regex: '^<.*>$'
+    Priority: 6
+  - Regex: '^"(llvm)/.*"$'
+    Priority: 4
+  - Regex: '.*/.*'
+    Priority: 3
+  - Regex: '.*'
+    Priority: 2
+IncludeIsMainRegex: ''
+SortIncludes: true
+SortUsingDeclarations: true
+SpaceInEmptyParentheses: false

src/Passes/.clang-tidy

@@ -0,0 +1,105 @@
+Checks: "-*,bugprone-*,\
+-readability-*,\
+readability-identifier-*,\
+readability-redundant-member-init,\
+readability-braces-around-statements,\
+cert-dcl*,\
+cert-env*,\
+cert-err52-cpp,\
+cert-err60-cpp,\
+cert-flp30-c,\
+clang-analyzer-*,\
+clang-analyzer-security.FloatLoopCounter,\
+google-build-explicit-make-pair,\
+google-build-namespaces,\
+google-explicit-constructor,\
+google-readability-*,\
+google-runtime-operator,\
+hicpp-exception-baseclass,\
+hicpp-explicit-conversions,\
+hicpp-use-*,\
+modernize-avoid-bind,\
+modernize-loop-convert,\
+modernize-make-shared,\
+modernize-make-unique,\
+modernize-redundant-void-arg,\
+modernize-replace-random-shuffle,\
+modernize-shrink-to-fit,\
+modernize-use-bool-literals,\
+modernize-use-default-member-init,\
+modernize-use-emplace,\
+modernize-use-equals-default,\
+modernize-use-equals-delete,\
+modernize-use-noexcept,\
+modernize-use-nullptr,\
+modernize-use-override,\
+modernize-use-transparent-functors,\
+misc-*,\
+-misc-misplaced-widening-cast,\
+-misc-no-recursion,\
+performance-*"
+
+WarningsAsErrors: '*'
+HeaderFilterRegex: '.*'
+
+CheckOptions:
+  # Configuration documentation: https://clang.llvm.org/extra/clang-tidy/checks/readability-identifier-naming.html
+  # Namespaces
+  - key:    readability-identifier-naming.NamespaceCase
+    value:  'lower_case'
+
+  # Classes and structs
+  - key:    readability-identifier-naming.AbstractClassPrefix
+    value:  'I'
+  - key:    readability-identifier-naming.ClassCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.StructCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.UnionCase
+    value:  'CamelCase'
+
+  # Class members
+  - key:    readability-identifier-naming.PrivateMemberCase
+    value:  'lower_case'
+  - key:    readability-identifier-naming.PrivateMemberSuffix
+    value:  '_'    
+  - key:    readability-identifier-naming.ProtectedMemberCase
+    value:  'lower_case'
+  - key:    readability-identifier-naming.ProtectedMemberSuffix
+    value:  '_'        
+
+  # Type Alias and Enum Types / constants
+  - key:    readability-identifier-naming.TypeAliasCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.TypedefCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.EnumCase
+    value:  'CamelCase'
+  - key:    readability-identifier-naming.EnumConstantCase
+    value:  'CamelCase'
+
+  # Globals, consts and enums
+  - key:    readability-identifier-naming.GlobalConstantCase
+    value:  'UPPER_CASE'
+  - key:    readability-identifier-naming.GlobalConstantPrefix
+    value:  'G_'
+  - key:    readability-identifier-naming.ConstantCase
+    value: 'UPPER_CASE'
+
+  # Functions
+  - key:    readability-identifier-naming.FunctionCase
+    value:  'camelBack'
+  - key: readability-identifier-naming.IgnoreMainLikeFunctions
+    value: true
+
+  # Variables and parameters
+  - key:    readability-identifier-naming.VariableCase
+    value:  'lower_case'
+  - key:    readability-identifier-naming.LocalVariableCase
+    value:  'lower_case'
+  - key:    readability-identifier-naming.ParameterCase
+    value:  'lower_case'
+
+  # Macros
+  - key:    readability-identifier-naming.MacroDefinitionCase
+    value:  'UPPER_CASE'

src/Passes/.dockerignore

@@ -0,0 +1,2 @@
+Debug/
+**_env/