From 8973dc6f78a8b63266bf81238d0de95329390299 Mon Sep 17 00:00:00 2001 From: "Michael D. Lowis" Date: Mon, 6 Nov 2017 14:09:14 -0500 Subject: [PATCH] Added documentation generation for lib files --- Makefile | 28 +- docs/Buf.Cursor.html | 55 ++++ docs/Buf.html | 56 ++++ docs/Cfg.Color.Syntax.html | 43 +++ docs/Cfg.Color.html | 41 +++ docs/Cfg.html | 53 ++++ docs/Draw.Cursor.html | 83 ++++++ docs/Draw.html | 49 ++++ docs/Misc.html | 30 ++ docs/Rope.html | 83 ++++++ docs/Scrollmap.html | 63 +++++ docs/X11.GlyphMap.html | 29 ++ docs/X11.Rune.html | 33 +++ docs/X11.html | 481 ++++++++++++++++++++++++++++++++ docs/index.html | 39 +++ docs/index_attributes.html | 26 ++ docs/index_class_types.html | 26 ++ docs/index_classes.html | 26 ++ docs/index_exceptions.html | 32 +++ docs/index_extensions.html | 26 ++ docs/index_methods.html | 26 ++ docs/index_module_types.html | 26 ++ docs/index_modules.html | 60 ++++ docs/index_types.html | 65 +++++ docs/index_values.html | 324 +++++++++++++++++++++ docs/style.css | 39 +++ docs/type_Buf.Cursor.html | 23 ++ docs/type_Buf.html | 19 ++ docs/type_Cfg.Color.Syntax.html | 36 +++ docs/type_Cfg.Color.html | 52 ++++ docs/type_Cfg.html | 19 ++ docs/type_Draw.Cursor.html | 37 +++ docs/type_Draw.html | 19 ++ docs/type_Misc.html | 19 ++ docs/type_Rope.html | 19 ++ docs/type_Scrollmap.html | 19 ++ docs/type_X11.GlyphMap.html | 56 ++++ docs/type_X11.Rune.html | 19 ++ docs/type_X11.html | 19 ++ 39 files changed, 2186 insertions(+), 12 deletions(-) create mode 100644 docs/Buf.Cursor.html create mode 100644 docs/Buf.html create mode 100644 docs/Cfg.Color.Syntax.html create mode 100644 docs/Cfg.Color.html create mode 100644 docs/Cfg.html create mode 100644 docs/Draw.Cursor.html create mode 100644 docs/Draw.html create mode 100644 docs/Misc.html create mode 100644 docs/Rope.html create mode 100644 docs/Scrollmap.html create mode 100644 docs/X11.GlyphMap.html create mode 100644 docs/X11.Rune.html create mode 100644 docs/X11.html create mode 100644 docs/index.html create mode 100644 docs/index_attributes.html create mode 100644 docs/index_class_types.html create mode 100644 docs/index_classes.html create mode 100644 docs/index_exceptions.html create mode 100644 docs/index_extensions.html create mode 100644 docs/index_methods.html create mode 100644 docs/index_module_types.html create mode 100644 docs/index_modules.html create mode 100644 docs/index_types.html create mode 100644 docs/index_values.html create mode 100644 docs/style.css create mode 100644 docs/type_Buf.Cursor.html create mode 100644 docs/type_Buf.html create mode 100644 docs/type_Cfg.Color.Syntax.html create mode 100644 docs/type_Cfg.Color.html create mode 100644 docs/type_Cfg.html create mode 100644 docs/type_Draw.Cursor.html create mode 100644 docs/type_Draw.html create mode 100644 docs/type_Misc.html create mode 100644 docs/type_Rope.html create mode 100644 docs/type_Scrollmap.html create mode 100644 docs/type_X11.GlyphMap.html create mode 100644 docs/type_X11.Rune.html create mode 100644 docs/type_X11.html diff --git a/Makefile b/Makefile index 2dadaeb..a4088f1 100644 --- a/Makefile +++ b/Makefile @@ -24,14 +24,17 @@ endif # Target Definitions #------------------------------------------------------------------------------- BINS = edit unittests +LIBSRCS = \ + lib/misc.ml \ + lib/x11.ml \ + lib/cfg.ml \ + lib/rope.ml \ + lib/buf.ml \ + lib/draw.ml \ + lib/scrollmap.ml + LIBOBJS = \ - lib/misc.$(OBJEXT) \ - lib/x11.$(OBJEXT) \ - lib/cfg.$(OBJEXT) \ - lib/rope.$(OBJEXT) \ - lib/buf.$(OBJEXT) \ - lib/draw.$(OBJEXT) \ - lib/scrollmap.$(OBJEXT) \ + $(LIBSRCS:.ml=.$(OBJEXT)) \ lib/x11_prims.o \ lib/misc_prims.o \ lib/utf8.o @@ -41,9 +44,9 @@ TESTOBJS = \ tests/rope_tests.$(OBJEXT) \ tests/scrollmap_tests.$(OBJEXT) -.PHONY: all clean +.PHONY: all clean docs -all: $(BINS) +all: docs/index.html $(BINS) ./unittests clean: @@ -55,10 +58,11 @@ unittests: tide.$(LIBEXT) $(TESTOBJS) unittests.$(OBJEXT) # Library targets tide.$(LIBEXT): $(LIBOBJS) +docs/index.html: tide.$(LIBEXT) + ocamldoc -d docs -html -I lib $(LIBSRCS) -deps.mk: - ocamldep *.ml* lib/*.ml* > deps.mk - +deps.mk: $(LIBSRCS) + ocamldep -all *.ml* lib/*.ml* > deps.mk -include deps.mk # Implicit Rule Definitions diff --git a/docs/Buf.Cursor.html b/docs/Buf.Cursor.html new file mode 100644 index 0000000..d8783be --- /dev/null +++ b/docs/Buf.Cursor.html @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + +Buf.Cursor + + + +

Module Buf.Cursor

+ +
module Cursor: sig .. end

+ +
type t = {
+ + + + + + + + + + + + + + +
+   +start : int;
+   +stop : int;
+   +column : int;
+} + + + +
val make : int -> int -> t
+
val clone : t -> t
\ No newline at end of file diff --git a/docs/Buf.html b/docs/Buf.html new file mode 100644 index 0000000..5a61b53 --- /dev/null +++ b/docs/Buf.html @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + +Buf + + + +

Module Buf

+ +
module Buf: sig .. end

+ +
module Cursor: sig .. end
+
type t = {
+ + + + + + + + + +
+   +path : string;
+   +rope : Rope.t;
+} + + + +
val empty : t
+
val load : string -> t
+
val rope : t -> Rope.t
+
val iter_from : (Rope.rune -> bool) -> t -> int -> unit
+
val iteri_from : (int -> Rope.rune -> bool) -> t -> int -> unit
\ No newline at end of file diff --git a/docs/Cfg.Color.Syntax.html b/docs/Cfg.Color.Syntax.html new file mode 100644 index 0000000..24bc7bf --- /dev/null +++ b/docs/Cfg.Color.Syntax.html @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + +Cfg.Color.Syntax + + + +

Module Cfg.Color.Syntax

+ +
module Syntax: sig .. end

+ +
val normal : int
+
val comment : int
+
val constant : int
+
val number : int
+
val boolean : int
+
val float : int
+
val string : int
+
val char : int
+
val preproc : int
+
val typedef : int
+
val keyword : int
+
val statement : int
+
val procedure : int
+
val variable : int
+
val special : int
+
val operator : int
\ No newline at end of file diff --git a/docs/Cfg.Color.html b/docs/Cfg.Color.html new file mode 100644 index 0000000..d52acd4 --- /dev/null +++ b/docs/Cfg.Color.html @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + +Cfg.Color + + + +

Module Cfg.Color

+ +
module Color: sig .. end

+ +
val palette : int array
+
val scroll_nor : int * int
+
val gutter_nor : int * int
+
val gutter_sel : int * int
+
val status_nor : int * int
+
val tags_nor : int * int
+
val tags_sel : int * int
+
val tags_csr : int
+
val edit_nor : int * int
+
val edit_sel : int * int
+
val edit_csr : int
+
val edit_rul : int
+
val borders : int * int
+
module Syntax: sig .. end
\ No newline at end of file diff --git a/docs/Cfg.html b/docs/Cfg.html new file mode 100644 index 0000000..3db7037 --- /dev/null +++ b/docs/Cfg.html @@ -0,0 +1,53 @@ + + + + + + + + + + + + + + + + + + + + +Cfg + + + +

Module Cfg

+ +
module Cfg: sig .. end

+ +
val boolvar : string -> bool -> bool
+
val intvar : string -> int -> int
+
val strvar : string -> string -> string
+
val clrvar : string -> int * int -> int * int
+
val edit_tags : string
+
val cmd_tags : string
+
val font : string
+
val line_spacing : int
+
val winwidth : int
+
val winheight : int
+
val line_nums : bool
+
val syntax_enabled : bool
+
val ruler_column : int
+
val event_timeout : int
+
val copy_indent : bool
+
val trim_on_save : bool
+
val expand_tabs : bool
+
val tab_width : int
+
val scroll_lines : int
+
val dbl_click_time : int
+
val max_scan_dist : int
+
module Color: sig .. end
\ No newline at end of file diff --git a/docs/Draw.Cursor.html b/docs/Draw.Cursor.html new file mode 100644 index 0000000..38ece7b --- /dev/null +++ b/docs/Draw.Cursor.html @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + +Draw.Cursor + + + +

Module Draw.Cursor

+ +
module Cursor: sig .. end

+ +
type t = {
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+   +height : int;
+   +width : int;
+   +startx : int;
+   +starty : int;
+   +mutable x : int;
+   +mutable y : int;
+} + + + +
val make : int * int -> int -> int -> t
+
val max_width : t -> int
+
val restart : t -> int -> int -> t
+
val next_line : t -> unit
+
val has_next_line : t -> bool
+
val draw_tab : t -> unit
+
val place_glyph : t -> X11.glyph -> unit
+
val draw_glyph : t -> X11.GlyphMap.key -> unit
+
val next_glyph : t -> X11.GlyphMap.key -> bool
\ No newline at end of file diff --git a/docs/Draw.html b/docs/Draw.html new file mode 100644 index 0000000..0bfe7fa --- /dev/null +++ b/docs/Draw.html @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + +Draw + + + +

Module Draw

+ +
module Draw: sig .. end

+ +
val font : X11.font
+
val font_height : int
+
val tabglyph : int
+
val tabwidth : int
+
val glyph_width : X11.glyph -> int
+
module Cursor: sig .. end
+
val rectangle : int -> int -> int -> Cursor.t -> unit
+
val dark_bkg : int -> int -> Cursor.t -> unit
+
val light_bkg : int -> int -> Cursor.t -> unit
+
val rule_bkg : int -> int -> Cursor.t -> unit
+
val string : string -> Cursor.t -> unit
+
val hrule : int -> Cursor.t -> unit
+
val vrule : int -> Cursor.t -> unit
+
val buffer : Cursor.t -> Buf.t -> int -> unit
+
val status : Cursor.t -> string -> unit
+
val tags : Cursor.t -> 'a -> unit
+
val scroll : Cursor.t -> unit
+
val edit : Cursor.t -> Buf.t -> int -> unit
\ No newline at end of file diff --git a/docs/Misc.html b/docs/Misc.html new file mode 100644 index 0000000..8182d24 --- /dev/null +++ b/docs/Misc.html @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + +Misc + + + +

Module Misc

+ +
module Misc: sig .. end

+ +
val load_file : string -> string
\ No newline at end of file diff --git a/docs/Rope.html b/docs/Rope.html new file mode 100644 index 0000000..6110fe7 --- /dev/null +++ b/docs/Rope.html @@ -0,0 +1,83 @@ + + + + + + + + + + + + + + + + + + + + +Rope + + + +

Module Rope

+ +
module Rope: sig .. end

+ +
exception Out_of_bounds of string
+ +
exception Bad_rotation
+ +
type t = 
+ + + + + + + + + +
+| +Leaf of string * int * int
+| +Node of t * t * int * int
+ + + +
type rope = t 
+ + +
type rune = int 
+ + +
val empty : t
+
val from_string : string -> t
+
val length : t -> int
+
val height : t -> int
+
val limit_index : t -> int -> int
+
val last : t -> int
+
val check_index : t -> int -> unit
+
val join : t -> t -> t
+
val split : t -> int -> t * t
+
val del : t -> int -> int -> t
+
val getb : t -> int -> char
+
val getc : t -> int -> int
+
val putc : 'a -> 'b -> 'c -> 'a
+
val iter_from : (int -> bool) -> t -> int -> unit
+
val iteri_from : (int -> int -> bool) -> t -> int -> unit
+
val gets : t -> int -> int -> string
+
val puts : t -> string -> int -> t
+
val nextc : t -> int -> int
+
val prevc : t -> int -> int
+
val is_bol : t -> int -> bool
+
val is_eol : t -> int -> bool
+
val move_till : int -> (t -> int -> bool) -> t -> int -> int
+
val to_bol : t -> int -> int
+
val to_eol : t -> int -> int
\ No newline at end of file diff --git a/docs/Scrollmap.html b/docs/Scrollmap.html new file mode 100644 index 0000000..0af79ac --- /dev/null +++ b/docs/Scrollmap.html @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + +Scrollmap + + + +

Module Scrollmap

+ +
module Scrollmap: sig .. end

+ +
type t = {
+ + + + + + + + + + + + + + +
+   +width : int;
+   +index : int;
+   +lines : int array;
+} + + + +
val find_line : 'a array -> 'a -> int -> int
+
val make : Buf.t -> int -> int -> t
+
val first : t -> int
+
val bopl : Buf.t -> int -> int
+
val bonl : Buf.t -> int -> int
+
val scroll_up : t -> Buf.t -> t
+
val scroll_dn : t -> Buf.t -> t
+
val resize : t -> Buf.t -> int -> t
\ No newline at end of file diff --git a/docs/X11.GlyphMap.html b/docs/X11.GlyphMap.html new file mode 100644 index 0000000..aa799ed --- /dev/null +++ b/docs/X11.GlyphMap.html @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + +X11.GlyphMap + + + +

Module X11.GlyphMap

+ +
module GlyphMap: Map.Make(Rune)

+ \ No newline at end of file diff --git a/docs/X11.Rune.html b/docs/X11.Rune.html new file mode 100644 index 0000000..3156c17 --- /dev/null +++ b/docs/X11.Rune.html @@ -0,0 +1,33 @@ + + + + + + + + + + + + + + + + + + + +X11.Rune + + + +

Module X11.Rune

+ +
module Rune: sig .. end

+ +
type t = int 
+ + +
val compare : int -> int -> int
\ No newline at end of file diff --git a/docs/X11.html b/docs/X11.html new file mode 100644 index 0000000..2697929 --- /dev/null +++ b/docs/X11.html @@ -0,0 +1,481 @@ + + + + + + + + + + + + + + + + + + + + +X11 + + + +

Module X11

+ +
module X11: sig .. end

+ +
type xatom 
+ + +
type xwin 
+ + +
type xfont 
+ + +
type xfontpatt 
+ + +
type xevent = 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+| +Focus of bool
+| +KeyPress of { + + + + + + + + + +
+   +mods : int;
+   +rune : int;
+} +
+| +MouseClick of { + + + + + + + + + + + + + + + + + + + +
+   +mods : int;
+   +btn : int;
+   +x : int;
+   +y : int;
+} +
+| +MouseRelease of { + + + + + + + + + + + + + + + + + + + +
+   +mods : int;
+   +btn : int;
+   +x : int;
+   +y : int;
+} +
+| +MouseMove of { + + + + + + + + + + + + + + +
+   +mods : int;
+   +x : int;
+   +y : int;
+} +
+| +Paste of { + + + + +
+   +text : string;
+} +
+| +Command of { + + + + +
+   +commands : string array;
+} +
+| +PipeClosed of { + + + + +
+   +fd : int;
+} +
+| +PipeWriteReady of { + + + + +
+   +fd : int;
+} +
+| +PipeReadReady of { + + + + +
+   +fd : int;
+} +
+| +Update of { + + + + + + + + + +
+   +width : int;
+   +height : int;
+} +
+| +Shutdown
+ + + +
type xrect = {
+ + + + + + + + + + + + + + + + + + + + + + + + +
+   +x : int;
+   +y : int;
+   +w : int;
+   +h : int;
+   +c : int;
+} + + + +
type xcfgvar = 
+ + + + + + + + + + + + + + + + + + + +
+| +Bool of bool
+| +Int of int
+| +String of string
+| +NotSet
+ + + +
type font = {
+ + + + + + + + + + + + + + + + + + + +
+   +font : xfont;
+   +patt : xfontpatt;
+   +height : int;
+   +next : font;
+} + + + +
type glyph = {
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+   +font : xfont;
+   +index : int;
+   +rune : int;
+   +width : int;
+   +x : int;
+   +y : int;
+   +xoff : int;
+   +yoff : int;
+} + + + +
module Rune: sig .. end
+
module GlyphMap: Map.Make(Rune)
+
val connect : unit -> unit
+
val disconnect : unit -> unit
+
val make_window : int -> int -> xwin
+
val make_dialog : int -> int -> xwin
+
val show_window : xwin -> bool -> unit
+
val draw_rect : xrect -> unit
+
val event_loop : int -> (xevent -> unit) -> unit
+
val intern : string -> xatom
+
val prop_set : xwin -> xatom -> string -> unit
+
val prop_get : xwin -> xatom -> string
+
val var_get : string -> xcfgvar
+
val font_load : string -> font
+
val font_glyph : font -> int -> glyph
+
val draw_glyph : int -> glyph -> int * int -> int
+
val glyph_cache : glyph GlyphMap.t Pervasives.ref
+
val cache_update : GlyphMap.key -> glyph -> glyph
+
val get_glyph : font -> GlyphMap.key -> glyph
+
val draw_rune : font -> int -> GlyphMap.key -> int * int -> int
+
val draw_char : font -> int -> char -> int * int -> int
+
val draw_stringi : font -> int -> string -> int * int -> int -> unit
+
val draw_string : font -> int -> string -> int * int -> unit
+
val make_rect : int -> int -> int -> int -> int -> xrect
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..995df80 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + +

+ +

+ + + + + + + + +
Misc
X11
Cfg
Rope
Buf
Draw
Scrollmap
+ + \ No newline at end of file diff --git a/docs/index_attributes.html b/docs/index_attributes.html new file mode 100644 index 0000000..c0642f2 --- /dev/null +++ b/docs/index_attributes.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of class attributes + + + +

Index of class attributes

+ +
+ + \ No newline at end of file diff --git a/docs/index_class_types.html b/docs/index_class_types.html new file mode 100644 index 0000000..e4743e1 --- /dev/null +++ b/docs/index_class_types.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of class types + + + +

Index of class types

+ +
+ + \ No newline at end of file diff --git a/docs/index_classes.html b/docs/index_classes.html new file mode 100644 index 0000000..b02809c --- /dev/null +++ b/docs/index_classes.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of classes + + + +

Index of classes

+ +
+ + \ No newline at end of file diff --git a/docs/index_exceptions.html b/docs/index_exceptions.html new file mode 100644 index 0000000..79682f4 --- /dev/null +++ b/docs/index_exceptions.html @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + +Index of exceptions + + + +

Index of exceptions

+ + + + + + + +

B
Bad_rotation [Rope]

O
Out_of_bounds [Rope]
+ + \ No newline at end of file diff --git a/docs/index_extensions.html b/docs/index_extensions.html new file mode 100644 index 0000000..e14ae70 --- /dev/null +++ b/docs/index_extensions.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of extensions + + + +

Index of extensions

+ +
+ + \ No newline at end of file diff --git a/docs/index_methods.html b/docs/index_methods.html new file mode 100644 index 0000000..e14ac89 --- /dev/null +++ b/docs/index_methods.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of class methods + + + +

Index of class methods

+ +
+ + \ No newline at end of file diff --git a/docs/index_module_types.html b/docs/index_module_types.html new file mode 100644 index 0000000..b291d77 --- /dev/null +++ b/docs/index_module_types.html @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + +Index of module types + + + +

Index of module types

+ +
+ + \ No newline at end of file diff --git a/docs/index_modules.html b/docs/index_modules.html new file mode 100644 index 0000000..f7ab3ae --- /dev/null +++ b/docs/index_modules.html @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + +Index of modules + + + +

Index of modules

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

B
Buf

C
Cfg
Color [Cfg]
Cursor [Draw]
Cursor [Buf]

D
Draw

G
GlyphMap [X11]

M
Misc

R
Rope
Rune [X11]

S
Scrollmap
Syntax [Cfg.Color]

X
X11
+ + \ No newline at end of file diff --git a/docs/index_types.html b/docs/index_types.html new file mode 100644 index 0000000..d213abe --- /dev/null +++ b/docs/index_types.html @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + +Index of types + + + +

Index of types

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

F
font [X11]

G
glyph [X11]

R
rope [Rope]
rune [Rope]

T
t [Scrollmap]
t [Draw.Cursor]
t [Buf.Cursor]
t [Buf]
t [Rope]
t [X11.Rune]

X
xatom [X11]
xcfgvar [X11]
xevent [X11]
xfont [X11]
xfontpatt [X11]
xrect [X11]
xwin [X11]
+ + \ No newline at end of file diff --git a/docs/index_values.html b/docs/index_values.html new file mode 100644 index 0000000..157b6bb --- /dev/null +++ b/docs/index_values.html @@ -0,0 +1,324 @@ + + + + + + + + + + + + + + + + +Index of values + + + +

Index of values

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

B
bonl [Scrollmap]
boolean [Cfg.Color.Syntax]
boolvar [Cfg]
bopl [Scrollmap]
borders [Cfg.Color]
buffer [Draw]

C
cache_update [X11]
char [Cfg.Color.Syntax]
check_index [Rope]
clone [Buf.Cursor]
clrvar [Cfg]
cmd_tags [Cfg]
comment [Cfg.Color.Syntax]
compare [X11.Rune]
connect [X11]
constant [Cfg.Color.Syntax]
copy_indent [Cfg]

D
dark_bkg [Draw]
dbl_click_time [Cfg]
del [Rope]
disconnect [X11]
draw_char [X11]
draw_glyph [Draw.Cursor]
draw_glyph [X11]
draw_rect [X11]
draw_rune [X11]
draw_string [X11]
draw_stringi [X11]
draw_tab [Draw.Cursor]

E
edit [Draw]
edit_csr [Cfg.Color]
edit_nor [Cfg.Color]
edit_rul [Cfg.Color]
edit_sel [Cfg.Color]
edit_tags [Cfg]
empty [Buf]
empty [Rope]
event_loop [X11]
event_timeout [Cfg]
expand_tabs [Cfg]

F
find_line [Scrollmap]
first [Scrollmap]
float [Cfg.Color.Syntax]
font [Draw]
font [Cfg]
font_glyph [X11]
font_height [Draw]
font_load [X11]
from_string [Rope]

G
get_glyph [X11]
getb [Rope]
getc [Rope]
gets [Rope]
glyph_cache [X11]
glyph_width [Draw]
gutter_nor [Cfg.Color]
gutter_sel [Cfg.Color]

H
has_next_line [Draw.Cursor]
height [Rope]
hrule [Draw]

I
intern [X11]
intvar [Cfg]
is_bol [Rope]
is_eol [Rope]
iter_from [Buf]
iter_from [Rope]
iteri_from [Buf]
iteri_from [Rope]

J
join [Rope]

K
keyword [Cfg.Color.Syntax]

L
last [Rope]
length [Rope]
light_bkg [Draw]
limit_index [Rope]
line_nums [Cfg]
line_spacing [Cfg]
load [Buf]
load_file [Misc]

M
make [Scrollmap]
make [Draw.Cursor]
make [Buf.Cursor]
make_dialog [X11]
make_rect [X11]
make_window [X11]
max_scan_dist [Cfg]
max_width [Draw.Cursor]
move_till [Rope]

N
next_glyph [Draw.Cursor]
next_line [Draw.Cursor]
nextc [Rope]
normal [Cfg.Color.Syntax]
number [Cfg.Color.Syntax]

O
operator [Cfg.Color.Syntax]

P
palette [Cfg.Color]
place_glyph [Draw.Cursor]
preproc [Cfg.Color.Syntax]
prevc [Rope]
procedure [Cfg.Color.Syntax]
prop_get [X11]
prop_set [X11]
putc [Rope]
puts [Rope]

R
rectangle [Draw]
resize [Scrollmap]
restart [Draw.Cursor]
rope [Buf]
rule_bkg [Draw]
ruler_column [Cfg]

S
scroll [Draw]
scroll_dn [Scrollmap]
scroll_lines [Cfg]
scroll_nor [Cfg.Color]
scroll_up [Scrollmap]
show_window [X11]
special [Cfg.Color.Syntax]
split [Rope]
statement [Cfg.Color.Syntax]
status [Draw]
status_nor [Cfg.Color]
string [Draw]
string [Cfg.Color.Syntax]
strvar [Cfg]
syntax_enabled [Cfg]

T
tab_width [Cfg]
tabglyph [Draw]
tabwidth [Draw]
tags [Draw]
tags_csr [Cfg.Color]
tags_nor [Cfg.Color]
tags_sel [Cfg.Color]
to_bol [Rope]
to_eol [Rope]
trim_on_save [Cfg]
typedef [Cfg.Color.Syntax]

V
var_get [X11]
variable [Cfg.Color.Syntax]
vrule [Draw]

W
winheight [Cfg]
winwidth [Cfg]
+ + \ No newline at end of file diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000..d8a7615 --- /dev/null +++ b/docs/style.css @@ -0,0 +1,39 @@ +.keyword { font-weight : bold ; color : Red } +.keywordsign { color : #C04600 } +.comment { color : Green } +.constructor { color : Blue } +.type { color : #5C6585 } +.string { color : Maroon } +.warning { color : Red ; font-weight : bold } +.info { margin-left : 3em; margin-right: 3em } +.param_info { margin-top: 4px; margin-left : 3em; margin-right : 3em } +.code { color : #465F91 ; } +.typetable { border-style : hidden } +.paramstable { border-style : hidden ; padding: 5pt 5pt} +tr { background-color : White } +td.typefieldcomment { background-color : #FFFFFF ; font-size: smaller ;} +div.sig_block {margin-left: 2em} +*:target { background: yellow; } +body {font: 13px sans-serif; color: black; text-align: left; padding: 5px; margin: 0} +h1 { font-size : 20pt ; text-align: center; } +h2 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ;padding: 2px; } +h3 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90DDFF ;padding: 2px; } +h4 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90EDFF ;padding: 2px; } +h5 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90FDFF ;padding: 2px; } +h6 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ; padding: 2px; } +div.h7 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #E0FFFF ; padding: 2px; } +div.h8 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #F0FFFF ; padding: 2px; } +div.h9 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #FFFFFF ; padding: 2px; } +a {color: #416DFF; text-decoration: none} +a:hover {background-color: #ddd; text-decoration: underline} +pre { margin-bottom: 4px; font-family: monospace; } +pre.verbatim, pre.codepre { } +.indextable {border: 1px #ddd solid; border-collapse: collapse} +.indextable td, .indextable th {border: 1px #ddd solid; min-width: 80px} +.indextable td.module {background-color: #eee ; padding-left: 2px; padding-right: 2px} +.indextable td.module a {color: #4E6272; text-decoration: none; display: block; width: 100%} +.indextable td.module a:hover {text-decoration: underline; background-color: transparent} +.deprecated {color: #888; font-style: italic} +.indextable tr td div.info { margin-left: 2px; margin-right: 2px } +ul.indexlist { margin-left: 0; padding-left: 0;} +ul.indexlist li { list-style-type: none ; margin-left: 0; padding-left: 0; } \ No newline at end of file diff --git a/docs/type_Buf.Cursor.html b/docs/type_Buf.Cursor.html new file mode 100644 index 0000000..b2a156d --- /dev/null +++ b/docs/type_Buf.Cursor.html @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + +Buf.Cursor + + +sig
+  type t = { start : int; stop : int; column : int; }
+  val make : int -> int -> Buf.Cursor.t
+  val clone : Buf.Cursor.t -> Buf.Cursor.t
+end
\ No newline at end of file diff --git a/docs/type_Buf.html b/docs/type_Buf.html new file mode 100644 index 0000000..e7472aa --- /dev/null +++ b/docs/type_Buf.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Buf + + +sig  end \ No newline at end of file diff --git a/docs/type_Cfg.Color.Syntax.html b/docs/type_Cfg.Color.Syntax.html new file mode 100644 index 0000000..4058345 --- /dev/null +++ b/docs/type_Cfg.Color.Syntax.html @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + +Cfg.Color.Syntax + + +sig
+  val normal : int
+  val comment : int
+  val constant : int
+  val number : int
+  val boolean : int
+  val float : int
+  val string : int
+  val char : int
+  val preproc : int
+  val typedef : int
+  val keyword : int
+  val statement : int
+  val procedure : int
+  val variable : int
+  val special : int
+  val operator : int
+end
\ No newline at end of file diff --git a/docs/type_Cfg.Color.html b/docs/type_Cfg.Color.html new file mode 100644 index 0000000..96343e5 --- /dev/null +++ b/docs/type_Cfg.Color.html @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + +Cfg.Color + + +sig
+  val palette : int array
+  val scroll_nor : int * int
+  val gutter_nor : int * int
+  val gutter_sel : int * int
+  val status_nor : int * int
+  val tags_nor : int * int
+  val tags_sel : int * int
+  val tags_csr : int
+  val edit_nor : int * int
+  val edit_sel : int * int
+  val edit_csr : int
+  val edit_rul : int
+  val borders : int * int
+  module Syntax :
+    sig
+      val normal : int
+      val comment : int
+      val constant : int
+      val number : int
+      val boolean : int
+      val float : int
+      val string : int
+      val char : int
+      val preproc : int
+      val typedef : int
+      val keyword : int
+      val statement : int
+      val procedure : int
+      val variable : int
+      val special : int
+      val operator : int
+    end
+end
\ No newline at end of file diff --git a/docs/type_Cfg.html b/docs/type_Cfg.html new file mode 100644 index 0000000..47691a6 --- /dev/null +++ b/docs/type_Cfg.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Cfg + + +sig  end \ No newline at end of file diff --git a/docs/type_Draw.Cursor.html b/docs/type_Draw.Cursor.html new file mode 100644 index 0000000..da3868f --- /dev/null +++ b/docs/type_Draw.Cursor.html @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + +Draw.Cursor + + +sig
+  type t = {
+    height : int;
+    width : int;
+    startx : int;
+    starty : int;
+    mutable x : int;
+    mutable y : int;
+  }
+  val make : int * int -> int -> int -> Draw.Cursor.t
+  val max_width : Draw.Cursor.t -> int
+  val restart : Draw.Cursor.t -> int -> int -> Draw.Cursor.t
+  val next_line : Draw.Cursor.t -> unit
+  val has_next_line : Draw.Cursor.t -> bool
+  val draw_tab : Draw.Cursor.t -> unit
+  val place_glyph : Draw.Cursor.t -> X11.glyph -> unit
+  val draw_glyph : Draw.Cursor.t -> X11.GlyphMap.key -> unit
+  val next_glyph : Draw.Cursor.t -> X11.GlyphMap.key -> bool
+end
\ No newline at end of file diff --git a/docs/type_Draw.html b/docs/type_Draw.html new file mode 100644 index 0000000..b9fab20 --- /dev/null +++ b/docs/type_Draw.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Draw + + +sig  end \ No newline at end of file diff --git a/docs/type_Misc.html b/docs/type_Misc.html new file mode 100644 index 0000000..178e962 --- /dev/null +++ b/docs/type_Misc.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Misc + + +sig  end \ No newline at end of file diff --git a/docs/type_Rope.html b/docs/type_Rope.html new file mode 100644 index 0000000..12b9d51 --- /dev/null +++ b/docs/type_Rope.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Rope + + +sig  end \ No newline at end of file diff --git a/docs/type_Scrollmap.html b/docs/type_Scrollmap.html new file mode 100644 index 0000000..5c005c1 --- /dev/null +++ b/docs/type_Scrollmap.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +Scrollmap + + +sig  end \ No newline at end of file diff --git a/docs/type_X11.GlyphMap.html b/docs/type_X11.GlyphMap.html new file mode 100644 index 0000000..c020538 --- /dev/null +++ b/docs/type_X11.GlyphMap.html @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + +X11.GlyphMap + + +sig
+  type key = Rune.t
+  type 'a t = 'Map.Make(Rune).t
+  val empty : 'a t
+  val is_empty : 'a t -> bool
+  val mem : key -> 'a t -> bool
+  val add : key -> '-> 'a t -> 'a t
+  val singleton : key -> '-> 'a t
+  val remove : key -> 'a t -> 'a t
+  val merge :
+    (key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
+  val union : (key -> '-> '-> 'a option) -> 'a t -> 'a t -> 'a t
+  val compare : ('-> '-> int) -> 'a t -> 'a t -> int
+  val equal : ('-> '-> bool) -> 'a t -> 'a t -> bool
+  val iter : (key -> '-> unit) -> 'a t -> unit
+  val fold : (key -> '-> '-> 'b) -> 'a t -> '-> 'b
+  val for_all : (key -> '-> bool) -> 'a t -> bool
+  val exists : (key -> '-> bool) -> 'a t -> bool
+  val filter : (key -> '-> bool) -> 'a t -> 'a t
+  val partition : (key -> '-> bool) -> 'a t -> 'a t * 'a t
+  val cardinal : 'a t -> int
+  val bindings : 'a t -> (key * 'a) list
+  val min_binding : 'a t -> key * 'a
+  val min_binding_opt : 'a t -> (key * 'a) option
+  val max_binding : 'a t -> key * 'a
+  val max_binding_opt : 'a t -> (key * 'a) option
+  val choose : 'a t -> key * 'a
+  val choose_opt : 'a t -> (key * 'a) option
+  val split : key -> 'a t -> 'a t * 'a option * 'a t
+  val find : key -> 'a t -> 'a
+  val find_opt : key -> 'a t -> 'a option
+  val find_first : (key -> bool) -> 'a t -> key * 'a
+  val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
+  val find_last : (key -> bool) -> 'a t -> key * 'a
+  val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
+  val map : ('-> 'b) -> 'a t -> 'b t
+  val mapi : (key -> '-> 'b) -> 'a t -> 'b t
+end
\ No newline at end of file diff --git a/docs/type_X11.Rune.html b/docs/type_X11.Rune.html new file mode 100644 index 0000000..292a182 --- /dev/null +++ b/docs/type_X11.Rune.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +X11.Rune + + +sig type t = int val compare : int -> int -> int end \ No newline at end of file diff --git a/docs/type_X11.html b/docs/type_X11.html new file mode 100644 index 0000000..f6f7286 --- /dev/null +++ b/docs/type_X11.html @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + +X11 + + +sig  end \ No newline at end of file -- 2.52.0