language: Change extern type syntax

Use a '$' instead of a '.' to indicate a type provided in application
code.

The reason for the change is to have a consistent "extern" symbol that
isn't widely used elsewhere and isn't ambiguous in expressions.

blueprintcompiler/errors.py

@@ -124,6 +124,11 @@ class CompileWarning(CompileError):
     color = Colors.YELLOW
 
 
+class UpgradeWarning(CompileWarning):
+    category = "upgrade"
+    color = Colors.PURPLE
+
+
 class UnexpectedTokenError(CompileError):
     def __init__(self, start, end):
         super().__init__("Unexpected tokens", start, end)

blueprintcompiler/language/common.py

@@ -20,7 +20,13 @@
 
 from .. import gir
 from ..ast_utils import AstNode, validate, docs
-from ..errors import CompileError, MultipleErrors
+from ..errors import (
+    CompileError,
+    MultipleErrors,
+    UpgradeWarning,
+    CompileWarning,
+    CodeAction,
+)
 from ..completions_utils import *
 from .. import decompiler as decompile
 from ..decompiler import DecompileCtx, decompiler

blueprintcompiler/language/gobject_object.py

@@ -87,7 +87,7 @@ def validate_parent_type(node, ns: str, name: str, err_msg: str):
 def decompile_object(ctx, gir, klass, id=None):
     gir_class = ctx.type_by_cname(klass)
     klass_name = (
-        decompile.full_name(gir_class) if gir_class is not None else "." + klass
+        decompile.full_name(gir_class) if gir_class is not None else "$" + klass
     )
     if id is None:
         ctx.print(f"{klass_name} {{")

blueprintcompiler/language/types.py

@@ -31,33 +31,41 @@ class TypeName(AstNode):
             UseIdent("class_name"),
         ],
         [
-            ".",
+            AnyOf("$", [".", UseLiteral("old_extern", True)]),
             UseIdent("class_name"),
-            UseLiteral("ignore_gir", True),
+            UseLiteral("extern", True),
         ],
         UseIdent("class_name"),
     )
 
+    @validate()
+    def old_extern(self):
+        if self.tokens["old_extern"]:
+            raise UpgradeWarning(
+                "Use the '$' extern syntax introduced in blueprint 0.8.0",
+                actions=[CodeAction("Use '$' syntax", "$" + self.tokens["class_name"])],
+            )
+
     @validate("class_name")
     def type_exists(self):
-        if not self.tokens["ignore_gir"] and self.gir_ns is not None:
+        if not self.tokens["extern"] and self.gir_ns is not None:
             self.root.gir.validate_type(
                 self.tokens["class_name"], self.tokens["namespace"]
             )
 
     @validate("namespace")
     def gir_ns_exists(self):
-        if not self.tokens["ignore_gir"]:
+        if not self.tokens["extern"]:
             self.root.gir.validate_ns(self.tokens["namespace"])
 
     @property
     def gir_ns(self):
-        if not self.tokens["ignore_gir"]:
+        if not self.tokens["extern"]:
             return self.root.gir.namespaces.get(self.tokens["namespace"] or "Gtk")
 
     @property
     def gir_type(self) -> gir.GirType:
-        if self.tokens["class_name"] and not self.tokens["ignore_gir"]:
+        if self.tokens["class_name"] and not self.tokens["extern"]:
             return self.root.gir.get_type(
                 self.tokens["class_name"], self.tokens["namespace"]
             )

blueprintcompiler/utils.py

@@ -24,6 +24,7 @@ class Colors:
     RED = "\033[91m"
     GREEN = "\033[92m"
     YELLOW = "\033[33m"
+    PURPLE = "\033[35m"
     FAINT = "\033[2m"
     BOLD = "\033[1m"
     BLUE = "\033[34m"

tests/sample_errors/warn_old_extern.blp

@@ -0,0 +1,5 @@
+using Gtk 4.0;
+
+.MyClass {
+  prop: typeof(.MyOtherClass);
+}

tests/sample_errors/warn_old_extern.err

@@ -0,0 +1,2 @@
+3,1,8,Use the '$' extern syntax introduced in blueprint 0.8.0
+4,16,13,Use the '$' extern syntax introduced in blueprint 0.8.0

tests/samples/typeof.blp

@@ -7,5 +7,5 @@ Gio.ListStore {
 }
 
 Gio.ListStore {
-  item-type: typeof(.MyObject);
+  item-type: typeof($MyObject);
 }

tests/samples/unchecked_class.blp

@@ -1,7 +1,7 @@
 using Gtk 4.0;
 
-.MyComponent component {
+$MyComponent component {
-  .MyComponent2 {
+  $MyComponent2 {
     flags-value: a | b;
   }
 }

tests/samples/unchecked_class_dec.blp

@@ -1,7 +1,7 @@
 using Gtk 4.0;
 
-.MyComponent component {
+$MyComponent component {
-  .MyComponent2 {
+  $MyComponent2 {
     flags-value: "a|b";
   }
 }

tests/test_samples.py

@@ -236,6 +236,7 @@ class TestSamples(unittest.TestCase):
         self.assert_sample_error("two_templates")
         self.assert_sample_error("uint")
         self.assert_sample_error("using_invalid_namespace")
+        self.assert_sample_error("warn_old_extern")
         self.assert_sample_error("widgets_in_non_size_group")
 
     def test_decompiler(self):