Integrate learn-ocaml-editor

learn-ocaml.opam

@@ -45,7 +45,7 @@ depends: [
   "ocp-indent-nlfork"
   "ocp-ocamlres" {>= "0.4"}
   "ocplib-json-typed" {= "0.6"}
-  "odoc" {build & >= "1.3.0"}
+  "odoc" {build & >= "1.4.0"}
   "omd" {<= "1.3.1"}
   "pprint"
   "ppx_cstruct"

src/ace-lib/ace.ml

@@ -43,6 +43,8 @@ let create_range s e =
 
 let read_position pos = (pos##.row, pos##.column)
 
+let get_cursor_position {editor} = editor##(getCursorPosition)                       
+
 let read_range range =
   ((range##.start##.row, range##.start##.column),
    (range##.end_##.row, range##.end_##.column))
@@ -92,6 +94,12 @@ let set_custom_data { editor } data =
 let set_mode {editor} name =
   editor##getSession##(setMode (Js.string name))
 
+let on {editor} event callback =
+  editor##getSession##(on (Js.string event) (Js.Unsafe.meth_callback callback))
+
+let insert {editor} position content =
+  editor##getSession##(insert position (Js.string content))
+
 type mark_type = Error | Warning | Message
 
 let string_of_make_type: mark_type -> string = function

src/ace-lib/ace.mli

@@ -20,6 +20,9 @@ type loc = {
 val create_editor: Dom_html.divElement Js.t -> 'a editor
 
 val set_mode: 'a editor -> string -> unit
+val on: 'b editor -> string -> (Dom_html.event Js.t -> unit) -> unit
+val insert: 'a editor -> Ace_types.position Js.t -> string -> unit
+
 
 val read_range: Ace_types.range Js.t -> (int * int) * (int * int)
 val create_range:
@@ -28,6 +31,7 @@ val create_position: int -> int -> Ace_types.position Js.t
 val read_position: Ace_types.position Js.t -> int * int
 val greater_position:
   Ace_types.position Js.t -> Ace_types.position Js.t -> bool
+val get_cursor_position: 'a editor -> Ace_types.position Js.t  
 
 val get_contents: ?range:Ace_types.range Js.t -> 'a editor -> string
 val get_line: 'a editor -> int -> string

src/ace-lib/ace_types.mli

@@ -60,6 +60,10 @@ class type editSession = object
   method getTokenAt : int -> int -> token Js.t Js.meth
   method replace : range Js.t -> Js.js_string Js.t -> unit Js.meth
   method setMode : Js.js_string Js.t -> unit Js.meth
+  method on : Js.js_string Js.t ->
+              ((Dom_html.event Js.t , unit) Js.meth_callback)->
+              unit Js.meth
+  method insert : position Js.t -> Js.js_string Js.t -> unit Js.meth      
   method setAnnotations : annotation Js.t Js.js_array Js.t -> unit Js.meth
   method getAnnotations : annotation Js.t Js.js_array Js.t Js.meth
   method clearAnnotations : unit Js.meth

src/app/dune

@@ -24,6 +24,7 @@
     learnocaml_data
     learnocaml_api
     sha
+    grading_jsoo
     ocplib_i18n)
 )
 
@@ -38,13 +39,14 @@
             learnocaml_app_common
             learnocaml_toplevel
             js_of_ocaml.ppx
-            ocplib_i18n)
+            ocplib_i18n
+	    learnocaml_editor_tab)
  (modules Learnocaml_teacher_tab
           Learnocaml_index_main)
  (preprocess (pps ppx_ocplib_i18n js_of_ocaml.ppx))
  (js_of_ocaml
   (flags :standard +cstruct/cstruct.js)
-  (javascript_files ../ace-lib/ace_bindings.js))
+  (javascript_files ../ace-lib/ace_bindings.js ../../static/js/jszip/learnocaml_jszip_wrapper.js))
 )
 
 (executable
@@ -59,7 +61,8 @@
             learnocaml_app_common
             learnocaml_toplevel
             js_of_ocaml.ppx
-            ocplib_i18n)
+	    editor_lib
+	    ocplib_i18n)
  (modules Learnocaml_exercise_main)
  (preprocess (pps ppx_ocplib_i18n js_of_ocaml.ppx))
  (js_of_ocaml

src/app/learnocaml_common.ml

@@ -113,12 +113,12 @@ let ext_alert ~title ?(buttons = [close_button [%i"OK"]]) message =
         Manip.(appendChild Elt.body) div;
         div in
   Manip.replaceChildren div [
-    H.div [
-      H.h3 [ H.txt title ];
-      H.div message;
-      H.div ~a:[ H.a_class ["buttons"] ] buttons;
+      H.div [
+          H.h3 [ H.pcdata title ];
+          H.div message;
+          H.div ~a:[ H.a_class ["buttons"] ] buttons;
+        ]
     ]
-  ]
 
 let lwt_alert ~title ~buttons message =
   let waiter, wakener = Lwt.task () in
@@ -1230,3 +1230,43 @@ module Display_exercise =
                       [ focus ; requirements ; backward ; forward ]
         ])
   end
+
+module Grade_exercise = struct
+
+let get_grade =
+  let get_worker = get_worker_code "learnocaml-grader-worker.js" in
+  fun ?callback ?timeout exercise ->
+    get_worker () >>= fun worker_js_file ->
+    Grading_jsoo.get_grade ~worker_js_file ?callback ?timeout exercise
+
+let display_report exo report =
+  let score, _failed = Report.result report in
+  let report_button = find_component "learnocaml-exo-button-report" in
+  Manip.removeClass report_button "success" ;
+  Manip.removeClass report_button "failure" ;
+  Manip.removeClass report_button "partial" ;
+  let grade =
+    let max = Learnocaml_exercise.(access File.max_score exo) in
+    if max = 0 then 999 else score * 100 / max
+  in
+  if grade >= 100 then begin
+    Manip.addClass report_button "success" ;
+    Manip.replaceChildren report_button
+      Tyxml_js.Html5.[ pcdata [%i"Report"] ]
+  end else if grade = 0 then begin
+    Manip.addClass report_button "failure" ;
+    Manip.replaceChildren report_button
+      Tyxml_js.Html5.[ pcdata [%i"Report"] ]
+  end else begin
+    Manip.addClass report_button "partial" ;
+    let pct = Format.asprintf "%2d%%" grade in
+    Manip.replaceChildren report_button
+      Tyxml_js.Html5.[ pcdata [%i"Report"] ;
+                       span ~a: [ a_class [ "score" ] ] [ pcdata pct ]]
+  end ;
+  let report_container = find_component "learnocaml-exo-tab-report" in
+  Manip.setInnerHtml report_container
+    (Format.asprintf "%a" Report.(output_html ~bare: true) report) ;
+  grade
+
+end

src/app/learnocaml_common.mli

@@ -23,6 +23,14 @@ val fatal : ?title: string -> string -> unit
 
 val alert : ?title: string -> ?buttons: Html_types.div_content Tyxml_js.Html.elt list -> string -> unit
 
+val box_button :
+  string Tyxml_js.Html5.wrap -> (unit -> 'a) ->
+  [> Html_types.button ] Tyxml_js.Html5.elt
+
+val close_button :
+  string Tyxml_js.Html5.wrap ->
+  [> Html_types.button ] Tyxml_js.Html5.elt
+
 val ext_alert :
   title: string ->
   ?buttons: Html_types.div_content_fun Tyxml_js.Html.elt list ->
@@ -277,3 +285,13 @@ module Display_exercise :functor
       'a Learnocaml_data.token option ->
       Learnocaml_data.Exercise.Meta.t -> string -> unit Lwt.t
   end
+
+module Grade_exercise : sig
+  val get_grade :
+    ?callback:(string -> unit) ->
+    ?timeout:float ->
+    Learnocaml_exercise.t ->
+    (string -> (Learnocaml_report.t * string * string * string) Lwt.t) Lwt.t
+  val display_report :
+    Learnocaml_exercise.t -> Learnocaml_data.Report.t -> int
+end

src/app/learnocaml_config.ml

@@ -9,6 +9,7 @@ class type learnocaml_config = object
   method enableTryocaml: bool Js.optdef_prop
   method enableLessons: bool Js.optdef_prop
   method enableExercises: bool Js.optdef_prop
+  method enableEditor: bool Js.optdef_prop
   method enableToplevel: bool Js.optdef_prop
   method enablePlayground: bool Js.optdef_prop
   method txtLoginWelcome: Js.js_string Js.t Js.optdef_prop

src/app/learnocaml_config.mli

@@ -13,6 +13,7 @@ class type learnocaml_config = object
   method enableTryocaml: bool Js.optdef_prop
   method enableLessons: bool Js.optdef_prop
   method enableExercises: bool Js.optdef_prop
+  method enableEditor: bool Js.optdef_prop
   method enableToplevel: bool Js.optdef_prop
   method enablePlayground: bool Js.optdef_prop
   method txtLoginWelcome: Js.js_string Js.t Js.optdef_prop

src/app/learnocaml_exercise_main.ml

@@ -12,6 +12,7 @@ open Lwt.Infix
 open Learnocaml_common
 open Learnocaml_data
 open Learnocaml_config
+open Grade_exercise
 
 module H = Tyxml_js.Html
 
@@ -34,42 +35,6 @@ let check_if_need_refresh has_server =
   else
     Lwt.return_unit
 
-let get_grade =
-  let get_worker = get_worker_code "learnocaml-grader-worker.js" in
-  fun ?callback ?timeout exercise ->
-    get_worker () >>= fun worker_js_file ->
-    Grading_jsoo.get_grade ~worker_js_file ?callback ?timeout exercise
-
-let display_report exo report =
-  let score, _failed = Report.result report in
-  let report_button = find_component "learnocaml-exo-button-report" in
-  Manip.removeClass report_button "success" ;
-  Manip.removeClass report_button "failure" ;
-  Manip.removeClass report_button "partial" ;
-  let grade =
-    let max = Learnocaml_exercise.(access File.max_score exo) in
-    if max = 0 then 999 else score * 100 / max
-  in
-  if grade >= 100 then begin
-    Manip.addClass report_button "success" ;
-    Manip.replaceChildren report_button
-      Tyxml_js.Html5.[ txt [%i"Report"] ]
-  end else if grade = 0 then begin
-    Manip.addClass report_button "failure" ;
-    Manip.replaceChildren report_button
-      Tyxml_js.Html5.[ txt [%i"Report"] ]
-  end else begin
-    Manip.addClass report_button "partial" ;
-    let pct = Format.asprintf "%2d%%" grade in
-    Manip.replaceChildren report_button
-      Tyxml_js.Html5.[ txt [%i"Report"] ;
-                       span ~a: [ a_class [ "score" ] ] [ txt pct ]]
-  end ;
-  let report_container = find_component "learnocaml-exo-tab-report" in
-  Manip.setInnerHtml report_container
-    (Format.asprintf "%a" Report.(output_html ~bare: true) report) ;
-  grade
-
 module Exercise_link =
   struct
     let exercise_link ?(cl = []) id content =
@@ -79,9 +44,9 @@ module Exercise_link =
         ]
         content
   end
-  
-module Display = Display_exercise(Exercise_link)    
-open Display  
+
+module Display = Display_exercise(Exercise_link)
+open Display
 
 let is_readonly = ref false
 
@@ -91,6 +56,13 @@ let make_readonly () =
     [%i"The deadline for this exercise has expired. Any changes you make \
         from now on will remain local only."]
 
+(* experiment button of editor.html redirects to the html associated to this ml
+   to know if we are in this page because of that we decide
+   to put a '.' before the id
+   therefore idEditor looks for a '.' before the id *)
+
+let idEditor s =  not ((Regexp.string_match (Regexp.regexp "^[.]+") s 0) = None)
+
 let () =
   run_async_with_log @@ fun () ->
   set_string_translations_exercises ();
@@ -115,12 +87,27 @@ let () =
   in
   Dom_html.document##.title :=
     Js.string (id ^ " - " ^ "Learn OCaml" ^" v."^ Learnocaml_api.version);
-  let exercise_fetch =
-    token >>= fun token ->
-    retrieve (Learnocaml_api.Exercise (token, id))
+
+  (* if we came from a true exercise we search in the server.
+   In the other case we get the exercise information from the Local storage *)
+  (* FIXME: for debug purposes; to be removed:
+  let ok str = lwt_alert ~title:"TEST1" ~buttons:["OK", (fun () -> Lwt.return_unit)]
+                [ H.p [H.txt (String.trim str)] ] in *)
+  let exercise_fetch = match idEditor id with
+    | false -> token >>= fun token ->
+               retrieve (Learnocaml_api.Exercise (token, id))
+
+    | true -> let proper_id = String.sub id 1 ((String.length id)-1) in
+              let state = Editor_lib.get_editor_state proper_id in
+              (* FIXME: for debug purposes; to be removed:
+              ok state.Editor.metadata.title >>= fun () -> *)
+              let exo = Editor_lib.exo_creator proper_id in
+              Lwt.return (state.Editor.metadata, exo, None)
   in
+
   let after_init top =
     exercise_fetch >>= fun (_meta, exo, _deadline) ->
+
     begin match Learnocaml_exercise.(decipher File.prelude exo) with
       | "" -> Lwt.return true
       | prelude ->
@@ -196,6 +183,18 @@ let () =
   (* ---- main toolbar -------------------------------------------------- *)
   let exo_toolbar = find_component "learnocaml-exo-toolbar" in
   let toolbar_button = button ~container: exo_toolbar ~theme: "light" in
+  let () =
+    if idEditor id then
+      begin
+        let id = String.sub id 1 ((String.length id)-1) in
+        begin toolbar_button
+       ~icon: "upload" [%i"Edit"] @@ fun ()->
+       Dom_html.window##.location##assign
+       (Js.string (api_server ^ "/editor.html#id=" ^ id ^ "&action=open"));
+       Lwt.return_unit
+        end;
+      end
+  in
   begin toolbar_button
       ~icon: "list" [%i"Exercises"] @@ fun () ->
     Dom_html.window##.location##assign
@@ -208,6 +207,7 @@ let () =
   let worker =
     ref (get_grade ~callback exo)
   in
+
   begin toolbar_button
       ~icon: "typecheck" [%i"Compile"] @@ fun () ->
     typecheck true

src/app/learnocaml_index_main.ml

@@ -512,6 +512,11 @@ let teacher_tab token a b () =
   Learnocaml_teacher_tab.teacher_tab token a b () >>= fun div ->
   Lwt.return div
 
+let editor_tab a b () =
+  show_loading[%i"Loading Editor"] @@ fun () ->
+  Learnocaml_editor_tab.editor_tab a b () >>= fun div ->
+  Lwt.return div                                    
+
 let get_stored_token () =
   Learnocaml_local_storage.(retrieve sync_token)
 
@@ -689,7 +694,12 @@ let () =
        then [ "playground", ([%i"Playground"], playground_tab token) ] else []) @
       (match token with
        | Some t when Token.is_teacher t ->
-           [ "teacher", ([%i"Teach"], teacher_tab t) ]
+          [ "teacher", ([%i"Teach"], teacher_tab t) ] @
+        if get_opt config##.enableEditor then
+          [ "editor", ([%i"Editor"], editor_tab) ]
+        else []
+       | None when get_opt config##.enableEditor ->
+          [ "editor", ([%i"Editor"], editor_tab) ]
        | _ -> [])
     in
     let container = El.tab_buttons_container in
@@ -798,8 +808,10 @@ let () =
        H.div ~a:[H.a_style "text-align: center;"]
          [token_disp_div (get_stored_token ())]]
       (fun () ->
-         Lwt.async @@ fun () ->
+        Lwt.async @@ fun () ->
+         let index = Learnocaml_local_storage.(retrieve editor_index) in
          Learnocaml_local_storage.clear ();
+         Learnocaml_local_storage.(store editor_index index);
          reload ();
          Lwt.return_unit)
   in