From 99e8dd050c2b09573c3ea37ee608b40df04aefb7 Mon Sep 17 00:00:00 2001
From: Qyriad <qyriad@qyriad.me>
Date: Sat, 22 Jun 2024 21:17:41 -0600
Subject: [PATCH] add an ExprPrinter class, like ValuePrinter

To be used Shortly

Change-Id: I9def7975aa55f251eb8486391677771f7352d7ce
---
 src/libexpr/print.cc |  6 ++++++
 src/libexpr/print.hh | 30 ++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)

diff --git a/src/libexpr/print.cc b/src/libexpr/print.cc
index e387a09fb..87db004b2 100644
--- a/src/libexpr/print.cc
+++ b/src/libexpr/print.cc
@@ -574,4 +574,10 @@ fmt_internal::HintFmt & fmt_internal::HintFmt::operator%(const ValuePrinter & va
         return *this;
 }
 
+std::ostream & operator<<(std::ostream & output, ExprPrinter const & printer)
+{
+    printer.expr.show(printer.state.symbols, output);
+    return output;
+}
+
 }
diff --git a/src/libexpr/print.hh b/src/libexpr/print.hh
index 42826d94d..3deaa33d4 100644
--- a/src/libexpr/print.hh
+++ b/src/libexpr/print.hh
@@ -15,6 +15,8 @@
 
 namespace nix {
 
+struct Expr;
+
 class EvalState;
 struct Value;
 
@@ -50,6 +52,12 @@ void printValue(EvalState & state, std::ostream & str, Value & v, PrintOptions o
 /**
  * A partially-applied form of `printValue` which can be formatted using `<<`
  * without allocating an intermediate string.
+ * This class should not outlive the eval state or it will UAF.
+ * FIXME: This should take `nix::ref`s, to avoid that, but our eval methods all have
+ * EvalState &, not ref<EvalState>, and constructing a new shared_ptr to data that
+ * already has a shared_ptr is a much bigger footgun. In the current architecture of
+ * libexpr, using a ValuePrinter after an EvalState has been destroyed would be
+ * pretty hard.
  */
 class ValuePrinter {
     friend std::ostream & operator << (std::ostream & output, const ValuePrinter & printer);
@@ -73,4 +81,26 @@ std::ostream & operator<<(std::ostream & output, const ValuePrinter & printer);
 template<>
 fmt_internal::HintFmt & fmt_internal::HintFmt::operator%(const ValuePrinter & value);
 
+/**
+ * A partially-applied form of Expr::show(), which can be formatted using `<<`
+ * without allocating an intermediate string.
+ * This class should not outlive the eval state or it will UAF.
+ * FIXME: This should take `nix::ref`s, to avoid that, but our eval methods all have
+ * EvalState &, not ref<EvalState>, and constructing a new shared_ptr to data that
+ * already has a shared_ptr is a much bigger footgun. In the current architecture of
+ * libexpr, using an ExprPrinter after an EvalState has been destroyed would be
+ * pretty hard.
+ */
+class ExprPrinter
+{
+    /** The eval state used to get symbols. */
+    EvalState const & state;
+    /** The expression to print. */
+    Expr const & expr;
+
+public:
+    ExprPrinter(EvalState const & state, Expr const & expr) : state(state), expr(expr) { }
+    friend std::ostream & operator << (std::ostream & output, ExprPrinter const & printer);
+};
+
 }