-
Notifications
You must be signed in to change notification settings - Fork 78
/
Copy pathvscode.mli
2432 lines (1686 loc) · 47.6 KB
/
vscode.mli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
open Interop
val version : string
module Disposable : sig
include Js.T
val from : t list -> t
val make : dispose:(unit -> unit) -> t
val dispose : t -> unit
end
module Command : sig
include Js.T
val title : t -> string
val command : t -> string
val tooltip : t -> string option
val arguments : t -> Js.Any.t list
val create :
title:string
-> command:string
-> ?tooltip:string
-> ?arguments:Js.Any.t list
-> unit
-> t
end
module Position : sig
include Js.T
val make : line:int -> character:int -> t
val line : t -> int
val character : t -> int
val isBefore : t -> other:t -> bool
val isBeforeOrEqual : t -> other:t -> bool
val isAfter : t -> other:t -> bool
val isAfterOrEqual : t -> other:t -> bool
val isEqual : t -> other:t -> bool
val compareTo : t -> other:t -> int
val translate : t -> ?lineDelta:int -> ?characterDelta:int -> unit -> t
val with_ : t -> ?line:int -> ?character:int -> unit -> t
end
module Range : sig
include Js.T
val start : t -> Position.t
val end_ : t -> Position.t
val makePositions : start:Position.t -> end_:Position.t -> t
val makeCoordinates :
startLine:int -> startCharacter:int -> endLine:int -> endCharacter:int -> t
val isEmpty : t -> bool
val isSingleLine : t -> bool
val contains :
t -> positionOrRange:[ `Position of Position.t | `Range of t ] -> bool
val isEqual : t -> other:t -> bool
val intersection : t -> range:t -> t option
val union : t -> other:t -> t
val with_ : t -> ?start:Position.t -> ?end_:Position.t -> unit -> t
end
module TextLine : sig
include Js.T
val lineNumber : t -> int
val text : t -> string
val range : t -> Range.t
val rangeIncludingLineBreak : t -> Range.t
val firstNonWhitespaceCharacterIndex : t -> int
val isEmptyOrWhitespace : t -> bool
val create :
lineNumber:int
-> text:string
-> range:Range.t
-> rangeIncludingLineBreak:Range.t
-> firstNonWhitespaceCharacterIndex:int
-> isEmptyOrWhitespace:bool
-> t
end
module EndOfLine : sig
type t =
| CRLF
| LF
include Js.T with type t := t
end
module TextEdit : sig
include Js.T
val replace : range:Range.t -> newText:string -> t
val insert : position:Position.t -> newText:string -> t
val delete : Range.t -> t
val setEndOfLine : EndOfLine.t -> t
val range : t -> Range.t
val newText : t -> string
val newEol : t -> EndOfLine.t option
val make : range:Range.t -> newText:string -> t
end
module Uri : sig
include Js.T
module Scheme : sig
type t =
[ `File
| `Untitled
(** URI scheme used by vscode for new draft (not-saved) files *)
]
val to_string : t -> string
end
val parse : string -> ?strict:bool -> unit -> t
val file : string -> t
val joinPath : t -> pathSegments:string list -> t
val scheme : t -> string
val authority : t -> string
val path : t -> string
val query : t -> string
val fragment : t -> string
val fsPath : t -> string
val with_ :
t
-> ?scheme:Scheme.t
-> ?authority:string
-> ?path:string
-> ?query:string
-> ?fragment:string
-> unit
-> t
val toString : t -> ?skipEncoding:bool -> unit -> string
val toJson : t -> Jsonoo.t
val equal : t -> t -> bool
end
module TextDocument : sig
include Js.T
val uri : t -> Uri.t
val fileName : t -> string
val isUntitled : t -> bool
val languageId : t -> string
val version : t -> int
val isDirty : t -> bool
val isClosed : t -> bool
val save : t -> bool Promise.t
val eol : t -> EndOfLine.t
val lineCount : t -> int
val lineAt : t -> line:int -> TextLine.t
val lineAtPosition : t -> position:Position.t -> TextLine.t
val offsetAt : t -> position:Position.t -> int
val positionAt : t -> offset:int -> Position.t
val getText : t -> ?range:Range.t -> unit -> string
val getWordRangeAtPosition :
t
-> position:Position.t
-> ?regex:Js_of_ocaml.Regexp.regexp
-> unit
-> Range.t option
val validateRange : t -> range:Range.t -> Range.t
val validatePosition : t -> position:Position.t -> Position.t
end
module WorkspaceFolder : sig
include Js.T
val uri : t -> Uri.t
val name : t -> string
val index : t -> int
val create : uri:Uri.t -> name:string -> index:int -> t
end
module ViewColumn : sig
type t =
| Active
| Beside
| One
| Two
| Three
| Four
| Five
| Six
| Seven
| Eight
| Nine
include Js.T with type t := t
end
module Selection : sig
include module type of Range with type t = private Range.t
val anchor : t -> Position.t
val active : t -> Position.t
val makePositions : anchor:Position.t -> active:Position.t -> t
val makeCoordinates :
anchorLine:int
-> anchorCharacter:int
-> activeLine:int
-> activeCharacter:int
-> t
val isReversed : t -> bool
end
module TextEditorEdit : sig
include Js.T
type replaceLocation =
[ `Position of Position.t
| `Range of Range.t
| `Selection of Selection.t
]
type deleteLocation =
[ `Range of Range.t
| `Selection of Selection.t
]
val replace : t -> location:replaceLocation -> value:string -> unit
val insert : t -> location:Position.t -> value:string -> unit
val delete : t -> location:deleteLocation -> unit
val setEndOfLine : t -> endOfLine:EndOfLine.t -> t
val create :
replace:(location:replaceLocation -> value:string -> unit)
-> insert:(location:Position.t -> value:string -> unit)
-> delete:(location:deleteLocation -> unit)
-> setEndOfLine:(endOfLine:EndOfLine.t -> t)
-> t
end
module TextEditorCursorStyle : sig
type t =
| Line
| Block
| Underline
| LineThin
| BlockOutline
| UnderlineThin
include Js.T with type t := t
end
module TextEditorLineNumbersStyle : sig
type t =
| Off
| On
| Relative
include Js.T with type t := t
end
module TextEditorRevealType : sig
type t =
| Default
| InCenter
| InCenterIfOutsideViewport
| AtTop
include Js.T with type t := t
end
module TextEditorOptions : sig
include Js.T
type tabSize =
[ `Int of int
| `String of string
]
type insertSpaces =
[ `Bool of bool
| `String of string
]
val tabSize : t -> tabSize option
val insertSpaces : t -> insertSpaces option
val cursorStyle : t -> TextEditorCursorStyle.t option
val lineNumbers : t -> TextEditorLineNumbersStyle.t option
val create :
?tabSize:tabSize
-> ?insertSpaces:insertSpaces
-> ?cursorStyle:TextEditorCursorStyle.t
-> ?lineNumbers:TextEditorLineNumbersStyle.t
-> unit
-> t
end
module TextEditorDecorationType : sig
include Js.T
val key : t -> string
val dispose : t -> unit
val disposable : t -> Disposable.t
val create : key:string -> dispose:(unit -> unit) -> t
end
module MarkdownString : sig
include Js.T
val value : t -> string
val isTrusted : t -> bool option
val supportThemeIcons : t -> bool option
val make : ?value:string -> ?supportThemeIcons:bool -> unit -> t
val appendText : t -> value:string -> t
val appendMarkdown : t -> value:string -> t
val appendCodeblock : t -> value:string -> ?language:string -> unit -> t
end
module ThemeColor : sig
include Js.T
val make : id:string -> t
end
module ThemableDecorationAttachmentRenderOptions : sig
include Js.T
type contentIconPath =
[ `String of string
| `Uri of Uri.t
]
type color =
[ `String of string
| `ThemeColor of ThemeColor.t
]
val contentText : t -> string option
val contentIconPath : t -> contentIconPath option
val border : t -> string option
val borderColor : t -> color option
val fontStyle : t -> string option
val fontWeight : t -> string option
val textDecoration : t -> string option
val color : t -> color option
val backgroundColor : t -> color option
val margin : t -> string option
val width : t -> string option
val height : t -> string option
val create :
?contentText:string
-> ?contentIconPath:contentIconPath
-> ?border:string
-> ?borderColor:color
-> ?fontStyle:string
-> ?fontWeight:string
-> ?textDecoration:string
-> ?color:color
-> ?backgroundColor:color
-> ?margin:string
-> ?width:string
-> ?height:string
-> unit
-> t
end
module ThemableDecorationInstanceRenderOptions : sig
include Js.T
val before : t -> ThemableDecorationAttachmentRenderOptions.t option
val after : t -> ThemableDecorationAttachmentRenderOptions.t option
val create :
?before:ThemableDecorationAttachmentRenderOptions.t
-> ?after:ThemableDecorationAttachmentRenderOptions.t
-> unit
-> t
end
module DecorationInstanceRenderOptions : sig
include Js.T
val light : t -> ThemableDecorationInstanceRenderOptions.t option
val dark : t -> ThemableDecorationInstanceRenderOptions.t option
val create :
?light:ThemableDecorationInstanceRenderOptions.t
-> ?dark:ThemableDecorationInstanceRenderOptions.t
-> unit
-> t
end
module DecorationOptions : sig
include Js.T
type hoverMessage =
[ `MarkdownString of MarkdownString.t
| `MarkdownStrings of MarkdownString.t list
]
val range : t -> Range.t
val hoverMessage : t -> hoverMessage option
val renderOptions : t -> DecorationInstanceRenderOptions.t option
val create :
range:Range.t
-> ?hoverMessage:hoverMessage
-> ?renderOptions:DecorationInstanceRenderOptions.t option
-> unit
-> t
end
module SnippetString : sig
include Js.T
val value : t -> string
val make : ?value:string -> unit -> t
val appendText : t -> string:string -> t
val appendTabStop : t -> number:int -> t
val appendPlaceHolder :
t
-> value:[ `String of string | `Function of t -> unit ]
-> ?number:int
-> unit
-> t
val appendChoice : t -> values:string list -> ?number:int -> unit -> t
val appendVariable :
t
-> name:string
-> defaultValue:[ `String of string | `Function of t -> unit ]
-> t
end
module TextEditor : sig
include Js.T
type insertSnippetLocation =
[ `Position of Position.t
| `Range of Range.t
| `Positions of Position.t list
| `Ranges of Range.t list
]
val document : t -> TextDocument.t
val selection : t -> Selection.t
val set_selection : t -> Selection.t -> unit
val selections : t -> Selection.t list
val visibleRanges : t -> Range.t list
val options : t -> TextEditorOptions.t
val viewColumn : t -> ViewColumn.t option
val edit :
t
-> callback:(editBuilder:TextEditorEdit.t -> unit)
-> ?undoStopBefore:bool
-> ?undoStopAfter:bool
-> unit
-> bool Promise.t
val insertSnippet :
t
-> snippet:SnippetString.t
-> ?location:insertSnippetLocation
-> ?undoStopBefore:bool
-> ?undoStopAfter:bool
-> unit
-> bool Promise.t
val setDecorations :
t
-> decorationType:TextEditorDecorationType.t
-> rangesOrOptions:
[ `Ranges of Range.t list | `Options of DecorationOptions.t list ]
-> unit
val revealRange :
t -> range:Range.t -> ?revealType:TextEditorRevealType.t -> unit -> unit
end
module ConfigurationTarget : sig
type t =
| Global
| Workspace
| WorkspaceFolder
include Js.T with type t := t
end
module WorkspaceConfiguration : sig
include Js.T
type 'a inspectResult =
{ key : string
; defaultValue : 'a option
; globalValue : 'a option
; workspaceValue : 'a option
; workspaceFolderValue : 'a option
; defaultLanguageValue : 'a option
; globalLanguageValue : 'a option
; workspaceLanguageValue : 'a option
; workspaceFolderLanguageValue : 'a option
; languageIds : string list option
}
val get : t -> section:string -> Js.Any.t option
val get_default : 'a Js.t -> t -> section:string -> defaultValue:'a -> 'a
val has : t -> section:string -> bool
val inspect : 'a Js.t -> t -> section:string -> 'a inspectResult option
val update :
t
-> section:string
-> value:Js.Any.t
-> ?configurationTarget:
[ `ConfigurationTarget of ConfigurationTarget.t | `Bool of bool ]
-> ?overrideInLanguage:bool
-> unit
-> Promise.void
end
module WorkspaceEdit : sig
include Js.T
val size : t -> int
val replace :
t
-> uri:Uri.t
-> range:Range.t
-> newText:string (*TODO ->?metadata:WorkspaceEditEntryMetadata.t*)
-> unit
val make : unit -> t
end
module StatusBarAlignment : sig
type t =
| Left
| Right
include Js.T with type t := t
end
module AccessibilityInformation : sig
include Js.T
val label : t -> string
val role : t -> string option
val create : label:string -> ?role:string -> unit -> t
end
module StatusBarItem : sig
include Js.T
type color =
[ `String of string
| `ThemeColor of ThemeColor.t
]
type command =
[ `String of string
| `Command of Command.t
]
val alignment : t -> StatusBarAlignment.t
val priority : t -> int option
val text : t -> string
val tooltip : t -> string option
val color : t -> color option
val backgroundColor : t -> ThemeColor.t option
val command : t -> command option
val accessibilityInformation : t -> AccessibilityInformation.t option
val set_alignment : t -> StatusBarAlignment.t -> unit
val set_priority : t -> int -> unit
val set_text : t -> string -> unit
val set_tooltip : t -> string -> unit
val set_color : t -> color -> unit
val set_backgroundColor : t -> ThemeColor.t -> unit
val set_command : t -> command -> unit
val set_accessibilityInformation : t -> AccessibilityInformation.t -> unit
val show : t -> unit
val hide : t -> unit
val dispose : t -> unit
val disposable : t -> Disposable.t
end
module WorkspaceFoldersChangeEvent : sig
include Js.T
val added : t -> WorkspaceFolder.t list
val removed : t -> WorkspaceFolder.t list
val create :
added:WorkspaceFolder.t list -> removed:WorkspaceFolder.t list -> t
end
module FormattingOptions : sig
include Js.T
val tabSize : t -> int
val insertSpaces : t -> bool
val create : tabSize:int -> insertSpaces:bool -> t
end
module Event : sig
type 'a t =
listener:('a -> unit)
-> ?thisArgs:Js.Any.t
-> ?disposables:Disposable.t list
-> unit
-> Disposable.t
module Make (T : Js.T) : Js.T with type t = T.t t
end
module EventEmitter : sig
type 'a t
module Make (T : Js.T) : sig
include Js.T with type t = T.t t
val make : unit -> t
val event : t -> T.t Event.t
val fire : t -> T.t -> unit
val dispose : t -> unit -> unit
end
end
module CancellationToken : sig
include Js.T
val isCancellationRequested : t -> bool
val onCancellationRequested : t -> Js.Any.t Event.t
val create :
isCancellationRequested:bool
-> onCancellationRequested:Js.Any.t Event.t
-> t
end
module CustomDocument : sig
module type T = sig
include Js.T
val uri : t -> Uri.t
val dispose : t -> unit
end
include T
val create : uri:Uri.t -> dispose:(unit -> unit) -> t
end
module QuickPickItem : sig
include Js.T
val label : t -> string
val description : t -> string option
val detail : t -> string option
val picked : t -> bool option
val alwaysShow : t -> bool option
val create :
label:string
-> ?description:string
-> ?detail:string
-> ?picked:bool
-> ?alwaysShow:bool
-> unit
-> t
end
module QuickPickOptions : sig
include Js.T
type onDidSelectItemArgs =
[ `QuickPickItem of QuickPickItem.t
| `String of string
]
val title : t -> string option
val matchOnDescription : t -> bool option
val matchOnDetail : t -> bool option
val placeHolder : t -> string option
val ignoreFocusOut : t -> bool option
val canPickMany : t -> bool option
val onDidSelectItem : t -> (onDidSelectItemArgs -> unit) option
val create :
?title:string
-> ?matchOnDescription:bool
-> ?matchOnDetail:bool
-> ?placeHolder:string
-> ?ignoreFocusOut:bool
-> ?canPickMany:bool
-> ?onDidSelectItem:(item:onDidSelectItemArgs -> unit)
-> unit
-> t
end
module ProviderResult : sig
type 'a t =
[ `Value of 'a option
| `Promise of 'a option Promise.t
]
val t_to_js : ('a -> Ojs.t) -> 'a t -> Ojs.t
val t_of_js : (Ojs.t -> 'a) -> Ojs.t -> 'a t
end
module InputBoxOptions : sig
include Js.T
val title : t -> string option
val value : t -> string option
val valueSelection : t -> (int * int) option
val prompt : t -> string option
val placeHolder : t -> string option
val password : t -> bool option
val ignoreFocusOut : t -> bool option
val validateInput : t -> (string -> string ProviderResult.t) option
val create :
?title:string
-> ?value:string
-> ?valueSelection:int * int
-> ?prompt:string
-> ?placeHolder:string
-> ?password:bool
-> ?ignoreFocusOut:bool
-> ?validateInput:(value:string -> string option Promise.t)
-> unit
-> t
end
module MessageItem : sig
include Js.T
val title : t -> string
val isCloseAffordance : t -> bool option
val create : title:string -> ?isCloseAffordance:bool -> unit -> t
end
module Location : sig
include Js.T
val uri : t -> Uri.t
val range : t -> Range.t
val make :
uri:Uri.t
-> rangeOrPosition:[ `Range of Range.t | `Position of Position.t ]
-> t
end
module ProgressLocation : sig
type t =
| SourceControl
| Window
| Notification
include Js.T with type t := t
end
module ProgressOptions : sig
include Js.T
type location =
[ `ProgressLocation of ProgressLocation.t
| `ViewIdLocation of viewIdLocation
]
and viewIdLocation = { viewId : string }
val location : t -> location
val title : t -> string option
val cancellable : t -> bool option
val create :
location:location -> ?title:string -> ?cancellable:bool -> unit -> t
end
module DiagnosticSeverity : sig
type t =
| Error
| Hint
| Information
| Warning
end
module DiagnosticRelatedInformation : sig
include Js.T
val location : t -> Location.t
val message : t -> string
val make : location:Location.t -> message:string -> t
end
module DiagnosticTag : sig
type t =
| Unnecessary
| Deprecated
end
module Diagnostic : sig
include Js.T
type code_target =
{ value : [ `String of string | `Int of int ]
; target : Uri.t
}
type code =
[ `String of string
| `Int of int
| `Targeted of code_target
]
val message : t -> string
val range : t -> Range.t
val severity : t -> DiagnosticSeverity.t
val source : t -> string option
val code : t -> code option
val relatedInformation : t -> DiagnosticRelatedInformation.t list option