Skip to content

Commit c77755f

Browse files
committed
change from 'of_string' -> 'make_std'
Signed-off-by: lubegasimon <[email protected]>
1 parent 817de31 commit c77755f

File tree

20 files changed

+128
-136
lines changed

20 files changed

+128
-136
lines changed

src/loader/cmi.ml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ let read_value_description env parent id vd =
526526
let read_label_declaration env parent ld =
527527
let open TypeDecl.Field in
528528
let name = Ident.name ld.ld_id in
529-
let id = `Field(parent, Odoc_model.Names.FieldName.of_string name) in
529+
let id = `Field(parent, Odoc_model.Names.FieldName.make_std name) in
530530
let doc =
531531
Doc_attr.attached
532532
(parent :> Identifier.LabelParent.t) ld.ld_attributes
@@ -552,7 +552,7 @@ let read_constructor_declaration_arguments env parent arg =
552552
let read_constructor_declaration env parent cd =
553553
let open TypeDecl.Constructor in
554554
let name = Ident.name cd.cd_id in
555-
let id = `Constructor(parent, Odoc_model.Names.ConstructorName.of_string name) in
555+
let id = `Constructor(parent, Odoc_model.Names.ConstructorName.make_std name) in
556556
let container = (parent : Identifier.DataType.t :> Identifier.LabelParent.t) in
557557
let doc = Doc_attr.attached container cd.cd_attributes in
558558
let args =
@@ -642,7 +642,7 @@ let read_type_declaration env parent id decl =
642642
let read_extension_constructor env parent id ext =
643643
let open Extension.Constructor in
644644
let name = Ident.name id in
645-
let id = `Extension(parent, Odoc_model.Names.ExtensionName.of_string name) in
645+
let id = `Extension(parent, Odoc_model.Names.ExtensionName.make_std name) in
646646
let container = (parent : Identifier.Signature.t :> Identifier.LabelParent.t) in
647647
let doc = Doc_attr.attached container ext.ext_attributes in
648648
let args =
@@ -675,7 +675,7 @@ let read_type_extension env parent id ext rest =
675675
let read_exception env parent id ext =
676676
let open Exception in
677677
let name = Ident.name id in
678-
let id = `Exception(parent, Odoc_model.Names.ExceptionName.of_string name) in
678+
let id = `Exception(parent, Odoc_model.Names.ExceptionName.make_std name) in
679679
let container = (parent : Identifier.Signature.t :> Identifier.LabelParent.t) in
680680
let doc = Doc_attr.attached container ext.ext_attributes in
681681
mark_exception ext;
@@ -688,7 +688,7 @@ let read_exception env parent id ext =
688688

689689
let read_method env parent concrete (name, kind, typ) =
690690
let open Method in
691-
let id = `Method(parent, Odoc_model.Names.MethodName.of_string name) in
691+
let id = `Method(parent, Odoc_model.Names.MethodName.make_std name) in
692692
let doc = Doc_attr.empty in
693693
let private_ = (Btype.field_kind_repr kind) <> Fpresent in
694694
let virtual_ = not (Concr.mem name concrete) in
@@ -697,7 +697,7 @@ let read_method env parent concrete (name, kind, typ) =
697697

698698
let read_instance_variable env parent (name, mutable_, virtual_, typ) =
699699
let open InstanceVariable in
700-
let id = `InstanceVariable(parent, Odoc_model.Names.InstanceVariableName.of_string name) in
700+
let id = `InstanceVariable(parent, Odoc_model.Names.InstanceVariableName.make_std name) in
701701
let doc = Doc_attr.empty in
702702
let mutable_ = (mutable_ = Mutable) in
703703
let virtual_ = (virtual_ = Virtual) in
@@ -837,7 +837,7 @@ let rec read_module_type env parent (mty : Odoc_model.Compat.module_type) =
837837
| Some id -> Ident.name id, Env.add_parameter parent id (ParameterName.of_ident id) env
838838
| None -> "_", env
839839
in
840-
let id = `Parameter(parent, Odoc_model.Names.ParameterName.of_string name) in
840+
let id = `Parameter(parent, Odoc_model.Names.ParameterName.make_std name) in
841841
let arg = read_module_type env id arg in
842842
Odoc_model.Lang.FunctorParameter.Named ({ FunctorParameter. id; expr = arg }), env
843843
in
@@ -984,7 +984,7 @@ and read_signature env parent (items : Odoc_model.Compat.signature) =
984984

985985

986986
let read_interface root name intf =
987-
let id = `Root(root, Odoc_model.Names.ModuleName.of_string name) in
987+
let id = `Root(root, Odoc_model.Names.ModuleName.make_std name) in
988988
let doc = Doc_attr.empty in
989989
let items = read_signature Env.empty id intf in
990990
(id, doc, items)

src/loader/cmt.ml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ let rec read_class_type_field env parent ctf =
127127
match ctf.ctf_desc with
128128
| Tctf_val(name, mutable_, virtual_, typ) ->
129129
let open InstanceVariable in
130-
let id = `InstanceVariable(parent, InstanceVariableName.of_string name) in
130+
let id = `InstanceVariable(parent, InstanceVariableName.make_std name) in
131131
let mutable_ = (mutable_ = Mutable) in
132132
let virtual_ = (virtual_ = Virtual) in
133133
let type_ = read_core_type env typ in
134134
Some (InstanceVariable {id; doc; mutable_; virtual_; type_})
135135
| Tctf_method(name, private_, virtual_, typ) ->
136136
let open Method in
137-
let id = `Method(parent, MethodName.of_string name) in
137+
let id = `Method(parent, MethodName.make_std name) in
138138
let private_ = (private_ = Private) in
139139
let virtual_ = (virtual_ = Virtual) in
140140
let type_ = read_core_type env typ in
@@ -207,7 +207,7 @@ let rec read_class_field env parent cf =
207207
match cf.cf_desc with
208208
| Tcf_val({txt = name; _}, mutable_, _, kind, _) ->
209209
let open InstanceVariable in
210-
let id = `InstanceVariable(parent, InstanceVariableName.of_string name) in
210+
let id = `InstanceVariable(parent, InstanceVariableName.make_std name) in
211211
let mutable_ = (mutable_ = Mutable) in
212212
let virtual_, type_ =
213213
match kind with
@@ -219,7 +219,7 @@ let rec read_class_field env parent cf =
219219
Some (InstanceVariable {id; doc; mutable_; virtual_; type_})
220220
| Tcf_method({txt = name; _}, private_, kind) ->
221221
let open Method in
222-
let id = `Method(parent, MethodName.of_string name) in
222+
let id = `Method(parent, MethodName.make_std name) in
223223
let private_ = (private_ = Private) in
224224
let virtual_, type_ =
225225
match kind with
@@ -348,7 +348,7 @@ let rec read_module_expr env parent label_parent mexpr =
348348
| Some id -> Ident.name id, Env.add_parameter parent id (ParameterName.of_ident id) env
349349
| None -> "_", env
350350
in
351-
let id = `Parameter(parent, Odoc_model.Names.ParameterName.of_string name) in
351+
let id = `Parameter(parent, Odoc_model.Names.ParameterName.make_std name) in
352352
let arg = Cmti.read_module_type env id label_parent arg in
353353

354354
Named { id; expr=arg }, env
@@ -551,7 +551,7 @@ and read_structure env parent str =
551551
{ items = List.rev items; compiled=false }
552552

553553
let read_implementation root name impl =
554-
let id = `Root(root, Odoc_model.Names.ModuleName.of_string name) in
554+
let id = `Root(root, Odoc_model.Names.ModuleName.make_std name) in
555555
let sg = read_structure Env.empty id impl in
556556
let doc, sg =
557557
let open Signature in

src/loader/cmti.ml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ let read_label_declaration env parent label_parent ld =
188188
let open TypeDecl.Field in
189189
let open Odoc_model.Names in
190190
let name = Ident.name ld.ld_id in
191-
let id = `Field(parent, FieldName.of_string name) in
191+
let id = `Field(parent, FieldName.make_std name) in
192192
let doc = Doc_attr.attached label_parent ld.ld_attributes in
193193
let mutable_ = (ld.ld_mutable = Mutable) in
194194
let type_ = read_core_type env label_parent ld.ld_type in
@@ -210,7 +210,7 @@ let read_constructor_declaration env parent cd =
210210
let open TypeDecl.Constructor in
211211
let open Odoc_model.Names in
212212
let name = Ident.name cd.cd_id in
213-
let id = `Constructor(parent, ConstructorName.of_string name) in
213+
let id = `Constructor(parent, ConstructorName.make_std name) in
214214
let container = (parent : Identifier.DataType.t :> Identifier.Parent.t) in
215215
let label_container = (container :> Identifier.LabelParent.t) in
216216
let doc = Doc_attr.attached label_container cd.cd_attributes in
@@ -283,7 +283,7 @@ let read_extension_constructor env parent ext =
283283
let open Extension.Constructor in
284284
let open Odoc_model.Names in
285285
let name = Ident.name ext.ext_id in
286-
let id = `Extension(parent, ExtensionName.of_string name) in
286+
let id = `Extension(parent, ExtensionName.make_std name) in
287287
let container = (parent : Identifier.Signature.t :> Identifier.Parent.t) in
288288
let label_container = (container :> Identifier.LabelParent.t) in
289289
let doc = Doc_attr.attached label_container ext.ext_attributes in
@@ -313,7 +313,7 @@ let read_exception env parent (ext : extension_constructor) =
313313
let open Exception in
314314
let open Odoc_model.Names in
315315
let name = Ident.name ext.ext_id in
316-
let id = `Exception(parent, ExceptionName.of_string name) in
316+
let id = `Exception(parent, ExceptionName.make_std name) in
317317
let container = (parent : Identifier.Signature.t :> Identifier.Parent.t) in
318318
let label_container = (container :> Identifier.LabelParent.t) in
319319
let doc = Doc_attr.attached label_container ext.ext_attributes in
@@ -336,14 +336,14 @@ let rec read_class_type_field env parent ctf =
336336
match ctf.ctf_desc with
337337
| Tctf_val(name, mutable_, virtual_, typ) ->
338338
let open InstanceVariable in
339-
let id = `InstanceVariable(parent, InstanceVariableName.of_string name) in
339+
let id = `InstanceVariable(parent, InstanceVariableName.make_std name) in
340340
let mutable_ = (mutable_ = Mutable) in
341341
let virtual_ = (virtual_ = Virtual) in
342342
let type_ = read_core_type env container typ in
343343
Some (InstanceVariable {id; doc; mutable_; virtual_; type_})
344344
| Tctf_method(name, private_, virtual_, typ) ->
345345
let open Method in
346-
let id = `Method(parent, MethodName.of_string name) in
346+
let id = `Method(parent, MethodName.make_std name) in
347347
let private_ = (private_ = Private) in
348348
let virtual_ = (virtual_ = Virtual) in
349349
let type_ = read_core_type env container typ in
@@ -487,7 +487,7 @@ and read_module_type env parent label_parent mty =
487487
Ident.name id, Env.add_parameter parent id (ParameterName.of_ident id) env
488488
| None -> "_", env
489489
in
490-
let id = `Parameter(parent, ParameterName.of_string name) in
490+
let id = `Parameter(parent, ParameterName.make_std name) in
491491
let arg = read_module_type env id label_parent arg in
492492
Named { id; expr = arg; }, env
493493
in
@@ -500,7 +500,7 @@ and read_module_type env parent label_parent mty =
500500
| None -> Odoc_model.Lang.FunctorParameter.Unit
501501
| Some arg ->
502502
let name = Ident.name id in
503-
let id = `Parameter(parent, Odoc_model.Names.ParameterName.of_string name) in
503+
let id = `Parameter(parent, Odoc_model.Names.ParameterName.make_std name) in
504504
let arg = read_module_type env id label_parent arg in
505505
Named { FunctorParameter. id; expr = arg }
506506
in
@@ -719,7 +719,7 @@ and read_signature env parent sg =
719719
{ items = List.rev items; compiled=false }
720720

721721
let read_interface root name intf =
722-
let id = `Root(root, Odoc_model.Names.ModuleName.of_string name) in
722+
let id = `Root(root, Odoc_model.Names.ModuleName.make_std name) in
723723
let sg = read_signature Env.empty id intf in
724724
let doc, sg =
725725
let open Signature in

src/loader/odoc_loader.ml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ let read_cmt ~make_root ~parent ~filename () =
113113
| Ok root -> root
114114
| Error (`Msg m) -> error_msg filename m
115115
in
116-
let id = `Root(parent, Odoc_model.Names.ModuleName.of_string name) in
116+
let id = `Root(parent, Odoc_model.Names.ModuleName.make_std name) in
117117
let items =
118118
List.map (fun file ->
119119
let pref = Misc.chop_extensions file in
@@ -123,7 +123,7 @@ let read_cmt ~make_root ~parent ~filename () =
123123
let items = List.sort String.compare items in
124124
let items =
125125
List.map (fun name ->
126-
let id = `Module(id, Odoc_model.Names.ModuleName.of_string name) in
126+
let id = `Module(id, Odoc_model.Names.ModuleName.make_std name) in
127127
let path = `Root name in
128128
{Odoc_model.Lang.Compilation_unit.Packed.id; path})
129129
items

src/model/ident_env.cppo.ml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ let env_of_items parent items env =
359359
let identifier, shadowed =
360360
if is_shadowed
361361
then `Type(parent, TypeName.internal_of_string name), t :: env.shadowed
362-
else `Type(parent, TypeName.of_string name), env.shadowed
362+
else `Type(parent, TypeName.make_std name), env.shadowed
363363
in
364364
let types = Ident.add t identifier env.types in
365365
inner rest { env with types; shadowed }
@@ -370,7 +370,7 @@ let env_of_items parent items env =
370370
let identifier, shadowed =
371371
if is_shadowed
372372
then `Value(parent, ValueName.internal_of_string name), t :: env.shadowed
373-
else `Value(parent, ValueName.of_string name), env.shadowed
373+
else `Value(parent, ValueName.make_std name), env.shadowed
374374
in
375375
let values = Ident.add t identifier env.values in
376376
inner rest { env with values; shadowed }
@@ -381,7 +381,7 @@ let env_of_items parent items env =
381381
let identifier, shadowed =
382382
if is_shadowed
383383
then `ModuleType(parent, ModuleTypeName.internal_of_string name), t :: env.shadowed
384-
else `ModuleType(parent, ModuleTypeName.of_string name), env.shadowed
384+
else `ModuleType(parent, ModuleTypeName.make_std name), env.shadowed
385385
in
386386
let module_types = Ident.add t identifier env.module_types in
387387
inner rest { env with module_types; shadowed }
@@ -391,7 +391,7 @@ let env_of_items parent items env =
391391
let identifier, shadowed =
392392
if is_shadowed
393393
then `Module(parent, ModuleName.internal_of_string name), t :: env.shadowed
394-
else `Module(parent, ModuleName.of_string name), env.shadowed
394+
else `Module(parent, ModuleName.make_std name), env.shadowed
395395
in
396396
let path = `Identifier(identifier, is_shadowed) in
397397
let modules = Ident.add t identifier env.modules in
@@ -403,7 +403,7 @@ let env_of_items parent items env =
403403
let identifier, shadowed =
404404
if is_shadowed
405405
then `Class(parent, ClassName.internal_of_string name), t :: t2 :: t3 :: t4 :: env.shadowed
406-
else `Class(parent, ClassName.of_string name), env.shadowed
406+
else `Class(parent, ClassName.make_std name), env.shadowed
407407
in
408408
let classes =
409409
List.fold_right (fun id classes -> Ident.add id identifier classes)
@@ -415,7 +415,7 @@ let env_of_items parent items env =
415415
let identifier, shadowed =
416416
if is_shadowed
417417
then `ClassType(parent, ClassTypeName.internal_of_string name), t :: t2 :: t3 :: env.shadowed
418-
else `ClassType(parent, ClassTypeName.of_string name), env.shadowed
418+
else `ClassType(parent, ClassTypeName.make_std name), env.shadowed
419419
in
420420
let class_types =
421421
List.fold_right (fun id class_types -> Ident.add id identifier class_types)

src/model/names.ml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ module type Name = sig
2222

2323
val to_string_unsafe : t -> string
2424

25-
val of_string : string -> t
25+
val make_std : string -> t
2626

2727
val of_ident : Ident.t -> t
2828

@@ -52,12 +52,12 @@ module Name : Name = struct
5252

5353
let to_string_unsafe = function Std s -> s | Internal (s, _i) -> s
5454

55-
let of_string s =
55+
let make_std s =
5656
let s = parenthesise s in
5757
if String.length s > 0 && s.[0] = '{' then raise (Invalid_argument s)
5858
else Std s
5959

60-
let of_ident id = of_string (Ident.name id)
60+
let of_ident id = make_std (Ident.name id)
6161

6262
let internal_of_string id =
6363
incr internal_counter;
@@ -95,7 +95,7 @@ module type SimpleName = sig
9595

9696
val to_string : t -> string
9797

98-
val of_string : string -> t
98+
val make_std : string -> t
9999

100100
val of_ident : Ident.t -> t
101101

@@ -113,9 +113,9 @@ module SimpleName : SimpleName = struct
113113

114114
let to_string s = s
115115

116-
let of_string s = s
116+
let make_std s = s
117117

118-
let of_ident id = of_string (Ident.name id)
118+
let of_ident id = make_std (Ident.name id)
119119

120120
let equal (x : t) (y : t) = x = y
121121

src/model/names.mli

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ module type Name = sig
2727
(** [to_string_unsafe] will allow even internal names to be turned into
2828
strings. Use with caution. *)
2929

30-
val of_string : string -> t
30+
val make_std : string -> t
3131

3232
val of_ident : Ident.t -> t
3333

@@ -55,7 +55,7 @@ module type SimpleName = sig
5555

5656
val to_string : t -> string
5757

58-
val of_string : string -> t
58+
val make_std : string -> t
5959

6060
val of_ident : Ident.t -> t
6161

src/model/paths.ml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -858,9 +858,8 @@ module Fragment = struct
858858
| Resolved.Branch (base, m) -> Branch (base, `Resolved m) )
859859
| `Dot (m, name) -> (
860860
match split_parent m with
861-
| Base None -> Branch (ModuleName.of_string name, `Root)
862-
| Base (Some i) ->
863-
Branch (ModuleName.of_string name, `Resolved (`Root i))
861+
| Base None -> Branch (ModuleName.make_std name, `Root)
862+
| Base (Some i) -> Branch (ModuleName.make_std name, `Resolved (`Root i))
864863
| Branch (base, m) -> Branch (base, `Dot (m, name)) )
865864

866865
module Signature = struct

0 commit comments

Comments
 (0)