Add SourceLoc.type_name method, showing the name of the containing ty…

…pe. (ponylang#2643) * Add SourceLoc.typ method, showing the name of the containing type. SourceLoc already shows the method name of the __loc object, but not the type name. Adding the type name is a logical next step, since it is available. The method is named typ, because type is a reserved keyword that cannot be used as a method name. * Rename SourceLoc.{typ, method} as {type_name, method_name}. * Add manual changelog entry for PR ponylang#2643.
dipinhora · Jun 5, 2018 · 42fcc7d · 42fcc7d
1 parent 5dae90a
commit 42fcc7d
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,7 @@ All notable changes to the Pony compiler and standard library will be documented
 
 ### Added
 
+- `SourceLoc.type_name` method ([PR #2643](https://github.com/ponylang/ponyc/pull/2643))
 - Update with experimental support for LLVM 6.0.0 ([PR #2595](https://github.com/ponylang/ponyc/pull/2595))
 - Improve pattern matching error reporting ([PR #2628](https://github.com/ponylang/ponyc/pull/2628))
 - Allow recovering at most one element of a tuple to mutable capability. ([PR #2585](https://github.com/ponylang/ponyc/pull/2585))
@@ -49,6 +50,7 @@ All notable changes to the Pony compiler and standard library will be documented
 
 ### Changed
 
+- `SourceLoc.method` renamed as `SourceLoc.method_name` method ([PR #2643](https://github.com/ponylang/ponyc/pull/2643))
 - New Ponybench API (RFC 52) ([PR #2578](https://github.com/ponylang/ponyc/pull/2578))
 - Forbid impossible pattern matching on generic capabilities ([PR #2499](https://github.com/ponylang/ponyc/pull/2499))
 - Remove case functions ([PR #2542](https://github.com/ponylang/ponyc/pull/2542))

diff --git a/packages/builtin/source_loc.pony b/packages/builtin/source_loc.pony
@@ -7,7 +7,12 @@ interface val SourceLoc
     Name and path of source file.
     """
 
-  fun method(): String
+  fun type_name(): String
+    """
+    Name of nearest class, actor, primitive, struct, interface, or trait.
+    """
+
+  fun method_name(): String
     """
     Name of containing method.
     """
@@ -23,4 +28,3 @@ interface val SourceLoc
     Character position on line.
     Character positions start at 1.
     """
-
diff --git a/src/libponyc/pass/sugar.c b/src/libponyc/pass/sugar.c
@@ -1065,6 +1065,21 @@ ast_t* expand_location(ast_t* location)
     }
   }
 
+  // Find name of containing type.
+  const char* type_name = "";
+  for(ast_t* typ = location; typ != NULL; typ = ast_parent(typ))
+  {
+    token_id variety = ast_id(typ);
+
+    if(variety == TK_INTERFACE || variety == TK_TRAIT ||
+      variety == TK_PRIMITIVE || variety == TK_STRUCT ||
+      variety == TK_CLASS || variety == TK_ACTOR)
+    {
+      type_name = ast_name(ast_child(typ));
+      break;
+    }
+  }
+
   // Create an object literal.
   BUILD(ast, location,
     NODE(TK_OBJECT, DATA("__loc")
@@ -1078,7 +1093,13 @@ ast_t* expand_location(ast_t* location)
           NODE(TK_SEQ, STRING(file_name))
           NONE)
         NODE(TK_FUN, AST_SCOPE
-          NODE(TK_TAG) ID("method") NONE NONE
+          NODE(TK_TAG) ID("type_name") NONE NONE
+          NODE(TK_NOMINAL, NONE ID("String") NONE NONE NONE)
+          NONE
+          NODE(TK_SEQ, STRING(type_name))
+          NONE)
+        NODE(TK_FUN, AST_SCOPE
+          NODE(TK_TAG) ID("method_name") NONE NONE
           NODE(TK_NOMINAL, NONE ID("String") NONE NONE NONE)
           NONE
           NODE(TK_SEQ, STRING(method_name))

diff --git a/test/libponyc/sugar_expr.cc b/test/libponyc/sugar_expr.cc
@@ -564,7 +564,8 @@ TEST_F(SugarExprTest, Location)
     "  fun box bar(): None =>\n"
     "    object\n"
     "      fun tag file(): String => \"\"\n"
-    "      fun tag method(): String => \"bar\"\n"
+    "      fun tag type_name(): String => \"Foo\"\n"
+    "      fun tag method_name(): String => \"bar\"\n"
     "      fun tag line(): USize => 4\n"
     "      fun tag pos(): USize => 5\n"
     "    end";
@@ -578,35 +579,40 @@ TEST_F(SugarExprTest, LocationDefaultArg)
   const char* short_form =
     "interface val SourceLoc\n"
     "  fun file(): String\n"
-    "  fun method(): String\n"
+    "  fun type_name(): String\n"
+    "  fun method_name(): String\n"
     "  fun line(): USize\n"
     "  fun pos(): USize\n"
 
     "class Foo\n"
     "  var create: U32\n"
     "  fun bar() =>\n"
-    "    wombat()\n"
-    "  fun wombat(x: SourceLoc = __loc) =>\n"
-    "    None";
+    "    Log.apply()"
+
+    "primitive Log\n"
+    "  fun apply(x: SourceLoc = __loc) => None\n";
 
   const char* full_form =
     "interface val SourceLoc\n"
     "  fun file(): String\n"
-    "  fun method(): String\n"
+    "  fun type_name(): String\n"
+    "  fun method_name(): String\n"
     "  fun line(): USize\n"
     "  fun pos(): USize\n"
 
     "class Foo\n"
     "  var create: U32\n"
     "  fun bar() =>\n"
-    "    wombat(object\n"
+    "    Log.apply(object\n"
     "      fun tag file(): String => \"\"\n"
-    "      fun tag method(): String => \"bar\"\n"
-    "      fun tag line(): USize => 9\n"
-    "      fun tag pos(): USize => 11\n"
-    "    end)\n"
-    "  fun wombat(x: SourceLoc = __loc) =>\n"
-    "    None";
+    "      fun tag type_name(): String => \"Foo\"\n"
+    "      fun tag method_name(): String => \"bar\"\n"
+    "      fun tag line(): USize => 10\n"
+    "      fun tag pos(): USize => 14\n"
+    "    end)"
+
+    "primitive Log\n"
+    "  fun apply(x: SourceLoc = __loc) => None\n";
 
   TEST_EQUIV(short_form, full_form);
 }