From 7d6e7a5608327d24bf8574bda53dc031d3b91140 Mon Sep 17 00:00:00 2001
From: Son Ho
Date: Wed, 26 Oct 2022 10:12:03 +0200
Subject: Add meta data with code locations to the various definitions

---
 src/Meta.ml | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 src/Meta.ml

(limited to 'src/Meta.ml')

diff --git a/src/Meta.ml b/src/Meta.ml
new file mode 100644
index 00000000..cca6f047
--- /dev/null
+++ b/src/Meta.ml
@@ -0,0 +1,44 @@
+(** Meta data like code spans *)
+
+(** A line location *)
+type loc = {
+  line : int;  (** The (1-based) line number. *)
+  col : int;  (** The (0-based) column offset. *)
+}
+[@@deriving show]
+
+type file_name =
+  | Virtual of string  (** A remapped path (namely paths into stdlib) *)
+  | Local of string
+      (** A local path (a file coming from the current crate for instance) *)
+[@@deriving show]
+
+(** Span data *)
+type span = { file : file_name; beg_loc : loc; end_loc : loc } [@@deriving show]
+
+type meta = {
+  span : span;
+      (** The source code span.
+
+          If this meta information is for a statement/terminator coming from a macro
+          expansion/inlining/etc., this span is (in case of macros) for the macro
+          before expansion (i.e., the location the code where the user wrote the call
+          to the macro).
+
+          Ex:
+          ```text
+          // Below, we consider the spans for the statements inside `test`
+
+          //   the statement we consider, which gets inlined in `test`
+                                   VV
+          macro_rules! macro { ... st ... } // `generated_from_span` refers to this location
+
+          fn test() {
+              macro!(); // <-- `span` refers to this location
+          }
+          ```
+       *)
+  generated_from_span : span option;
+      (** Where the code actually comes from, in case of macro expansion/inlining/etc. *)
+}
+[@@deriving show]
-- 
cgit v1.2.3