Disable debug info comments.

Author: yurydelendik

src/pass.h

@@ -167,14 +167,26 @@ class NameManager : public WalkerPass<PostWalker<NameManager, Visitor<NameManage
   size_t counter = 0;
 };
 
+struct PrinterArgs {
+  std::ostream& o;
+  bool minify;
+  bool fullAST;
+  bool debugInfo;
+
+  PrinterArgs(): o(std::cout), minify(false), fullAST(false), debugInfo(false) {}
+  PrinterArgs(std::ostream& o): o(o), minify(false), fullAST(false), debugInfo(false) {}
+  PrinterArgs(std::ostream& o, bool minify, bool fullAST, bool debugInfo): o(o), minify(minify), fullAST(fullAST), debugInfo(debugInfo) {}
+};
+
 // Prints out a module
 class Printer : public Pass {
 protected:
-  std::ostream& o;
+  PrinterArgs args;
 
 public:
-  Printer() : o(std::cout) {}
-  Printer(std::ostream& o) : o(o) {}
+  Printer() : args(PrinterArgs()) {}
+  Printer(std::ostream& o) : args(PrinterArgs(o)) {}
+  Printer(const PrinterArgs& args) : args(args) {}
 
   void run(PassRunner* runner, Module* module) override;
 };

src/passes/Print.cpp

@@ -28,6 +28,7 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
   std::ostream& o;
   unsigned indent = 0;
 
+  bool debugInfoComments = false;
   size_t lastDebugLocationId = 0;
   std::vector<DebugLocation>* functionDebugLocations = nullptr;
   size_t lastLabelId = 0;
@@ -54,6 +55,8 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
 
   void setFullAST(bool fullAST_) { fullAST = fullAST_; }
 
+  void setDebugInfoComments(bool debugInfoComments_) { debugInfoComments = debugInfoComments_; }
+
   void incIndent() {
     if (minify) return;
     o << '\n';
@@ -84,7 +87,7 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
   }
 
   void visit(Expression *curr) {
-    if (curr->debugInfo.labelIndex != lastLabelId) {
+    if (debugInfoComments && curr->debugInfo.labelIndex != lastLabelId) {
       lastLabelId = curr->debugInfo.labelIndex;
       if (functionLabels) { // no labels -- skipping
         const Name& labelName = (*functionLabels)[lastLabelId];
@@ -93,7 +96,7 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
         !minify && doIndent(o, indent);
       }
     }
-    if (curr->debugInfo.locationIndex != lastDebugLocationId) {
+    if (debugInfoComments && curr->debugInfo.locationIndex != lastDebugLocationId) {
       lastDebugLocationId = curr->debugInfo.locationIndex;
       // skipping location id 0 or debug information is absent
       if (functionDebugLocations && lastDebugLocationId) {
@@ -561,7 +564,7 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
       printMinorOpening(o, "local ") << printableLocal(i) << ' ' << printWasmType(curr->getLocalType(i)) << ")";
       o << maybeNewLine;
     }
-    if (functionLabels) { // no labels -- skipping
+    if (debugInfoComments && functionLabels) { // no labels -- skipping
       const Name& labelName = (*functionLabels)[0]; // first label is normally a function name
       doIndent(o, indent);
       o << "(;!bookmark " << labelName.str << ";)";
@@ -587,6 +590,9 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
     o << ')';
   }
   void printDebugSections(Module *curr) {
+    if (!debugInfoComments)
+      return;
+
     bool hasSequences = false;
     for (auto& child : curr->functions) {
       if (child->labels.size() > 0) {
@@ -676,12 +682,14 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
       visitTable(&curr->table);
       o << maybeNewLine;
     }
-    for(auto const &item : curr->debugFileMap) {
-      doIndent(o, indent);
-      o << "(;!file " << item.first << " ";
-      printText(o, item.second.str);
-      o << ";)";
-      o << maybeNewLine;
+    if (debugInfoComments) {
+      for(auto const &item : curr->debugFileMap) {
+        doIndent(o, indent);
+        o << "(;!file " << item.first << " ";
+        printText(o, item.second.str);
+        o << ";)";
+        o << maybeNewLine;
+      }
     }
     for (auto& child : curr->functions) {
       doIndent(o, indent);
@@ -695,7 +703,10 @@ struct PrintSExpression : public Visitor<PrintSExpression> {
 };
 
 void Printer::run(PassRunner* runner, Module* module) {
-  PrintSExpression print(o);
+  PrintSExpression print(args.o);
+  print.setMinify(args.minify);
+  print.setFullAST(args.fullAST);
+  print.setDebugInfoComments(args.debugInfo);
   print.visitModule(module);
 }
 
@@ -705,14 +716,8 @@ static RegisterPass<Printer> registerPass("print", "print in s-expression format
 
 class MinifiedPrinter : public Printer {
   public:
-  MinifiedPrinter() : Printer() {}
-  MinifiedPrinter(std::ostream& o) : Printer(o) {}
-
-  void run(PassRunner* runner, Module* module) override {
-    PrintSExpression print(o);
-    print.setMinify(true);
-    print.visitModule(module);
-  }
+  MinifiedPrinter() : Printer(PrinterArgs(std::cout, true, false, false)) {}
+  MinifiedPrinter(std::ostream& o) : Printer(PrinterArgs(o, true, false, false)) {}
 };
 
 static RegisterPass<MinifiedPrinter> registerMinifyPass("print-minified", "print in minified s-expression format");
@@ -721,18 +726,21 @@ static RegisterPass<MinifiedPrinter> registerMinifyPass("print-minified", "print
 
 class FullPrinter : public Printer {
   public:
-  FullPrinter() : Printer() {}
-  FullPrinter(std::ostream& o) : Printer(o) {}
-
-  void run(PassRunner* runner, Module* module) override {
-    PrintSExpression print(o);
-    print.setFullAST(true);
-    print.visitModule(module);
-  }
+  FullPrinter() : Printer(PrinterArgs(std::cout, false, true, false)) {}
+  FullPrinter(std::ostream& o) : Printer(PrinterArgs(o, false, true, false)) {}
 };
 
 static RegisterPass<FullPrinter> registerFullASTPass("print-full", "print in full s-expression format");
 
+// Prints out full ast module with additional debug info comments
+class DebugInfoCommentsPrinter : public Printer {
+  public:
+  DebugInfoCommentsPrinter() : Printer(PrinterArgs(std::cout, false, true, true)) {}
+  DebugInfoCommentsPrinter(std::ostream& o) : Printer(PrinterArgs(o, false, true, true)) {}
+};
+
+static RegisterPass<DebugInfoCommentsPrinter> registerDebugInfoCommentsPass("print-debug-info", "print in full s-expression format with debug info comments");
+
 // Print individual expressions
 
 std::ostream& WasmPrinter::printExpression(Expression* expression, std::ostream& o, bool minify) {

src/tools/s2wasm.cpp

@@ -31,6 +31,7 @@ using namespace wasm;
 int main(int argc, const char *argv[]) {
   bool ignoreUnknownSymbols = false;
   bool generateEmscriptenGlue = false;
+  bool addDebugInfoComments = false;
   std::string startFunction;
   std::vector<std::string> archiveLibraries;
   Options options("s2wasm", "Link .s file into .wast");
@@ -81,6 +82,11 @@ int main(int argc, const char *argv[]) {
            [&archiveLibraries](Options *o, const std::string &argument) {
              archiveLibraries.push_back(argument);
            })
+      .add("--debug-info", "", "Add debug info comments to the AST",
+           Options::Arguments::Zero,
+           [&addDebugInfoComments](Options *, const std::string &) {
+             addDebugInfoComments = true;
+           })
       .add_positional("INFILE", Options::Arguments::One,
                       [](Options *o, const std::string &argument) {
                         o->extra["infile"] = argument;
@@ -133,7 +139,8 @@ int main(int argc, const char *argv[]) {
 
   if (options.debug) std::cerr << "Printing..." << std::endl;
   Output output(options.extra["output"], Flags::Text, options.debug ? Flags::Debug : Flags::Release);
-  WasmPrinter::printModule(&linker.getOutput().wasm, output.getStream());
+  WasmPrinter::printModule(&linker.getOutput().wasm, PrinterArgs(output.getStream(), false, false, addDebugInfoComments));
+
   output << meta.str();
 
   if (options.debug) std::cerr << "Done." << std::endl;

src/wasm-printing.h

@@ -32,6 +32,12 @@ struct WasmPrinter {
     return o;
   }
 
+  static void printModule(Module* module, const PrinterArgs& args) {
+    PassRunner passRunner(module);
+    passRunner.add<Printer>(args);
+    passRunner.run();
+  }
+
   static std::ostream& printModule(Module* module) {
     return printModule(module, std::cout);
   }