Complete odoc extract-code

Author: panglesd

src/odoc/bin/main.ml

@@ -1690,21 +1690,18 @@ module Extract_code = struct
     Arg.(value & flag & info ~doc [ "line-directives" ])
 
   let names =
-    let doc = "From which name of code blocks to extract content" in
+    let doc =
+      "From which name(s) of code blocks to extract content. When no names are \
+       provided, extract all OCaml code blocks."
+    in
     Arg.(value & opt_all string [] & info ~doc [ "name" ])
 
   let input =
-    let doc = "Input $(i,.cmti), $(i,.cmt), $(i,.cmi) or $(i,.mld) file." in
+    let doc = "Input $(i,.mld) file." in
     Arg.(required & pos 0 (some file) None & info ~doc ~docv:"FILE" [])
 
   let dst =
-    let doc =
-      "Output file path. Non-existing intermediate directories are created. If \
-       absent outputs a $(i,BASE.odoc) file in the same directory as the input \
-       file where $(i,BASE) is the basename of the input file. For mld files \
-       the \"page-\" prefix will be added if not already present in the input \
-       basename."
-    in
+    let doc = "Output file path." in
     Arg.(
       value
       & opt (some string) None
@@ -1718,8 +1715,7 @@ module Extract_code = struct
   let info ~docs =
     Term.info "extract-code" ~docs
       ~doc:
-        "Classify the modules into libraries based on heuristics. Libraries \
-         are specified by the --library option."
+        "Extract code blocks from mld files in order to be able to execute them"
 end
 
 let section_pipeline = "COMMANDS: Compilation pipeline"

src/odoc/extract_code.ml

@@ -11,17 +11,18 @@ let tags_included_in_names names tags =
     fields
 
 let needs_extraction names meta =
-  let check_language l = String.equal "ocaml" l.Loc.value in
-  let check_name tags =
-    if List.is_empty names then true
-    else
-      match tags with
-      | None -> false
-      | Some tags -> tags_included_in_names names tags.Loc.value
+  let check_language () =
+    match meta with
+    | None -> true
+    | Some { Ast.language; _ } -> String.equal "ocaml" language.Loc.value
   in
-  match meta with
-  | None -> false
-  | Some meta -> check_language meta.Ast.language && check_name meta.tags
+  let check_name () =
+    match meta with
+    | Some { Ast.tags = Some tags; _ } ->
+        tags_included_in_names names tags.Loc.value
+    | _ -> false
+  in
+  match names with [] -> check_language () | _ :: _ -> check_name ()
 
 let print oc line_directives location value =
   if line_directives then (

test/extract_code/mld_extraction.t/run.t

@@ -1,15 +1,51 @@
-Without --name argument, all OCaml code blocks are extracted
+----------- Names ---------------------------------------------
+
+Without --name argument, all **OCaml** code blocks are extracted
 
   $ odoc extract-code main.mld
+  
+  (** By default, an odoc code block is assumed to contain OCaml code *)
+  let () = ()
   let x = 5
      let () = print_int x
 
      let y = x + 6. (* This is a typing error *)
 
 
+With --name argument, language does not matter
+
+  $ odoc extract-code --name c-quine main.mld
+  
+  #include <stdio.h>
+  int main(){
+  char*a="#include <stdio.h>%cint main(){char*a=%c%s%c;printf(a,10,34,a,34);}";
+  printf(a,10,34,a,34);
+  }
+
+Multiple name can be given
+
+  $ odoc extract-code --line-directives --name error.ml --name printing main.mld
+  #18 "main.mld"
+                                       let x = 5
+  #20 "main.mld"
+                            
+     let () = print_int x
+    
+  #25 "main.mld"
+                            
+     let y = x + 6. (* This is a typing error *)
+     
+
+------- Line directives ---------------------------------------
+
 We can add (OCaml) line directives
 
   $ odoc extract-code --line-directives main.mld
+  #5 "main.mld"
+     
+  (** By default, an odoc code block is assumed to contain OCaml code *)
+  let () = ()
+  
   #18 "main.mld"
                                        let x = 5
   #20 "main.mld"
@@ -21,7 +57,7 @@ We can add (OCaml) line directives
      let y = x + 6. (* This is a typing error *)
 
 
-We can restrict to a named code blocks
+Let's restrict to a named code blocks
 
   $ odoc extract-code --line-directives --name error.ml main.mld
   #18 "main.mld"
@@ -56,24 +92,3 @@ Here is the line 26, and the characters 15-17:
      let y = x + 6. (* This is a typing error *)
   $ sed -n '26p' main.mld | cut -c15-17
    6.
-
-We can get content from multiple names
-
-  $ odoc extract-code --line-directives --name error.ml --name printing main.mld
-  #18 "main.mld"
-                                       let x = 5
-  #20 "main.mld"
-                            
-     let () = print_int x
-    
-  #25 "main.mld"
-                            
-     let y = x + 6. (* This is a typing error *)
-     
-  $ odoc extract-code --line-directives --name error.ml --name printing -o names.ml main.mld
-  $ ocaml names.ml
-  File "main.mld", line 26, characters 15-17:
-  Error: This expression has type "float" but an expression was expected of type
-           "int"
-  5
-  [2]