Fix file naming in doxygen headers

souffle-lang · Jul 31, 2020 · 34f421b · 34f421b
1 parent f271c45
commit 34f421b
Show file tree

Hide file tree

Showing 68 changed files with 1,437 additions and 1,050 deletions.
diff --git a/src/AstToRamTranslator.cpp b/src/AstToRamTranslator.cpp
@@ -36,9 +36,11 @@
 #include "ast/AstUtils.h"
 #include "ast/AstVisitor.h"
 #include "ast/TypeSystem.h"
-#include "ast/analysis/AstTypeEnvironmentAnalysis.h"
-#include "ast/analysis/AuxArityAnalysis.h"
-#include "ast/analysis/PrecedenceGraph.h"
+#include "ast/analysis/AstTypeEnvironment.h"
+#include "ast/analysis/AuxArity.h"
+#include "ast/analysis/RelationSchedule.h"
+#include "ast/analysis/SCCGraph.h"
+#include "ast/analysis/TopologicallySortedSCCGraph.h"
 #include "json11.h"
 #include "ram/RamCondition.h"
 #include "ram/RamExpression.h"

diff --git a/src/FunctorOps.cpp b/src/FunctorOps.cpp
@@ -290,4 +290,4 @@ struct FUNCTOR_INTRINSIC_SANCHECKER {
 }  // namespace
 #endif
 
-}  // namespace souffle
+}  // namespace souffle
diff --git a/src/GraphUtils.h b/src/GraphUtils.h
@@ -16,11 +16,13 @@
 
 #pragma once
 
+#include "utility/FileUtil.h"
 #include <functional>
 #include <map>
 #include <ostream>
 #include <set>
 #include <utility>
+#include <vector>
 
 namespace souffle {
 
@@ -161,4 +163,69 @@ class Graph {
     }
 };
 
+inline std::string toBase64(const std::string& data) {
+    static const std::vector<char> table = {'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M',
+            'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
+            'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y',
+            'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '+', '/'};
+    std::string result;
+    std::string tmp = data;
+    unsigned int padding = 0;
+    if (data.size() % 3 == 2) {
+        padding = 1;
+    } else if (data.size() % 3 == 1) {
+        padding = 2;
+    }
+
+    for (unsigned int i = 0; i < padding; i++) {
+        tmp.push_back(0);
+    }
+    for (unsigned int i = 0; i < tmp.size(); i += 3) {
+        auto c1 = static_cast<unsigned char>(tmp[i]);
+        auto c2 = static_cast<unsigned char>(tmp[i + 1]);
+        auto c3 = static_cast<unsigned char>(tmp[i + 2]);
+        unsigned char index1 = c1 >> 2;
+        unsigned char index2 = ((c1 & 0x03) << 4) | (c2 >> 4);
+        unsigned char index3 = ((c2 & 0x0F) << 2) | (c3 >> 6);
+        unsigned char index4 = c3 & 0x3F;
+
+        result.push_back(table[index1]);
+        result.push_back(table[index2]);
+        result.push_back(table[index3]);
+        result.push_back(table[index4]);
+    }
+    if (padding == 1) {
+        result[result.size() - 1] = '=';
+    } else if (padding == 2) {
+        result[result.size() - 1] = '=';
+        result[result.size() - 2] = '=';
+    }
+    return result;
+}
+
+inline std::string convertDotToSVG(const std::string& dotSpec) {
+    // Check if dot is present
+    std::string cmd = which("dot");
+    if (!isExecutable(cmd)) {
+        return "";
+    }
+
+    TempFileStream dotFile;
+    dotFile << dotSpec;
+    dotFile.flush();
+    return execStdOut("dot -Tsvg < " + dotFile.getFileName()).str();
+}
+
+inline void printHTMLGraph(std::ostream& out, const std::string& dotSpec, const std::string& id) {
+    std::string data = convertDotToSVG(dotSpec);
+
+    if (data.find("<svg") != std::string::npos) {
+        out << "<img alt='graph image' src='data:image/svg+xml;base64," << toBase64(data) << "'><br/>\n";
+    } else {
+        out << "<div class='" << id << "-source"
+            << "'>\n<pre>" << dotSpec << "</pre>\n";
+        out << "</div>\n";
+    }
+}
+
 }  // end of namespace souffle
diff --git a/src/Makefile.am b/src/Makefile.am
@@ -127,21 +127,21 @@ souffle_sources = \
         ast/TypeSystem.cpp                                 \
         ast/TypeSystem.h                                   \
         ast/analysis/AstAnalysis.h                         \
-        ast/analysis/AstConstraintAnalysis.h               \
-        ast/analysis/AstGroundAnalysis.cpp                 \
-        ast/analysis/AstGroundAnalysis.h                   \
-        ast/analysis/AstIOTypeAnalysis.cpp                 \
-        ast/analysis/AstIOTypeAnalysis.h                   \
+        ast/analysis/AstConstraint.h                       \
+        ast/analysis/AstGround.cpp                         \
+        ast/analysis/AstGround.h                           \
+        ast/analysis/AstIOType.cpp                         \
+        ast/analysis/AstIOType.h                           \
         ast/analysis/AstProfileUse.cpp                     \
         ast/analysis/AstProfileUse.h                       \
-        ast/analysis/AstTypeAnalysis.cpp                   \
-        ast/analysis/AstTypeAnalysis.h                     \
-        ast/analysis/AstTypeEnvironmentAnalysis.cpp        \
-        ast/analysis/AstTypeEnvironmentAnalysis.h          \
-        ast/analysis/AuxArityAnalysis.cpp                  \
-        ast/analysis/AuxArityAnalysis.h                    \
-        ast/analysis/ComponentLookupAnalysis.cpp           \
-        ast/analysis/ComponentLookupAnalysis.h             \
+        ast/analysis/AstType.cpp                           \
+        ast/analysis/AstType.h                             \
+        ast/analysis/AstTypeEnvironment.cpp                \
+        ast/analysis/AstTypeEnvironment.h                  \
+        ast/analysis/AuxArity.cpp                          \
+        ast/analysis/AuxArity.h                            \
+        ast/analysis/ComponentLookup.cpp                   \
+        ast/analysis/ComponentLookup.h                     \
         ast/analysis/PrecedenceGraph.cpp                   \
         ast/analysis/PrecedenceGraph.h                     \
         ast/transform/AstComponentChecker.cpp              \

diff --git a/src/ast/AstTranslationUnit.h b/src/ast/AstTranslationUnit.h
@@ -22,7 +22,8 @@
 #include "Global.h"
 #include "ast/AstProgram.h"
 #include "ast/analysis/AstAnalysis.h"
-#include "ast/analysis/PrecedenceGraph.h"
+#include "ast/analysis/RecursiveClauses.h"
+#include "ast/analysis/SCCGraph.h"
 #include <iosfwd>
 #include <map>
 #include <memory>

diff --git a/src/ast/AstUtils.cpp b/src/ast/AstUtils.cpp
@@ -28,7 +28,7 @@
 #include "ast/AstRelation.h"
 #include "ast/AstType.h"
 #include "ast/AstVisitor.h"
-#include "ast/analysis/AstTypeAnalysis.h"
+#include "ast/analysis/AstType.h"
 #include "utility/ContainerUtil.h"
 #include "utility/MiscUtil.h"
 #include "utility/StringUtil.h"

diff --git a/src/ast/analysis/AstConstraintAnalysis.h → src/ast/analysis/AstConstraint.h b/src/ast/analysis/AstConstraintAnalysis.h → src/ast/analysis/AstConstraint.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AstConstraintAnalysis.h
+ * @file AstConstraint.h
  *
  * Contains AST Constraint Analysis Infrastructure for doing constraint analysis on AST objects
  *

diff --git a/src/ast/analysis/AstGroundAnalysis.cpp → src/ast/analysis/AstGround.cpp b/src/ast/analysis/AstGroundAnalysis.cpp → src/ast/analysis/AstGround.cpp
@@ -14,18 +14,17 @@
  *
  ***********************************************************************/
 
-#include "ast/analysis/AstGroundAnalysis.h"
+#include "ast/analysis/AstGround.h"
 #include "BinaryConstraintOps.h"
 #include "Constraints.h"
-#include "PrecedenceGraph.h"
 #include "RelationTag.h"
 #include "ast/AstArgument.h"
 #include "ast/AstClause.h"
 #include "ast/AstLiteral.h"
+#include "ast/AstRelation.h"
 #include "ast/AstTranslationUnit.h"
-#include "ast/AstVisitor.h"
-#include "ast/analysis/AstConstraintAnalysis.h"
-#include "ast/analysis/AstGroundAnalysis.h"
+#include "ast/analysis/AstConstraint.h"
+#include "ast/analysis/RelationDetailCache.h"
 #include "utility/StreamUtil.h"
 #include <algorithm>
 #include <map>

diff --git a/src/ast/analysis/AstGroundAnalysis.h → src/ast/analysis/AstGround.h b/src/ast/analysis/AstGroundAnalysis.h → src/ast/analysis/AstGround.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AstGroundAnalysis.h
+ * @file AstGround.h
  *
  * Defines a function for computing the grounded arguments in a clause
  *

diff --git a/src/ast/analysis/AstIOTypeAnalysis.cpp → src/ast/analysis/AstIOType.cpp b/src/ast/analysis/AstIOTypeAnalysis.cpp → src/ast/analysis/AstIOType.cpp
@@ -14,7 +14,7 @@
  *
  ***********************************************************************/
 
-#include "ast/analysis/AstIOTypeAnalysis.h"
+#include "ast/analysis/AstIOType.h"
 #include "ast/AstIO.h"
 #include "ast/AstProgram.h"
 #include "ast/AstQualifiedName.h"

diff --git a/src/ast/analysis/AstIOTypeAnalysis.h → src/ast/analysis/AstIOType.h b/src/ast/analysis/AstIOTypeAnalysis.h → src/ast/analysis/AstIOType.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AstIOTypeAnalysis.h
+ * @file AstIOType.h
  *
  * Declares methods to identify a relation as input, output, or printsize.
  *

diff --git a/src/ast/analysis/AstTypeAnalysis.cpp → src/ast/analysis/AstType.cpp b/src/ast/analysis/AstTypeAnalysis.cpp → src/ast/analysis/AstType.cpp
@@ -14,12 +14,13 @@
  *
  ***********************************************************************/
 
-#include "ast/analysis/AstTypeAnalysis.h"
+#include "ast/analysis/AstType.h"
 #include "AggregateOp.h"
 #include "Constraints.h"
 #include "FunctorOps.h"
 #include "Global.h"
 #include "RamTypes.h"
+#include "ast/AstAbstract.h"
 #include "ast/AstArgument.h"
 #include "ast/AstAttribute.h"
 #include "ast/AstClause.h"
@@ -32,10 +33,11 @@
 #include "ast/AstUtils.h"
 #include "ast/AstVisitor.h"
 #include "ast/TypeSystem.h"
-#include "ast/analysis/AstConstraintAnalysis.h"
-#include "ast/analysis/AstTypeEnvironmentAnalysis.h"
+#include "ast/analysis/AstConstraint.h"
+#include "ast/analysis/AstTypeEnvironment.h"
 #include "utility/ContainerUtil.h"
 #include "utility/FunctionalUtil.h"
+#include "utility/MiscUtil.h"
 #include "utility/StringUtil.h"
 #include <algorithm>
 #include <cassert>

diff --git a/src/ast/analysis/AstTypeAnalysis.h → src/ast/analysis/AstType.h b/src/ast/analysis/AstTypeAnalysis.h → src/ast/analysis/AstType.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AstTypeAnalysis.h
+ * @file AstType.h
  *
  * A collection of type analyses operating on AST constructs.
  *

diff --git a/...t/analysis/AstTypeEnvironmentAnalysis.cpp → src/ast/analysis/AstTypeEnvironment.cpp b/...t/analysis/AstTypeEnvironmentAnalysis.cpp → src/ast/analysis/AstTypeEnvironment.cpp
@@ -14,7 +14,7 @@
  *
  ***********************************************************************/
 
-#include "ast/analysis/AstTypeEnvironmentAnalysis.h"
+#include "ast/analysis/AstTypeEnvironment.h"
 #include "GraphUtils.h"
 #include "ast/AstAttribute.h"
 #include "ast/AstProgram.h"
@@ -23,6 +23,7 @@
 #include "ast/TypeSystem.h"
 #include "utility/MiscUtil.h"
 #include "utility/tinyformat.h"
+#include <algorithm>
 #include <functional>
 #include <ostream>
 #include <typeinfo>

diff --git a/...ast/analysis/AstTypeEnvironmentAnalysis.h → src/ast/analysis/AstTypeEnvironment.h b/...ast/analysis/AstTypeEnvironmentAnalysis.h → src/ast/analysis/AstTypeEnvironment.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AstTypeEnvironmentAnalysis.h
+ * @file AstTypeEnvironment.h
  *
  * A wrapper for TypeEnvironment to be used for AST Analysis
  *
@@ -26,7 +26,6 @@
 #include <ostream>
 #include <set>
 #include <string>
-#include <vector>
 
 namespace souffle {
 

diff --git a/src/ast/analysis/AuxArityAnalysis.cpp → src/ast/analysis/AuxArity.cpp b/src/ast/analysis/AuxArityAnalysis.cpp → src/ast/analysis/AuxArity.cpp
@@ -14,17 +14,13 @@
  *
  ***********************************************************************/
 
-#include "AuxArityAnalysis.h"
+#include "ast/analysis/AuxArity.h"
 #include "Global.h"
-#include "ast/AstClause.h"
-#include "ast/AstUtils.h"
-#include <algorithm>
 #include <string>
-#include <vector>
 
 namespace souffle {
 
-size_t AuxiliaryArity::computeArity(const AstRelation* relation) const {
+size_t AuxiliaryArity::computeArity(const AstRelation* /* relation */) const {
     if (Global::config().has("provenance")) {
         return 2;
     } else {

diff --git a/src/ast/analysis/AuxArityAnalysis.h → src/ast/analysis/AuxArity.h b/src/ast/analysis/AuxArityAnalysis.h → src/ast/analysis/AuxArity.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file AuxArityAnalysis.h
+ * @file AuxArity.h
  *
  * Define of AST analyses classes
  *

diff --git a/src/ast/analysis/ComponentLookupAnalysis.cpp → src/ast/analysis/ComponentLookup.cpp b/src/ast/analysis/ComponentLookupAnalysis.cpp → src/ast/analysis/ComponentLookup.cpp
@@ -14,7 +14,7 @@
  *
  ***********************************************************************/
 
-#include "ComponentLookupAnalysis.h"
+#include "ast/analysis/ComponentLookup.h"
 #include "ast/AstComponent.h"
 #include "ast/AstProgram.h"
 #include "ast/AstTranslationUnit.h"

diff --git a/src/ast/analysis/ComponentLookupAnalysis.h → src/ast/analysis/ComponentLookup.h b/src/ast/analysis/ComponentLookupAnalysis.h → src/ast/analysis/ComponentLookup.h
@@ -8,7 +8,7 @@
 
 /************************************************************************
  *
- * @file ComponentLookupAnalysis.h
+ * @file ComponentLookup.h
  *
  ***********************************************************************/