From 0ce2d828966997dd0265a25e4816e4ddb923186e Mon Sep 17 00:00:00 2001
From: Matthew Gaudet <mgaudet@mozilla.com>
Date: Fri, 20 Dec 2019 16:24:58 +0000
Subject: [PATCH] Bug 1604952 - Rename FunctionCreationData.h to Stencil.h
 r=tcampbell

Because I'm planning on moving non-function data into this, I think the time is
potentially right to start calling this stencil.h

Differential Revision: https://phabricator.services.mozilla.com/D57902

--HG--
rename : js/src/frontend/FunctionCreationData.h => js/src/frontend/Stencil.h
extra : moz-landing-system : lando
---
 js/src/frontend/SharedContext.h                   |  2 +-
 .../{FunctionCreationData.h => Stencil.h}         | 15 ++++++++++++---
 2 files changed, 13 insertions(+), 4 deletions(-)
 rename js/src/frontend/{FunctionCreationData.h => Stencil.h} (88%)

diff --git a/js/src/frontend/SharedContext.h b/js/src/frontend/SharedContext.h
index 61d3800848aca..0b53ca32feb85 100644
--- a/js/src/frontend/SharedContext.h
+++ b/js/src/frontend/SharedContext.h
@@ -12,8 +12,8 @@
 
 #include "ds/InlineTable.h"
 #include "frontend/AbstractScope.h"
-#include "frontend/FunctionCreationData.h"
 #include "frontend/ParseNode.h"
+#include "frontend/Stencil.h"
 #include "vm/BytecodeUtil.h"
 #include "vm/JSFunction.h"
 #include "vm/JSScript.h"
diff --git a/js/src/frontend/FunctionCreationData.h b/js/src/frontend/Stencil.h
similarity index 88%
rename from js/src/frontend/FunctionCreationData.h
rename to js/src/frontend/Stencil.h
index 40596368c5f94..28b64e2c9d2d6 100644
--- a/js/src/frontend/FunctionCreationData.h
+++ b/js/src/frontend/Stencil.h
@@ -4,8 +4,8 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-#ifndef frontend_FunctionCreationData_h
-#define frontend_FunctionCreationData_h
+#ifndef frontend_Stencil_h
+#define frontend_Stencil_h
 
 #include "frontend/ParseNode.h"
 #include "gc/AllocKind.h"
@@ -16,6 +16,15 @@
 namespace js {
 namespace frontend {
 
+// [SMDOC] Script Stencil (Frontend Representation)
+//
+// Stencils are GC object free representations of artifacts created during
+// parsing and bytecode emission that are being used as part of Project
+// Stencil (https://bugzilla.mozilla.org/show_bug.cgi?id=stencil) to revamp
+// the frontend.
+//
+// Renaming to use the term stencil more broadly is still in progress.
+
 // Data used to instantiate the lazy script before script emission.
 struct LazyScriptCreationData {
   frontend::AtomVector closedOverBindings;
@@ -105,4 +114,4 @@ struct FunctionCreationData {
 } /* namespace frontend */
 } /* namespace js */
 
-#endif /* frontend_FunctionCreationData_h */
\ No newline at end of file
+#endif /* frontend_Stencil_h */
\ No newline at end of file
-- 
GitLab