jon.recoil.org
this repo has no description
Fully remove Assets from the document abstraction
+1
-4
src/document/renderer.ml
+1
-4
src/document/renderer.ml
···
24
type 'a t = {
25
name : string;
26
render : 'a -> Types.Block.t option -> Types.Document.t -> page list;
27
}
28
29
let document_of_page ~syntax v =
···
38
match syntax with
39
| Reason -> Reason.compilation_unit v
40
| OCaml -> ML.compilation_unit v
41
-
42
-
let document_of_asset path (v : Odoc_model.Lang.Asset.t) =
43
-
let url = Url.Path.from_identifier v.name in
44
-
Types.Document.Asset { url; src = path }
···
24
type 'a t = {
25
name : string;
26
render : 'a -> Types.Block.t option -> Types.Document.t -> page list;
27
+
filepath : 'a -> Url.Path.t -> Fpath.t;
28
}
29
30
let document_of_page ~syntax v =
···
39
match syntax with
40
| Reason -> Reason.compilation_unit v
41
| OCaml -> ML.compilation_unit v
+1
-6
src/document/types.ml
+1
-6
src/document/types.ml
···
196
end =
197
Source_page
198
199
-
and Asset : sig
200
-
type t = { url : Url.Path.t; src : Fpath.t }
201
-
end =
202
-
Asset
203
-
204
module Document = struct
205
-
type t = Page of Page.t | Source_page of Source_page.t | Asset of Asset.t
206
end
207
208
let inline ?(attr = []) desc = Inline.{ attr; desc }
+3
-21
src/html/generator.ml
+3
-21
src/html/generator.ml
···
535
if Config.as_json config then
536
Html_fragment_json.make_src ~config ~url ~breadcrumbs [ doc ]
537
else Html_page.make_src ~breadcrumbs ~header ~config ~url title [ doc ]
538
-
539
-
let asset ~config { Asset.url; src } =
540
-
let filename = Link.Path.as_filename ~is_flat:(Config.flat config) url in
541
-
let content ppf =
542
-
let ic = open_in_bin (Fpath.to_string src) in
543
-
let len = 1024 in
544
-
let buf = Bytes.create len in
545
-
let rec loop () =
546
-
let read = input ic buf 0 len in
547
-
if read = len then (
548
-
Format.fprintf ppf "%s" (Bytes.to_string buf);
549
-
loop ())
550
-
else if len > 0 then
551
-
let buf = Bytes.sub buf 0 read in
552
-
Format.fprintf ppf "%s" (Bytes.to_string buf)
553
-
in
554
-
loop ();
555
-
close_in ic
556
-
in
557
-
{ Odoc_document.Renderer.filename; content; children = [] }
558
end
559
560
let render ~config ~sidebar = function
561
| Document.Page page -> [ Page.page ~config ~sidebar page ]
562
| Source_page src -> [ Page.source_page ~config src ]
563
-
| Asset asset -> [ Page.asset ~config asset ]
564
565
let doc ~config ~xref_base_uri b =
566
let resolve = Link.Base xref_base_uri in
···
535
if Config.as_json config then
536
Html_fragment_json.make_src ~config ~url ~breadcrumbs [ doc ]
537
else Html_page.make_src ~breadcrumbs ~header ~config ~url title [ doc ]
538
end
539
540
let render ~config ~sidebar = function
541
| Document.Page page -> [ Page.page ~config ~sidebar page ]
542
| Source_page src -> [ Page.source_page ~config src ]
543
+
544
+
let filepath ~config url =
545
+
Link.Path.as_filename ~is_flat:(Config.flat config) url
546
547
let doc ~config ~xref_base_uri b =
548
let resolve = Link.Base xref_base_uri in
+2
src/html/generator.mli
+2
src/html/generator.mli
+5
-3
src/latex/generator.ml
+5
-3
src/latex/generator.ml
···
40
( List.map segment_to_string dir,
41
String.concat "." (List.map segment_to_string file) )
42
43
-
let filename url =
44
let dir, file = get_dir_and_file url in
45
let file = Fpath.(v (String.concat dir_sep (dir @ [ file ]))) in
46
-
Fpath.(add_ext "tex" file)
47
end
48
49
let style = function
···
477
478
let render ~with_children = function
479
| Document.Page page -> [ Page.page ~with_children page ]
480
-
| Source_page _ | Asset _ -> []
···
40
( List.map segment_to_string dir,
41
String.concat "." (List.map segment_to_string file) )
42
43
+
let filename ?(add_ext = true) url =
44
let dir, file = get_dir_and_file url in
45
let file = Fpath.(v (String.concat dir_sep (dir @ [ file ]))) in
46
+
if add_ext then Fpath.add_ext "tex" file else file
47
end
48
49
let style = function
···
477
478
let render ~with_children = function
479
| Document.Page page -> [ Page.page ~with_children page ]
480
+
| Source_page _ -> []
481
+
482
+
let filepath url = Link.filename ~add_ext:false url
+2
src/latex/generator.mli
+2
src/latex/generator.mli
+3
-1
src/manpage/generator.ml
+3
-1
src/manpage/generator.ml
+2
src/manpage/generator.mli
+2
src/manpage/generator.mli
+2
-2
src/manpage/link.ml
+2
-2
src/manpage/link.ml
···
7
| `Module | `Page | `LeafPage | `Class -> name
8
| _ -> Format.asprintf "%a-%s" Odoc_document.Url.Path.pp_kind kind name
9
10
-
let as_filename (url : Url.Path.t) =
11
let components = Url.Path.to_list url in
12
let dir, path =
13
Url.Path.split
···
17
let dir = List.map segment_to_string dir in
18
let path = String.concat "." (List.map segment_to_string path) in
19
let str_path = String.concat Fpath.dir_sep (dir @ [ path ]) in
20
-
Fpath.(v str_path + ".3o")
21
22
let rec is_class_or_module_path (url : Url.Path.t) =
23
match url.kind with
···
7
| `Module | `Page | `LeafPage | `Class -> name
8
| _ -> Format.asprintf "%a-%s" Odoc_document.Url.Path.pp_kind kind name
9
10
+
let as_filename ?(add_ext = true) (url : Url.Path.t) =
11
let components = Url.Path.to_list url in
12
let dir, path =
13
Url.Path.split
···
17
let dir = List.map segment_to_string dir in
18
let path = String.concat "." (List.map segment_to_string path) in
19
let str_path = String.concat Fpath.dir_sep (dir @ [ path ]) in
20
+
if add_ext then Fpath.(v str_path + ".3o") else Fpath.v str_path
21
22
let rec is_class_or_module_path (url : Url.Path.t) =
23
match url.kind with
+34
-11
src/odoc/fs.ml
+34
-11
src/odoc/fs.ml
···
21
22
type file = Fpath.t
23
24
module File = struct
25
type t = file
26
···
92
Result.Error (`Msg err)
93
with Sys_error e -> Result.Error (`Msg e)
94
95
let exists file = Sys.file_exists (Fpath.to_string file)
96
97
let rec of_segs_tl acc = function
···
140
141
let contains ~parentdir f = Fpath.is_rooted ~root:parentdir f
142
143
-
let mkdir_p dir =
144
-
let mkdir d =
145
-
try Unix.mkdir (Fpath.to_string d) 0o755 with
146
-
| Unix.Unix_error (Unix.EEXIST, _, _) -> ()
147
-
| exn -> raise exn
148
-
in
149
-
let rec dirs_to_create p acc =
150
-
if Sys.file_exists (Fpath.to_string p) then acc
151
-
else dirs_to_create (Fpath.parent p) (p :: acc)
152
-
in
153
-
List.iter (dirs_to_create dir []) ~f:mkdir
154
155
let to_string = Fpath.to_string
156
···
21
22
type file = Fpath.t
23
24
+
let mkdir_p dir =
25
+
let mkdir d =
26
+
try Unix.mkdir (Fpath.to_string d) 0o755 with
27
+
| Unix.Unix_error (Unix.EEXIST, _, _) -> ()
28
+
| exn -> raise exn
29
+
in
30
+
let rec dirs_to_create p acc =
31
+
if Sys.file_exists (Fpath.to_string p) then acc
32
+
else dirs_to_create (Fpath.parent p) (p :: acc)
33
+
in
34
+
List.iter (dirs_to_create dir []) ~f:mkdir
35
+
36
module File = struct
37
type t = file
38
···
104
Result.Error (`Msg err)
105
with Sys_error e -> Result.Error (`Msg e)
106
107
+
let copy ~src ~dst =
108
+
let with_ open_ close filename f =
109
+
let c = open_ (Fpath.to_string filename) in
110
+
Odoc_utils.Fun.protect ~finally:(fun () -> close c) (fun () -> f c)
111
+
in
112
+
let with_ic = with_ open_in_bin close_in_noerr in
113
+
let with_oc = with_ open_out_bin close_out_noerr in
114
+
try
115
+
with_ic src (fun ic ->
116
+
mkdir_p (dirname dst);
117
+
with_oc dst (fun oc ->
118
+
let len = 1024 in
119
+
let buf = Bytes.create len in
120
+
let rec loop () =
121
+
let read = input ic buf 0 len in
122
+
output oc buf 0 read;
123
+
if read = len then loop ()
124
+
in
125
+
Ok (loop ())))
126
+
with Sys_error e -> Result.Error (`Msg e)
127
+
128
let exists file = Sys.file_exists (Fpath.to_string file)
129
130
let rec of_segs_tl acc = function
···
173
174
let contains ~parentdir f = Fpath.is_rooted ~root:parentdir f
175
176
+
let mkdir_p dir = mkdir_p dir
177
178
let to_string = Fpath.to_string
179
+2
src/odoc/fs.mli
+2
src/odoc/fs.mli
+4
-1
src/odoc/html_page.ml
+4
-1
src/odoc/html_page.ml
+3
-1
src/odoc/latex.ml
+3
-1
src/odoc/latex.ml
+3
-1
src/odoc/man_page.ml
+3
-1
src/odoc/man_page.ml
+10
-4
src/odoc/rendering.ml
+10
-4
src/odoc/rendering.ml
···
42
match doc with
43
| Odoc_document.Types.Document.Page { url; _ } -> url
44
| Source_page { url; _ } -> url
45
-
| Asset { url; _ } -> url
46
in
47
let sidebar =
48
Odoc_utils.Option.map
···
120
Odoc_file.load file >>= fun unit ->
121
match unit.content with
122
| Odoc_file.Asset_content unit ->
123
-
let doc = Renderer.document_of_asset asset_file unit in
124
-
render_document renderer ~output ~sidebar:None ~extra_suffix ~extra doc;
125
-
Ok ()
126
| Page_content _ | Unit_content _ | Impl_content _ ->
127
Error (`Msg "Expected an asset unit")
128
···
42
match doc with
43
| Odoc_document.Types.Document.Page { url; _ } -> url
44
| Source_page { url; _ } -> url
45
in
46
let sidebar =
47
Odoc_utils.Option.map
···
119
Odoc_file.load file >>= fun unit ->
120
match unit.content with
121
| Odoc_file.Asset_content unit ->
122
+
let url = Odoc_document.Url.Path.from_identifier unit.name in
123
+
let filename = renderer.Renderer.filepath extra url in
124
+
let filename =
125
+
match extra_suffix with
126
+
| Some s -> Fpath.add_ext s filename
127
+
| None -> filename
128
+
in
129
+
130
+
let dst = Fs.File.append output filename in
131
+
Fs.File.copy ~src:asset_file ~dst
132
| Page_content _ | Unit_content _ | Impl_content _ ->
133
Error (`Msg "Expected an asset unit")
134
+19
src/utils/odoc_utils.ml
+19
src/utils/odoc_utils.ml
···
80
module Option = struct
81
let map f = function None -> None | Some x -> Some (f x)
82
end
83
+
84
+
module Fun = struct
85
+
include Fun
86
+
let protect ~(finally : unit -> unit) work =
87
+
let finally_no_exn () =
88
+
try finally ()
89
+
with e ->
90
+
let bt = Printexc.get_raw_backtrace () in
91
+
Printexc.raise_with_backtrace (Finally_raised e) bt
92
+
in
93
+
match work () with
94
+
| result ->
95
+
finally_no_exn ();
96
+
result
97
+
| exception work_exn ->
98
+
let work_bt = Printexc.get_raw_backtrace () in
99
+
finally_no_exn ();
100
+
Printexc.raise_with_backtrace work_exn work_bt
101
+
end