Merge pull request #1239 from jbj/qlformat-1

C++: Autoformat QL code in Architecture and Best Practices

Author: geoffw0

cpp/ql/src/Architecture/FeatureEnvy.ql

@@ -10,11 +10,12 @@
  *       statistical
  *       non-attributable
  */
+
 import cpp
 
 predicate functionUsesVariable(Function source, Variable v, File target) {
   v.getAnAccess().getEnclosingFunction() = source and
-  not (v.(LocalScopeVariable).getFunction() = source) and
+  not v.(LocalScopeVariable).getFunction() = source and
   v.getFile() = target
 }
 
@@ -25,23 +26,23 @@ predicate functionUsesFunction(Function source, Function f, File target) {
 
 predicate dependencyCount(Function source, File target, int res) {
   res = strictcount(Declaration d |
-    functionUsesVariable(source, d, target) or
-    functionUsesFunction(source, d, target)
-  )
+      functionUsesVariable(source, d, target) or
+      functionUsesFunction(source, d, target)
+    )
 }
 
 predicate selfDependencyCountOrZero(Function source, int res) {
-  exists(File target
-       | target = source.getFile() and onlyInFile(source, target)
-       | res = max(int i | dependencyCount(source, target, i) or i = 0))
+  exists(File target | target = source.getFile() and onlyInFile(source, target) |
+    res = max(int i | dependencyCount(source, target, i) or i = 0)
+  )
 }
 
 predicate dependsHighlyOn(Function source, File target, int res) {
   dependencyCount(source, target, res) and
   target.fromSource() and
   exists(int selfCount |
     selfDependencyCountOrZero(source, selfCount) and
-    res > 2*selfCount and
+    res > 2 * selfCount and
     res > 4
   )
 }
@@ -52,14 +53,18 @@ predicate onlyInFile(Function f, File file) {
 }
 
 from Function f, File other, int selfCount, int depCount, string selfDeps
-where dependsHighlyOn(f, other, depCount) and
-      selfDependencyCountOrZero(f, selfCount) and
-      not exists(File yetAnother | dependsHighlyOn(f, yetAnother, _) and yetAnother != other) and
-      not other instanceof HeaderFile and
-      not f instanceof MemberFunction
-      and if      selfCount = 0 then selfDeps = "0 dependencies"
-          else if selfCount = 1 then selfDeps = "only 1 dependency"
-          else                       selfDeps = "only " + selfCount.toString() + " dependencies"
-select f, "Function " + f.getName() + " could be moved to file $@" +
-       " since it has " + depCount.toString() + " dependencies to that file, but " +
-       selfDeps + " to its own file.", other, other.getBaseName()
+where
+  dependsHighlyOn(f, other, depCount) and
+  selfDependencyCountOrZero(f, selfCount) and
+  not exists(File yetAnother | dependsHighlyOn(f, yetAnother, _) and yetAnother != other) and
+  not other instanceof HeaderFile and
+  not f instanceof MemberFunction and
+  if selfCount = 0
+  then selfDeps = "0 dependencies"
+  else
+    if selfCount = 1
+    then selfDeps = "only 1 dependency"
+    else selfDeps = "only " + selfCount.toString() + " dependencies"
+select f,
+  "Function " + f.getName() + " could be moved to file $@" + " since it has " + depCount.toString() +
+    " dependencies to that file, but " + selfDeps + " to its own file.", other, other.getBaseName()

cpp/ql/src/Architecture/General Class-Level Information/ClassHierarchies.ql

@@ -9,6 +9,7 @@
  * @result_ondemand succeed 48
  * @tags maintainability
  */
+
 import cpp
 
 from Class s

cpp/ql/src/Architecture/General Class-Level Information/HubClasses.ql

@@ -7,11 +7,10 @@
  * @treemap.warnOn highValues
  * @tags maintainability
  */
+
 import cpp
 
 from Class c
 where c.fromSource()
-select c as Class,
-       c.getMetrics().getAfferentCoupling() as AfferentCoupling,
-       c.getMetrics().getEfferentSourceCoupling() as EfferentCoupling
-order by AfferentCoupling desc
+select c as Class, c.getMetrics().getAfferentCoupling() as AfferentCoupling,
+  c.getMetrics().getEfferentSourceCoupling() as EfferentCoupling order by AfferentCoupling desc

cpp/ql/src/Architecture/General Class-Level Information/InheritanceDepthDistribution.ql

@@ -9,6 +9,7 @@
  * @result_ondemand succeed 48
  * @tags maintainability
  */
+
 import cpp
 
 /** does source class c have inheritance depth d? */
@@ -18,6 +19,5 @@ predicate hasInheritanceDepth(Class c, int d) {
 
 from int depth
 where hasInheritanceDepth(_, depth)
-select depth as InheritanceDepth,
-       count(Class c | hasInheritanceDepth(c, depth)) as NumberOfClasses
-order by InheritanceDepth
+select depth as InheritanceDepth, count(Class c | hasInheritanceDepth(c, depth)) as NumberOfClasses
+  order by InheritanceDepth

cpp/ql/src/Architecture/General Namespace-Level Information/CyclicNamespaces.ql

@@ -7,6 +7,7 @@
  * @tags maintainability
  *       modularity
  */
+
 import cpp
 
 from MetricNamespace a, MetricNamespace b

cpp/ql/src/Architecture/General Namespace-Level Information/GlobalNamespaceClasses.ql

@@ -6,10 +6,12 @@
  * @tags maintainability
  *       modularity
  */
+
 import cpp
 
 from Class c
-where c.fromSource()
-  and c.isTopLevel()
-  and c.getParentScope() instanceof GlobalNamespace
+where
+  c.fromSource() and
+  c.isTopLevel() and
+  c.getParentScope() instanceof GlobalNamespace
 select c, "This class is not declared in any namespace"

cpp/ql/src/Architecture/General Namespace-Level Information/NamespaceDependencies.ql

@@ -7,6 +7,7 @@
  * @tags maintainability
  *       modularity
  */
+
 import cpp
 
 from MetricNamespace a, MetricNamespace b

cpp/ql/src/Architecture/General Top-Level Information/GeneralStatistics.ql

@@ -5,31 +5,48 @@
  * @id cpp/architecture/general-statistics
  * @tags maintainability
  */
+
 import cpp
 
 from string l, string n
-where (l = "Number of Namespaces" and
-         n = count(Namespace p | p.fromSource()).toString())
-   or (l = "Number of Files" and
-         n = count(File f | f.fromSource()).toString())
-   or (l = "Number of Header Files" and
-         n = count(HeaderFile f | f.fromSource()).toString())
-   or (l = "Number of C Files" and
-         n = count(CFile f | f.fromSource()).toString())
-   or (l = "Number of C++ Files" and
-         n = count(CppFile f | f.fromSource()).toString())
-   or (l = "Number of Classes" and
-         n = count(Class c | c.fromSource() and not c instanceof Struct).toString())
-   or (l = "Number of Structs" and
-         n = count(Struct s | s.fromSource()and not s instanceof Union).toString())
-   or (l = "Number of Unions" and
-         n = count(Union u | u.fromSource()).toString())
-   or (l = "Number of Functions" and
-         n = count(Function f | f.fromSource()).toString())
-   or (l = "Number of Lines Of Code" and
-         n = sum(File f, int toSum | (f.fromSource()) and (toSum = f.getMetrics().getNumberOfLinesOfCode()) | toSum).toString())
-   or (l = "Self-Containedness" and
-         n = (100 * sum(Class c, int toSum | (c.fromSource()) and (toSum = c.getMetrics().getEfferentSourceCoupling()) | toSum)
-                  / sum(Class c, int toSum | (c.fromSource()) and (toSum = c.getMetrics().getEfferentCoupling()) | toSum)).toString()
-           + "%")
+where
+  l = "Number of Namespaces" and
+  n = count(Namespace p | p.fromSource()).toString()
+  or
+  l = "Number of Files" and
+  n = count(File f | f.fromSource()).toString()
+  or
+  l = "Number of Header Files" and
+  n = count(HeaderFile f | f.fromSource()).toString()
+  or
+  l = "Number of C Files" and
+  n = count(CFile f | f.fromSource()).toString()
+  or
+  l = "Number of C++ Files" and
+  n = count(CppFile f | f.fromSource()).toString()
+  or
+  l = "Number of Classes" and
+  n = count(Class c | c.fromSource() and not c instanceof Struct).toString()
+  or
+  l = "Number of Structs" and
+  n = count(Struct s | s.fromSource() and not s instanceof Union).toString()
+  or
+  l = "Number of Unions" and
+  n = count(Union u | u.fromSource()).toString()
+  or
+  l = "Number of Functions" and
+  n = count(Function f | f.fromSource()).toString()
+  or
+  l = "Number of Lines Of Code" and
+  n = sum(File f, int toSum |
+      f.fromSource() and toSum = f.getMetrics().getNumberOfLinesOfCode()
+    |
+      toSum
+    ).toString()
+  or
+  l = "Self-Containedness" and
+  n = (
+        100 * sum(Class c | c.fromSource() | c.getMetrics().getEfferentSourceCoupling()) /
+          sum(Class c | c.fromSource() | c.getMetrics().getEfferentCoupling())
+      ).toString() + "%"
 select l as Title, n as Value

cpp/ql/src/Architecture/InappropriateIntimacy.ql

@@ -10,6 +10,7 @@
  *       statistical
  *       non-attributable
  */
+
 import cpp
 
 predicate remoteVarAccess(File source, File target, VariableAccess va) {
@@ -48,16 +49,19 @@ predicate highDependencyCount(File source, File target, int res) {
     variableDependencyCount(source, target, varCount) and
     functionDependencyCount(source, target, funCount) and
     res = varCount + funCount and
-    res > 20)
+    res > 20
+  )
 }
 
 from File a, File b, int ca, int cb
-where highDependencyCount(a, b, ca) and
-      highDependencyCount(b, a, cb) and
-      ca >= cb and
-      a != b and
-      not a instanceof HeaderFile and
-      not b instanceof HeaderFile and
-      b.getShortName().trim().length() > 0
-select a, "File is too closely tied to $@ (" + ca.toString() + " dependencies one way and " + cb.toString() + " the other).",
-       b, b.getBaseName()
+where
+  highDependencyCount(a, b, ca) and
+  highDependencyCount(b, a, cb) and
+  ca >= cb and
+  a != b and
+  not a instanceof HeaderFile and
+  not b instanceof HeaderFile and
+  b.getShortName().trim().length() > 0
+select a,
+  "File is too closely tied to $@ (" + ca.toString() + " dependencies one way and " + cb.toString() +
+    " the other).", b, b.getBaseName()

cpp/ql/src/Architecture/Refactoring Opportunities/ClassesWithManyDependencies.ql

@@ -11,10 +11,12 @@
  *       statistical
  *       non-attributable
  */
+
 import cpp
 
 from Class t, int n
-where t.fromSource() and
-      n = t.getMetrics().getEfferentSourceCoupling() and
-      n > 10
+where
+  t.fromSource() and
+  n = t.getMetrics().getEfferentSourceCoupling() and
+  n > 10
 select t as Class, "This class has too many dependencies (" + n.toString() + ")"