Form refactor

mathics/builtin/forms/base.py

@@ -1,5 +1,8 @@
+from typing import Callable
+
 import mathics.core.definitions as definitions
 from mathics.builtin.base import Builtin
+from mathics.core.element import BaseElement
 from mathics.core.symbols import Symbol
 
 form_symbol_to_class = {}
@@ -36,6 +39,57 @@ def __new__(cls, *args, **kwargs):
         form_symbol_to_class[Symbol(name)] = cls
         return instance
 
+    @classmethod
+    def box(cls, element: BaseElement, evaluation):
+        """
+        This method is is called for each element that can be boxed.
+        ("box" here is a an active verb, not a noun).
+
+        This is a generic routine which calls the specific boxing routine
+        that has been regstered in class variable ``form_box_methods`` previously.
+
+        If nothing has been registered, we just return ``element`` back unmodified
+        as we do in evaluation.
+
+        Specific and custom method need to be implemented for each Form
+        and element_type that perform some kind of boxing.
+        """
+        method = cls.form_box_methods.get((cls, element.head), None)
+        if method is None:
+            # The default class should have been registered under FormBaseClass
+            method = cls.form_box_methods.get((FormBaseClass, element.head), None)
+            if method is None:
+                # Just return the element unmodified.
+                # Note: this is what we do in evaluation when we don't have a match
+                return element
+
+        return method(element, evaluation)
+
+    @classmethod
+    def register_box_method(cls, symbol: Symbol, method: Callable):
+        """
+        Register ``method`` so method(element, ...) is called when
+        ``form.box(element, ...)`` is called.
+
+        "form" is something like ``StandardForm``, ``TraditionalForm``, etc.
+
+        To register the default boxing routine, register under the class
+        ``FormBaseClass``
+        """
+
+        cls.form_box_methods[cls, symbol] = method
+
+
+def box(element: BaseElement, evaluation, form: Symbol):
+    """
+    Basically redirects the "box" call from a form symbol name to the "box" method off of
+    the Form class named by the symbol.
+    """
+    form_class = form_symbol_to_class.get(form, None)
+    if form_class is None:
+        return element
+    return form_class.box(element, evaluation)
+
 
 # FormBaseClass is a public Builtin class that
 # should not get added as a definition (and therefore not added to

test/formtest.py

@@ -0,0 +1,112 @@
+"""
+Example to show how new Format-directed Boxing might work.
+
+This is a minimal example so we can discuss feasiblity.
+"""
+from mathics.builtin.forms.base import box
+from mathics.core.atoms import IntegerM1, Integer1, Integer2, Rational
+from mathics.core.expression import Expression
+from mathics.core.parser import parse, MathicsSingleLineFeeder
+from mathics.core.symbols import SymbolDivide
+from mathics.core.systemsymbols import (
+    SymbolFractionBox,
+    SymbolMakeBoxes,
+    SymbolPower,
+    SymbolSqrt,
+    SymbolStandardForm,
+)
+from mathics.session import MathicsSession
+
+session = MathicsSession(character_encoding="ASCII")
+
+
+# Hacky pseudo boxing rules.
+# Currently in MakeBox rule rewriting occurs via MakeBox rewrite rules
+# which are attached to various Builtin classes.
+
+# The rewrite is performed as a part of rewriting portion of Expression evaluation.
+# We probably want to segregate these rules from other kinds of rules.
+#
+# The below hacky code is to simulate the rule behavior for
+# just a few kinds of things so we don't have to hook into the
+# complex rewrite mechanism in use in general evaluation. The implementation we use
+# is just good enough for the new kinds of things we need.
+# It is not intended to be used in a final implementation.
+
+
+def fractionbox_fn(expr):
+    # To be continued...
+    return Expression(SymbolFractionBox, *expr.elements)
+
+
+def sqrtbox_fn(expr):
+    return Expression(SymbolSqrt, expr.elements[0])
+
+
+def powerbox_fn(expr):
+    new_expr = expr.elements[0]
+    if new_expr.elements[-1] == IntegerM1:
+        return Expression(SymbolDivide, Integer1, new_expr.elements[0])
+    elif new_expr.elements[-1] in (Rational(1, 2), Integer1 * (Integer2**IntegerM1)):
+        return Expression(SymbolSqrt, new_expr.elements[0])
+    return new_expr
+
+
+boxform_rules = {
+    # SymbolTimes: fractionbox_fn,
+    SymbolPower: powerbox_fn,
+    SymbolSqrt: sqrtbox_fn,
+}
+
+
+def apply_formatvalues_rules(expr, evaluation):
+    """
+    Hacky replacement for rules() found in Expression rewrite_apply_eval().
+    Note, we need to add builtin FormatValues() and the internals that go with that.
+    """
+    if expr.elements[-1] not in (SymbolStandardForm,):  # Or more generally $BoxForms
+        # For other forms, there might be other transformations too, and this should
+        # be discussed.
+        # For simplicity, we will just handle a small number of $BoxForms rules
+        return expr
+
+    # Remove the Form from expression "expr"
+    unboxed_expr = expr.elements[0]
+
+    if unboxed_expr.head in boxform_rules:
+        new_expr = boxform_rules[unboxed_expr.head](expr)
+        return new_expr
+    return unboxed_expr
+
+
+# Begin demo code.
+
+for expr_str in (
+    # FIXME;
+    # "1 / x",  # Show off "Division" boxing
+    "a ^ b",  # Show off "Power" boxing
+    "Sqrt[a]",  # "Square-root boxing"
+    "a ^ (1/2)",  # "Square-root boxing"
+):
+    print("expression:        ", expr_str)
+
+    # Parse, but don't evaluate expression.
+    expr = parse(session.definitions, MathicsSingleLineFeeder(expr_str))
+    print("Parsed expression: ", expr)
+
+    # Here is how Mathics currently evaluates MakeBoxes
+    boxed_expr = Expression(SymbolMakeBoxes, expr, SymbolStandardForm)
+    print("Mathics MakeBoxes: ", boxed_expr)
+
+    # Evaluate to get final printed/rendered form
+    print("Eval'd Makeboxes:  ", boxed_expr.evaluate(session.evaluation))
+
+    # Here is how Mathics might better box an expression.
+    # First we apply MakeBox boxing transformation rules.
+    # This handles expression rewriting.
+    transformed_boxed_expr = apply_formatvalues_rules(boxed_expr, session.evaluation)
+
+    boxed_expr2 = box(transformed_boxed_expr, session.evaluation, SymbolStandardForm)
+    print("New    MakeBoxes:  ", boxed_expr2)
+    print("-" * 30)
+    print("")