[Heavy] Add dump-source-loc

Author: ricejasonf

heavy/include/heavy/Context.h

@@ -48,6 +48,7 @@ using llvm::dyn_cast;
 using llvm::dyn_cast_or_null;
 using llvm::isa;
 
+class SourceManager;
 class OpGen;
 class Context;
 
@@ -128,6 +129,7 @@ class Context : public ContinuationStack<Context>,
   mlir::Operation* ModuleOp = nullptr;
 
 public:
+  heavy::SourceManager* SourceManager = nullptr;
   heavy::OpGen* OpGen = nullptr;
   heavy::OpEvalPtr OpEval;
 

heavy/include/heavy/Value.h

@@ -697,6 +697,8 @@ class SourceValue : public ValueBase,
         ValueWithSource(L)
   { }
 
+  using ValueWithSource::getSourceLocation;
+
   static bool classof(Value V) {
     return V.getKind() == ValueKind::SourceValue;
   }

heavy/include/heavy/base.sld

@@ -31,6 +31,7 @@
     include-ci
     include-library-declarations
     source-loc
+    dump-source-loc
     parse-source-file
     +
     -

heavy/lib/Builtins.cpp

@@ -15,6 +15,7 @@
 #include "heavy/Context.h"
 #include "heavy/Dialect.h"
 #include "heavy/OpGen.h"
+#include "heavy/SourceManager.h"
 #include "heavy/Value.h"
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/Support/Casting.h"
@@ -88,6 +89,7 @@ heavy::ExternFunction error;
 heavy::ExternFunction dynamic_wind;
 heavy::ExternFunction load_module;
 heavy::ExternFunction source_loc;
+heavy::ExternFunction dump_source_loc;
 heavy::ExternFunction make_syntactic_closure;
 
 heavy::ExternFunction eval;
@@ -402,6 +404,37 @@ void source_loc(Context& C, ValueRefs Args) {
   C.Cont(C.CreateSourceValue(Loc));
 }
 
+void dump_source_loc(Context& C, ValueRefs Args) {
+  if (Args.size() != 1)
+    return C.RaiseError("invalid arity");
+  if (!C.SourceManager)
+    return C.RaiseError("source manager not available");
+
+  // TODO
+  // This could be generalize to take an optional message to work with
+  // errors, warnings, notes, etc.
+
+  heavy::SourceLocation Loc = Args[0].getSourceLocation();
+  heavy::FullSourceLocation SL = C.SourceManager->getFullSourceLocation(Loc);
+  if (SL.isValid()) {
+    heavy::SourceLineContext LineContext = SL.getLineContext();
+    llvm::errs() << LineContext.FileName
+                 << ':' << LineContext.LineNumber
+                 << ':' << LineContext.Column
+                 // TODO optional message could go here
+                 << '\n'
+                 << LineContext.LineRange << '\n';
+    // Display the caret pointing to the point of interest.
+    for (unsigned i = 1; i < LineContext.Column; i++) {
+      llvm::errs() << ' ';
+    }
+    llvm::errs() << "^\n";
+  } else {
+    llvm::errs() << "<<INVALID SOURCE LOCATION>>\n";
+  }
+  C.Cont();
+}
+
 } // end of namespace heavy::builtins
 
 namespace heavy {
@@ -1217,6 +1250,7 @@ void HEAVY_BASE_INIT(heavy::Context& Context) {
 
 
   HEAVY_BASE_VAR(source_loc)      = heavy::builtins::source_loc;
+  HEAVY_BASE_VAR(dump_source_loc) = heavy::builtins::dump_source_loc;
   HEAVY_BASE_VAR(parse_source_file).init(Context);
 
   // functions
@@ -1311,6 +1345,7 @@ void HEAVY_BASE_LOAD_MODULE(heavy::Context& Context) {
       HEAVY_BASE_VAR(include_library_declarations)},
 
     {"source-loc",    HEAVY_BASE_VAR(source_loc)},
+    {"dump-source-loc", HEAVY_BASE_VAR(dump_source_loc)},
     {"parse-source-file",
                       HEAVY_BASE_VAR(parse_source_file).get(Context)},
 

heavy/lib/Context.cpp

@@ -80,6 +80,7 @@ Context::Context()
     EnvStack(Empty()),
     DialectRegistry(std::make_unique<mlir::DialectRegistry>()),
     MLIRContext(std::make_unique<mlir::MLIRContext>(*DialectRegistry)),
+    SourceManager(nullptr),
     OpGen(nullptr)
 {
   NameForImportVar = HEAVY_IMPORT_VAR;
@@ -365,6 +366,13 @@ class Writer : public ValueVisitor<Writer> {
        << ">";
   }
 
+  void VisitSourceValue(SourceValue* SV) {
+    heavy::SourceLocation Loc = SV->getSourceLocation();
+    OS << "\n#<SourceValue {"
+       << Loc.getEncoding()
+       << "}>";
+  }
+
   void VisitUndefined(Undefined U) {
     OS << "#<Undefined";
     if (Value Tracer = U.getTracer()) {

heavy/lib/HeavyScheme.cpp

@@ -60,6 +60,7 @@ void HeavyScheme::ProcessTopLevelCommands(
                               heavy::tok Terminator) {
   auto& Context = getContext();
   auto& SM = getSourceManager();
+  Context.SourceManager = &SM;
   auto ParserPtr = std::make_unique<Parser>(Lexer, Context);
   Parser& Parser = *ParserPtr;
   heavy::Environment* Env = Context.DefaultEnv.get();

heavy/lib/SourceManager.cpp

@@ -96,6 +96,7 @@ SourceManager::getClosestLineStart(SourceFile File,
 
 SourceLineContext
 FullSourceLocation::getLineContext() const {
+  assert(isValid() && "expecting valid source location");
   char const* const FileStartPos = File.Buffer.begin();
   char const* const FileEndPos = File.Buffer.end();
   // We could store SourceLineStarts to help with speeding