Rewording

Author: Stevendeo

src/mlang/index.mld

@@ -6,7 +6,7 @@ intermediate representations going from the source code to the target backend.
 {1 Frontend}
 
 First, the source code is parsed according to the Menhir grammar specified in {!module: Mlang.M_frontend.Mparser}.
-The grammar is not exactly LR(1) so we rely on {!module: Mlang.M_frontend.Parse_utils} to backtrack, especially on symbol parsing. The target intermediate representation is {!module: Mlang.M_frontend.Mast}, which is very close to the concrete syntax and can be printed using {!module: Mlang.M_frontend.Format_mast}.
+The grammar is not exactly LR(1) so we rely on {!module: Mlang.M_frontend.Parse_utils} to backtrack, especially on symbol parsing. {!module: Mlang.M_frontend.Syntax_messages} treats the error messages in the different failing cases. The target intermediate representation is {!module: Mlang.M_frontend.Mast}, which is very close to the concrete syntax and can be printed using {!module: Mlang.M_frontend.Format_mast}.
 The frontend also handles ast expansion with {!module: Mlang.M_frontend.Expander} and validation with {!module: Mlang.M_frontend.Validator}.
 
 {!modules:

src/mlang/m_frontend/dune

@@ -17,7 +17,7 @@
  (target syntax_messages.ml)
  (deps
   (:parser mparser.mly)
-  (:msg mparser.messages))
+  (:msg syntax.messages))
  (action
   (with-stdout-to
    %{target}
@@ -38,14 +38,14 @@
  (target updated.messages)
  (deps
   (:parser mparser.mly)
-  (:msg mparser.messages))
+  (:msg syntax.messages))
  (action
   (with-stdout-to
    %{target}
    (run menhir %{parser} --base %{parser} --update-errors %{msg}))))
 
 (rule
- (target mparser.messages.updated)
+ (target syntax.messages.updated)
  (deps
   (:parser mparser.mly)
   (:new new.messages)
@@ -56,12 +56,12 @@
    (run menhir %{parser} --base %{parser} --merge-errors %{new}
      --merge-errors %{updated}))))
 
-; Tests the mparser.messages file when the parser changes.
+; Tests the syntax.messages file when the parser changes.
 ; To update the file, use dune runtest --auto-update
 
 (rule
  (alias runtest)
  (package mlang)
- (deps mparser.messages mparser.messages.updated)
+ (deps syntax.messages syntax.messages.updated)
  (action
-  (diff mparser.messages mparser.messages.updated)))
+  (diff syntax.messages syntax.messages.updated)))

src/mlang/m_frontend/mparser.messages src/mlang/m_frontend/syntax.messagessrc/mlang/m_frontend/mparser.messages renamed to src/mlang/m_frontend/syntax.messages

@@ -1,29 +1,26 @@
-(** Parsing error messages handler.
-    The .ml file corresponding to this mli is generated automatically generated
-    by menhir (check the dune file) from the [mparser.messages] file. This file
-    is the core of parsing message handling: this is where all error messages
-    must be added.
+(** Parsing error messages handler. The .ml file corresponding to this mli is
+    generated automatically generated by menhir from the [syntax.messages] file.
+    This file is the core of parsing message handling: this is where all error
+    messages must be added.
 
-    The structure of the [mparser.messages] strongly depends on the parser's. If
+    The structure of the [syntax.messages] strongly depends on the parser's. If
     the parser changes, it may be necessary to rework on it to update the error
     messages. Hopefully, [menhir] comes with a way to automatically update
     messages when the parser changes. This can be automatically done by running
     [dune runtest --auto-promote]. Check the [src/mlang/m_frontend/dune] file
     for more information.
 
     Each possible error is mapped to a state (an integer) and a custom message
-    in the [mparser.messages] file. When the parser raises an exception, it also
-    raises the state where it failed. This module allows to get the
+    in the [syntax.messages] file. When the parser raises an exception, it also
+    raises the state in which it failed. This module allows to get the
     corresponding error message.
 
-    There is then three possibilities:
-    * the state has a custom error message, which can be printed;
-    * the state has the default error message (<"YOUR SYNTAX ERROR MESSAGE HERE>"),
-      which has not been written yet;
-    * the state has no error message, which should not happen unless the
-      [mparser.messages] is not sync with [mparser.mly].
- *)
+    There is then three possibilities: * the state has a custom error message,
+    which can be printed; * the state has the default error message (<"YOUR
+    SYNTAX ERROR MESSAGE HERE>"), which has not been customized yet; * the state
+    has no error message, which should happen only if the [syntax.messages] is
+    not sync with [mparser.mly]. *)
 
 val message : int -> string
-(** Returns the error message corresponding to a parser error state.
-    Raises [Not_found] if the state has no error message. *)
+(** Returns the error message corresponding to a parser error state. Raises
+    [Not_found] if the state has no error message. *)

src/mlang/m_frontend/syntax_messages.mli

@@ -22,14 +22,13 @@
     - Constants have been inlined.
     - Loops (FunCallLoop, Loop) have been unrolled.
     - Chaining, domain and verification calculations have been unified into
-    Target calculations.
-    This filtering is performed by {!M_frontend.Expander}, {!M_frontend.Validator} and
-    {!M_frontend.Mast_to_mir}.
+      Target calculations. This filtering is performed by
+      {!M_frontend.Expander}, {!M_frontend.Validator} and
+      {!M_frontend.Mast_to_mir}.
 
-    The structural difference between {!M_frontend.Mast} and Mir common types are
-    the replacement of {!Mir.Com.m_var_name} by {!M_ir.Com.Var.t} and
-    {!M_frontend.Mast.error_name} by {!M_ir.Com.Error.t}.
- *)
+    The structural difference between {!M_frontend.Mast} and Mir common types
+    are the replacement of {!Mir.Com.m_var_name} by {!M_ir.Com.Var.t} and
+    {!M_frontend.Mast.error_name} by {!M_ir.Com.Error.t}. *)
 
 type set_value = Com.Var.t Com.set_value
 
@@ -64,8 +63,7 @@ type stats = {
   max_nb_args : int;
   table_map : Com.Var.t IntMap.t;
 }
-(** A set of constants relative to the program and its selected
-    applications. *)
+(** A set of constants relative to the program and its selected applications. *)
 
 type program = {
   program_safe_prefix : string;