proper management of magic number

Author: bobzhang

jscomp/bin/bsb.ml

@@ -7803,10 +7803,9 @@ type dep_info = {
 
 type check_result = 
   | Good
-  | Bsb_file_not_exist (** We assume that it is a clean repo *)
-  | Bsb_version_mismatch
+  | Bsb_file_not_exist (** We assume that it is a clean repo *)  
   | Bsb_source_directory_changed
-  | Bsc_version_mismatch
+  | Bsb_bsc_version_mismatch  
   | Bsb_forced
   | Other of string
 
@@ -7856,45 +7855,36 @@ type t =
   }
 
 
-let magic_number = "BS_DEP_INFOS_20161116"
-let bsb_version = "20160121+dev"
+let magic_number = "BS_DEP_INFOS_20170209"
+let bsb_version = "20170209+dev"
+(* TODO: for such small data structure, maybe text format is better *)
 
 let write (fname : string)  (x : t) = 
   let oc = open_out_bin fname in 
   output_string oc magic_number ;
   output_value oc x ; 
   close_out oc 
 
-let read (fname : string) : t = 
-  let ic = open_in_bin fname in  (* Windows binary mode*)
-  let buffer = really_input_string ic (String.length magic_number) in
-  assert (buffer = magic_number);
-  let res : t = input_value ic  in 
-  close_in ic ; 
-  res
-
 
 
 
 
 type check_result = 
   | Good
   | Bsb_file_not_exist (** We assume that it is a clean repo *)
-  | Bsb_version_mismatch
   | Bsb_source_directory_changed
-  | Bsc_version_mismatch
+  | Bsb_bsc_version_mismatch
   | Bsb_forced
   | Other of string
 
 let to_str (check_resoult : check_result) = 
   match check_resoult with
   | Good -> Ext_string.empty
   | Bsb_file_not_exist -> "File not found"
-  | Bsb_version_mismatch -> "Bsb version mismatch"
   | Bsb_source_directory_changed -> 
     "Bsb source directory changed"
-  | Bsc_version_mismatch -> 
-    "Bsc version mismatch"
+  | Bsb_bsc_version_mismatch -> 
+    "bsc or bsb version mismatch"
   | Bsb_forced -> 
     "Bsb forced rebuild "  
   | Other s -> 
@@ -7910,33 +7900,46 @@ let rec check_aux xs i finish =
       check_aux xs (i + 1 ) finish 
     else Other current_file
 
-  
+
+let read (fname : string) cont = 
+  match open_in_bin fname with   (* Windows binary mode*)
+  | ic -> 
+    let buffer = really_input_string ic (String.length magic_number) in
+    if (buffer <> magic_number) then Bsb_bsc_version_mismatch
+    else 
+      let res : t = input_value ic  in 
+      close_in ic ; 
+      cont res
+  | exception _ -> Bsb_file_not_exist 
+
+
 (** check time stamp for all files 
     TODO: those checks system call can be saved later
     Return a reason 
     Even forced, we still need walk through a little 
     bit in case we found a different version of compiler
 *)
 let check ~cwd forced file =
-  try 
-    let {
-      file_stamps = xs; source_directory; bsb_version = old_version;
-      bsc_version
-      } = read file  in 
-    if old_version <> bsb_version then Bsb_version_mismatch else
+  read file  begin  function  {
+    file_stamps = xs; source_directory; bsb_version = old_version;
+    bsc_version
+  } ->  
+    if old_version <> bsb_version then Bsb_bsc_version_mismatch else
     if cwd <> source_directory then Bsb_source_directory_changed else
-    if bsc_version <> Bs_version.version then Bsc_version_mismatch else 
+    if bsc_version <> Bs_version.version then Bsb_bsc_version_mismatch else 
     if forced then Bsb_forced (* No need walk through *)
     else
-      check_aux xs  0 (Array.length xs)  
-  with _ -> Bsb_file_not_exist
+      try 
+        check_aux xs  0 (Array.length xs)  
+      with _ -> Bsb_file_not_exist
+  end 
 
 let store ~cwd name file_stamps = 
   write name 
-  { file_stamps ; 
-    source_directory = cwd ; 
-    bsb_version ;
-    bsc_version = Bs_version.version }
+    { file_stamps ; 
+      source_directory = cwd ; 
+      bsb_version ;
+      bsc_version = Bs_version.version }
 
 end
 module Bsb_file : sig 
@@ -9048,14 +9051,13 @@ let regenerate_ninja cwd bsc_dir forced =
   begin match reason  with 
     | Good -> None  (* Fast path *)
     | Bsb_forced 
-    | Bsc_version_mismatch 
+    | Bsb_bsc_version_mismatch 
     | Bsb_file_not_exist 
-    | Bsb_version_mismatch
     | Bsb_source_directory_changed  
     | Other _ -> 
       print_string "Regenerating build spec : ";
       print_endline (Bsb_dep_infos.to_str reason) ; 
-      if reason = Bsc_version_mismatch then begin 
+      if reason = Bsb_bsc_version_mismatch then begin 
         print_endline "Also clean current repo due to we have detected a different compiler";
         clean_self (); 
       end ; 

jscomp/bsb/bsb_dep_infos.ml

@@ -35,45 +35,36 @@ type t =
   }
 
 
-let magic_number = "BS_DEP_INFOS_20161116"
-let bsb_version = "20160121+dev"
+let magic_number = "BS_DEP_INFOS_20170209"
+let bsb_version = "20170209+dev"
+(* TODO: for such small data structure, maybe text format is better *)
 
 let write (fname : string)  (x : t) = 
   let oc = open_out_bin fname in 
   output_string oc magic_number ;
   output_value oc x ; 
   close_out oc 
 
-let read (fname : string) : t = 
-  let ic = open_in_bin fname in  (* Windows binary mode*)
-  let buffer = really_input_string ic (String.length magic_number) in
-  assert (buffer = magic_number);
-  let res : t = input_value ic  in 
-  close_in ic ; 
-  res
-
 
 
 
 
 type check_result = 
   | Good
   | Bsb_file_not_exist (** We assume that it is a clean repo *)
-  | Bsb_version_mismatch
   | Bsb_source_directory_changed
-  | Bsc_version_mismatch
+  | Bsb_bsc_version_mismatch
   | Bsb_forced
   | Other of string
 
 let to_str (check_resoult : check_result) = 
   match check_resoult with
   | Good -> Ext_string.empty
   | Bsb_file_not_exist -> "File not found"
-  | Bsb_version_mismatch -> "Bsb version mismatch"
   | Bsb_source_directory_changed -> 
     "Bsb source directory changed"
-  | Bsc_version_mismatch -> 
-    "Bsc version mismatch"
+  | Bsb_bsc_version_mismatch -> 
+    "bsc or bsb version mismatch"
   | Bsb_forced -> 
     "Bsb forced rebuild "  
   | Other s -> 
@@ -89,30 +80,43 @@ let rec check_aux xs i finish =
       check_aux xs (i + 1 ) finish 
     else Other current_file
 
-  
+
+let read (fname : string) cont = 
+  match open_in_bin fname with   (* Windows binary mode*)
+  | ic -> 
+    let buffer = really_input_string ic (String.length magic_number) in
+    if (buffer <> magic_number) then Bsb_bsc_version_mismatch
+    else 
+      let res : t = input_value ic  in 
+      close_in ic ; 
+      cont res
+  | exception _ -> Bsb_file_not_exist 
+
+
 (** check time stamp for all files 
     TODO: those checks system call can be saved later
     Return a reason 
     Even forced, we still need walk through a little 
     bit in case we found a different version of compiler
 *)
 let check ~cwd forced file =
-  try 
-    let {
-      file_stamps = xs; source_directory; bsb_version = old_version;
-      bsc_version
-      } = read file  in 
-    if old_version <> bsb_version then Bsb_version_mismatch else
+  read file  begin  function  {
+    file_stamps = xs; source_directory; bsb_version = old_version;
+    bsc_version
+  } ->  
+    if old_version <> bsb_version then Bsb_bsc_version_mismatch else
     if cwd <> source_directory then Bsb_source_directory_changed else
-    if bsc_version <> Bs_version.version then Bsc_version_mismatch else 
+    if bsc_version <> Bs_version.version then Bsb_bsc_version_mismatch else 
     if forced then Bsb_forced (* No need walk through *)
     else
-      check_aux xs  0 (Array.length xs)  
-  with _ -> Bsb_file_not_exist
+      try 
+        check_aux xs  0 (Array.length xs)  
+      with _ -> Bsb_file_not_exist
+  end 
 
 let store ~cwd name file_stamps = 
   write name 
-  { file_stamps ; 
-    source_directory = cwd ; 
-    bsb_version ;
-    bsc_version = Bs_version.version }
+    { file_stamps ; 
+      source_directory = cwd ; 
+      bsb_version ;
+      bsc_version = Bs_version.version }

jscomp/bsb/bsb_dep_infos.mli

@@ -45,10 +45,9 @@ type dep_info = {
 
 type check_result = 
   | Good
-  | Bsb_file_not_exist (** We assume that it is a clean repo *)
-  | Bsb_version_mismatch
+  | Bsb_file_not_exist (** We assume that it is a clean repo *)  
   | Bsb_source_directory_changed
-  | Bsc_version_mismatch
+  | Bsb_bsc_version_mismatch  
   | Bsb_forced
   | Other of string
 

jscomp/bsb/bsb_main.ml

@@ -130,14 +130,13 @@ let regenerate_ninja cwd bsc_dir forced =
   begin match reason  with 
     | Good -> None  (* Fast path *)
     | Bsb_forced 
-    | Bsc_version_mismatch 
+    | Bsb_bsc_version_mismatch 
     | Bsb_file_not_exist 
-    | Bsb_version_mismatch
     | Bsb_source_directory_changed  
     | Other _ -> 
       print_string "Regenerating build spec : ";
       print_endline (Bsb_dep_infos.to_str reason) ; 
-      if reason = Bsc_version_mismatch then begin 
+      if reason = Bsb_bsc_version_mismatch then begin 
         print_endline "Also clean current repo due to we have detected a different compiler";
         clean_self (); 
       end ;