pax_global_header00006660000000000000000000000064124534510770014522gustar00rootroot0000000000000052 comment=03e0f4dd390853003942b42dd3dda5f7c85e8d2e zed-1.4/000077500000000000000000000000001245345107700121505ustar00rootroot00000000000000zed-1.4/.gitignore000066400000000000000000000001071245345107700141360ustar00rootroot00000000000000_build/ /zed-*.tar.gz /setup.data /setup.log /setup.exe /setup-dev.exe zed-1.4/CHANGES.md000066400000000000000000000014671245345107700135520ustar00rootroot000000000000001.4 (2015-01-07) ---------------- * added `Zed_edit.get_line` * added `Zed_line.line_{length,stop}` * fix a bug in cursor updates * fix some invalid use of react 1.3 (2014-04-21) ---------------- * `Zed_rope` fixes: - `rev_map`: fix recursion - enforce evaluation order in `map` & `rev_map` 1.2 (2012-07-30) ---------------- * add escaping functions * add `Zed_utf8.next_error` 1.1 (2011-08-06) ---------------- * add the `{delete,kill}-{prev,next}-word` actions and functions * add `Zed_edit.Insert(ch)` * add `Zed_edit.replace` * raise an exception when editing a read-only part of a text * disable the move function * add support for undo * add `Zed_input` to ease writing key binders * add `Zed_macro` to ease writing macro system * fix `Zed_rope.Zip.sub` * add `Zed_edit.new_clipboard` * add `Zed_utf8.add` zed-1.4/LICENSE000066400000000000000000000027561245345107700131670ustar00rootroot00000000000000Copyright (c) 2011, Jeremie Dimino All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Jeremie Dimino nor the names of his contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. zed-1.4/Makefile000066400000000000000000000026621245345107700136160ustar00rootroot00000000000000# Makefile # -------- # Copyright : (c) 2012, Jeremie Dimino # Licence : BSD3 # # Generic Makefile for oasis project # Set to setup.exe for the release SETUP := setup.exe # Default rule default: build # Setup for the development version setup-dev.exe: _oasis setup.ml sed '/^#/D' setup.ml > setup_dev.ml ocamlfind ocamlopt -o $@ -linkpkg -package ocamlbuild,oasis.dynrun setup_dev.ml || \ ocamlfind ocamlc -o $@ -linkpkg -package ocamlbuild,oasis.dynrun setup_dev.ml || true rm -f setup_dev.* # Setup for the release setup.exe: setup.ml ocamlopt.opt -o $@ $< || ocamlopt -o $@ $< || ocamlc -o $@ $< rm -f setup.cmx setup.cmi setup.o setup.obj setup.cmo build: $(SETUP) setup.data ./$(SETUP) -build $(BUILDFLAGS) doc: $(SETUP) setup.data build ./$(SETUP) -doc $(DOCFLAGS) test: $(SETUP) setup.data build ./$(SETUP) -test $(TESTFLAGS) all: $(SETUP) ./$(SETUP) -all $(ALLFLAGS) install: $(SETUP) setup.data ./$(SETUP) -install $(INSTALLFLAGS) uninstall: $(SETUP) setup.data ./$(SETUP) -uninstall $(UNINSTALLFLAGS) reinstall: $(SETUP) setup.data ./$(SETUP) -reinstall $(REINSTALLFLAGS) clean: $(SETUP) ./$(SETUP) -clean $(CLEANFLAGS) distclean: $(SETUP) ./$(SETUP) -distclean $(DISTCLEANFLAGS) configure: $(SETUP) ./$(SETUP) -configure $(CONFIGUREFLAGS) setup.data: $(SETUP) ./$(SETUP) -configure $(CONFIGUREFLAGS) .PHONY: default build doc test all install uninstall reinstall clean distclean configure zed-1.4/README.md000066400000000000000000000027521245345107700134350ustar00rootroot00000000000000Zed === Zed is an abstract engine for text edition. It can be used to write text editors, edition widgets, readlines, ... You just have to _connect_ an engine to your inputs and rendering functions to get an editor. Zed provides: * edition state management, * multiple cursor support, * key-binding helpers, * general purpose unicode rope manipulation functions. Dependencies ------------ * [OCaml](http://caml.inria.fr/ocaml/) (>= 3.12) * [findlib](http://projects.camlcity.org/projects/findlib.html) * [Camomile](http://github.com/yoriyuki/Camomile) (>= 0.8) * [react](http://erratique.ch/software/react) For building the development version, you also need to install [oasis](http://oasis.forge.ocamlcore.org/) (>= 0.3.0). Installation ------------ To build and install zed: $ ./configure $ make $ make install ### Documentation _(optional)_ To build the documentation: $ make doc It will then be installed by `make install`. ### Tests _(optionnal)_ To build and execute tests: $ ./configure --enable-tests $ make test Modules ------- * `Zed_edit`: the main module, it defines edition engines. * `Zed_cursor`: manages cursors. Cursors are automatically updated when the text is modified. * `Zed_lines`: maintains the offsets of beginning of lines. * `Zed_input`: helpers for implementing key bindings. * `Zed_macro`: helpers for writing macro systems. * `Zed_utf8`: general purpose UTF-8 strings manipulation. * `Zed_rope`: general purpose unicode ropes manipulation. zed-1.4/_oasis000066400000000000000000000044631245345107700133570ustar00rootroot00000000000000# +-------------------------------------------------------------------+ # | Package parameters | # +-------------------------------------------------------------------+ OASISFormat: 0.3 OCamlVersion: >= 3.12 Name: zed Version: 1.4 LicenseFile: LICENSE License: BSD-3-clause Authors: Jeremie Dimino Maintainers: Jeremie Dimino Homepage: http://zed.forge.ocamlcore.org/ BuildTools: ocamlbuild Plugins: DevFiles (0.3), META (0.3) XDevFilesEnableMakefile: false Synopsis: Abstract engine for text edition in OCaml Description: Zed is an abstract engine for text edition. It can be used to write text editors, edition widgets, readlines, ... . Zed uses Camomile to fully support the Unicode specification, and implements an UTF-8 encoded string type with validation, and a rope datastructure to achieve efficient operations on large Unicode buffers. Zed also features a regular expression search on ropes. . To support efficient text edition capabilities, Zed provides macro recording and cursor management facilities. # +-------------------------------------------------------------------+ # | The library | # +-------------------------------------------------------------------+ Library zed FindlibName: zed BuildDepends: bytes, react, camomile (>= 0.8) XMETADescription: Edition engine Path: src Install: true Modules: Zed_utf8, Zed_rope, Zed_edit, Zed_cursor, Zed_lines, Zed_re, Zed_input, Zed_macro # +-------------------------------------------------------------------+ # | Doc | # +-------------------------------------------------------------------+ Document "zed-api" Title: API reference for Zed Type: ocamlbuild (0.3) Install: true InstallDir: $htmldir/api DataFiles: style.css BuildTools: ocamldoc XOCamlbuildPath: ./ XOCamlbuildLibraries: zed # +-------------------------------------------------------------------+ # | Misc | # +-------------------------------------------------------------------+ SourceRepository head Type: git Location: https://github.com/diml/zed.git Browser: https://github.com/diml/zed zed-1.4/_tags000066400000000000000000000011411245345107700131650ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: bf9a998597fdf67b0b4fae25145f3bc3) # Ignore VCS directories, you can use the same kind of rule outside # OASIS_START/STOP if you want to exclude directories that contains # useless stuff for the build process true: annot, bin_annot <**/.svn>: -traverse <**/.svn>: not_hygienic ".bzr": -traverse ".bzr": not_hygienic ".hg": -traverse ".hg": not_hygienic ".git": -traverse ".git": not_hygienic "_darcs": -traverse "_darcs": not_hygienic # Library zed "src/zed.cmxs": use_zed : pkg_bytes : pkg_camomile : pkg_react # OASIS_STOP zed-1.4/configure000077500000000000000000000005531245345107700140620ustar00rootroot00000000000000#!/bin/sh # OASIS_START # DO NOT EDIT (digest: dc86c2ad450f91ca10c931b6045d0499) set -e FST=true for i in "$@"; do if $FST; then set -- FST=false fi case $i in --*=*) ARG=${i%%=*} VAL=${i##*=} set -- "$@" "$ARG" "$VAL" ;; *) set -- "$@" "$i" ;; esac done ocaml setup.ml -configure "$@" # OASIS_STOP zed-1.4/myocamlbuild.ml000066400000000000000000000416031245345107700151670ustar00rootroot00000000000000(* OASIS_START *) (* DO NOT EDIT (digest: b10f2078af5a5fb2b4945766c99d8884) *) module OASISGettext = struct (* # 22 "src/oasis/OASISGettext.ml" *) let ns_ str = str let s_ str = str let f_ (str: ('a, 'b, 'c, 'd) format4) = str let fn_ fmt1 fmt2 n = if n = 1 then fmt1^^"" else fmt2^^"" let init = [] end module OASISExpr = struct (* # 22 "src/oasis/OASISExpr.ml" *) open OASISGettext type test = string type flag = string type t = | EBool of bool | ENot of t | EAnd of t * t | EOr of t * t | EFlag of flag | ETest of test * string type 'a choices = (t * 'a) list let eval var_get t = let rec eval' = function | EBool b -> b | ENot e -> not (eval' e) | EAnd (e1, e2) -> (eval' e1) && (eval' e2) | EOr (e1, e2) -> (eval' e1) || (eval' e2) | EFlag nm -> let v = var_get nm in assert(v = "true" || v = "false"); (v = "true") | ETest (nm, vl) -> let v = var_get nm in (v = vl) in eval' t let choose ?printer ?name var_get lst = let rec choose_aux = function | (cond, vl) :: tl -> if eval var_get cond then vl else choose_aux tl | [] -> let str_lst = if lst = [] then s_ "" else String.concat (s_ ", ") (List.map (fun (cond, vl) -> match printer with | Some p -> p vl | None -> s_ "") lst) in match name with | Some nm -> failwith (Printf.sprintf (f_ "No result for the choice list '%s': %s") nm str_lst) | None -> failwith (Printf.sprintf (f_ "No result for a choice list: %s") str_lst) in choose_aux (List.rev lst) end # 132 "myocamlbuild.ml" module BaseEnvLight = struct (* # 22 "src/base/BaseEnvLight.ml" *) module MapString = Map.Make(String) type t = string MapString.t let default_filename = Filename.concat (Sys.getcwd ()) "setup.data" let load ?(allow_empty=false) ?(filename=default_filename) () = if Sys.file_exists filename then begin let chn = open_in_bin filename in let st = Stream.of_channel chn in let line = ref 1 in let st_line = Stream.from (fun _ -> try match Stream.next st with | '\n' -> incr line; Some '\n' | c -> Some c with Stream.Failure -> None) in let lexer = Genlex.make_lexer ["="] st_line in let rec read_file mp = match Stream.npeek 3 lexer with | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> Stream.junk lexer; Stream.junk lexer; Stream.junk lexer; read_file (MapString.add nm value mp) | [] -> mp | _ -> failwith (Printf.sprintf "Malformed data file '%s' line %d" filename !line) in let mp = read_file MapString.empty in close_in chn; mp end else if allow_empty then begin MapString.empty end else begin failwith (Printf.sprintf "Unable to load environment, the file '%s' doesn't exist." filename) end let rec var_expand str env = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try var_expand (MapString.find var env) env with Not_found -> failwith (Printf.sprintf "No variable %s defined when trying to expand %S." var str)) str; Buffer.contents buff let var_get name env = var_expand (MapString.find name env) env let var_choose lst env = OASISExpr.choose (fun nm -> var_get nm env) lst end # 237 "myocamlbuild.ml" module MyOCamlbuildFindlib = struct (* # 22 "src/plugins/ocamlbuild/MyOCamlbuildFindlib.ml" *) (** OCamlbuild extension, copied from * http://brion.inria.fr/gallium/index.php/Using_ocamlfind_with_ocamlbuild * by N. Pouillard and others * * Updated on 2009/02/28 * * Modified by Sylvain Le Gall *) open Ocamlbuild_plugin type conf = { no_automatic_syntax: bool; } (* these functions are not really officially exported *) let run_and_read = Ocamlbuild_pack.My_unix.run_and_read let blank_sep_strings = Ocamlbuild_pack.Lexers.blank_sep_strings let exec_from_conf exec = let exec = let env_filename = Pathname.basename BaseEnvLight.default_filename in let env = BaseEnvLight.load ~filename:env_filename ~allow_empty:true () in try BaseEnvLight.var_get exec env with Not_found -> Printf.eprintf "W: Cannot get variable %s\n" exec; exec in let fix_win32 str = if Sys.os_type = "Win32" then begin let buff = Buffer.create (String.length str) in (* Adapt for windowsi, ocamlbuild + win32 has a hard time to handle '\\'. *) String.iter (fun c -> Buffer.add_char buff (if c = '\\' then '/' else c)) str; Buffer.contents buff end else begin str end in fix_win32 exec let split s ch = let buf = Buffer.create 13 in let x = ref [] in let flush () = x := (Buffer.contents buf) :: !x; Buffer.clear buf in String.iter (fun c -> if c = ch then flush () else Buffer.add_char buf c) s; flush (); List.rev !x let split_nl s = split s '\n' let before_space s = try String.before s (String.index s ' ') with Not_found -> s (* ocamlfind command *) let ocamlfind x = S[Sh (exec_from_conf "ocamlfind"); x] (* This lists all supported packages. *) let find_packages () = List.map before_space (split_nl & run_and_read (exec_from_conf "ocamlfind" ^ " list")) (* Mock to list available syntaxes. *) let find_syntaxes () = ["camlp4o"; "camlp4r"] let well_known_syntax = [ "camlp4.quotations.o"; "camlp4.quotations.r"; "camlp4.exceptiontracer"; "camlp4.extend"; "camlp4.foldgenerator"; "camlp4.listcomprehension"; "camlp4.locationstripper"; "camlp4.macro"; "camlp4.mapgenerator"; "camlp4.metagenerator"; "camlp4.profiler"; "camlp4.tracer" ] let dispatch conf = function | After_options -> (* By using Before_options one let command line options have an higher * priority on the contrary using After_options will guarantee to have * the higher priority override default commands by ocamlfind ones *) Options.ocamlc := ocamlfind & A"ocamlc"; Options.ocamlopt := ocamlfind & A"ocamlopt"; Options.ocamldep := ocamlfind & A"ocamldep"; Options.ocamldoc := ocamlfind & A"ocamldoc"; Options.ocamlmktop := ocamlfind & A"ocamlmktop"; Options.ocamlmklib := ocamlfind & A"ocamlmklib" | After_rules -> (* When one link an OCaml library/binary/package, one should use * -linkpkg *) flag ["ocaml"; "link"; "program"] & A"-linkpkg"; if not (conf.no_automatic_syntax) then begin (* For each ocamlfind package one inject the -package option when * compiling, computing dependencies, generating documentation and * linking. *) List.iter begin fun pkg -> let base_args = [A"-package"; A pkg] in (* TODO: consider how to really choose camlp4o or camlp4r. *) let syn_args = [A"-syntax"; A "camlp4o"] in let (args, pargs) = (* Heuristic to identify syntax extensions: whether they end in ".syntax"; some might not. *) if Filename.check_suffix pkg "syntax" || List.mem pkg well_known_syntax then (syn_args @ base_args, syn_args) else (base_args, []) in flag ["ocaml"; "compile"; "pkg_"^pkg] & S args; flag ["ocaml"; "ocamldep"; "pkg_"^pkg] & S args; flag ["ocaml"; "doc"; "pkg_"^pkg] & S args; flag ["ocaml"; "link"; "pkg_"^pkg] & S base_args; flag ["ocaml"; "infer_interface"; "pkg_"^pkg] & S args; (* TODO: Check if this is allowed for OCaml < 3.12.1 *) flag ["ocaml"; "compile"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "ocamldep"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "doc"; "package("^pkg^")"] & S pargs; flag ["ocaml"; "infer_interface"; "package("^pkg^")"] & S pargs; end (find_packages ()); end; (* Like -package but for extensions syntax. Morover -syntax is useless * when linking. *) List.iter begin fun syntax -> flag ["ocaml"; "compile"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "ocamldep"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "doc"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; flag ["ocaml"; "infer_interface"; "syntax_"^syntax] & S[A"-syntax"; A syntax]; end (find_syntaxes ()); (* The default "thread" tag is not compatible with ocamlfind. * Indeed, the default rules add the "threads.cma" or "threads.cmxa" * options when using this tag. When using the "-linkpkg" option with * ocamlfind, this module will then be added twice on the command line. * * To solve this, one approach is to add the "-thread" option when using * the "threads" package using the previous plugin. *) flag ["ocaml"; "pkg_threads"; "compile"] (S[A "-thread"]); flag ["ocaml"; "pkg_threads"; "doc"] (S[A "-I"; A "+threads"]); flag ["ocaml"; "pkg_threads"; "link"] (S[A "-thread"]); flag ["ocaml"; "pkg_threads"; "infer_interface"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "compile"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "doc"] (S[A "-I"; A "+threads"]); flag ["ocaml"; "package(threads)"; "link"] (S[A "-thread"]); flag ["ocaml"; "package(threads)"; "infer_interface"] (S[A "-thread"]); | _ -> () end module MyOCamlbuildBase = struct (* # 22 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) (** Base functions for writing myocamlbuild.ml @author Sylvain Le Gall *) open Ocamlbuild_plugin module OC = Ocamlbuild_pack.Ocaml_compiler type dir = string type file = string type name = string type tag = string (* # 62 "src/plugins/ocamlbuild/MyOCamlbuildBase.ml" *) type t = { lib_ocaml: (name * dir list * string list) list; lib_c: (name * dir * file list) list; flags: (tag list * (spec OASISExpr.choices)) list; (* Replace the 'dir: include' from _tags by a precise interdepends in * directory. *) includes: (dir * dir list) list; } let env_filename = Pathname.basename BaseEnvLight.default_filename let dispatch_combine lst = fun e -> List.iter (fun dispatch -> dispatch e) lst let tag_libstubs nm = "use_lib"^nm^"_stubs" let nm_libstubs nm = nm^"_stubs" let dispatch t e = let env = BaseEnvLight.load ~filename:env_filename ~allow_empty:true () in match e with | Before_options -> let no_trailing_dot s = if String.length s >= 1 && s.[0] = '.' then String.sub s 1 ((String.length s) - 1) else s in List.iter (fun (opt, var) -> try opt := no_trailing_dot (BaseEnvLight.var_get var env) with Not_found -> Printf.eprintf "W: Cannot get variable %s\n" var) [ Options.ext_obj, "ext_obj"; Options.ext_lib, "ext_lib"; Options.ext_dll, "ext_dll"; ] | After_rules -> (* Declare OCaml libraries *) List.iter (function | nm, [], intf_modules -> ocaml_lib nm; let cmis = List.map (fun m -> (String.uncapitalize m) ^ ".cmi") intf_modules in dep ["ocaml"; "link"; "library"; "file:"^nm^".cma"] cmis | nm, dir :: tl, intf_modules -> ocaml_lib ~dir:dir (dir^"/"^nm); List.iter (fun dir -> List.iter (fun str -> flag ["ocaml"; "use_"^nm; str] (S[A"-I"; P dir])) ["compile"; "infer_interface"; "doc"]) tl; let cmis = List.map (fun m -> dir^"/"^(String.uncapitalize m)^".cmi") intf_modules in dep ["ocaml"; "link"; "library"; "file:"^dir^"/"^nm^".cma"] cmis) t.lib_ocaml; (* Declare directories dependencies, replace "include" in _tags. *) List.iter (fun (dir, include_dirs) -> Pathname.define_context dir include_dirs) t.includes; (* Declare C libraries *) List.iter (fun (lib, dir, headers) -> (* Handle C part of library *) flag ["link"; "library"; "ocaml"; "byte"; tag_libstubs lib] (S[A"-dllib"; A("-l"^(nm_libstubs lib)); A"-cclib"; A("-l"^(nm_libstubs lib))]); flag ["link"; "library"; "ocaml"; "native"; tag_libstubs lib] (S[A"-cclib"; A("-l"^(nm_libstubs lib))]); flag ["link"; "program"; "ocaml"; "byte"; tag_libstubs lib] (S[A"-dllib"; A("dll"^(nm_libstubs lib))]); (* When ocaml link something that use the C library, then one need that file to be up to date. This holds both for programs and for libraries. *) dep ["link"; "ocaml"; tag_libstubs lib] [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; dep ["compile"; "ocaml"; tag_libstubs lib] [dir/"lib"^(nm_libstubs lib)^"."^(!Options.ext_lib)]; (* TODO: be more specific about what depends on headers *) (* Depends on .h files *) dep ["compile"; "c"] headers; (* Setup search path for lib *) flag ["link"; "ocaml"; "use_"^lib] (S[A"-I"; P(dir)]); ) t.lib_c; (* Add flags *) List.iter (fun (tags, cond_specs) -> let spec = BaseEnvLight.var_choose cond_specs env in let rec eval_specs = function | S lst -> S (List.map eval_specs lst) | A str -> A (BaseEnvLight.var_expand str env) | spec -> spec in flag tags & (eval_specs spec)) t.flags | _ -> () let dispatch_default conf t = dispatch_combine [ dispatch t; MyOCamlbuildFindlib.dispatch conf; ] end # 606 "myocamlbuild.ml" open Ocamlbuild_plugin;; let package_default = { MyOCamlbuildBase.lib_ocaml = [("zed", ["src"], [])]; lib_c = []; flags = []; includes = [] } ;; let conf = {MyOCamlbuildFindlib.no_automatic_syntax = false} let dispatch_default = MyOCamlbuildBase.dispatch_default conf package_default;; # 622 "myocamlbuild.ml" (* OASIS_STOP *) Ocamlbuild_plugin.dispatch dispatch_default;; zed-1.4/setup.ml000066400000000000000000005330351245345107700136530ustar00rootroot00000000000000(* * setup.ml * -------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (* OASIS_START *) (* DO NOT EDIT (digest: 997a8cb91565bf8badda02c37668d3f1) *) (* Regenerated by OASIS v0.4.5 Visit http://oasis.forge.ocamlcore.org for more information and documentation about functions used in this file. *) module OASISGettext = struct (* # 22 "src/oasis/OASISGettext.ml" *) let ns_ str = str let s_ str = str let f_ (str: ('a, 'b, 'c, 'd) format4) = str let fn_ fmt1 fmt2 n = if n = 1 then fmt1^^"" else fmt2^^"" let init = [] end module OASISContext = struct (* # 22 "src/oasis/OASISContext.ml" *) open OASISGettext type level = [ `Debug | `Info | `Warning | `Error] type t = { (* TODO: replace this by a proplist. *) quiet: bool; info: bool; debug: bool; ignore_plugins: bool; ignore_unknown_fields: bool; printf: level -> string -> unit; } let printf lvl str = let beg = match lvl with | `Error -> s_ "E: " | `Warning -> s_ "W: " | `Info -> s_ "I: " | `Debug -> s_ "D: " in prerr_endline (beg^str) let default = ref { quiet = false; info = false; debug = false; ignore_plugins = false; ignore_unknown_fields = false; printf = printf; } let quiet = {!default with quiet = true} let fspecs () = (* TODO: don't act on default. *) let ignore_plugins = ref false in ["-quiet", Arg.Unit (fun () -> default := {!default with quiet = true}), s_ " Run quietly"; "-info", Arg.Unit (fun () -> default := {!default with info = true}), s_ " Display information message"; "-debug", Arg.Unit (fun () -> default := {!default with debug = true}), s_ " Output debug message"; "-ignore-plugins", Arg.Set ignore_plugins, s_ " Ignore plugin's field."; "-C", (* TODO: remove this chdir. *) Arg.String (fun str -> Sys.chdir str), s_ "dir Change directory before running."], fun () -> {!default with ignore_plugins = !ignore_plugins} end module OASISString = struct (* # 22 "src/oasis/OASISString.ml" *) (** Various string utilities. Mostly inspired by extlib and batteries ExtString and BatString libraries. @author Sylvain Le Gall *) let nsplitf str f = if str = "" then [] else let buf = Buffer.create 13 in let lst = ref [] in let push () = lst := Buffer.contents buf :: !lst; Buffer.clear buf in let str_len = String.length str in for i = 0 to str_len - 1 do if f str.[i] then push () else Buffer.add_char buf str.[i] done; push (); List.rev !lst (** [nsplit c s] Split the string [s] at char [c]. It doesn't include the separator. *) let nsplit str c = nsplitf str ((=) c) let find ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in while !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else what_idx := 0; incr str_idx done; if !what_idx <> String.length what then raise Not_found else !str_idx - !what_idx let sub_start str len = let str_len = String.length str in if len >= str_len then "" else String.sub str len (str_len - len) let sub_end ?(offset=0) str len = let str_len = String.length str in if len >= str_len then "" else String.sub str 0 (str_len - len) let starts_with ~what ?(offset=0) str = let what_idx = ref 0 in let str_idx = ref offset in let ok = ref true in while !ok && !str_idx < String.length str && !what_idx < String.length what do if str.[!str_idx] = what.[!what_idx] then incr what_idx else ok := false; incr str_idx done; if !what_idx = String.length what then true else false let strip_starts_with ~what str = if starts_with ~what str then sub_start str (String.length what) else raise Not_found let ends_with ~what ?(offset=0) str = let what_idx = ref ((String.length what) - 1) in let str_idx = ref ((String.length str) - 1) in let ok = ref true in while !ok && offset <= !str_idx && 0 <= !what_idx do if str.[!str_idx] = what.[!what_idx] then decr what_idx else ok := false; decr str_idx done; if !what_idx = -1 then true else false let strip_ends_with ~what str = if ends_with ~what str then sub_end str (String.length what) else raise Not_found let replace_chars f s = let buf = Buffer.create (String.length s) in String.iter (fun c -> Buffer.add_char buf (f c)) s; Buffer.contents buf end module OASISUtils = struct (* # 22 "src/oasis/OASISUtils.ml" *) open OASISGettext module MapExt = struct module type S = sig include Map.S val add_list: 'a t -> (key * 'a) list -> 'a t val of_list: (key * 'a) list -> 'a t val to_list: 'a t -> (key * 'a) list end module Make (Ord: Map.OrderedType) = struct include Map.Make(Ord) let rec add_list t = function | (k, v) :: tl -> add_list (add k v t) tl | [] -> t let of_list lst = add_list empty lst let to_list t = fold (fun k v acc -> (k, v) :: acc) t [] end end module MapString = MapExt.Make(String) module SetExt = struct module type S = sig include Set.S val add_list: t -> elt list -> t val of_list: elt list -> t val to_list: t -> elt list end module Make (Ord: Set.OrderedType) = struct include Set.Make(Ord) let rec add_list t = function | e :: tl -> add_list (add e t) tl | [] -> t let of_list lst = add_list empty lst let to_list = elements end end module SetString = SetExt.Make(String) let compare_csl s1 s2 = String.compare (String.lowercase s1) (String.lowercase s2) module HashStringCsl = Hashtbl.Make (struct type t = string let equal s1 s2 = (String.lowercase s1) = (String.lowercase s2) let hash s = Hashtbl.hash (String.lowercase s) end) module SetStringCsl = SetExt.Make (struct type t = string let compare = compare_csl end) let varname_of_string ?(hyphen='_') s = if String.length s = 0 then begin invalid_arg "varname_of_string" end else begin let buf = OASISString.replace_chars (fun c -> if ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || ('0' <= c && c <= '9') then c else hyphen) s; in let buf = (* Start with a _ if digit *) if '0' <= s.[0] && s.[0] <= '9' then "_"^buf else buf in String.lowercase buf end let varname_concat ?(hyphen='_') p s = let what = String.make 1 hyphen in let p = try OASISString.strip_ends_with ~what p with Not_found -> p in let s = try OASISString.strip_starts_with ~what s with Not_found -> s in p^what^s let is_varname str = str = varname_of_string str let failwithf fmt = Printf.ksprintf failwith fmt end module PropList = struct (* # 22 "src/oasis/PropList.ml" *) open OASISGettext type name = string exception Not_set of name * string option exception No_printer of name exception Unknown_field of name * name let () = Printexc.register_printer (function | Not_set (nm, Some rsn) -> Some (Printf.sprintf (f_ "Field '%s' is not set: %s") nm rsn) | Not_set (nm, None) -> Some (Printf.sprintf (f_ "Field '%s' is not set") nm) | No_printer nm -> Some (Printf.sprintf (f_ "No default printer for value %s") nm) | Unknown_field (nm, schm) -> Some (Printf.sprintf (f_ "Field %s is not defined in schema %s") nm schm) | _ -> None) module Data = struct type t = (name, unit -> unit) Hashtbl.t let create () = Hashtbl.create 13 let clear t = Hashtbl.clear t (* # 78 "src/oasis/PropList.ml" *) end module Schema = struct type ('ctxt, 'extra) value = { get: Data.t -> string; set: Data.t -> ?context:'ctxt -> string -> unit; help: (unit -> string) option; extra: 'extra; } type ('ctxt, 'extra) t = { name: name; fields: (name, ('ctxt, 'extra) value) Hashtbl.t; order: name Queue.t; name_norm: string -> string; } let create ?(case_insensitive=false) nm = { name = nm; fields = Hashtbl.create 13; order = Queue.create (); name_norm = (if case_insensitive then String.lowercase else fun s -> s); } let add t nm set get extra help = let key = t.name_norm nm in if Hashtbl.mem t.fields key then failwith (Printf.sprintf (f_ "Field '%s' is already defined in schema '%s'") nm t.name); Hashtbl.add t.fields key { set = set; get = get; help = help; extra = extra; }; Queue.add nm t.order let mem t nm = Hashtbl.mem t.fields nm let find t nm = try Hashtbl.find t.fields (t.name_norm nm) with Not_found -> raise (Unknown_field (nm, t.name)) let get t data nm = (find t nm).get data let set t data nm ?context x = (find t nm).set data ?context x let fold f acc t = Queue.fold (fun acc k -> let v = find t k in f acc k v.extra v.help) acc t.order let iter f t = fold (fun () -> f) () t let name t = t.name end module Field = struct type ('ctxt, 'value, 'extra) t = { set: Data.t -> ?context:'ctxt -> 'value -> unit; get: Data.t -> 'value; sets: Data.t -> ?context:'ctxt -> string -> unit; gets: Data.t -> string; help: (unit -> string) option; extra: 'extra; } let new_id = let last_id = ref 0 in fun () -> incr last_id; !last_id let create ?schema ?name ?parse ?print ?default ?update ?help extra = (* Default value container *) let v = ref None in (* If name is not given, create unique one *) let nm = match name with | Some s -> s | None -> Printf.sprintf "_anon_%d" (new_id ()) in (* Last chance to get a value: the default *) let default () = match default with | Some d -> d | None -> raise (Not_set (nm, Some (s_ "no default value"))) in (* Get data *) let get data = (* Get value *) try (Hashtbl.find data nm) (); match !v with | Some x -> x | None -> default () with Not_found -> default () in (* Set data *) let set data ?context x = let x = match update with | Some f -> begin try f ?context (get data) x with Not_set _ -> x end | None -> x in Hashtbl.replace data nm (fun () -> v := Some x) in (* Parse string value, if possible *) let parse = match parse with | Some f -> f | None -> fun ?context s -> failwith (Printf.sprintf (f_ "Cannot parse field '%s' when setting value %S") nm s) in (* Set data, from string *) let sets data ?context s = set ?context data (parse ?context s) in (* Output value as string, if possible *) let print = match print with | Some f -> f | None -> fun _ -> raise (No_printer nm) in (* Get data, as a string *) let gets data = print (get data) in begin match schema with | Some t -> Schema.add t nm sets gets extra help | None -> () end; { set = set; get = get; sets = sets; gets = gets; help = help; extra = extra; } let fset data t ?context x = t.set data ?context x let fget data t = t.get data let fsets data t ?context s = t.sets data ?context s let fgets data t = t.gets data end module FieldRO = struct let create ?schema ?name ?parse ?print ?default ?update ?help extra = let fld = Field.create ?schema ?name ?parse ?print ?default ?update ?help extra in fun data -> Field.fget data fld end end module OASISMessage = struct (* # 22 "src/oasis/OASISMessage.ml" *) open OASISGettext open OASISContext let generic_message ~ctxt lvl fmt = let cond = if ctxt.quiet then false else match lvl with | `Debug -> ctxt.debug | `Info -> ctxt.info | _ -> true in Printf.ksprintf (fun str -> if cond then begin ctxt.printf lvl str end) fmt let debug ~ctxt fmt = generic_message ~ctxt `Debug fmt let info ~ctxt fmt = generic_message ~ctxt `Info fmt let warning ~ctxt fmt = generic_message ~ctxt `Warning fmt let error ~ctxt fmt = generic_message ~ctxt `Error fmt end module OASISVersion = struct (* # 22 "src/oasis/OASISVersion.ml" *) open OASISGettext type s = string type t = string type comparator = | VGreater of t | VGreaterEqual of t | VEqual of t | VLesser of t | VLesserEqual of t | VOr of comparator * comparator | VAnd of comparator * comparator (* Range of allowed characters *) let is_digit c = '0' <= c && c <= '9' let is_alpha c = ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') let is_special = function | '.' | '+' | '-' | '~' -> true | _ -> false let rec version_compare v1 v2 = if v1 <> "" || v2 <> "" then begin (* Compare ascii string, using special meaning for version * related char *) let val_ascii c = if c = '~' then -1 else if is_digit c then 0 else if c = '\000' then 0 else if is_alpha c then Char.code c else (Char.code c) + 256 in let len1 = String.length v1 in let len2 = String.length v2 in let p = ref 0 in (** Compare ascii part *) let compare_vascii () = let cmp = ref 0 in while !cmp = 0 && !p < len1 && !p < len2 && not (is_digit v1.[!p] && is_digit v2.[!p]) do cmp := (val_ascii v1.[!p]) - (val_ascii v2.[!p]); incr p done; if !cmp = 0 && !p < len1 && !p = len2 then val_ascii v1.[!p] else if !cmp = 0 && !p = len1 && !p < len2 then - (val_ascii v2.[!p]) else !cmp in (** Compare digit part *) let compare_digit () = let extract_int v p = let start_p = !p in while !p < String.length v && is_digit v.[!p] do incr p done; let substr = String.sub v !p ((String.length v) - !p) in let res = match String.sub v start_p (!p - start_p) with | "" -> 0 | s -> int_of_string s in res, substr in let i1, tl1 = extract_int v1 (ref !p) in let i2, tl2 = extract_int v2 (ref !p) in i1 - i2, tl1, tl2 in match compare_vascii () with | 0 -> begin match compare_digit () with | 0, tl1, tl2 -> if tl1 <> "" && is_digit tl1.[0] then 1 else if tl2 <> "" && is_digit tl2.[0] then -1 else version_compare tl1 tl2 | n, _, _ -> n end | n -> n end else begin 0 end let version_of_string str = str let string_of_version t = t let version_compare_string s1 s2 = version_compare (version_of_string s1) (version_of_string s2) let chop t = try let pos = String.rindex t '.' in String.sub t 0 pos with Not_found -> t let rec comparator_apply v op = match op with | VGreater cv -> (version_compare v cv) > 0 | VGreaterEqual cv -> (version_compare v cv) >= 0 | VLesser cv -> (version_compare v cv) < 0 | VLesserEqual cv -> (version_compare v cv) <= 0 | VEqual cv -> (version_compare v cv) = 0 | VOr (op1, op2) -> (comparator_apply v op1) || (comparator_apply v op2) | VAnd (op1, op2) -> (comparator_apply v op1) && (comparator_apply v op2) let rec string_of_comparator = function | VGreater v -> "> "^(string_of_version v) | VEqual v -> "= "^(string_of_version v) | VLesser v -> "< "^(string_of_version v) | VGreaterEqual v -> ">= "^(string_of_version v) | VLesserEqual v -> "<= "^(string_of_version v) | VOr (c1, c2) -> (string_of_comparator c1)^" || "^(string_of_comparator c2) | VAnd (c1, c2) -> (string_of_comparator c1)^" && "^(string_of_comparator c2) let rec varname_of_comparator = let concat p v = OASISUtils.varname_concat p (OASISUtils.varname_of_string (string_of_version v)) in function | VGreater v -> concat "gt" v | VLesser v -> concat "lt" v | VEqual v -> concat "eq" v | VGreaterEqual v -> concat "ge" v | VLesserEqual v -> concat "le" v | VOr (c1, c2) -> (varname_of_comparator c1)^"_or_"^(varname_of_comparator c2) | VAnd (c1, c2) -> (varname_of_comparator c1)^"_and_"^(varname_of_comparator c2) let rec comparator_ge v' = let cmp v = version_compare v v' >= 0 in function | VEqual v | VGreaterEqual v | VGreater v -> cmp v | VLesserEqual _ | VLesser _ -> false | VOr (c1, c2) -> comparator_ge v' c1 || comparator_ge v' c2 | VAnd (c1, c2) -> comparator_ge v' c1 && comparator_ge v' c2 end module OASISLicense = struct (* # 22 "src/oasis/OASISLicense.ml" *) (** License for _oasis fields @author Sylvain Le Gall *) type license = string type license_exception = string type license_version = | Version of OASISVersion.t | VersionOrLater of OASISVersion.t | NoVersion type license_dep_5_unit = { license: license; excption: license_exception option; version: license_version; } type license_dep_5 = | DEP5Unit of license_dep_5_unit | DEP5Or of license_dep_5 list | DEP5And of license_dep_5 list type t = | DEP5License of license_dep_5 | OtherLicense of string (* URL *) end module OASISExpr = struct (* # 22 "src/oasis/OASISExpr.ml" *) open OASISGettext type test = string type flag = string type t = | EBool of bool | ENot of t | EAnd of t * t | EOr of t * t | EFlag of flag | ETest of test * string type 'a choices = (t * 'a) list let eval var_get t = let rec eval' = function | EBool b -> b | ENot e -> not (eval' e) | EAnd (e1, e2) -> (eval' e1) && (eval' e2) | EOr (e1, e2) -> (eval' e1) || (eval' e2) | EFlag nm -> let v = var_get nm in assert(v = "true" || v = "false"); (v = "true") | ETest (nm, vl) -> let v = var_get nm in (v = vl) in eval' t let choose ?printer ?name var_get lst = let rec choose_aux = function | (cond, vl) :: tl -> if eval var_get cond then vl else choose_aux tl | [] -> let str_lst = if lst = [] then s_ "" else String.concat (s_ ", ") (List.map (fun (cond, vl) -> match printer with | Some p -> p vl | None -> s_ "") lst) in match name with | Some nm -> failwith (Printf.sprintf (f_ "No result for the choice list '%s': %s") nm str_lst) | None -> failwith (Printf.sprintf (f_ "No result for a choice list: %s") str_lst) in choose_aux (List.rev lst) end module OASISText = struct (* # 22 "src/oasis/OASISText.ml" *) type elt = | Para of string | Verbatim of string | BlankLine type t = elt list end module OASISTypes = struct (* # 22 "src/oasis/OASISTypes.ml" *) type name = string type package_name = string type url = string type unix_dirname = string type unix_filename = string type host_dirname = string type host_filename = string type prog = string type arg = string type args = string list type command_line = (prog * arg list) type findlib_name = string type findlib_full = string type compiled_object = | Byte | Native | Best type dependency = | FindlibPackage of findlib_full * OASISVersion.comparator option | InternalLibrary of name type tool = | ExternalTool of name | InternalExecutable of name type vcs = | Darcs | Git | Svn | Cvs | Hg | Bzr | Arch | Monotone | OtherVCS of url type plugin_kind = [ `Configure | `Build | `Doc | `Test | `Install | `Extra ] type plugin_data_purpose = [ `Configure | `Build | `Install | `Clean | `Distclean | `Install | `Uninstall | `Test | `Doc | `Extra | `Other of string ] type 'a plugin = 'a * name * OASISVersion.t option type all_plugin = plugin_kind plugin type plugin_data = (all_plugin * plugin_data_purpose * (unit -> unit)) list (* # 115 "src/oasis/OASISTypes.ml" *) type 'a conditional = 'a OASISExpr.choices type custom = { pre_command: (command_line option) conditional; post_command: (command_line option) conditional; } type common_section = { cs_name: name; cs_data: PropList.Data.t; cs_plugin_data: plugin_data; } type build_section = { bs_build: bool conditional; bs_install: bool conditional; bs_path: unix_dirname; bs_compiled_object: compiled_object; bs_build_depends: dependency list; bs_build_tools: tool list; bs_c_sources: unix_filename list; bs_data_files: (unix_filename * unix_filename option) list; bs_ccopt: args conditional; bs_cclib: args conditional; bs_dlllib: args conditional; bs_dllpath: args conditional; bs_byteopt: args conditional; bs_nativeopt: args conditional; } type library = { lib_modules: string list; lib_pack: bool; lib_internal_modules: string list; lib_findlib_parent: findlib_name option; lib_findlib_name: findlib_name option; lib_findlib_containers: findlib_name list; } type object_ = { obj_modules: string list; obj_findlib_fullname: findlib_name list option; } type executable = { exec_custom: bool; exec_main_is: unix_filename; } type flag = { flag_description: string option; flag_default: bool conditional; } type source_repository = { src_repo_type: vcs; src_repo_location: url; src_repo_browser: url option; src_repo_module: string option; src_repo_branch: string option; src_repo_tag: string option; src_repo_subdir: unix_filename option; } type test = { test_type: [`Test] plugin; test_command: command_line conditional; test_custom: custom; test_working_directory: unix_filename option; test_run: bool conditional; test_tools: tool list; } type doc_format = | HTML of unix_filename | DocText | PDF | PostScript | Info of unix_filename | DVI | OtherDoc type doc = { doc_type: [`Doc] plugin; doc_custom: custom; doc_build: bool conditional; doc_install: bool conditional; doc_install_dir: unix_filename; doc_title: string; doc_authors: string list; doc_abstract: string option; doc_format: doc_format; doc_data_files: (unix_filename * unix_filename option) list; doc_build_tools: tool list; } type section = | Library of common_section * build_section * library | Object of common_section * build_section * object_ | Executable of common_section * build_section * executable | Flag of common_section * flag | SrcRepo of common_section * source_repository | Test of common_section * test | Doc of common_section * doc type section_kind = [ `Library | `Object | `Executable | `Flag | `SrcRepo | `Test | `Doc ] type package = { oasis_version: OASISVersion.t; ocaml_version: OASISVersion.comparator option; findlib_version: OASISVersion.comparator option; alpha_features: string list; beta_features: string list; name: package_name; version: OASISVersion.t; license: OASISLicense.t; license_file: unix_filename option; copyrights: string list; maintainers: string list; authors: string list; homepage: url option; synopsis: string; description: OASISText.t option; categories: url list; conf_type: [`Configure] plugin; conf_custom: custom; build_type: [`Build] plugin; build_custom: custom; install_type: [`Install] plugin; install_custom: custom; uninstall_custom: custom; clean_custom: custom; distclean_custom: custom; files_ab: unix_filename list; sections: section list; plugins: [`Extra] plugin list; disable_oasis_section: unix_filename list; schema_data: PropList.Data.t; plugin_data: plugin_data; } end module OASISFeatures = struct (* # 22 "src/oasis/OASISFeatures.ml" *) open OASISTypes open OASISUtils open OASISGettext open OASISVersion module MapPlugin = Map.Make (struct type t = plugin_kind * name let compare = Pervasives.compare end) module Data = struct type t = { oasis_version: OASISVersion.t; plugin_versions: OASISVersion.t option MapPlugin.t; alpha_features: string list; beta_features: string list; } let create oasis_version alpha_features beta_features = { oasis_version = oasis_version; plugin_versions = MapPlugin.empty; alpha_features = alpha_features; beta_features = beta_features } let of_package pkg = create pkg.OASISTypes.oasis_version pkg.OASISTypes.alpha_features pkg.OASISTypes.beta_features let add_plugin (plugin_kind, plugin_name, plugin_version) t = {t with plugin_versions = MapPlugin.add (plugin_kind, plugin_name) plugin_version t.plugin_versions} let plugin_version plugin_kind plugin_name t = MapPlugin.find (plugin_kind, plugin_name) t.plugin_versions let to_string t = Printf.sprintf "oasis_version: %s; alpha_features: %s; beta_features: %s; \ plugins_version: %s" (OASISVersion.string_of_version t.oasis_version) (String.concat ", " t.alpha_features) (String.concat ", " t.beta_features) (String.concat ", " (MapPlugin.fold (fun (_, plg) ver_opt acc -> (plg^ (match ver_opt with | Some v -> " "^(OASISVersion.string_of_version v) | None -> "")) :: acc) t.plugin_versions [])) end type origin = | Field of string * string | Section of string | NoOrigin type stage = Alpha | Beta let string_of_stage = function | Alpha -> "alpha" | Beta -> "beta" let field_of_stage = function | Alpha -> "AlphaFeatures" | Beta -> "BetaFeatures" type publication = InDev of stage | SinceVersion of OASISVersion.t type t = { name: string; plugin: all_plugin option; publication: publication; description: unit -> string; } (* TODO: mutex protect this. *) let all_features = Hashtbl.create 13 let since_version ver_str = SinceVersion (version_of_string ver_str) let alpha = InDev Alpha let beta = InDev Beta let to_string t = Printf.sprintf "feature: %s; plugin: %s; publication: %s" t.name (match t.plugin with | None -> "" | Some (_, nm, _) -> nm) (match t.publication with | InDev stage -> string_of_stage stage | SinceVersion ver -> ">= "^(OASISVersion.string_of_version ver)) let data_check t data origin = let no_message = "no message" in let check_feature features stage = let has_feature = List.mem t.name features in if not has_feature then match origin with | Field (fld, where) -> Some (Printf.sprintf (f_ "Field %s in %s is only available when feature %s \ is in field %s.") fld where t.name (field_of_stage stage)) | Section sct -> Some (Printf.sprintf (f_ "Section %s is only available when features %s \ is in field %s.") sct t.name (field_of_stage stage)) | NoOrigin -> Some no_message else None in let version_is_good ~min_version version fmt = let version_is_good = OASISVersion.comparator_apply version (OASISVersion.VGreaterEqual min_version) in Printf.ksprintf (fun str -> if version_is_good then None else Some str) fmt in match origin, t.plugin, t.publication with | _, _, InDev Alpha -> check_feature data.Data.alpha_features Alpha | _, _, InDev Beta -> check_feature data.Data.beta_features Beta | Field(fld, where), None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version (f_ "Field %s in %s is only valid since OASIS v%s, update \ OASISFormat field from '%s' to '%s' after checking \ OASIS changelog.") fld where (string_of_version min_version) (string_of_version data.Data.oasis_version) (string_of_version min_version) | Field(fld, where), Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = try match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> failwithf (f_ "Field %s in %s is only valid for the OASIS \ plugin %s since v%s, but no plugin version is \ defined in the _oasis file, change '%s' to \ '%s (%s)' in your _oasis file.") fld where plugin_name (string_of_version min_version) plugin_name plugin_name (string_of_version min_version) with Not_found -> failwithf (f_ "Field %s in %s is only valid when the OASIS plugin %s \ is defined.") fld where plugin_name in version_is_good ~min_version plugin_version_current (f_ "Field %s in %s is only valid for the OASIS plugin %s \ since v%s, update your plugin from '%s (%s)' to \ '%s (%s)' after checking the plugin's changelog.") fld where plugin_name (string_of_version min_version) plugin_name (string_of_version plugin_version_current) plugin_name (string_of_version min_version) with Failure msg -> Some msg end | Section sct, None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version (f_ "Section %s is only valid for since OASIS v%s, update \ OASISFormat field from '%s' to '%s' after checking OASIS \ changelog.") sct (string_of_version min_version) (string_of_version data.Data.oasis_version) (string_of_version min_version) | Section sct, Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = try match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> failwithf (f_ "Section %s is only valid for the OASIS \ plugin %s since v%s, but no plugin version is \ defined in the _oasis file, change '%s' to \ '%s (%s)' in your _oasis file.") sct plugin_name (string_of_version min_version) plugin_name plugin_name (string_of_version min_version) with Not_found -> failwithf (f_ "Section %s is only valid when the OASIS plugin %s \ is defined.") sct plugin_name in version_is_good ~min_version plugin_version_current (f_ "Section %s is only valid for the OASIS plugin %s \ since v%s, update your plugin from '%s (%s)' to \ '%s (%s)' after checking the plugin's changelog.") sct plugin_name (string_of_version min_version) plugin_name (string_of_version plugin_version_current) plugin_name (string_of_version min_version) with Failure msg -> Some msg end | NoOrigin, None, SinceVersion min_version -> version_is_good ~min_version data.Data.oasis_version "%s" no_message | NoOrigin, Some(plugin_knd, plugin_name, _), SinceVersion min_version -> begin try let plugin_version_current = match Data.plugin_version plugin_knd plugin_name data with | Some ver -> ver | None -> raise Not_found in version_is_good ~min_version plugin_version_current "%s" no_message with Not_found -> Some no_message end let data_assert t data origin = match data_check t data origin with | None -> () | Some str -> failwith str let data_test t data = match data_check t data NoOrigin with | None -> true | Some str -> false let package_test t pkg = data_test t (Data.of_package pkg) let create ?plugin name publication description = let () = if Hashtbl.mem all_features name then failwithf "Feature '%s' is already declared." name in let t = { name = name; plugin = plugin; publication = publication; description = description; } in Hashtbl.add all_features name t; t let get_stage name = try (Hashtbl.find all_features name).publication with Not_found -> failwithf (f_ "Feature %s doesn't exist.") name let list () = Hashtbl.fold (fun _ v acc -> v :: acc) all_features [] (* * Real flags. *) let features = create "features_fields" (since_version "0.4") (fun () -> s_ "Enable to experiment not yet official features.") let flag_docs = create "flag_docs" (since_version "0.3") (fun () -> s_ "Building docs require '-docs' flag at configure.") let flag_tests = create "flag_tests" (since_version "0.3") (fun () -> s_ "Running tests require '-tests' flag at configure.") let pack = create "pack" (since_version "0.3") (fun () -> s_ "Allow to create packed library.") let section_object = create "section_object" beta (fun () -> s_ "Implement an object section.") let dynrun_for_release = create "dynrun_for_release" alpha (fun () -> s_ "Make '-setup-update dynamic' suitable for releasing project.") let compiled_setup_ml = create "compiled_setup_ml" alpha (fun () -> s_ "It compiles the setup.ml and speed-up actions done with it.") let disable_oasis_section = create "disable_oasis_section" alpha (fun () -> s_ "Allows the OASIS section comments and digest to be omitted in \ generated files.") let no_automatic_syntax = create "no_automatic_syntax" alpha (fun () -> s_ "Disable the automatic inclusion of -syntax camlp4o for packages \ that matches the internal heuristic (if a dependency ends with \ a .syntax or is a well known syntax).") end module OASISUnixPath = struct (* # 22 "src/oasis/OASISUnixPath.ml" *) type unix_filename = string type unix_dirname = string type host_filename = string type host_dirname = string let current_dir_name = "." let parent_dir_name = ".." let is_current_dir fn = fn = current_dir_name || fn = "" let concat f1 f2 = if is_current_dir f1 then f2 else let f1' = try OASISString.strip_ends_with ~what:"/" f1 with Not_found -> f1 in f1'^"/"^f2 let make = function | hd :: tl -> List.fold_left (fun f p -> concat f p) hd tl | [] -> invalid_arg "OASISUnixPath.make" let dirname f = try String.sub f 0 (String.rindex f '/') with Not_found -> current_dir_name let basename f = try let pos_start = (String.rindex f '/') + 1 in String.sub f pos_start ((String.length f) - pos_start) with Not_found -> f let chop_extension f = try let last_dot = String.rindex f '.' in let sub = String.sub f 0 last_dot in try let last_slash = String.rindex f '/' in if last_slash < last_dot then sub else f with Not_found -> sub with Not_found -> f let capitalize_file f = let dir = dirname f in let base = basename f in concat dir (String.capitalize base) let uncapitalize_file f = let dir = dirname f in let base = basename f in concat dir (String.uncapitalize base) end module OASISHostPath = struct (* # 22 "src/oasis/OASISHostPath.ml" *) open Filename module Unix = OASISUnixPath let make = function | [] -> invalid_arg "OASISHostPath.make" | hd :: tl -> List.fold_left Filename.concat hd tl let of_unix ufn = if Sys.os_type = "Unix" then ufn else make (List.map (fun p -> if p = Unix.current_dir_name then current_dir_name else if p = Unix.parent_dir_name then parent_dir_name else p) (OASISString.nsplit ufn '/')) end module OASISSection = struct (* # 22 "src/oasis/OASISSection.ml" *) open OASISTypes let section_kind_common = function | Library (cs, _, _) -> `Library, cs | Object (cs, _, _) -> `Object, cs | Executable (cs, _, _) -> `Executable, cs | Flag (cs, _) -> `Flag, cs | SrcRepo (cs, _) -> `SrcRepo, cs | Test (cs, _) -> `Test, cs | Doc (cs, _) -> `Doc, cs let section_common sct = snd (section_kind_common sct) let section_common_set cs = function | Library (_, bs, lib) -> Library (cs, bs, lib) | Object (_, bs, obj) -> Object (cs, bs, obj) | Executable (_, bs, exec) -> Executable (cs, bs, exec) | Flag (_, flg) -> Flag (cs, flg) | SrcRepo (_, src_repo) -> SrcRepo (cs, src_repo) | Test (_, tst) -> Test (cs, tst) | Doc (_, doc) -> Doc (cs, doc) (** Key used to identify section *) let section_id sct = let k, cs = section_kind_common sct in k, cs.cs_name let string_of_section sct = let k, nm = section_id sct in (match k with | `Library -> "library" | `Object -> "object" | `Executable -> "executable" | `Flag -> "flag" | `SrcRepo -> "src repository" | `Test -> "test" | `Doc -> "doc") ^" "^nm let section_find id scts = List.find (fun sct -> id = section_id sct) scts module CSection = struct type t = section let id = section_id let compare t1 t2 = compare (id t1) (id t2) let equal t1 t2 = (id t1) = (id t2) let hash t = Hashtbl.hash (id t) end module MapSection = Map.Make(CSection) module SetSection = Set.Make(CSection) end module OASISBuildSection = struct (* # 22 "src/oasis/OASISBuildSection.ml" *) end module OASISExecutable = struct (* # 22 "src/oasis/OASISExecutable.ml" *) open OASISTypes let unix_exec_is (cs, bs, exec) is_native ext_dll suffix_program = let dir = OASISUnixPath.concat bs.bs_path (OASISUnixPath.dirname exec.exec_main_is) in let is_native_exec = match bs.bs_compiled_object with | Native -> true | Best -> is_native () | Byte -> false in OASISUnixPath.concat dir (cs.cs_name^(suffix_program ())), if not is_native_exec && not exec.exec_custom && bs.bs_c_sources <> [] then Some (dir^"/dll"^cs.cs_name^"_stubs"^(ext_dll ())) else None end module OASISLibrary = struct (* # 22 "src/oasis/OASISLibrary.ml" *) open OASISTypes open OASISUtils open OASISGettext open OASISSection (* Look for a module file, considering capitalization or not. *) let find_module source_file_exists bs modul = let possible_base_fn = List.map (OASISUnixPath.concat bs.bs_path) [modul; OASISUnixPath.uncapitalize_file modul; OASISUnixPath.capitalize_file modul] in (* TODO: we should be able to be able to determine the source for every * files. Hence we should introduce a Module(source: fn) for the fields * Modules and InternalModules *) List.fold_left (fun acc base_fn -> match acc with | `No_sources _ -> begin let file_found = List.fold_left (fun acc ext -> if source_file_exists (base_fn^ext) then (base_fn^ext) :: acc else acc) [] [".ml"; ".mli"; ".mll"; ".mly"] in match file_found with | [] -> acc | lst -> `Sources (base_fn, lst) end | `Sources _ -> acc) (`No_sources possible_base_fn) possible_base_fn let source_unix_files ~ctxt (cs, bs, lib) source_file_exists = List.fold_left (fun acc modul -> match find_module source_file_exists bs modul with | `Sources (base_fn, lst) -> (base_fn, lst) :: acc | `No_sources _ -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching \ module '%s' in library %s") modul cs.cs_name; acc) [] (lib.lib_modules @ lib.lib_internal_modules) let generated_unix_files ~ctxt ~is_native ~has_native_dynlink ~ext_lib ~ext_dll ~source_file_exists (cs, bs, lib) = let find_modules lst ext = let find_module modul = match find_module source_file_exists bs modul with | `Sources (base_fn, [fn]) when ext <> "cmi" && Filename.check_suffix fn ".mli" -> None (* No implementation files for pure interface. *) | `Sources (base_fn, _) -> Some [base_fn] | `No_sources lst -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching \ module '%s' in library %s") modul cs.cs_name; Some lst in List.fold_left (fun acc nm -> match find_module nm with | None -> acc | Some base_fns -> List.map (fun base_fn -> base_fn ^"."^ext) base_fns :: acc) [] lst in (* The .cmx that be compiled along *) let cmxs = let should_be_built = match bs.bs_compiled_object with | Native -> true | Best -> is_native | Byte -> false in if should_be_built then if lib.lib_pack then find_modules [cs.cs_name] "cmx" else find_modules (lib.lib_modules @ lib.lib_internal_modules) "cmx" else [] in let acc_nopath = [] in (* The headers and annot/cmt files that should be compiled along *) let headers = let sufx = if lib.lib_pack then [".cmti"; ".cmt"; ".annot"] else [".cmi"; ".cmti"; ".cmt"; ".annot"] in List.map begin List.fold_left begin fun accu s -> let dot = String.rindex s '.' in let base = String.sub s 0 dot in List.map ((^) base) sufx @ accu end [] end (find_modules lib.lib_modules "cmi") in (* Compute what libraries should be built *) let acc_nopath = (* Add the packed header file if required *) let add_pack_header acc = if lib.lib_pack then [cs.cs_name^".cmi"; cs.cs_name^".cmti"; cs.cs_name^".cmt"] :: acc else acc in let byte acc = add_pack_header ([cs.cs_name^".cma"] :: acc) in let native acc = let acc = add_pack_header (if has_native_dynlink then [cs.cs_name^".cmxs"] :: acc else acc) in [cs.cs_name^".cmxa"] :: [cs.cs_name^ext_lib] :: acc in match bs.bs_compiled_object with | Native -> byte (native acc_nopath) | Best when is_native -> byte (native acc_nopath) | Byte | Best -> byte acc_nopath in (* Add C library to be built *) let acc_nopath = if bs.bs_c_sources <> [] then begin ["lib"^cs.cs_name^"_stubs"^ext_lib] :: ["dll"^cs.cs_name^"_stubs"^ext_dll] :: acc_nopath end else acc_nopath in (* All the files generated *) List.rev_append (List.rev_map (List.rev_map (OASISUnixPath.concat bs.bs_path)) acc_nopath) (headers @ cmxs) end module OASISObject = struct (* # 22 "src/oasis/OASISObject.ml" *) open OASISTypes open OASISGettext let source_unix_files ~ctxt (cs, bs, obj) source_file_exists = List.fold_left (fun acc modul -> match OASISLibrary.find_module source_file_exists bs modul with | `Sources (base_fn, lst) -> (base_fn, lst) :: acc | `No_sources _ -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching \ module '%s' in object %s") modul cs.cs_name; acc) [] obj.obj_modules let generated_unix_files ~ctxt ~is_native ~source_file_exists (cs, bs, obj) = let find_module ext modul = match OASISLibrary.find_module source_file_exists bs modul with | `Sources (base_fn, _) -> [base_fn ^ ext] | `No_sources lst -> OASISMessage.warning ~ctxt (f_ "Cannot find source file matching \ module '%s' in object %s") modul cs.cs_name ; lst in let header, byte, native, c_object, f = match obj.obj_modules with | [ m ] -> (find_module ".cmi" m, find_module ".cmo" m, find_module ".cmx" m, find_module ".o" m, fun x -> x) | _ -> ([cs.cs_name ^ ".cmi"], [cs.cs_name ^ ".cmo"], [cs.cs_name ^ ".cmx"], [cs.cs_name ^ ".o"], OASISUnixPath.concat bs.bs_path) in List.map (List.map f) ( match bs.bs_compiled_object with | Native -> native :: c_object :: byte :: header :: [] | Best when is_native -> native :: c_object :: byte :: header :: [] | Byte | Best -> byte :: header :: []) end module OASISFindlib = struct (* # 22 "src/oasis/OASISFindlib.ml" *) open OASISTypes open OASISUtils open OASISGettext open OASISSection type library_name = name type findlib_part_name = name type 'a map_of_findlib_part_name = 'a OASISUtils.MapString.t exception InternalLibraryNotFound of library_name exception FindlibPackageNotFound of findlib_name type group_t = | Container of findlib_name * group_t list | Package of (findlib_name * common_section * build_section * [`Library of library | `Object of object_] * group_t list) type data = common_section * build_section * [`Library of library | `Object of object_] type tree = | Node of (data option) * (tree MapString.t) | Leaf of data let findlib_mapping pkg = (* Map from library name to either full findlib name or parts + parent. *) let fndlb_parts_of_lib_name = let fndlb_parts cs lib = let name = match lib.lib_findlib_name with | Some nm -> nm | None -> cs.cs_name in let name = String.concat "." (lib.lib_findlib_containers @ [name]) in name in List.fold_left (fun mp -> function | Library (cs, _, lib) -> begin let lib_name = cs.cs_name in let fndlb_parts = fndlb_parts cs lib in if MapString.mem lib_name mp then failwithf (f_ "The library name '%s' is used more than once.") lib_name; match lib.lib_findlib_parent with | Some lib_name_parent -> MapString.add lib_name (`Unsolved (lib_name_parent, fndlb_parts)) mp | None -> MapString.add lib_name (`Solved fndlb_parts) mp end | Object (cs, _, obj) -> begin let obj_name = cs.cs_name in if MapString.mem obj_name mp then failwithf (f_ "The object name '%s' is used more than once.") obj_name; let findlib_full_name = match obj.obj_findlib_fullname with | Some ns -> String.concat "." ns | None -> obj_name in MapString.add obj_name (`Solved findlib_full_name) mp end | Executable _ | Test _ | Flag _ | SrcRepo _ | Doc _ -> mp) MapString.empty pkg.sections in (* Solve the above graph to be only library name to full findlib name. *) let fndlb_name_of_lib_name = let rec solve visited mp lib_name lib_name_child = if SetString.mem lib_name visited then failwithf (f_ "Library '%s' is involved in a cycle \ with regard to findlib naming.") lib_name; let visited = SetString.add lib_name visited in try match MapString.find lib_name mp with | `Solved fndlb_nm -> fndlb_nm, mp | `Unsolved (lib_nm_parent, post_fndlb_nm) -> let pre_fndlb_nm, mp = solve visited mp lib_nm_parent lib_name in let fndlb_nm = pre_fndlb_nm^"."^post_fndlb_nm in fndlb_nm, MapString.add lib_name (`Solved fndlb_nm) mp with Not_found -> failwithf (f_ "Library '%s', which is defined as the findlib parent of \ library '%s', doesn't exist.") lib_name lib_name_child in let mp = MapString.fold (fun lib_name status mp -> match status with | `Solved _ -> (* Solved initialy, no need to go further *) mp | `Unsolved _ -> let _, mp = solve SetString.empty mp lib_name "" in mp) fndlb_parts_of_lib_name fndlb_parts_of_lib_name in MapString.map (function | `Solved fndlb_nm -> fndlb_nm | `Unsolved _ -> assert false) mp in (* Convert an internal library name to a findlib name. *) let findlib_name_of_library_name lib_nm = try MapString.find lib_nm fndlb_name_of_lib_name with Not_found -> raise (InternalLibraryNotFound lib_nm) in (* Add a library to the tree. *) let add sct mp = let fndlb_fullname = let cs, _, _ = sct in let lib_name = cs.cs_name in findlib_name_of_library_name lib_name in let rec add_children nm_lst (children: tree MapString.t) = match nm_lst with | (hd :: tl) -> begin let node = try add_node tl (MapString.find hd children) with Not_found -> (* New node *) new_node tl in MapString.add hd node children end | [] -> (* Should not have a nameless library. *) assert false and add_node tl node = if tl = [] then begin match node with | Node (None, children) -> Node (Some sct, children) | Leaf (cs', _, _) | Node (Some (cs', _, _), _) -> (* TODO: allow to merge Package, i.e. * archive(byte) = "foo.cma foo_init.cmo" *) let cs, _, _ = sct in failwithf (f_ "Library '%s' and '%s' have the same findlib name '%s'") cs.cs_name cs'.cs_name fndlb_fullname end else begin match node with | Leaf data -> Node (Some data, add_children tl MapString.empty) | Node (data_opt, children) -> Node (data_opt, add_children tl children) end and new_node = function | [] -> Leaf sct | hd :: tl -> Node (None, MapString.add hd (new_node tl) MapString.empty) in add_children (OASISString.nsplit fndlb_fullname '.') mp in let rec group_of_tree mp = MapString.fold (fun nm node acc -> let cur = match node with | Node (Some (cs, bs, lib), children) -> Package (nm, cs, bs, lib, group_of_tree children) | Node (None, children) -> Container (nm, group_of_tree children) | Leaf (cs, bs, lib) -> Package (nm, cs, bs, lib, []) in cur :: acc) mp [] in let group_mp = List.fold_left (fun mp -> function | Library (cs, bs, lib) -> add (cs, bs, `Library lib) mp | Object (cs, bs, obj) -> add (cs, bs, `Object obj) mp | _ -> mp) MapString.empty pkg.sections in let groups = group_of_tree group_mp in let library_name_of_findlib_name = lazy begin (* Revert findlib_name_of_library_name. *) MapString.fold (fun k v mp -> MapString.add v k mp) fndlb_name_of_lib_name MapString.empty end in let library_name_of_findlib_name fndlb_nm = try MapString.find fndlb_nm (Lazy.force library_name_of_findlib_name) with Not_found -> raise (FindlibPackageNotFound fndlb_nm) in groups, findlib_name_of_library_name, library_name_of_findlib_name let findlib_of_group = function | Container (fndlb_nm, _) | Package (fndlb_nm, _, _, _, _) -> fndlb_nm let root_of_group grp = let rec root_lib_aux = (* We do a DFS in the group. *) function | Container (_, children) -> List.fold_left (fun res grp -> if res = None then root_lib_aux grp else res) None children | Package (_, cs, bs, lib, _) -> Some (cs, bs, lib) in match root_lib_aux grp with | Some res -> res | None -> failwithf (f_ "Unable to determine root library of findlib library '%s'") (findlib_of_group grp) end module OASISFlag = struct (* # 22 "src/oasis/OASISFlag.ml" *) end module OASISPackage = struct (* # 22 "src/oasis/OASISPackage.ml" *) end module OASISSourceRepository = struct (* # 22 "src/oasis/OASISSourceRepository.ml" *) end module OASISTest = struct (* # 22 "src/oasis/OASISTest.ml" *) end module OASISDocument = struct (* # 22 "src/oasis/OASISDocument.ml" *) end module OASISExec = struct (* # 22 "src/oasis/OASISExec.ml" *) open OASISGettext open OASISUtils open OASISMessage (* TODO: I don't like this quote, it is there because $(rm) foo expands to * 'rm -f' foo... *) let run ~ctxt ?f_exit_code ?(quote=true) cmd args = let cmd = if quote then if Sys.os_type = "Win32" then if String.contains cmd ' ' then (* Double the 1st double quote... win32... sigh *) "\""^(Filename.quote cmd) else cmd else Filename.quote cmd else cmd in let cmdline = String.concat " " (cmd :: args) in info ~ctxt (f_ "Running command '%s'") cmdline; match f_exit_code, Sys.command cmdline with | None, 0 -> () | None, i -> failwithf (f_ "Command '%s' terminated with error code %d") cmdline i | Some f, i -> f i let run_read_output ~ctxt ?f_exit_code cmd args = let fn = Filename.temp_file "oasis-" ".txt" in try begin let () = run ~ctxt ?f_exit_code cmd (args @ [">"; Filename.quote fn]) in let chn = open_in fn in let routput = ref [] in begin try while true do routput := (input_line chn) :: !routput done with End_of_file -> () end; close_in chn; Sys.remove fn; List.rev !routput end with e -> (try Sys.remove fn with _ -> ()); raise e let run_read_one_line ~ctxt ?f_exit_code cmd args = match run_read_output ~ctxt ?f_exit_code cmd args with | [fst] -> fst | lst -> failwithf (f_ "Command return unexpected output %S") (String.concat "\n" lst) end module OASISFileUtil = struct (* # 22 "src/oasis/OASISFileUtil.ml" *) open OASISGettext let file_exists_case fn = let dirname = Filename.dirname fn in let basename = Filename.basename fn in if Sys.file_exists dirname then if basename = Filename.current_dir_name then true else List.mem basename (Array.to_list (Sys.readdir dirname)) else false let find_file ?(case_sensitive=true) paths exts = (* Cardinal product of two list *) let ( * ) lst1 lst2 = List.flatten (List.map (fun a -> List.map (fun b -> a, b) lst2) lst1) in let rec combined_paths lst = match lst with | p1 :: p2 :: tl -> let acc = (List.map (fun (a, b) -> Filename.concat a b) (p1 * p2)) in combined_paths (acc :: tl) | [e] -> e | [] -> [] in let alternatives = List.map (fun (p, e) -> if String.length e > 0 && e.[0] <> '.' then p ^ "." ^ e else p ^ e) ((combined_paths paths) * exts) in List.find (fun file -> (if case_sensitive then file_exists_case file else Sys.file_exists file) && not (Sys.is_directory file) ) alternatives let which ~ctxt prg = let path_sep = match Sys.os_type with | "Win32" -> ';' | _ -> ':' in let path_lst = OASISString.nsplit (Sys.getenv "PATH") path_sep in let exec_ext = match Sys.os_type with | "Win32" -> "" :: (OASISString.nsplit (Sys.getenv "PATHEXT") path_sep) | _ -> [""] in find_file ~case_sensitive:false [path_lst; [prg]] exec_ext (**/**) let rec fix_dir dn = (* Windows hack because Sys.file_exists "src\\" = false when * Sys.file_exists "src" = true *) let ln = String.length dn in if Sys.os_type = "Win32" && ln > 0 && dn.[ln - 1] = '\\' then fix_dir (String.sub dn 0 (ln - 1)) else dn let q = Filename.quote (**/**) let cp ~ctxt ?(recurse=false) src tgt = if recurse then match Sys.os_type with | "Win32" -> OASISExec.run ~ctxt "xcopy" [q src; q tgt; "/E"] | _ -> OASISExec.run ~ctxt "cp" ["-r"; q src; q tgt] else OASISExec.run ~ctxt (match Sys.os_type with | "Win32" -> "copy" | _ -> "cp") [q src; q tgt] let mkdir ~ctxt tgt = OASISExec.run ~ctxt (match Sys.os_type with | "Win32" -> "md" | _ -> "mkdir") [q tgt] let rec mkdir_parent ~ctxt f tgt = let tgt = fix_dir tgt in if Sys.file_exists tgt then begin if not (Sys.is_directory tgt) then OASISUtils.failwithf (f_ "Cannot create directory '%s', a file of the same name already \ exists") tgt end else begin mkdir_parent ~ctxt f (Filename.dirname tgt); if not (Sys.file_exists tgt) then begin f tgt; mkdir ~ctxt tgt end end let rmdir ~ctxt tgt = if Sys.readdir tgt = [||] then begin match Sys.os_type with | "Win32" -> OASISExec.run ~ctxt "rd" [q tgt] | _ -> OASISExec.run ~ctxt "rm" ["-r"; q tgt] end else begin OASISMessage.error ~ctxt (f_ "Cannot remove directory '%s': not empty.") tgt end let glob ~ctxt fn = let basename = Filename.basename fn in if String.length basename >= 2 && basename.[0] = '*' && basename.[1] = '.' then begin let ext_len = (String.length basename) - 2 in let ext = String.sub basename 2 ext_len in let dirname = Filename.dirname fn in Array.fold_left (fun acc fn -> try let fn_ext = String.sub fn ((String.length fn) - ext_len) ext_len in if fn_ext = ext then (Filename.concat dirname fn) :: acc else acc with Invalid_argument _ -> acc) [] (Sys.readdir dirname) end else begin if file_exists_case fn then [fn] else [] end end # 2893 "setup.ml" module BaseEnvLight = struct (* # 22 "src/base/BaseEnvLight.ml" *) module MapString = Map.Make(String) type t = string MapString.t let default_filename = Filename.concat (Sys.getcwd ()) "setup.data" let load ?(allow_empty=false) ?(filename=default_filename) () = if Sys.file_exists filename then begin let chn = open_in_bin filename in let st = Stream.of_channel chn in let line = ref 1 in let st_line = Stream.from (fun _ -> try match Stream.next st with | '\n' -> incr line; Some '\n' | c -> Some c with Stream.Failure -> None) in let lexer = Genlex.make_lexer ["="] st_line in let rec read_file mp = match Stream.npeek 3 lexer with | [Genlex.Ident nm; Genlex.Kwd "="; Genlex.String value] -> Stream.junk lexer; Stream.junk lexer; Stream.junk lexer; read_file (MapString.add nm value mp) | [] -> mp | _ -> failwith (Printf.sprintf "Malformed data file '%s' line %d" filename !line) in let mp = read_file MapString.empty in close_in chn; mp end else if allow_empty then begin MapString.empty end else begin failwith (Printf.sprintf "Unable to load environment, the file '%s' doesn't exist." filename) end let rec var_expand str env = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try var_expand (MapString.find var env) env with Not_found -> failwith (Printf.sprintf "No variable %s defined when trying to expand %S." var str)) str; Buffer.contents buff let var_get name env = var_expand (MapString.find name env) env let var_choose lst env = OASISExpr.choose (fun nm -> var_get nm env) lst end # 2998 "setup.ml" module BaseContext = struct (* # 22 "src/base/BaseContext.ml" *) (* TODO: get rid of this module. *) open OASISContext let args () = fst (fspecs ()) let default = default end module BaseMessage = struct (* # 22 "src/base/BaseMessage.ml" *) (** Message to user, overrid for Base @author Sylvain Le Gall *) open OASISMessage open BaseContext let debug fmt = debug ~ctxt:!default fmt let info fmt = info ~ctxt:!default fmt let warning fmt = warning ~ctxt:!default fmt let error fmt = error ~ctxt:!default fmt end module BaseEnv = struct (* # 22 "src/base/BaseEnv.ml" *) open OASISGettext open OASISUtils open PropList module MapString = BaseEnvLight.MapString type origin_t = | ODefault | OGetEnv | OFileLoad | OCommandLine type cli_handle_t = | CLINone | CLIAuto | CLIWith | CLIEnable | CLIUser of (Arg.key * Arg.spec * Arg.doc) list type definition_t = { hide: bool; dump: bool; cli: cli_handle_t; arg_help: string option; group: string option; } let schema = Schema.create "environment" (* Environment data *) let env = Data.create () (* Environment data from file *) let env_from_file = ref MapString.empty (* Lexer for var *) let var_lxr = Genlex.make_lexer [] let rec var_expand str = let buff = Buffer.create ((String.length str) * 2) in Buffer.add_substitute buff (fun var -> try (* TODO: this is a quick hack to allow calling Test.Command * without defining executable name really. I.e. if there is * an exec Executable toto, then $(toto) should be replace * by its real name. It is however useful to have this function * for other variable that depend on the host and should be * written better than that. *) let st = var_lxr (Stream.of_string var) in match Stream.npeek 3 st with | [Genlex.Ident "utoh"; Genlex.Ident nm] -> OASISHostPath.of_unix (var_get nm) | [Genlex.Ident "utoh"; Genlex.String s] -> OASISHostPath.of_unix s | [Genlex.Ident "ocaml_escaped"; Genlex.Ident nm] -> String.escaped (var_get nm) | [Genlex.Ident "ocaml_escaped"; Genlex.String s] -> String.escaped s | [Genlex.Ident nm] -> var_get nm | _ -> failwithf (f_ "Unknown expression '%s' in variable expansion of %s.") var str with | Unknown_field (_, _) -> failwithf (f_ "No variable %s defined when trying to expand %S.") var str | Stream.Error e -> failwithf (f_ "Syntax error when parsing '%s' when trying to \ expand %S: %s") var str e) str; Buffer.contents buff and var_get name = let vl = try Schema.get schema env name with Unknown_field _ as e -> begin try MapString.find name !env_from_file with Not_found -> raise e end in var_expand vl let var_choose ?printer ?name lst = OASISExpr.choose ?printer ?name var_get lst let var_protect vl = let buff = Buffer.create (String.length vl) in String.iter (function | '$' -> Buffer.add_string buff "\\$" | c -> Buffer.add_char buff c) vl; Buffer.contents buff let var_define ?(hide=false) ?(dump=true) ?short_desc ?(cli=CLINone) ?arg_help ?group name (* TODO: type constraint on the fact that name must be a valid OCaml id *) dflt = let default = [ OFileLoad, (fun () -> MapString.find name !env_from_file); ODefault, dflt; OGetEnv, (fun () -> Sys.getenv name); ] in let extra = { hide = hide; dump = dump; cli = cli; arg_help = arg_help; group = group; } in (* Try to find a value that can be defined *) let var_get_low lst = let errors, res = List.fold_left (fun (errors, res) (o, v) -> if res = None then begin try errors, Some (v ()) with | Not_found -> errors, res | Failure rsn -> (rsn :: errors), res | e -> (Printexc.to_string e) :: errors, res end else errors, res) ([], None) (List.sort (fun (o1, _) (o2, _) -> Pervasives.compare o2 o1) lst) in match res, errors with | Some v, _ -> v | None, [] -> raise (Not_set (name, None)) | None, lst -> raise (Not_set (name, Some (String.concat (s_ ", ") lst))) in let help = match short_desc with | Some fs -> Some fs | None -> None in let var_get_lst = FieldRO.create ~schema ~name ~parse:(fun ?(context=ODefault) s -> [context, fun () -> s]) ~print:var_get_low ~default ~update:(fun ?context x old_x -> x @ old_x) ?help extra in fun () -> var_expand (var_get_low (var_get_lst env)) let var_redefine ?hide ?dump ?short_desc ?cli ?arg_help ?group name dflt = if Schema.mem schema name then begin (* TODO: look suspsicious, we want to memorize dflt not dflt () *) Schema.set schema env ~context:ODefault name (dflt ()); fun () -> var_get name end else begin var_define ?hide ?dump ?short_desc ?cli ?arg_help ?group name dflt end let var_ignore (e: unit -> string) = () let print_hidden = var_define ~hide:true ~dump:false ~cli:CLIAuto ~arg_help:"Print even non-printable variable. (debug)" "print_hidden" (fun () -> "false") let var_all () = List.rev (Schema.fold (fun acc nm def _ -> if not def.hide || bool_of_string (print_hidden ()) then nm :: acc else acc) [] schema) let default_filename = BaseEnvLight.default_filename let load ?allow_empty ?filename () = env_from_file := BaseEnvLight.load ?allow_empty ?filename () let unload () = env_from_file := MapString.empty; Data.clear env let dump ?(filename=default_filename) () = let chn = open_out_bin filename in let output nm value = Printf.fprintf chn "%s=%S\n" nm value in let mp_todo = (* Dump data from schema *) Schema.fold (fun mp_todo nm def _ -> if def.dump then begin try let value = Schema.get schema env nm in output nm value with Not_set _ -> () end; MapString.remove nm mp_todo) !env_from_file schema in (* Dump data defined outside of schema *) MapString.iter output mp_todo; (* End of the dump *) close_out chn let print () = let printable_vars = Schema.fold (fun acc nm def short_descr_opt -> if not def.hide || bool_of_string (print_hidden ()) then begin try let value = Schema.get schema env nm in let txt = match short_descr_opt with | Some s -> s () | None -> nm in (txt, value) :: acc with Not_set _ -> acc end else acc) [] schema in let max_length = List.fold_left max 0 (List.rev_map String.length (List.rev_map fst printable_vars)) in let dot_pad str = String.make ((max_length - (String.length str)) + 3) '.' in Printf.printf "\nConfiguration: \n"; List.iter (fun (name, value) -> Printf.printf "%s: %s %s\n" name (dot_pad name) value) (List.rev printable_vars); Printf.printf "\n%!" let args () = let arg_concat = OASISUtils.varname_concat ~hyphen:'-' in [ "--override", Arg.Tuple ( let rvr = ref "" in let rvl = ref "" in [ Arg.Set_string rvr; Arg.Set_string rvl; Arg.Unit (fun () -> Schema.set schema env ~context:OCommandLine !rvr !rvl) ] ), "var+val Override any configuration variable."; ] @ List.flatten (Schema.fold (fun acc name def short_descr_opt -> let var_set s = Schema.set schema env ~context:OCommandLine name s in let arg_name = OASISUtils.varname_of_string ~hyphen:'-' name in let hlp = match short_descr_opt with | Some txt -> txt () | None -> "" in let arg_hlp = match def.arg_help with | Some s -> s | None -> "str" in let default_value = try Printf.sprintf (f_ " [%s]") (Schema.get schema env name) with Not_set _ -> "" in let args = match def.cli with | CLINone -> [] | CLIAuto -> [ arg_concat "--" arg_name, Arg.String var_set, Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value ] | CLIWith -> [ arg_concat "--with-" arg_name, Arg.String var_set, Printf.sprintf (f_ "%s %s%s") arg_hlp hlp default_value ] | CLIEnable -> let dflt = if default_value = " [true]" then s_ " [default: enabled]" else s_ " [default: disabled]" in [ arg_concat "--enable-" arg_name, Arg.Unit (fun () -> var_set "true"), Printf.sprintf (f_ " %s%s") hlp dflt; arg_concat "--disable-" arg_name, Arg.Unit (fun () -> var_set "false"), Printf.sprintf (f_ " %s%s") hlp dflt ] | CLIUser lst -> lst in args :: acc) [] schema) end module BaseArgExt = struct (* # 22 "src/base/BaseArgExt.ml" *) open OASISUtils open OASISGettext let parse argv args = (* Simulate command line for Arg *) let current = ref 0 in try Arg.parse_argv ~current:current (Array.concat [[|"none"|]; argv]) (Arg.align args) (failwithf (f_ "Don't know what to do with arguments: '%s'")) (s_ "configure options:") with | Arg.Help txt -> print_endline txt; exit 0 | Arg.Bad txt -> prerr_endline txt; exit 1 end module BaseCheck = struct (* # 22 "src/base/BaseCheck.ml" *) open BaseEnv open BaseMessage open OASISUtils open OASISGettext let prog_best prg prg_lst = var_redefine prg (fun () -> let alternate = List.fold_left (fun res e -> match res with | Some _ -> res | None -> try Some (OASISFileUtil.which ~ctxt:!BaseContext.default e) with Not_found -> None) None prg_lst in match alternate with | Some prg -> prg | None -> raise Not_found) let prog prg = prog_best prg [prg] let prog_opt prg = prog_best prg [prg^".opt"; prg] let ocamlfind = prog "ocamlfind" let version var_prefix cmp fversion () = (* Really compare version provided *) let var = var_prefix^"_version_"^(OASISVersion.varname_of_comparator cmp) in var_redefine ~hide:true var (fun () -> let version_str = match fversion () with | "[Distributed with OCaml]" -> begin try (var_get "ocaml_version") with Not_found -> warning (f_ "Variable ocaml_version not defined, fallback \ to default"); Sys.ocaml_version end | res -> res in let version = OASISVersion.version_of_string version_str in if OASISVersion.comparator_apply version cmp then version_str else failwithf (f_ "Cannot satisfy version constraint on %s: %s (version: %s)") var_prefix (OASISVersion.string_of_comparator cmp) version_str) () let package_version pkg = OASISExec.run_read_one_line ~ctxt:!BaseContext.default (ocamlfind ()) ["query"; "-format"; "%v"; pkg] let package ?version_comparator pkg () = let var = OASISUtils.varname_concat "pkg_" (OASISUtils.varname_of_string pkg) in let findlib_dir pkg = let dir = OASISExec.run_read_one_line ~ctxt:!BaseContext.default (ocamlfind ()) ["query"; "-format"; "%d"; pkg] in if Sys.file_exists dir && Sys.is_directory dir then dir else failwithf (f_ "When looking for findlib package %s, \ directory %s return doesn't exist") pkg dir in let vl = var_redefine var (fun () -> findlib_dir pkg) () in ( match version_comparator with | Some ver_cmp -> ignore (version var ver_cmp (fun _ -> package_version pkg) ()) | None -> () ); vl end module BaseOCamlcConfig = struct (* # 22 "src/base/BaseOCamlcConfig.ml" *) open BaseEnv open OASISUtils open OASISGettext module SMap = Map.Make(String) let ocamlc = BaseCheck.prog_opt "ocamlc" let ocamlc_config_map = (* Map name to value for ocamlc -config output (name ^": "^value) *) let rec split_field mp lst = match lst with | line :: tl -> let mp = try let pos_semicolon = String.index line ':' in if pos_semicolon > 1 then ( let name = String.sub line 0 pos_semicolon in let linelen = String.length line in let value = if linelen > pos_semicolon + 2 then String.sub line (pos_semicolon + 2) (linelen - pos_semicolon - 2) else "" in SMap.add name value mp ) else ( mp ) with Not_found -> ( mp ) in split_field mp tl | [] -> mp in let cache = lazy (var_protect (Marshal.to_string (split_field SMap.empty (OASISExec.run_read_output ~ctxt:!BaseContext.default (ocamlc ()) ["-config"])) [])) in var_redefine "ocamlc_config_map" ~hide:true ~dump:false (fun () -> (* TODO: update if ocamlc change !!! *) Lazy.force cache) let var_define nm = (* Extract data from ocamlc -config *) let avlbl_config_get () = Marshal.from_string (ocamlc_config_map ()) 0 in let chop_version_suffix s = try String.sub s 0 (String.index s '+') with _ -> s in let nm_config, value_config = match nm with | "ocaml_version" -> "version", chop_version_suffix | _ -> nm, (fun x -> x) in var_redefine nm (fun () -> try let map = avlbl_config_get () in let value = SMap.find nm_config map in value_config value with Not_found -> failwithf (f_ "Cannot find field '%s' in '%s -config' output") nm (ocamlc ())) end module BaseStandardVar = struct (* # 22 "src/base/BaseStandardVar.ml" *) open OASISGettext open OASISTypes open OASISExpr open BaseCheck open BaseEnv let ocamlfind = BaseCheck.ocamlfind let ocamlc = BaseOCamlcConfig.ocamlc let ocamlopt = prog_opt "ocamlopt" let ocamlbuild = prog "ocamlbuild" (**/**) let rpkg = ref None let pkg_get () = match !rpkg with | Some pkg -> pkg | None -> failwith (s_ "OASIS Package is not set") let var_cond = ref [] let var_define_cond ~since_version f dflt = let holder = ref (fun () -> dflt) in let since_version = OASISVersion.VGreaterEqual (OASISVersion.version_of_string since_version) in var_cond := (fun ver -> if OASISVersion.comparator_apply ver since_version then holder := f ()) :: !var_cond; fun () -> !holder () (**/**) let pkg_name = var_define ~short_desc:(fun () -> s_ "Package name") "pkg_name" (fun () -> (pkg_get ()).name) let pkg_version = var_define ~short_desc:(fun () -> s_ "Package version") "pkg_version" (fun () -> (OASISVersion.string_of_version (pkg_get ()).version)) let c = BaseOCamlcConfig.var_define let os_type = c "os_type" let system = c "system" let architecture = c "architecture" let ccomp_type = c "ccomp_type" let ocaml_version = c "ocaml_version" (* TODO: Check standard variable presence at runtime *) let standard_library_default = c "standard_library_default" let standard_library = c "standard_library" let standard_runtime = c "standard_runtime" let bytecomp_c_compiler = c "bytecomp_c_compiler" let native_c_compiler = c "native_c_compiler" let model = c "model" let ext_obj = c "ext_obj" let ext_asm = c "ext_asm" let ext_lib = c "ext_lib" let ext_dll = c "ext_dll" let default_executable_name = c "default_executable_name" let systhread_supported = c "systhread_supported" let flexlink = BaseCheck.prog "flexlink" let flexdll_version = var_define ~short_desc:(fun () -> "FlexDLL version (Win32)") "flexdll_version" (fun () -> let lst = OASISExec.run_read_output ~ctxt:!BaseContext.default (flexlink ()) ["-help"] in match lst with | line :: _ -> Scanf.sscanf line "FlexDLL version %s" (fun ver -> ver) | [] -> raise Not_found) (**/**) let p name hlp dflt = var_define ~short_desc:hlp ~cli:CLIAuto ~arg_help:"dir" name dflt let (/) a b = if os_type () = Sys.os_type then Filename.concat a b else if os_type () = "Unix" then OASISUnixPath.concat a b else OASISUtils.failwithf (f_ "Cannot handle os_type %s filename concat") (os_type ()) (**/**) let prefix = p "prefix" (fun () -> s_ "Install architecture-independent files dir") (fun () -> match os_type () with | "Win32" -> let program_files = Sys.getenv "PROGRAMFILES" in program_files/(pkg_name ()) | _ -> "/usr/local") let exec_prefix = p "exec_prefix" (fun () -> s_ "Install architecture-dependent files in dir") (fun () -> "$prefix") let bindir = p "bindir" (fun () -> s_ "User executables") (fun () -> "$exec_prefix"/"bin") let sbindir = p "sbindir" (fun () -> s_ "System admin executables") (fun () -> "$exec_prefix"/"sbin") let libexecdir = p "libexecdir" (fun () -> s_ "Program executables") (fun () -> "$exec_prefix"/"libexec") let sysconfdir = p "sysconfdir" (fun () -> s_ "Read-only single-machine data") (fun () -> "$prefix"/"etc") let sharedstatedir = p "sharedstatedir" (fun () -> s_ "Modifiable architecture-independent data") (fun () -> "$prefix"/"com") let localstatedir = p "localstatedir" (fun () -> s_ "Modifiable single-machine data") (fun () -> "$prefix"/"var") let libdir = p "libdir" (fun () -> s_ "Object code libraries") (fun () -> "$exec_prefix"/"lib") let datarootdir = p "datarootdir" (fun () -> s_ "Read-only arch-independent data root") (fun () -> "$prefix"/"share") let datadir = p "datadir" (fun () -> s_ "Read-only architecture-independent data") (fun () -> "$datarootdir") let infodir = p "infodir" (fun () -> s_ "Info documentation") (fun () -> "$datarootdir"/"info") let localedir = p "localedir" (fun () -> s_ "Locale-dependent data") (fun () -> "$datarootdir"/"locale") let mandir = p "mandir" (fun () -> s_ "Man documentation") (fun () -> "$datarootdir"/"man") let docdir = p "docdir" (fun () -> s_ "Documentation root") (fun () -> "$datarootdir"/"doc"/"$pkg_name") let htmldir = p "htmldir" (fun () -> s_ "HTML documentation") (fun () -> "$docdir") let dvidir = p "dvidir" (fun () -> s_ "DVI documentation") (fun () -> "$docdir") let pdfdir = p "pdfdir" (fun () -> s_ "PDF documentation") (fun () -> "$docdir") let psdir = p "psdir" (fun () -> s_ "PS documentation") (fun () -> "$docdir") let destdir = p "destdir" (fun () -> s_ "Prepend a path when installing package") (fun () -> raise (PropList.Not_set ("destdir", Some (s_ "undefined by construct")))) let findlib_version = var_define "findlib_version" (fun () -> BaseCheck.package_version "findlib") let is_native = var_define "is_native" (fun () -> try let _s: string = ocamlopt () in "true" with PropList.Not_set _ -> let _s: string = ocamlc () in "false") let ext_program = var_define "suffix_program" (fun () -> match os_type () with | "Win32" | "Cygwin" -> ".exe" | _ -> "") let rm = var_define ~short_desc:(fun () -> s_ "Remove a file.") "rm" (fun () -> match os_type () with | "Win32" -> "del" | _ -> "rm -f") let rmdir = var_define ~short_desc:(fun () -> s_ "Remove a directory.") "rmdir" (fun () -> match os_type () with | "Win32" -> "rd" | _ -> "rm -rf") let debug = var_define ~short_desc:(fun () -> s_ "Turn ocaml debug flag on") ~cli:CLIEnable "debug" (fun () -> "true") let profile = var_define ~short_desc:(fun () -> s_ "Turn ocaml profile flag on") ~cli:CLIEnable "profile" (fun () -> "false") let tests = var_define_cond ~since_version:"0.3" (fun () -> var_define ~short_desc:(fun () -> s_ "Compile tests executable and library and run them") ~cli:CLIEnable "tests" (fun () -> "false")) "true" let docs = var_define_cond ~since_version:"0.3" (fun () -> var_define ~short_desc:(fun () -> s_ "Create documentations") ~cli:CLIEnable "docs" (fun () -> "true")) "true" let native_dynlink = var_define ~short_desc:(fun () -> s_ "Compiler support generation of .cmxs.") ~cli:CLINone "native_dynlink" (fun () -> let res = let ocaml_lt_312 () = OASISVersion.comparator_apply (OASISVersion.version_of_string (ocaml_version ())) (OASISVersion.VLesser (OASISVersion.version_of_string "3.12.0")) in let flexdll_lt_030 () = OASISVersion.comparator_apply (OASISVersion.version_of_string (flexdll_version ())) (OASISVersion.VLesser (OASISVersion.version_of_string "0.30")) in let has_native_dynlink = let ocamlfind = ocamlfind () in try let fn = OASISExec.run_read_one_line ~ctxt:!BaseContext.default ocamlfind ["query"; "-predicates"; "native"; "dynlink"; "-format"; "%d/%a"] in Sys.file_exists fn with _ -> false in if not has_native_dynlink then false else if ocaml_lt_312 () then false else if (os_type () = "Win32" || os_type () = "Cygwin") && flexdll_lt_030 () then begin BaseMessage.warning (f_ ".cmxs generation disabled because FlexDLL needs to be \ at least 0.30. Please upgrade FlexDLL from %s to 0.30.") (flexdll_version ()); false end else true in string_of_bool res) let init pkg = rpkg := Some pkg; List.iter (fun f -> f pkg.oasis_version) !var_cond end module BaseFileAB = struct (* # 22 "src/base/BaseFileAB.ml" *) open BaseEnv open OASISGettext open BaseMessage let to_filename fn = let fn = OASISHostPath.of_unix fn in if not (Filename.check_suffix fn ".ab") then warning (f_ "File '%s' doesn't have '.ab' extension") fn; Filename.chop_extension fn let replace fn_lst = let buff = Buffer.create 13 in List.iter (fun fn -> let fn = OASISHostPath.of_unix fn in let chn_in = open_in fn in let chn_out = open_out (to_filename fn) in ( try while true do Buffer.add_string buff (var_expand (input_line chn_in)); Buffer.add_char buff '\n' done with End_of_file -> () ); Buffer.output_buffer chn_out buff; Buffer.clear buff; close_in chn_in; close_out chn_out) fn_lst end module BaseLog = struct (* # 22 "src/base/BaseLog.ml" *) open OASISUtils let default_filename = Filename.concat (Filename.dirname BaseEnv.default_filename) "setup.log" module SetTupleString = Set.Make (struct type t = string * string let compare (s11, s12) (s21, s22) = match String.compare s11 s21 with | 0 -> String.compare s12 s22 | n -> n end) let load () = if Sys.file_exists default_filename then begin let chn = open_in default_filename in let scbuf = Scanf.Scanning.from_file default_filename in let rec read_aux (st, lst) = if not (Scanf.Scanning.end_of_input scbuf) then begin let acc = try Scanf.bscanf scbuf "%S %S\n" (fun e d -> let t = e, d in if SetTupleString.mem t st then st, lst else SetTupleString.add t st, t :: lst) with Scanf.Scan_failure _ -> failwith (Scanf.bscanf scbuf "%l" (fun line -> Printf.sprintf "Malformed log file '%s' at line %d" default_filename line)) in read_aux acc end else begin close_in chn; List.rev lst end in read_aux (SetTupleString.empty, []) end else begin [] end let register event data = let chn_out = open_out_gen [Open_append; Open_creat; Open_text] 0o644 default_filename in Printf.fprintf chn_out "%S %S\n" event data; close_out chn_out let unregister event data = if Sys.file_exists default_filename then begin let lst = load () in let chn_out = open_out default_filename in let write_something = ref false in List.iter (fun (e, d) -> if e <> event || d <> data then begin write_something := true; Printf.fprintf chn_out "%S %S\n" e d end) lst; close_out chn_out; if not !write_something then Sys.remove default_filename end let filter events = let st_events = List.fold_left (fun st e -> SetString.add e st) SetString.empty events in List.filter (fun (e, _) -> SetString.mem e st_events) (load ()) let exists event data = List.exists (fun v -> (event, data) = v) (load ()) end module BaseBuilt = struct (* # 22 "src/base/BaseBuilt.ml" *) open OASISTypes open OASISGettext open BaseStandardVar open BaseMessage type t = | BExec (* Executable *) | BExecLib (* Library coming with executable *) | BLib (* Library *) | BObj (* Library *) | BDoc (* Document *) let to_log_event_file t nm = "built_"^ (match t with | BExec -> "exec" | BExecLib -> "exec_lib" | BLib -> "lib" | BObj -> "obj" | BDoc -> "doc")^ "_"^nm let to_log_event_done t nm = "is_"^(to_log_event_file t nm) let register t nm lst = BaseLog.register (to_log_event_done t nm) "true"; List.iter (fun alt -> let registered = List.fold_left (fun registered fn -> if OASISFileUtil.file_exists_case fn then begin BaseLog.register (to_log_event_file t nm) (if Filename.is_relative fn then Filename.concat (Sys.getcwd ()) fn else fn); true end else registered) false alt in if not registered then warning (f_ "Cannot find an existing alternative files among: %s") (String.concat (s_ ", ") alt)) lst let unregister t nm = List.iter (fun (e, d) -> BaseLog.unregister e d) (BaseLog.filter [to_log_event_file t nm; to_log_event_done t nm]) let fold t nm f acc = List.fold_left (fun acc (_, fn) -> if OASISFileUtil.file_exists_case fn then begin f acc fn end else begin warning (f_ "File '%s' has been marked as built \ for %s but doesn't exist") fn (Printf.sprintf (match t with | BExec | BExecLib -> (f_ "executable %s") | BLib -> (f_ "library %s") | BObj -> (f_ "object %s") | BDoc -> (f_ "documentation %s")) nm); acc end) acc (BaseLog.filter [to_log_event_file t nm]) let is_built t nm = List.fold_left (fun is_built (_, d) -> (try bool_of_string d with _ -> false)) false (BaseLog.filter [to_log_event_done t nm]) let of_executable ffn (cs, bs, exec) = let unix_exec_is, unix_dll_opt = OASISExecutable.unix_exec_is (cs, bs, exec) (fun () -> bool_of_string (is_native ())) ext_dll ext_program in let evs = (BExec, cs.cs_name, [[ffn unix_exec_is]]) :: (match unix_dll_opt with | Some fn -> [BExecLib, cs.cs_name, [[ffn fn]]] | None -> []) in evs, unix_exec_is, unix_dll_opt let of_library ffn (cs, bs, lib) = let unix_lst = OASISLibrary.generated_unix_files ~ctxt:!BaseContext.default ~source_file_exists:(fun fn -> OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) ~is_native:(bool_of_string (is_native ())) ~has_native_dynlink:(bool_of_string (native_dynlink ())) ~ext_lib:(ext_lib ()) ~ext_dll:(ext_dll ()) (cs, bs, lib) in let evs = [BLib, cs.cs_name, List.map (List.map ffn) unix_lst] in evs, unix_lst let of_object ffn (cs, bs, obj) = let unix_lst = OASISObject.generated_unix_files ~ctxt:!BaseContext.default ~source_file_exists:(fun fn -> OASISFileUtil.file_exists_case (OASISHostPath.of_unix fn)) ~is_native:(bool_of_string (is_native ())) (cs, bs, obj) in let evs = [BObj, cs.cs_name, List.map (List.map ffn) unix_lst] in evs, unix_lst end module BaseCustom = struct (* # 22 "src/base/BaseCustom.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISGettext let run cmd args extra_args = OASISExec.run ~ctxt:!BaseContext.default ~quote:false (var_expand cmd) (List.map var_expand (args @ (Array.to_list extra_args))) let hook ?(failsafe=false) cstm f e = let optional_command lst = let printer = function | Some (cmd, args) -> String.concat " " (cmd :: args) | None -> s_ "No command" in match var_choose ~name:(s_ "Pre/Post Command") ~printer lst with | Some (cmd, args) -> begin try run cmd args [||] with e when failsafe -> warning (f_ "Command '%s' fail with error: %s") (String.concat " " (cmd :: args)) (match e with | Failure msg -> msg | e -> Printexc.to_string e) end | None -> () in let res = optional_command cstm.pre_command; f e in optional_command cstm.post_command; res end module BaseDynVar = struct (* # 22 "src/base/BaseDynVar.ml" *) open OASISTypes open OASISGettext open BaseEnv open BaseBuilt let init pkg = (* TODO: disambiguate exec vs other variable by adding exec_VARNAME. *) (* TODO: provide compile option for library libary_byte_args_VARNAME... *) List.iter (function | Executable (cs, bs, exec) -> if var_choose bs.bs_build then var_ignore (var_redefine (* We don't save this variable *) ~dump:false ~short_desc:(fun () -> Printf.sprintf (f_ "Filename of executable '%s'") cs.cs_name) (OASISUtils.varname_of_string cs.cs_name) (fun () -> let fn_opt = fold BExec cs.cs_name (fun _ fn -> Some fn) None in match fn_opt with | Some fn -> fn | None -> raise (PropList.Not_set (cs.cs_name, Some (Printf.sprintf (f_ "Executable '%s' not yet built.") cs.cs_name))))) | Library _ | Object _ | Flag _ | Test _ | SrcRepo _ | Doc _ -> ()) pkg.sections end module BaseTest = struct (* # 22 "src/base/BaseTest.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISExpr open OASISGettext let test lst pkg extra_args = let one_test (failure, n) (test_plugin, cs, test) = if var_choose ~name:(Printf.sprintf (f_ "test %s run") cs.cs_name) ~printer:string_of_bool test.test_run then begin let () = info (f_ "Running test '%s'") cs.cs_name in let back_cwd = match test.test_working_directory with | Some dir -> let cwd = Sys.getcwd () in let chdir d = info (f_ "Changing directory to '%s'") d; Sys.chdir d in chdir dir; fun () -> chdir cwd | None -> fun () -> () in try let failure_percent = BaseCustom.hook test.test_custom (test_plugin pkg (cs, test)) extra_args in back_cwd (); (failure_percent +. failure, n + 1) with e -> begin back_cwd (); raise e end end else begin info (f_ "Skipping test '%s'") cs.cs_name; (failure, n) end in let failed, n = List.fold_left one_test (0.0, 0) lst in let failure_percent = if n = 0 then 0.0 else failed /. (float_of_int n) in let msg = Printf.sprintf (f_ "Tests had a %.2f%% failure rate") (100. *. failure_percent) in if failure_percent > 0.0 then failwith msg else info "%s" msg; (* Possible explanation why the tests where not run. *) if OASISFeatures.package_test OASISFeatures.flag_tests pkg && not (bool_of_string (BaseStandardVar.tests ())) && lst <> [] then BaseMessage.warning "Tests are turned off, consider enabling with \ 'ocaml setup.ml -configure --enable-tests'" end module BaseDoc = struct (* # 22 "src/base/BaseDoc.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISGettext let doc lst pkg extra_args = let one_doc (doc_plugin, cs, doc) = if var_choose ~name:(Printf.sprintf (f_ "documentation %s build") cs.cs_name) ~printer:string_of_bool doc.doc_build then begin info (f_ "Building documentation '%s'") cs.cs_name; BaseCustom.hook doc.doc_custom (doc_plugin pkg (cs, doc)) extra_args end in List.iter one_doc lst; if OASISFeatures.package_test OASISFeatures.flag_docs pkg && not (bool_of_string (BaseStandardVar.docs ())) && lst <> [] then BaseMessage.warning "Docs are turned off, consider enabling with \ 'ocaml setup.ml -configure --enable-docs'" end module BaseSetup = struct (* # 22 "src/base/BaseSetup.ml" *) open BaseEnv open BaseMessage open OASISTypes open OASISSection open OASISGettext open OASISUtils type std_args_fun = package -> string array -> unit type ('a, 'b) section_args_fun = name * (package -> (common_section * 'a) -> string array -> 'b) type t = { configure: std_args_fun; build: std_args_fun; doc: ((doc, unit) section_args_fun) list; test: ((test, float) section_args_fun) list; install: std_args_fun; uninstall: std_args_fun; clean: std_args_fun list; clean_doc: (doc, unit) section_args_fun list; clean_test: (test, unit) section_args_fun list; distclean: std_args_fun list; distclean_doc: (doc, unit) section_args_fun list; distclean_test: (test, unit) section_args_fun list; package: package; oasis_fn: string option; oasis_version: string; oasis_digest: Digest.t option; oasis_exec: string option; oasis_setup_args: string list; setup_update: bool; } (* Associate a plugin function with data from package *) let join_plugin_sections filter_map lst = List.rev (List.fold_left (fun acc sct -> match filter_map sct with | Some e -> e :: acc | None -> acc) [] lst) (* Search for plugin data associated with a section name *) let lookup_plugin_section plugin action nm lst = try List.assoc nm lst with Not_found -> failwithf (f_ "Cannot find plugin %s matching section %s for %s action") plugin nm action let configure t args = (* Run configure *) BaseCustom.hook t.package.conf_custom (fun () -> (* Reload if preconf has changed it *) begin try unload (); load (); with _ -> () end; (* Run plugin's configure *) t.configure t.package args; (* Dump to allow postconf to change it *) dump ()) (); (* Reload environment *) unload (); load (); (* Save environment *) print (); (* Replace data in file *) BaseFileAB.replace t.package.files_ab let build t args = BaseCustom.hook t.package.build_custom (t.build t.package) args let doc t args = BaseDoc.doc (join_plugin_sections (function | Doc (cs, e) -> Some (lookup_plugin_section "documentation" (s_ "build") cs.cs_name t.doc, cs, e) | _ -> None) t.package.sections) t.package args let test t args = BaseTest.test (join_plugin_sections (function | Test (cs, e) -> Some (lookup_plugin_section "test" (s_ "run") cs.cs_name t.test, cs, e) | _ -> None) t.package.sections) t.package args let all t args = let rno_doc = ref false in let rno_test = ref false in let arg_rest = ref [] in Arg.parse_argv ~current:(ref 0) (Array.of_list ((Sys.executable_name^" all") :: (Array.to_list args))) [ "-no-doc", Arg.Set rno_doc, s_ "Don't run doc target"; "-no-test", Arg.Set rno_test, s_ "Don't run test target"; "--", Arg.Rest (fun arg -> arg_rest := arg :: !arg_rest), s_ "All arguments for configure."; ] (failwithf (f_ "Don't know what to do with '%s'")) ""; info "Running configure step"; configure t (Array.of_list (List.rev !arg_rest)); info "Running build step"; build t [||]; (* Load setup.log dynamic variables *) BaseDynVar.init t.package; if not !rno_doc then begin info "Running doc step"; doc t [||]; end else begin info "Skipping doc step" end; if not !rno_test then begin info "Running test step"; test t [||] end else begin info "Skipping test step" end let install t args = BaseCustom.hook t.package.install_custom (t.install t.package) args let uninstall t args = BaseCustom.hook t.package.uninstall_custom (t.uninstall t.package) args let reinstall t args = uninstall t args; install t args let clean, distclean = let failsafe f a = try f a with e -> warning (f_ "Action fail with error: %s") (match e with | Failure msg -> msg | e -> Printexc.to_string e) in let generic_clean t cstm mains docs tests args = BaseCustom.hook ~failsafe:true cstm (fun () -> (* Clean section *) List.iter (function | Test (cs, test) -> let f = try List.assoc cs.cs_name tests with Not_found -> fun _ _ _ -> () in failsafe (f t.package (cs, test)) args | Doc (cs, doc) -> let f = try List.assoc cs.cs_name docs with Not_found -> fun _ _ _ -> () in failsafe (f t.package (cs, doc)) args | Library _ | Object _ | Executable _ | Flag _ | SrcRepo _ -> ()) t.package.sections; (* Clean whole package *) List.iter (fun f -> failsafe (f t.package) args) mains) () in let clean t args = generic_clean t t.package.clean_custom t.clean t.clean_doc t.clean_test args in let distclean t args = (* Call clean *) clean t args; (* Call distclean code *) generic_clean t t.package.distclean_custom t.distclean t.distclean_doc t.distclean_test args; (* Remove generated file *) List.iter (fun fn -> if Sys.file_exists fn then begin info (f_ "Remove '%s'") fn; Sys.remove fn end) (BaseEnv.default_filename :: BaseLog.default_filename :: (List.rev_map BaseFileAB.to_filename t.package.files_ab)) in clean, distclean let version t _ = print_endline t.oasis_version let update_setup_ml, no_update_setup_ml_cli = let b = ref true in b, ("-no-update-setup-ml", Arg.Clear b, s_ " Don't try to update setup.ml, even if _oasis has changed.") let default_oasis_fn = "_oasis" let update_setup_ml t = let oasis_fn = match t.oasis_fn with | Some fn -> fn | None -> default_oasis_fn in let oasis_exec = match t.oasis_exec with | Some fn -> fn | None -> "oasis" in let ocaml = Sys.executable_name in let setup_ml, args = match Array.to_list Sys.argv with | setup_ml :: args -> setup_ml, args | [] -> failwith (s_ "Expecting non-empty command line arguments.") in let ocaml, setup_ml = if Sys.executable_name = Sys.argv.(0) then (* We are not running in standard mode, probably the script * is precompiled. *) "ocaml", "setup.ml" else ocaml, setup_ml in let no_update_setup_ml_cli, _, _ = no_update_setup_ml_cli in let do_update () = let oasis_exec_version = OASISExec.run_read_one_line ~ctxt:!BaseContext.default ~f_exit_code: (function | 0 -> () | 1 -> failwithf (f_ "Executable '%s' is probably an old version \ of oasis (< 0.3.0), please update to version \ v%s.") oasis_exec t.oasis_version | 127 -> failwithf (f_ "Cannot find executable '%s', please install \ oasis v%s.") oasis_exec t.oasis_version | n -> failwithf (f_ "Command '%s version' exited with code %d.") oasis_exec n) oasis_exec ["version"] in if OASISVersion.comparator_apply (OASISVersion.version_of_string oasis_exec_version) (OASISVersion.VGreaterEqual (OASISVersion.version_of_string t.oasis_version)) then begin (* We have a version >= for the executable oasis, proceed with * update. *) (* TODO: delegate this check to 'oasis setup'. *) if Sys.os_type = "Win32" then failwithf (f_ "It is not possible to update the running script \ setup.ml on Windows. Please update setup.ml by \ running '%s'.") (String.concat " " (oasis_exec :: "setup" :: t.oasis_setup_args)) else begin OASISExec.run ~ctxt:!BaseContext.default ~f_exit_code: (function | 0 -> () | n -> failwithf (f_ "Unable to update setup.ml using '%s', \ please fix the problem and retry.") oasis_exec) oasis_exec ("setup" :: t.oasis_setup_args); OASISExec.run ~ctxt:!BaseContext.default ocaml (setup_ml :: args) end end else failwithf (f_ "The version of '%s' (v%s) doesn't match the version of \ oasis used to generate the %s file. Please install at \ least oasis v%s.") oasis_exec oasis_exec_version setup_ml t.oasis_version in if !update_setup_ml then begin try match t.oasis_digest with | Some dgst -> if Sys.file_exists oasis_fn && dgst <> Digest.file default_oasis_fn then begin do_update (); true end else false | None -> false with e -> error (f_ "Error when updating setup.ml. If you want to avoid this error, \ you can bypass the update of %s by running '%s %s %s %s'") setup_ml ocaml setup_ml no_update_setup_ml_cli (String.concat " " args); raise e end else false let setup t = let catch_exn = ref true in try let act_ref = ref (fun _ -> failwithf (f_ "No action defined, run '%s %s -help'") Sys.executable_name Sys.argv.(0)) in let extra_args_ref = ref [] in let allow_empty_env_ref = ref false in let arg_handle ?(allow_empty_env=false) act = Arg.Tuple [ Arg.Rest (fun str -> extra_args_ref := str :: !extra_args_ref); Arg.Unit (fun () -> allow_empty_env_ref := allow_empty_env; act_ref := act); ] in Arg.parse (Arg.align ([ "-configure", arg_handle ~allow_empty_env:true configure, s_ "[options*] Configure the whole build process."; "-build", arg_handle build, s_ "[options*] Build executables and libraries."; "-doc", arg_handle doc, s_ "[options*] Build documents."; "-test", arg_handle test, s_ "[options*] Run tests."; "-all", arg_handle ~allow_empty_env:true all, s_ "[options*] Run configure, build, doc and test targets."; "-install", arg_handle install, s_ "[options*] Install libraries, data, executables \ and documents."; "-uninstall", arg_handle uninstall, s_ "[options*] Uninstall libraries, data, executables \ and documents."; "-reinstall", arg_handle reinstall, s_ "[options*] Uninstall and install libraries, data, \ executables and documents."; "-clean", arg_handle ~allow_empty_env:true clean, s_ "[options*] Clean files generated by a build."; "-distclean", arg_handle ~allow_empty_env:true distclean, s_ "[options*] Clean files generated by a build and configure."; "-version", arg_handle ~allow_empty_env:true version, s_ " Display version of OASIS used to generate this setup.ml."; "-no-catch-exn", Arg.Clear catch_exn, s_ " Don't catch exception, useful for debugging."; ] @ (if t.setup_update then [no_update_setup_ml_cli] else []) @ (BaseContext.args ()))) (failwithf (f_ "Don't know what to do with '%s'")) (s_ "Setup and run build process current package\n"); (* Build initial environment *) load ~allow_empty:!allow_empty_env_ref (); (** Initialize flags *) List.iter (function | Flag (cs, {flag_description = hlp; flag_default = choices}) -> begin let apply ?short_desc () = var_ignore (var_define ~cli:CLIEnable ?short_desc (OASISUtils.varname_of_string cs.cs_name) (fun () -> string_of_bool (var_choose ~name:(Printf.sprintf (f_ "default value of flag %s") cs.cs_name) ~printer:string_of_bool choices))) in match hlp with | Some hlp -> apply ~short_desc:(fun () -> hlp) () | None -> apply () end | _ -> ()) t.package.sections; BaseStandardVar.init t.package; BaseDynVar.init t.package; if t.setup_update && update_setup_ml t then () else !act_ref t (Array.of_list (List.rev !extra_args_ref)) with e when !catch_exn -> error "%s" (Printexc.to_string e); exit 1 end # 5409 "setup.ml" module InternalConfigurePlugin = struct (* # 22 "src/plugins/internal/InternalConfigurePlugin.ml" *) (** Configure using internal scheme @author Sylvain Le Gall *) open BaseEnv open OASISTypes open OASISUtils open OASISGettext open BaseMessage (** Configure build using provided series of check to be done * and then output corresponding file. *) let configure pkg argv = let var_ignore_eval var = let _s: string = var () in () in let errors = ref SetString.empty in let buff = Buffer.create 13 in let add_errors fmt = Printf.kbprintf (fun b -> errors := SetString.add (Buffer.contents b) !errors; Buffer.clear b) buff fmt in let warn_exception e = warning "%s" (Printexc.to_string e) in (* Check tools *) let check_tools lst = List.iter (function | ExternalTool tool -> begin try var_ignore_eval (BaseCheck.prog tool) with e -> warn_exception e; add_errors (f_ "Cannot find external tool '%s'") tool end | InternalExecutable nm1 -> (* Check that matching tool is built *) List.iter (function | Executable ({cs_name = nm2}, {bs_build = build}, _) when nm1 = nm2 -> if not (var_choose build) then add_errors (f_ "Cannot find buildable internal executable \ '%s' when checking build depends") nm1 | _ -> ()) pkg.sections) lst in let build_checks sct bs = if var_choose bs.bs_build then begin if bs.bs_compiled_object = Native then begin try var_ignore_eval BaseStandardVar.ocamlopt with e -> warn_exception e; add_errors (f_ "Section %s requires native compilation") (OASISSection.string_of_section sct) end; (* Check tools *) check_tools bs.bs_build_tools; (* Check depends *) List.iter (function | FindlibPackage (findlib_pkg, version_comparator) -> begin try var_ignore_eval (BaseCheck.package ?version_comparator findlib_pkg) with e -> warn_exception e; match version_comparator with | None -> add_errors (f_ "Cannot find findlib package %s") findlib_pkg | Some ver_cmp -> add_errors (f_ "Cannot find findlib package %s (%s)") findlib_pkg (OASISVersion.string_of_comparator ver_cmp) end | InternalLibrary nm1 -> (* Check that matching library is built *) List.iter (function | Library ({cs_name = nm2}, {bs_build = build}, _) when nm1 = nm2 -> if not (var_choose build) then add_errors (f_ "Cannot find buildable internal library \ '%s' when checking build depends") nm1 | _ -> ()) pkg.sections) bs.bs_build_depends end in (* Parse command line *) BaseArgExt.parse argv (BaseEnv.args ()); (* OCaml version *) begin match pkg.ocaml_version with | Some ver_cmp -> begin try var_ignore_eval (BaseCheck.version "ocaml" ver_cmp BaseStandardVar.ocaml_version) with e -> warn_exception e; add_errors (f_ "OCaml version %s doesn't match version constraint %s") (BaseStandardVar.ocaml_version ()) (OASISVersion.string_of_comparator ver_cmp) end | None -> () end; (* Findlib version *) begin match pkg.findlib_version with | Some ver_cmp -> begin try var_ignore_eval (BaseCheck.version "findlib" ver_cmp BaseStandardVar.findlib_version) with e -> warn_exception e; add_errors (f_ "Findlib version %s doesn't match version constraint %s") (BaseStandardVar.findlib_version ()) (OASISVersion.string_of_comparator ver_cmp) end | None -> () end; (* Make sure the findlib version is fine for the OCaml compiler. *) begin let ocaml_ge4 = OASISVersion.version_compare (OASISVersion.version_of_string (BaseStandardVar.ocaml_version())) (OASISVersion.version_of_string "4.0.0") >= 0 in if ocaml_ge4 then let findlib_lt132 = OASISVersion.version_compare (OASISVersion.version_of_string (BaseStandardVar.findlib_version())) (OASISVersion.version_of_string "1.3.2") < 0 in if findlib_lt132 then add_errors "OCaml >= 4.0.0 requires Findlib version >= 1.3.2" end; (* FlexDLL *) if BaseStandardVar.os_type () = "Win32" || BaseStandardVar.os_type () = "Cygwin" then begin try var_ignore_eval BaseStandardVar.flexlink with e -> warn_exception e; add_errors (f_ "Cannot find 'flexlink'") end; (* Check build depends *) List.iter (function | Executable (_, bs, _) | Library (_, bs, _) as sct -> build_checks sct bs | Doc (_, doc) -> if var_choose doc.doc_build then check_tools doc.doc_build_tools | Test (_, test) -> if var_choose test.test_run then check_tools test.test_tools | _ -> ()) pkg.sections; (* Check if we need native dynlink (presence of libraries that compile to * native) *) begin let has_cmxa = List.exists (function | Library (_, bs, _) -> var_choose bs.bs_build && (bs.bs_compiled_object = Native || (bs.bs_compiled_object = Best && bool_of_string (BaseStandardVar.is_native ()))) | _ -> false) pkg.sections in if has_cmxa then var_ignore_eval BaseStandardVar.native_dynlink end; (* Check errors *) if SetString.empty != !errors then begin List.iter (fun e -> error "%s" e) (SetString.elements !errors); failwithf (fn_ "%d configuration error" "%d configuration errors" (SetString.cardinal !errors)) (SetString.cardinal !errors) end end module InternalInstallPlugin = struct (* # 22 "src/plugins/internal/InternalInstallPlugin.ml" *) (** Install using internal scheme @author Sylvain Le Gall *) open BaseEnv open BaseStandardVar open BaseMessage open OASISTypes open OASISFindlib open OASISGettext open OASISUtils let exec_hook = ref (fun (cs, bs, exec) -> cs, bs, exec) let lib_hook = ref (fun (cs, bs, lib) -> cs, bs, lib, []) let obj_hook = ref (fun (cs, bs, obj) -> cs, bs, obj, []) let doc_hook = ref (fun (cs, doc) -> cs, doc) let install_file_ev = "install-file" let install_dir_ev = "install-dir" let install_findlib_ev = "install-findlib" let win32_max_command_line_length = 8000 let split_install_command ocamlfind findlib_name meta files = if Sys.os_type = "Win32" then (* Arguments for the first command: *) let first_args = ["install"; findlib_name; meta] in (* Arguments for remaining commands: *) let other_args = ["install"; findlib_name; "-add"] in (* Extract as much files as possible from [files], [len] is the current command line length: *) let rec get_files len acc files = match files with | [] -> (List.rev acc, []) | file :: rest -> let len = len + 1 + String.length file in if len > win32_max_command_line_length then (List.rev acc, files) else get_files len (file :: acc) rest in (* Split the command into several commands. *) let rec split args files = match files with | [] -> [] | _ -> (* Length of "ocamlfind install [META|-add]" *) let len = List.fold_left (fun len arg -> len + 1 (* for the space *) + String.length arg) (String.length ocamlfind) args in match get_files len [] files with | ([], _) -> failwith (s_ "Command line too long.") | (firsts, others) -> let cmd = args @ firsts in (* Use -add for remaining commands: *) let () = let findlib_ge_132 = OASISVersion.comparator_apply (OASISVersion.version_of_string (BaseStandardVar.findlib_version ())) (OASISVersion.VGreaterEqual (OASISVersion.version_of_string "1.3.2")) in if not findlib_ge_132 then failwithf (f_ "Installing the library %s require to use the \ flag '-add' of ocamlfind because the command \ line is too long. This flag is only available \ for findlib 1.3.2. Please upgrade findlib from \ %s to 1.3.2") findlib_name (BaseStandardVar.findlib_version ()) in let cmds = split other_args others in cmd :: cmds in (* The first command does not use -add: *) split first_args files else ["install" :: findlib_name :: meta :: files] let install pkg argv = let in_destdir = try let destdir = destdir () in (* Practically speaking destdir is prepended * at the beginning of the target filename *) fun fn -> destdir^fn with PropList.Not_set _ -> fun fn -> fn in let install_file ?tgt_fn src_file envdir = let tgt_dir = in_destdir (envdir ()) in let tgt_file = Filename.concat tgt_dir (match tgt_fn with | Some fn -> fn | None -> Filename.basename src_file) in (* Create target directory if needed *) OASISFileUtil.mkdir_parent ~ctxt:!BaseContext.default (fun dn -> info (f_ "Creating directory '%s'") dn; BaseLog.register install_dir_ev dn) tgt_dir; (* Really install files *) info (f_ "Copying file '%s' to '%s'") src_file tgt_file; OASISFileUtil.cp ~ctxt:!BaseContext.default src_file tgt_file; BaseLog.register install_file_ev tgt_file in (* Install data into defined directory *) let install_data srcdir lst tgtdir = let tgtdir = OASISHostPath.of_unix (var_expand tgtdir) in List.iter (fun (src, tgt_opt) -> let real_srcs = OASISFileUtil.glob ~ctxt:!BaseContext.default (Filename.concat srcdir src) in if real_srcs = [] then failwithf (f_ "Wildcard '%s' doesn't match any files") src; List.iter (fun fn -> install_file fn (fun () -> match tgt_opt with | Some s -> OASISHostPath.of_unix (var_expand s) | None -> tgtdir)) real_srcs) lst in let make_fnames modul sufx = List.fold_right begin fun sufx accu -> (String.capitalize modul ^ sufx) :: (String.uncapitalize modul ^ sufx) :: accu end sufx [] in (** Install all libraries *) let install_libs pkg = let files_of_library (f_data, acc) data_lib = let cs, bs, lib, lib_extra = !lib_hook data_lib in if var_choose bs.bs_install && BaseBuilt.is_built BaseBuilt.BLib cs.cs_name then begin let acc = (* Start with acc + lib_extra *) List.rev_append lib_extra acc in let acc = (* Add uncompiled header from the source tree *) let path = OASISHostPath.of_unix bs.bs_path in List.fold_left begin fun acc modul -> begin try [List.find OASISFileUtil.file_exists_case (List.map (Filename.concat path) (make_fnames modul [".mli"; ".ml"]))] with Not_found -> warning (f_ "Cannot find source header for module %s \ in library %s") modul cs.cs_name; [] end @ List.filter OASISFileUtil.file_exists_case (List.map (Filename.concat path) (make_fnames modul [".annot";".cmti";".cmt"])) @ acc end acc lib.lib_modules in let acc = (* Get generated files *) BaseBuilt.fold BaseBuilt.BLib cs.cs_name (fun acc fn -> fn :: acc) acc in let f_data () = (* Install data associated with the library *) install_data bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name); f_data () in (f_data, acc) end else begin (f_data, acc) end and files_of_object (f_data, acc) data_obj = let cs, bs, obj, obj_extra = !obj_hook data_obj in if var_choose bs.bs_install && BaseBuilt.is_built BaseBuilt.BObj cs.cs_name then begin let acc = (* Start with acc + obj_extra *) List.rev_append obj_extra acc in let acc = (* Add uncompiled header from the source tree *) let path = OASISHostPath.of_unix bs.bs_path in List.fold_left begin fun acc modul -> begin try [List.find OASISFileUtil.file_exists_case (List.map (Filename.concat path) (make_fnames modul [".mli"; ".ml"]))] with Not_found -> warning (f_ "Cannot find source header for module %s \ in object %s") modul cs.cs_name; [] end @ List.filter OASISFileUtil.file_exists_case (List.map (Filename.concat path) (make_fnames modul [".annot";".cmti";".cmt"])) @ acc end acc obj.obj_modules in let acc = (* Get generated files *) BaseBuilt.fold BaseBuilt.BObj cs.cs_name (fun acc fn -> fn :: acc) acc in let f_data () = (* Install data associated with the object *) install_data bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name); f_data () in (f_data, acc) end else begin (f_data, acc) end in (* Install one group of library *) let install_group_lib grp = (* Iterate through all group nodes *) let rec install_group_lib_aux data_and_files grp = let data_and_files, children = match grp with | Container (_, children) -> data_and_files, children | Package (_, cs, bs, `Library lib, children) -> files_of_library data_and_files (cs, bs, lib), children | Package (_, cs, bs, `Object obj, children) -> files_of_object data_and_files (cs, bs, obj), children in List.fold_left install_group_lib_aux data_and_files children in (* Findlib name of the root library *) let findlib_name = findlib_of_group grp in (* Determine root library *) let root_lib = root_of_group grp in (* All files to install for this library *) let f_data, files = install_group_lib_aux (ignore, []) grp in (* Really install, if there is something to install *) if files = [] then begin warning (f_ "Nothing to install for findlib library '%s'") findlib_name end else begin let meta = (* Search META file *) let _, bs, _ = root_lib in let res = Filename.concat bs.bs_path "META" in if not (OASISFileUtil.file_exists_case res) then failwithf (f_ "Cannot find file '%s' for findlib library %s") res findlib_name; res in let files = (* Make filename shorter to avoid hitting command max line length * too early, esp. on Windows. *) let remove_prefix p n = let plen = String.length p in let nlen = String.length n in if plen <= nlen && String.sub n 0 plen = p then begin let fn_sep = if Sys.os_type = "Win32" then '\\' else '/' in let cutpoint = plen + (if plen < nlen && n.[plen] = fn_sep then 1 else 0) in String.sub n cutpoint (nlen - cutpoint) end else n in List.map (remove_prefix (Sys.getcwd ())) files in info (f_ "Installing findlib library '%s'") findlib_name; let ocamlfind = ocamlfind () in let commands = split_install_command ocamlfind findlib_name meta files in List.iter (OASISExec.run ~ctxt:!BaseContext.default ocamlfind) commands; BaseLog.register install_findlib_ev findlib_name end; (* Install data files *) f_data (); in let group_libs, _, _ = findlib_mapping pkg in (* We install libraries in groups *) List.iter install_group_lib group_libs in let install_execs pkg = let install_exec data_exec = let cs, bs, exec = !exec_hook data_exec in if var_choose bs.bs_install && BaseBuilt.is_built BaseBuilt.BExec cs.cs_name then begin let exec_libdir () = Filename.concat (libdir ()) pkg.name in BaseBuilt.fold BaseBuilt.BExec cs.cs_name (fun () fn -> install_file ~tgt_fn:(cs.cs_name ^ ext_program ()) fn bindir) (); BaseBuilt.fold BaseBuilt.BExecLib cs.cs_name (fun () fn -> install_file fn exec_libdir) (); install_data bs.bs_path bs.bs_data_files (Filename.concat (datarootdir ()) pkg.name) end in List.iter (function | Executable (cs, bs, exec)-> install_exec (cs, bs, exec) | _ -> ()) pkg.sections in let install_docs pkg = let install_doc data = let cs, doc = !doc_hook data in if var_choose doc.doc_install && BaseBuilt.is_built BaseBuilt.BDoc cs.cs_name then begin let tgt_dir = OASISHostPath.of_unix (var_expand doc.doc_install_dir) in BaseBuilt.fold BaseBuilt.BDoc cs.cs_name (fun () fn -> install_file fn (fun () -> tgt_dir)) (); install_data Filename.current_dir_name doc.doc_data_files doc.doc_install_dir end in List.iter (function | Doc (cs, doc) -> install_doc (cs, doc) | _ -> ()) pkg.sections in install_libs pkg; install_execs pkg; install_docs pkg (* Uninstall already installed data *) let uninstall _ argv = List.iter (fun (ev, data) -> if ev = install_file_ev then begin if OASISFileUtil.file_exists_case data then begin info (f_ "Removing file '%s'") data; Sys.remove data end else begin warning (f_ "File '%s' doesn't exist anymore") data end end else if ev = install_dir_ev then begin if Sys.file_exists data && Sys.is_directory data then begin if Sys.readdir data = [||] then begin info (f_ "Removing directory '%s'") data; OASISFileUtil.rmdir ~ctxt:!BaseContext.default data end else begin warning (f_ "Directory '%s' is not empty (%s)") data (String.concat ", " (Array.to_list (Sys.readdir data))) end end else begin warning (f_ "Directory '%s' doesn't exist anymore") data end end else if ev = install_findlib_ev then begin info (f_ "Removing findlib library '%s'") data; OASISExec.run ~ctxt:!BaseContext.default (ocamlfind ()) ["remove"; data] end else failwithf (f_ "Unknown log event '%s'") ev; BaseLog.unregister ev data) (* We process event in reverse order *) (List.rev (BaseLog.filter [install_file_ev; install_dir_ev; install_findlib_ev])) end # 6273 "setup.ml" module OCamlbuildCommon = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildCommon.ml" *) (** Functions common to OCamlbuild build and doc plugin *) open OASISGettext open BaseEnv open BaseStandardVar open OASISTypes type extra_args = string list let ocamlbuild_clean_ev = "ocamlbuild-clean" let ocamlbuildflags = var_define ~short_desc:(fun () -> "OCamlbuild additional flags") "ocamlbuildflags" (fun () -> "") (** Fix special arguments depending on environment *) let fix_args args extra_argv = List.flatten [ if (os_type ()) = "Win32" then [ "-classic-display"; "-no-log"; "-no-links"; "-install-lib-dir"; (Filename.concat (standard_library ()) "ocamlbuild") ] else []; if not (bool_of_string (is_native ())) || (os_type ()) = "Win32" then [ "-byte-plugin" ] else []; args; if bool_of_string (debug ()) then ["-tag"; "debug"] else []; if bool_of_string (tests ()) then ["-tag"; "tests"] else []; if bool_of_string (profile ()) then ["-tag"; "profile"] else []; OASISString.nsplit (ocamlbuildflags ()) ' '; Array.to_list extra_argv; ] (** Run 'ocamlbuild -clean' if not already done *) let run_clean extra_argv = let extra_cli = String.concat " " (Array.to_list extra_argv) in (* Run if never called with these args *) if not (BaseLog.exists ocamlbuild_clean_ev extra_cli) then begin OASISExec.run ~ctxt:!BaseContext.default (ocamlbuild ()) (fix_args ["-clean"] extra_argv); BaseLog.register ocamlbuild_clean_ev extra_cli; at_exit (fun () -> try BaseLog.unregister ocamlbuild_clean_ev extra_cli with _ -> ()) end (** Run ocamlbuild, unregister all clean events *) let run_ocamlbuild args extra_argv = (* TODO: enforce that target in args must be UNIX encoded i.e. toto/index.html *) OASISExec.run ~ctxt:!BaseContext.default (ocamlbuild ()) (fix_args args extra_argv); (* Remove any clean event, we must run it again *) List.iter (fun (e, d) -> BaseLog.unregister e d) (BaseLog.filter [ocamlbuild_clean_ev]) (** Determine real build directory *) let build_dir extra_argv = let rec search_args dir = function | "-build-dir" :: dir :: tl -> search_args dir tl | _ :: tl -> search_args dir tl | [] -> dir in search_args "_build" (fix_args [] extra_argv) end module OCamlbuildPlugin = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildPlugin.ml" *) (** Build using ocamlbuild @author Sylvain Le Gall *) open OASISTypes open OASISGettext open OASISUtils open OASISString open BaseEnv open OCamlbuildCommon open BaseStandardVar open BaseMessage let cond_targets_hook = ref (fun lst -> lst) let build extra_args pkg argv = (* Return the filename in build directory *) let in_build_dir fn = Filename.concat (build_dir argv) fn in (* Return the unix filename in host build directory *) let in_build_dir_of_unix fn = in_build_dir (OASISHostPath.of_unix fn) in let cond_targets = List.fold_left (fun acc -> function | Library (cs, bs, lib) when var_choose bs.bs_build -> begin let evs, unix_files = BaseBuilt.of_library in_build_dir_of_unix (cs, bs, lib) in let tgts = List.flatten (List.filter (fun l -> l <> []) (List.map (List.filter (fun fn -> ends_with ~what:".cma" fn || ends_with ~what:".cmxs" fn || ends_with ~what:".cmxa" fn || ends_with ~what:(ext_lib ()) fn || ends_with ~what:(ext_dll ()) fn)) unix_files)) in match tgts with | _ :: _ -> (evs, tgts) :: acc | [] -> failwithf (f_ "No possible ocamlbuild targets for library %s") cs.cs_name end | Object (cs, bs, obj) when var_choose bs.bs_build -> begin let evs, unix_files = BaseBuilt.of_object in_build_dir_of_unix (cs, bs, obj) in let tgts = List.flatten (List.filter (fun l -> l <> []) (List.map (List.filter (fun fn -> ends_with ".cmo" fn || ends_with ".cmx" fn)) unix_files)) in match tgts with | _ :: _ -> (evs, tgts) :: acc | [] -> failwithf (f_ "No possible ocamlbuild targets for object %s") cs.cs_name end | Executable (cs, bs, exec) when var_choose bs.bs_build -> begin let evs, unix_exec_is, unix_dll_opt = BaseBuilt.of_executable in_build_dir_of_unix (cs, bs, exec) in let target ext = let unix_tgt = (OASISUnixPath.concat bs.bs_path (OASISUnixPath.chop_extension exec.exec_main_is))^ext in let evs = (* Fix evs, we want to use the unix_tgt, without copying *) List.map (function | BaseBuilt.BExec, nm, lst when nm = cs.cs_name -> BaseBuilt.BExec, nm, [[in_build_dir_of_unix unix_tgt]] | ev -> ev) evs in evs, [unix_tgt] in (* Add executable *) let acc = match bs.bs_compiled_object with | Native -> (target ".native") :: acc | Best when bool_of_string (is_native ()) -> (target ".native") :: acc | Byte | Best -> (target ".byte") :: acc in acc end | Library _ | Object _ | Executable _ | Test _ | SrcRepo _ | Flag _ | Doc _ -> acc) [] (* Keep the pkg.sections ordered *) (List.rev pkg.sections); in (* Check and register built files *) let check_and_register (bt, bnm, lst) = List.iter (fun fns -> if not (List.exists OASISFileUtil.file_exists_case fns) then failwithf (fn_ "Expected built file %s doesn't exist." "None of expected built files %s exists." (List.length fns)) (String.concat (s_ " or ") (List.map (Printf.sprintf "'%s'") fns))) lst; (BaseBuilt.register bt bnm lst) in (* Run the hook *) let cond_targets = !cond_targets_hook cond_targets in (* Run a list of target... *) run_ocamlbuild (List.flatten (List.map snd cond_targets) @ extra_args) argv; (* ... and register events *) List.iter check_and_register (List.flatten (List.map fst cond_targets)) let clean pkg extra_args = run_clean extra_args; List.iter (function | Library (cs, _, _) -> BaseBuilt.unregister BaseBuilt.BLib cs.cs_name | Executable (cs, _, _) -> BaseBuilt.unregister BaseBuilt.BExec cs.cs_name; BaseBuilt.unregister BaseBuilt.BExecLib cs.cs_name | _ -> ()) pkg.sections end module OCamlbuildDocPlugin = struct (* # 22 "src/plugins/ocamlbuild/OCamlbuildDocPlugin.ml" *) (* Create documentation using ocamlbuild .odocl files @author Sylvain Le Gall *) open OASISTypes open OASISGettext open OASISMessage open OCamlbuildCommon open BaseStandardVar type run_t = { extra_args: string list; run_path: unix_filename; } let doc_build run pkg (cs, doc) argv = let index_html = OASISUnixPath.make [ run.run_path; cs.cs_name^".docdir"; "index.html"; ] in let tgt_dir = OASISHostPath.make [ build_dir argv; OASISHostPath.of_unix run.run_path; cs.cs_name^".docdir"; ] in run_ocamlbuild (index_html :: run.extra_args) argv; List.iter (fun glb -> BaseBuilt.register BaseBuilt.BDoc cs.cs_name [OASISFileUtil.glob ~ctxt:!BaseContext.default (Filename.concat tgt_dir glb)]) ["*.html"; "*.css"] let doc_clean run pkg (cs, doc) argv = run_clean argv; BaseBuilt.unregister BaseBuilt.BDoc cs.cs_name end # 6651 "setup.ml" open OASISTypes;; let setup_t = { BaseSetup.configure = InternalConfigurePlugin.configure; build = OCamlbuildPlugin.build []; test = []; doc = [ ("zed-api", OCamlbuildDocPlugin.doc_build {OCamlbuildDocPlugin.extra_args = []; run_path = "./"}) ]; install = InternalInstallPlugin.install; uninstall = InternalInstallPlugin.uninstall; clean = [OCamlbuildPlugin.clean]; clean_test = []; clean_doc = [ ("zed-api", OCamlbuildDocPlugin.doc_clean {OCamlbuildDocPlugin.extra_args = []; run_path = "./"}) ]; distclean = []; distclean_test = []; distclean_doc = []; package = { oasis_version = "0.3"; ocaml_version = Some (OASISVersion.VGreaterEqual "3.12"); findlib_version = None; alpha_features = []; beta_features = []; name = "zed"; version = "1.4"; license = OASISLicense.DEP5License (OASISLicense.DEP5Unit { OASISLicense.license = "BSD-3-clause"; excption = None; version = OASISLicense.NoVersion }); license_file = Some "LICENSE"; copyrights = []; maintainers = ["Jeremie Dimino "]; authors = ["Jeremie Dimino"]; homepage = Some "http://zed.forge.ocamlcore.org/"; synopsis = "Abstract engine for text edition in OCaml"; description = Some [ OASISText.Para "Zed is an abstract engine for text edition. It can be used to write text editors, edition widgets, readlines, ..."; OASISText.Para "Zed uses Camomile to fully support the Unicode specification, and implements an UTF-8 encoded string type with validation, and a rope datastructure to achieve efficient operations on large Unicode buffers. Zed also features a regular expression search on ropes."; OASISText.Para "To support efficient text edition capabilities, Zed provides macro recording and cursor management facilities." ]; categories = []; conf_type = (`Configure, "internal", Some "0.4"); conf_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; build_type = (`Build, "ocamlbuild", Some "0.4"); build_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; install_type = (`Install, "internal", Some "0.4"); install_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; uninstall_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; clean_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; distclean_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; files_ab = []; sections = [ Library ({ cs_name = "zed"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { bs_build = [(OASISExpr.EBool true, true)]; bs_install = [(OASISExpr.EBool true, true)]; bs_path = "src"; bs_compiled_object = Best; bs_build_depends = [ FindlibPackage ("bytes", None); FindlibPackage ("react", None); FindlibPackage ("camomile", Some (OASISVersion.VGreaterEqual "0.8")) ]; bs_build_tools = [ExternalTool "ocamlbuild"]; bs_c_sources = []; bs_data_files = []; bs_ccopt = [(OASISExpr.EBool true, [])]; bs_cclib = [(OASISExpr.EBool true, [])]; bs_dlllib = [(OASISExpr.EBool true, [])]; bs_dllpath = [(OASISExpr.EBool true, [])]; bs_byteopt = [(OASISExpr.EBool true, [])]; bs_nativeopt = [(OASISExpr.EBool true, [])] }, { lib_modules = [ "Zed_utf8"; "Zed_rope"; "Zed_edit"; "Zed_cursor"; "Zed_lines"; "Zed_re"; "Zed_input"; "Zed_macro" ]; lib_pack = false; lib_internal_modules = []; lib_findlib_parent = None; lib_findlib_name = Some "zed"; lib_findlib_containers = [] }); Doc ({ cs_name = "zed-api"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { doc_type = (`Doc, "ocamlbuild", Some "0.3"); doc_custom = { pre_command = [(OASISExpr.EBool true, None)]; post_command = [(OASISExpr.EBool true, None)] }; doc_build = [ (OASISExpr.ENot (OASISExpr.EFlag "docs"), false); (OASISExpr.EFlag "docs", true) ]; doc_install = [(OASISExpr.EBool true, true)]; doc_install_dir = "$htmldir/api"; doc_title = "API reference for Zed"; doc_authors = []; doc_abstract = None; doc_format = OtherDoc; doc_data_files = [("style.css", None)]; doc_build_tools = [ExternalTool "ocamlbuild"; ExternalTool "ocamldoc"] }); SrcRepo ({ cs_name = "head"; cs_data = PropList.Data.create (); cs_plugin_data = [] }, { src_repo_type = Git; src_repo_location = "https://github.com/diml/zed.git"; src_repo_browser = Some "https://github.com/diml/zed"; src_repo_module = None; src_repo_branch = None; src_repo_tag = None; src_repo_subdir = None }) ]; plugins = [(`Extra, "DevFiles", Some "0.3"); (`Extra, "META", Some "0.3")]; disable_oasis_section = []; schema_data = PropList.Data.create (); plugin_data = [] }; oasis_fn = Some "_oasis"; oasis_version = "0.4.5"; oasis_digest = Some "A\223\139\197j\1759\151\006rA;\219\169\214\b"; oasis_exec = None; oasis_setup_args = []; setup_update = false };; let setup () = BaseSetup.setup setup_t;; # 6856 "setup.ml" (* OASIS_STOP *) let () = setup ();; zed-1.4/src/000077500000000000000000000000001245345107700127375ustar00rootroot00000000000000zed-1.4/src/META000066400000000000000000000004721245345107700134130ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 6385b5511b372175e2f554771063b58a) version = "1.4" description = "Edition engine" requires = "bytes react camomile" archive(byte) = "zed.cma" archive(byte, plugin) = "zed.cma" archive(native) = "zed.cmxa" archive(native, plugin) = "zed.cmxs" exists_if = "zed.cma" # OASIS_STOP zed-1.4/src/zed.mldylib000066400000000000000000000002371245345107700151010ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: c22b9ff32b957e4d6413268196f6b213) Zed_utf8 Zed_rope Zed_edit Zed_cursor Zed_lines Zed_re Zed_input Zed_macro # OASIS_STOP zed-1.4/src/zed.mllib000066400000000000000000000002371245345107700145440ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: c22b9ff32b957e4d6413268196f6b213) Zed_utf8 Zed_rope Zed_edit Zed_cursor Zed_lines Zed_re Zed_input Zed_macro # OASIS_STOP zed-1.4/src/zed_cursor.ml000066400000000000000000000070541245345107700154560ustar00rootroot00000000000000(* * zed_cursor.ml * ------------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open React exception Out_of_bounds type action = | User_move of int | Text_modification of (int * int * int) (* start, added, removed *) type t = { position : int signal; send : action -> unit; length : int ref; changes : (int * int * int) event; get_lines : unit -> Zed_lines.t; coordinates : (int * int) signal; line : int signal; column : int signal; wanted_column : int signal; set_wanted_column : int -> unit; } let create length changes get_lines position wanted_column = if position < 0 || position > length then raise Out_of_bounds; let length = ref length in let user_moves, send = E.create () in let update_position position action = match action with | User_move pos -> pos | Text_modification (start, added, removed) -> let delta = added - removed in length := !length + delta; if !length < 0 then raise Out_of_bounds; (* Move the cursor if it is after the start of the changes. *) if position > start then begin if delta >= 0 then (* Text has been inserted, advance the cursor. *) position + delta else if position < start - delta then (* Text has been removed and the removed block contains the cursor, move it at the beginning of the removed block. *) start else (* Text has been removed before the cursor, move back the cursor. *) position + delta end else position in let text_modifications = E.map (fun x -> Text_modification x) changes in let position = S.fold update_position position (E.select [user_moves; text_modifications]) in let compute_coordinates position = let lines = get_lines () in let index = Zed_lines.line_index lines position in (index, position - Zed_lines.line_start lines index) in let coordinates = S.map compute_coordinates position in let wanted_column, set_wanted_column = S.create wanted_column in { position; send; length; changes; get_lines; coordinates; line = S.map fst coordinates; column = S.map snd coordinates; wanted_column; set_wanted_column; } let copy cursor = create !(cursor.length) cursor.changes cursor.get_lines (S.value cursor.position) (S.value cursor.wanted_column) let position cursor = cursor.position let get_position cursor = S.value cursor.position let line cursor = cursor.line let get_line cursor = S.value cursor.line let column cursor = cursor.column let get_column cursor = S.value cursor.column let coordinates cursor = cursor.coordinates let get_coordinates cursor = S.value cursor.coordinates let wanted_column cursor = cursor.wanted_column let get_wanted_column cursor = S.value cursor.wanted_column let set_wanted_column cursor column = cursor.set_wanted_column column let move cursor ?(set_wanted_column=true) delta = let new_position = S.value cursor.position + delta in if new_position < 0 || new_position > !(cursor.length) then raise Out_of_bounds else begin cursor.send (User_move new_position); if set_wanted_column then cursor.set_wanted_column (S.value cursor.column) end let goto cursor ?(set_wanted_column=true) position = if position < 0 || position > !(cursor.length) then raise Out_of_bounds else begin cursor.send (User_move position); if set_wanted_column then cursor.set_wanted_column (S.value cursor.column) end zed-1.4/src/zed_cursor.mli000066400000000000000000000066001245345107700156230ustar00rootroot00000000000000(* * zed_cursor.mli * -------------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Cursors *) (** A cursor is a pointer in an edition buffer. When some text is inserted or removed, all cursors after the modification are automatically moved accordingly. *) open React type t (** Type of a cursor. *) exception Out_of_bounds (** Exception raised when trying to move a cursor outside the bounds of the text it points to. *) val create : int -> (int * int * int) event -> (unit -> Zed_lines.t) -> int -> int -> t (** [create length changes get_lines position wanted_column] creates a new cursor pointing to position [position]. [length] is the current length of the text the cursor points to. It raises {!Out_of_bounds} if [position] is greater than [length]. [changes] is an event which occurs with values of the form [(start, added, removed)] when the text changes, with the same semantic as {!Zed_edit.changes}. [get_lines] is used to retreive the current set of line positions of the text. It is used to compute the line and column of the cursor. [wanted_column] is the column on which the cursor want to be, if there is enough room on the line. *) val copy : t -> t (** [copy cursor] creates a copy of the given cursor. The new cursor initially points to the same location as [cursor]. *) val position : t -> int signal (** [position cursor] returns the signal holding the current position of the given cursor. *) val get_position : t -> int (** [get_position cursor] returns the current position of [cursor]. *) val line : t -> int signal (** [line cursor] returns the signal holding the current line on which the cursor is. *) val get_line : t -> int (** [get_line cursor] returns the current line of the cursor. *) val column : t -> int signal (** [column cursor] returns the signal holding the current column of the cursor. *) val get_column : t -> int (** [get_column cursor] returns the current column of the cursor. *) val coordinates : t -> (int * int) signal (** [coordinates cursor] returns the signal holding the current line & column of the cursor. *) val get_coordinates : t -> int * int (** [get_coordinates cursor] returns the current line & column of the cursor. *) val wanted_column : t -> int signal (** [wanted_column cursor] returns the signal holding the column on which the cursor wants to be. *) val get_wanted_column : t -> int (** [get_wanted_column cursor] returns the column on which the cursor wants to be. *) val set_wanted_column : t -> int -> unit (** [set_wanted_column cursor] sets the column on which the cursor want to be. *) val goto : t -> ?set_wanted_column : bool -> int -> unit (** [goto cursor position] moves the given cursor to the given position. It raises {!Out_of_bounds} if [position] is outside the bounds of the text. If [set_wanted_column] is [true] (the default), then the wanted column will be set to the column of the cursor at given position. *) val move : t -> ?set_wanted_column : bool -> int -> unit (** [move cursor delta] moves the given cursor by the given number of characters. It raises {!Out_of_bounds} if the result is outside the bounds of the text. *) zed-1.4/src/zed_edit.ml000066400000000000000000000664631245345107700150770ustar00rootroot00000000000000(* * zed_edit.ml * ----------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open CamomileLibraryDyn.Camomile open React module CaseMap = CaseMap.Make(Zed_rope.Text) (* +-----------------------------------------------------------------+ | Types | +-----------------------------------------------------------------+ *) type clipboard = { clipboard_get : unit -> Zed_rope.t; clipboard_set : Zed_rope.t -> unit; } type 'a t = { mutable data : 'a option; (* Custom data attached to the engine. *) mutable text : Zed_rope.t; (* The contents of the engine. *) mutable lines : Zed_lines.t; (* The set of line position of [text]. *) changes : (int * int * int) event; send_changes : (int * int * int) -> unit; (* Changes of the contents. *) erase_mode : bool signal; set_erase_mode : bool -> unit; (* The current erase mode. *) editable : int -> int -> bool; (* The editable function of the engine. *) clipboard : clipboard; (* The clipboard for this engine. *) mutable mark : Zed_cursor.t; (* The cursor that points to the mark. *) selection : bool signal; set_selection : bool -> unit; (* The current selection state. *) match_word : Zed_rope.t -> int -> int option; (* The function for matching words. *) locale : string option signal; (* The buffer's locale. *) undo : (Zed_rope.t * Zed_lines.t * int * int * int * int) array; (* The undo buffer. It is an array of element of the form [(text, lines, pos, new_pos, added, removed)]. *) undo_size : int; (* Size of the undo buffer. *) mutable undo_start : int; (* Position of the first used cell in the undo buffer. *) mutable undo_index : int; (* Position of the next available cell in the undo buffer. *) mutable undo_count : int; (* Number of used cell in the undo buffer. *) } (* +-----------------------------------------------------------------+ | Creation | +-----------------------------------------------------------------+ *) let dummy_cursor = Zed_cursor.create 0 E.never (fun () -> Zed_lines.empty) 0 0 let match_by_regexp re rope idx = match Zed_re.regexp_match ~sem:`Longest re rope idx with | None -> None | Some arr -> match arr.(0) with | Some(zip1, zip2) -> Some(Zed_rope.Zip.offset zip2) | None -> None let regexp_word = let set = UCharInfo.load_property_set `Alphabetic in let set = List.fold_left (fun set ch -> USet.add (UChar.of_char ch) set) set ['0'; '1'; '2'; '3'; '4'; '5'; '6'; '7'; '8'; '9'] in Zed_re.compile (`Repn(`Set set, 1, None)) let new_clipboard () = let r = ref Zed_rope.empty in { clipboard_get = (fun () -> !r); clipboard_set = (fun x -> r := x) } let create ?(editable=fun pos len -> true) ?(move = (+)) ?clipboard ?(match_word = match_by_regexp regexp_word) ?(locale = S.const None) ?(undo_size = 1000) () = let changes, send_changes = E.create () in let erase_mode, set_erase_mode = S.create false in let selection, set_selection = S.create false in let clipboard = match clipboard with | Some clipboard -> clipboard | None -> new_clipboard () in let rec edit = { data = None; text = Zed_rope.empty; lines = Zed_lines.empty; changes; send_changes; erase_mode; set_erase_mode; editable; clipboard; mark = dummy_cursor; selection; set_selection; match_word; locale; undo = Array.make undo_size (Zed_rope.empty, Zed_lines.empty, 0, 0, 0, 0); undo_size; undo_start = 0; undo_index = 0; undo_count = 0; } in edit.mark <- Zed_cursor.create 0 changes (fun () -> edit.lines) 0 0; edit (* +-----------------------------------------------------------------+ | State | +-----------------------------------------------------------------+ *) let get_data engine = match engine.data with | Some data -> data | None -> raise Not_found let set_data engine data = engine.data <- Some data let clear_data engine = engine.data <- None let text engine = engine.text let lines engine = engine.lines let changes engine = engine.changes let erase_mode engine = engine.erase_mode let get_erase_mode engine = S.value engine.erase_mode let set_erase_mode engine state = engine.set_erase_mode state let mark engine = engine.mark let selection engine = engine.selection let get_selection engine = S.value engine.selection let set_selection engine state = engine.set_selection state let get_line e i = let txt = text e in let lines = lines e in let start = Zed_lines.line_start lines i in let stop = Zed_lines.line_stop lines i in Zed_rope.sub txt start (stop - start) let update engine cursors = E.select ( E.stamp engine.changes () :: E.stamp (S.changes engine.selection) () :: E.stamp (S.changes (Zed_cursor.position engine.mark)) () :: List.map (fun cursor -> E.stamp (S.changes (Zed_cursor.position cursor)) ()) cursors ) (* +-----------------------------------------------------------------+ | Cursors | +-----------------------------------------------------------------+ *) let new_cursor engine = Zed_cursor.create (Zed_rope.length engine.text) engine.changes (fun () -> engine.lines) 0 0 (* +-----------------------------------------------------------------+ | Actions | +-----------------------------------------------------------------+ *) exception Cannot_edit type 'a context = { edit : 'a t; cursor : Zed_cursor.t; check : bool; } let context ?(check=true) edit cursor = { edit; cursor; check } let edit ctx = ctx.edit let cursor ctx = ctx.cursor let check ctx = ctx.check let with_check check ctx = { ctx with check } let goto ctx ?set_wanted_column new_position = Zed_cursor.goto ctx.cursor ?set_wanted_column new_position let move ctx ?set_wanted_column delta = Zed_cursor.move ctx.cursor ?set_wanted_column delta let next_line_n ctx n = let index = Zed_cursor.get_line ctx.cursor in if index + n > Zed_lines.count ctx.edit.lines then goto ctx ~set_wanted_column:false (Zed_rope.length ctx.edit.text) else begin let start = Zed_lines.line_start ctx.edit.lines (index + n) in let stop = if index + n = Zed_lines.count ctx.edit.lines then Zed_rope.length ctx.edit.text else Zed_lines.line_start ctx.edit.lines (index + n + 1) - 1 in goto ctx ~set_wanted_column:false (start + min (Zed_cursor.get_wanted_column ctx.cursor) (stop - start)) end let prev_line_n ctx n = let index = Zed_cursor.get_line ctx.cursor in if index - n < 0 then begin goto ctx ~set_wanted_column:false 0 end else begin let start = Zed_lines.line_start ctx.edit.lines (index - n) in let stop = Zed_lines.line_start ctx.edit.lines (index - (n - 1)) - 1 in goto ctx ~set_wanted_column:false (start + min (Zed_cursor.get_wanted_column ctx.cursor) (stop - start)) end let move_line ctx delta = match delta with | _ when delta < 0 -> prev_line_n ctx (-delta) | _ when delta > 0 -> next_line_n ctx delta | _ -> () let position ctx = Zed_cursor.get_position ctx.cursor let line ctx = Zed_cursor.get_line ctx.cursor let column ctx = Zed_cursor.get_column ctx.cursor let at_bol ctx = Zed_cursor.get_column ctx.cursor = 0 let at_eol ctx = let position = Zed_cursor.get_position ctx.cursor in let index = Zed_cursor.get_line ctx.cursor in if index = Zed_lines.count ctx.edit.lines then position = Zed_rope.length ctx.edit.text else position = Zed_lines.line_start ctx.edit.lines (index + 1) - 1 let at_bot ctx = Zed_cursor.get_position ctx.cursor = 0 let at_eot ctx = Zed_cursor.get_position ctx.cursor = Zed_rope.length ctx.edit.text let modify { edit } text lines position new_position added removed = if edit.undo_size > 0 then begin edit.undo.(edit.undo_index) <- (text, lines, position, new_position, added, removed); edit.undo_index <- (edit.undo_index + 1) mod edit.undo_size; if edit.undo_count = edit.undo_size then edit.undo_start <- (edit.undo_start + 1) mod edit.undo_size else edit.undo_count <- edit.undo_count + 1 end; edit.send_changes (position, added, removed) let insert ctx rope = let position = Zed_cursor.get_position ctx.cursor in if not ctx.check || ctx.edit.editable position 0 then begin let len = Zed_rope.length rope in let text = ctx.edit.text and lines = ctx.edit.lines in if S.value ctx.edit.erase_mode then begin let text_len = Zed_rope.length ctx.edit.text in if position + len > text_len then begin ctx.edit.text <- Zed_rope.replace text position (text_len - position) rope; ctx.edit.lines <- Zed_lines.replace ctx.edit.lines position (text_len - position) (Zed_lines.of_rope rope); modify ctx text lines position position len (text_len - position) end else begin ctx.edit.text <- Zed_rope.replace text position len rope; ctx.edit.lines <- Zed_lines.replace ctx.edit.lines position len (Zed_lines.of_rope rope); modify ctx text lines position position len len; end; move ctx len end else begin ctx.edit.text <- Zed_rope.insert ctx.edit.text position rope; ctx.edit.lines <- Zed_lines.insert ctx.edit.lines position (Zed_lines.of_rope rope); modify ctx text lines position position len 0; move ctx len end end else raise Cannot_edit let insert_no_erase ctx rope = let position = Zed_cursor.get_position ctx.cursor in if not ctx.check || ctx.edit.editable position 0 then begin let len = Zed_rope.length rope and text = ctx.edit.text and lines = ctx.edit.lines in ctx.edit.text <- Zed_rope.insert text position rope; ctx.edit.lines <- Zed_lines.insert ctx.edit.lines position (Zed_lines.of_rope rope); modify ctx text lines position position len 0; move ctx len end else raise Cannot_edit let remove_next ctx len = let position = Zed_cursor.get_position ctx.cursor in let text_len = Zed_rope.length ctx.edit.text in let len = if position + len > text_len then text_len - position else len in if not ctx.check || ctx.edit.editable position len then begin let text = ctx.edit.text and lines = ctx.edit.lines in ctx.edit.text <- Zed_rope.remove text position len; ctx.edit.lines <- Zed_lines.remove ctx.edit.lines position len; modify ctx text lines position position 0 len; end else raise Cannot_edit let remove_prev ctx len = let position = Zed_cursor.get_position ctx.cursor in let len = min position len in if not ctx.check || ctx.edit.editable (position - len) len then begin let text = ctx.edit.text and lines = ctx.edit.lines in ctx.edit.text <- Zed_rope.remove text (position - len) len; ctx.edit.lines <- Zed_lines.remove ctx.edit.lines (position - len) len; modify ctx text lines (position - len) position 0 len; end else raise Cannot_edit let remove = remove_next let replace ctx len rope = let position = Zed_cursor.get_position ctx.cursor in let text_len = Zed_rope.length ctx.edit.text in let len = if position + len > text_len then text_len - position else len in if not ctx.check || ctx.edit.editable position len then begin let rope_len = Zed_rope.length rope and text = ctx.edit.text and lines = ctx.edit.lines in ctx.edit.text <- Zed_rope.replace text position len rope; ctx.edit.lines <- Zed_lines.replace ctx.edit.lines position len (Zed_lines.of_rope rope); modify ctx text lines position position rope_len len; move ctx rope_len end else raise Cannot_edit let newline_rope = Zed_rope.singleton (UChar.of_char '\n') let newline ctx = insert ctx newline_rope let next_char ctx = if not (at_eot ctx) then move ctx 1 let prev_char ctx = if not (at_bot ctx) then move ctx (-1) let next_line ctx = let index = Zed_cursor.get_line ctx.cursor in if index = Zed_lines.count ctx.edit.lines then goto ctx ~set_wanted_column:false (Zed_rope.length ctx.edit.text) else begin let start = Zed_lines.line_start ctx.edit.lines (index + 1) in let stop = if index + 1 = Zed_lines.count ctx.edit.lines then Zed_rope.length ctx.edit.text else Zed_lines.line_start ctx.edit.lines (index + 2) - 1 in goto ctx ~set_wanted_column:false (start + min (Zed_cursor.get_wanted_column ctx.cursor) (stop - start)) end let prev_line ctx = let index = Zed_cursor.get_line ctx.cursor in if index = 0 then begin goto ctx ~set_wanted_column:false 0 end else begin let start = Zed_lines.line_start ctx.edit.lines (index - 1) in let stop = Zed_lines.line_start ctx.edit.lines index - 1 in goto ctx ~set_wanted_column:false (start + min (Zed_cursor.get_wanted_column ctx.cursor) (stop - start)) end let goto_bol ctx = goto ctx (Zed_lines.line_start ctx.edit.lines (Zed_cursor.get_line ctx.cursor)) let goto_eol ctx = let index = Zed_cursor.get_line ctx.cursor in if index = Zed_lines.count ctx.edit.lines then goto ctx (Zed_rope.length ctx.edit.text) else goto ctx (Zed_lines.line_start ctx.edit.lines (index + 1) - 1) let goto_bot ctx = goto ctx 0 let goto_eot ctx = goto ctx (Zed_rope.length ctx.edit.text) let delete_next_char ctx = if not (at_eot ctx) then begin ctx.edit.set_selection false; remove_next ctx 1 end let delete_prev_char ctx = if not (at_bot ctx) then begin ctx.edit.set_selection false; remove_prev ctx 1 end let delete_next_line ctx = ctx.edit.set_selection false; let position = Zed_cursor.get_position ctx.cursor in let index = Zed_cursor.get_line ctx.cursor in if index = Zed_lines.count ctx.edit.lines then remove_next ctx (Zed_rope.length ctx.edit.text - position) else remove_next ctx (Zed_lines.line_start ctx.edit.lines (index + 1) - position) let delete_prev_line ctx = ctx.edit.set_selection false; let position = Zed_cursor.get_position ctx.cursor in let start = Zed_lines.line_start ctx.edit.lines (Zed_cursor.get_line ctx.cursor) in remove_prev ctx (position - start) let kill_next_line ctx = let position = Zed_cursor.get_position ctx.cursor in let index = Zed_cursor.get_line ctx.cursor in if index = Zed_lines.count ctx.edit.lines then begin ctx.edit.clipboard.clipboard_set (Zed_rope.after ctx.edit.text position); ctx.edit.set_selection false; remove ctx (Zed_rope.length ctx.edit.text - position) end else begin let len = Zed_lines.line_start ctx.edit.lines (index + 1) - position in ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text position len); ctx.edit.set_selection false; remove ctx len end let kill_prev_line ctx = let position = Zed_cursor.get_position ctx.cursor in let start = Zed_lines.line_start ctx.edit.lines (Zed_cursor.get_line ctx.cursor) in ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text start (position - start)); ctx.edit.set_selection false; remove_prev ctx (position - start) let switch_erase_mode ctx = ctx.edit.set_erase_mode (not (S.value ctx.edit.erase_mode)) let set_mark ctx = Zed_cursor.goto ctx.edit.mark (Zed_cursor.get_position ctx.cursor); ctx.edit.set_selection true let goto_mark ctx = goto ctx (Zed_cursor.get_position ctx.edit.mark) let copy ctx = if S.value ctx.edit.selection then begin let a = Zed_cursor.get_position ctx.cursor and b = Zed_cursor.get_position ctx.edit.mark in let a = min a b and b = max a b in ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text a (b - a)); ctx.edit.set_selection false end let kill ctx = if S.value ctx.edit.selection then begin let a = Zed_cursor.get_position ctx.cursor and b = Zed_cursor.get_position ctx.edit.mark in let a = min a b and b = max a b in ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text a (b - a)); ctx.edit.set_selection false; goto ctx a; let a = Zed_cursor.get_position ctx.cursor in if a <= b then remove ctx (b - a) end let yank ctx = ctx.edit.set_selection false; insert ctx (ctx.edit.clipboard.clipboard_get ()) let search_word_forward ctx = let len = Zed_rope.length ctx.edit.text in let rec loop idx = if idx = len then None else match ctx.edit.match_word ctx.edit.text idx with | Some idx' -> Some(idx, idx') | None -> loop (idx + 1) in loop (Zed_cursor.get_position ctx.cursor) let search_word_backward ctx = let rec loop idx = if idx = -1 then None else match ctx.edit.match_word ctx.edit.text idx with | Some idx' -> loop2 (idx - 1) (idx, idx') | None -> loop (idx - 1) and loop2 idx result = if idx = -1 then Some result else match ctx.edit.match_word ctx.edit.text idx with | Some idx' -> loop2 (idx - 1) (idx, idx') | None -> Some result in loop (Zed_cursor.get_position ctx.cursor - 1) let capitalize_word ctx = match search_word_forward ctx with | Some(idx1, idx2) -> goto ctx idx1; if Zed_cursor.get_position ctx.cursor = idx1 && idx1 < idx2 then begin let str = Zed_rope.sub ctx.edit.text idx1 (idx2 - idx1) in let ch, str' = Zed_rope.break str 1 in replace ctx (Zed_rope.length str) (Zed_rope.append (CaseMap.uppercase ?locale:(S.value ctx.edit.locale) ch) (CaseMap.lowercase ?locale:(S.value ctx.edit.locale) str')) end | None -> () let lowercase_word ctx = match search_word_forward ctx with | Some(idx1, idx2) -> goto ctx idx1; if Zed_cursor.get_position ctx.cursor = idx1 then begin let str = Zed_rope.sub ctx.edit.text idx1 (idx2 - idx1) in replace ctx (Zed_rope.length str) (CaseMap.lowercase ?locale:(S.value ctx.edit.locale) str) end | None -> () let uppercase_word ctx = match search_word_forward ctx with | Some(idx1, idx2) -> goto ctx idx1; if Zed_cursor.get_position ctx.cursor = idx1 then begin let str = Zed_rope.sub ctx.edit.text idx1 (idx2 - idx1) in replace ctx (Zed_rope.length str) (CaseMap.uppercase ?locale:(S.value ctx.edit.locale) str) end | None -> () let next_word ctx = match search_word_forward ctx with | Some(idx1, idx2) -> goto ctx idx2 | None -> () let prev_word ctx = match search_word_backward ctx with | Some(idx1, idx2) -> goto ctx idx1 | None -> () let delete_next_word ctx = let position = Zed_cursor.get_position ctx.cursor in match search_word_forward ctx with | Some(idx1, idx2) -> remove ctx (idx2 - position) | None -> () let delete_prev_word ctx = let position = Zed_cursor.get_position ctx.cursor in match search_word_backward ctx with | Some(idx1, idx2) -> remove_prev ctx (position - idx1) | None -> () let kill_next_word ctx = let position = Zed_cursor.get_position ctx.cursor in match search_word_forward ctx with | Some(idx1, idx2) -> ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text position (idx2 - position)); ctx.edit.set_selection false; remove ctx (idx2 - position) | None -> () let kill_prev_word ctx = let position = Zed_cursor.get_position ctx.cursor in match search_word_backward ctx with | Some(idx1, idx2) -> ctx.edit.clipboard.clipboard_set (Zed_rope.sub ctx.edit.text idx1 (position - idx1)); ctx.edit.set_selection false; remove_prev ctx (position - idx1) | None -> () let undo { check; edit; cursor } = if edit.undo_count > 0 then begin let index = if edit.undo_index = 0 then edit.undo_size - 1 else edit.undo_index - 1 in let text, lines, pos, new_pos, added, removed = edit.undo.(index) in if not check || edit.editable pos added then begin edit.undo_count <- edit.undo_count - 1; edit.undo_index <- index; edit.text <- text; edit.lines <- lines; edit.send_changes (pos, removed, added); Zed_cursor.goto cursor new_pos end else raise Cannot_edit end (* +-----------------------------------------------------------------+ | Action by names | +-----------------------------------------------------------------+ *) type action = | Insert of UChar.t | Newline | Next_char | Prev_char | Next_line | Prev_line | Goto_bol | Goto_eol | Goto_bot | Goto_eot | Delete_next_char | Delete_prev_char | Delete_next_line | Delete_prev_line | Kill_next_line | Kill_prev_line | Switch_erase_mode | Set_mark | Goto_mark | Copy | Kill | Yank | Capitalize_word | Lowercase_word | Uppercase_word | Next_word | Prev_word | Delete_next_word | Delete_prev_word | Kill_next_word | Kill_prev_word | Undo let get_action = function | Insert ch -> (fun ctx -> insert ctx (Zed_rope.singleton ch)) | Newline -> newline | Next_char -> next_char | Prev_char -> prev_char | Next_line -> next_line | Prev_line -> prev_line | Goto_bol -> goto_bol | Goto_eol -> goto_eol | Goto_bot -> goto_bot | Goto_eot -> goto_eot | Delete_next_char -> delete_next_char | Delete_prev_char -> delete_prev_char | Delete_next_line -> delete_next_line | Delete_prev_line -> delete_prev_line | Kill_next_line -> kill_next_line | Kill_prev_line -> kill_prev_line | Switch_erase_mode -> switch_erase_mode | Set_mark -> set_mark | Goto_mark -> goto_mark | Copy -> copy | Kill -> kill | Yank -> yank | Capitalize_word -> capitalize_word | Lowercase_word -> lowercase_word | Uppercase_word -> uppercase_word | Next_word -> next_word | Prev_word -> prev_word | Delete_next_word -> delete_next_word | Delete_prev_word -> delete_prev_word | Kill_next_word -> kill_next_word | Kill_prev_word -> kill_prev_word | Undo -> undo let doc_of_action = function | Insert _ -> "insert the given character." | Newline -> "insert a newline character." | Next_char -> "move the cursor to the next character." | Prev_char -> "move the cursor to the previous character." | Next_line -> "move the cursor to the next line." | Prev_line -> "move the cursor to the previous line." | Goto_bol -> "move the cursor to the beginning of the current line." | Goto_eol -> "move the cursor to the end of the current line." | Goto_bot -> "move the cursor to the beginning of the text." | Goto_eot -> "move the cursor to the end of the text." | Delete_next_char -> "delete the character after the cursor." | Delete_prev_char -> "delete the character before the cursor." | Delete_next_line -> "delete everything until the end of the current line." | Delete_prev_line -> "delete everything until the beginning of the current line." | Kill_next_line -> "cut everything until the end of the current line." | Kill_prev_line -> "cut everything until the beginning of the current line." | Switch_erase_mode -> "switch the current erasing mode." | Set_mark -> "set the mark to the current position." | Goto_mark -> "move the cursor to the mark." | Copy -> "copy the current region to the clipboard." | Kill -> "cut the current region to the clipboard." | Yank -> "paste the contents of the clipboard at current position." | Capitalize_word -> "capitalize the first word after the cursor." | Lowercase_word -> "convert the first word after the cursor to lowercase." | Uppercase_word -> "convert the first word after the cursor to uppercase." | Next_word -> "move the cursor to the end of the next word." | Prev_word -> "move the cursor to the beginning of the previous word." | Delete_next_word -> "delete up until the next non-word character." | Delete_prev_word -> "delete the word behind the cursor." | Kill_next_word -> "cut up until the next non-word character." | Kill_prev_word -> "cut the word behind the cursor." | Undo -> "revert the last action." let actions = [ Newline, "newline"; Next_char, "next-char"; Prev_char, "prev-char"; Next_line, "next-line"; Prev_line, "prev-line"; Goto_bol, "goto-bol"; Goto_eol, "goto-eol"; Goto_bot, "goto-bot"; Goto_eot, "goto-eot"; Delete_next_char, "delete-next-char"; Delete_prev_char, "delete-prev-char"; Delete_next_line, "delete-next-line"; Delete_prev_line, "delete-prev-line"; Kill_next_line, "kill-next-line"; Kill_prev_line, "kill-prev-line"; Switch_erase_mode, "switch-erase-mode"; Set_mark, "set-mark"; Goto_mark, "goto-mark"; Copy, "copy"; Kill, "kill"; Yank, "yank"; Capitalize_word, "capitalize-word"; Lowercase_word, "lowercase-word"; Uppercase_word, "uppercase-word"; Next_word, "next-word"; Prev_word, "prev-word"; Delete_next_word, "delete-next-word"; Delete_prev_word, "delete-prev-word"; Kill_next_word, "kill-next-word"; Kill_prev_word, "kill-prev-word"; Undo, "undo"; ] let actions_to_names = Array.of_list (List.sort (fun (a1, n1) (a2, n2) -> compare a1 a2) actions) let names_to_actions = Array.of_list (List.sort (fun (a1, n1) (a2, n2) -> compare n1 n2) actions) let parse_insert x = if Zed_utf8.starts_with x "insert(" && Zed_utf8.ends_with x ")" then begin let str = String.sub x 7 (String.length x - 8) in if String.length str = 1 && Char.code str.[0] < 128 then Insert(UChar.of_char str.[0]) else if String.length str > 2 && str.[0] = 'U' && str.[1] = '+' then let acc = ref 0 in for i = 2 to String.length str - 1 do let ch = str.[i] in acc := !acc * 16 + (match ch with | '0' .. '9' -> Char.code ch - Char.code '0' | 'a' .. 'f' -> Char.code ch - Char.code 'a' + 10 | 'A' .. 'F' -> Char.code ch - Char.code 'A' + 10 | _ -> raise Not_found) done; try Insert(UChar.of_int !acc) with _ -> raise Not_found else raise Not_found end else raise Not_found let action_of_name x = let rec loop a b = if a = b then parse_insert x else let c = (a + b) / 2 in let action, name = Array.unsafe_get names_to_actions c in match compare x name with | d when d < 0 -> loop a c | d when d > 0 -> loop (c + 1) b | _ -> action in loop 0 (Array.length names_to_actions) let name_of_action x = let rec loop a b = if a = b then raise Not_found else let c = (a + b) / 2 in let action, name = Array.unsafe_get actions_to_names c in match compare x action with | d when d < 0 -> loop a c | d when d > 0 -> loop (c + 1) b | _ -> name in match x with | Insert ch -> let code = UChar.code ch in if code <= 255 then let ch = Char.chr (UChar.code ch) in match ch with | 'a' .. 'z' | 'A' .. 'Z' | '0' .. '9' -> Printf.sprintf "insert(%c)" ch | _ -> Printf.sprintf "insert(U+%02x)" code else if code <= 0xffff then Printf.sprintf "insert(U+%04x)" code else Printf.sprintf "insert(U+%06x)" code | _ -> loop 0 (Array.length actions_to_names) zed-1.4/src/zed_edit.mli000066400000000000000000000321631245345107700152360ustar00rootroot00000000000000(* * zed_edit.mli * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Edition engines *) open CamomileLibrary open React type 'a t (** Type of edition engines. ['a] is the type of custom data attached to the engine in order to extend it. *) (** Type of clipboards. *) type clipboard = { clipboard_get : unit -> Zed_rope.t; (** Returns the current contents of the clipboard. *) clipboard_set : Zed_rope.t -> unit; (** Sets the contents of the clipboard. *) } val new_clipboard : unit -> clipboard (** [new_clipboard ()] creates a new clipboard using a reference. *) val create : ?editable : (int -> int -> bool) -> ?move : (int -> int -> int) -> ?clipboard : clipboard -> ?match_word : (Zed_rope.t -> int -> int option) -> ?locale : string option signal -> ?undo_size : int -> unit -> 'a t (** [create ?editable ?move ?clipboard ()] creates a new edition engine in the initial state. [editable] is used to determine whether the text at given position is editable or not. It takes as argument the position and the length of the text to remove. [move] is unused. [clipboard] is the clipboard to use for this engine. If none is defined, a new one using a reference is created. [match_word] is used to recognize words. It must returns the end of the matched word if any. [locale] is the locale of this buffer. It is used for case mapping. [undo_size] is the size of the undo buffer. It is the number of state zed will remember. It defaults to [1000]. *) val match_by_regexp : Zed_re.t -> Zed_rope.t -> int -> int option (** [match_by_regexp re] creates a word-matching function using a regular expression. *) (** {6 State} *) val get_data : 'a t -> 'a (** [get_data edit] returns the custom data attached to the engine. It raises [Not_found] if no data is attached to the engine. *) val set_data : 'a t -> 'a -> unit (** [set_data edit data] attach [data] to the engine. *) val clear_data : 'a t -> unit (** [clear_data edit] removes the custom data of engine. *) val text : 'a t -> Zed_rope.t (** [text edit] returns the signal holding the current contents of the buffer. *) val lines : 'a t -> Zed_lines.t (** [lines edit] returns the set of line position of [text edit]. *) val get_line : 'a t -> int -> Zed_rope.t (** [get_line edit n] returns the rope corresponding to the [n]th line without the newline character. *) val changes : 'a t -> (int * int * int) event (** [changes edit] returns an event which occurs with values of the form [(start, added, removed)] when the contents of the engine changes. [start] is the start of modifications, [added] is the number of characters added and [removed] is the number of characters removed. *) val update : 'a t -> Zed_cursor.t list -> unit event (** [update edit cursors] returns an event which occurs each the rendering of the engine should be updated. *) val erase_mode : 'a t -> bool signal (** [erase_mode edit] returns the ``erase'' mode of the buffer. In this mode character inserted in the buffer erase existing ones. *) val get_erase_mode : 'a t -> bool (** [erase_mode edit] returns the current erase mode of the buffer. *) val set_erase_mode : 'a t -> bool -> unit (** [set_erase_mode edit state] sets the status of the erase mode for the given engine. *) val mark : 'a t -> Zed_cursor.t (** [mark edit] returns the cursor used to for the mark in the given engine. *) val selection : 'a t -> bool signal (** [selection edit] returns the signal holding the current selection state. If [true], text is being selectionned. *) val get_selection : 'a t -> bool (** [selection edit] returns the current selection state. *) val set_selection : 'a t -> bool -> unit (** [set_selection edit state] sets the selection state. *) (** {6 Cursors} *) val new_cursor : 'a t -> Zed_cursor.t (** [new_cursor edit] creates a new cursor for the given edition engine. The cursor initially points to the beginning of the buffer. *) (** {6 Actions} *) exception Cannot_edit (** Exception raised when trying to edit a non-editable portion of a buffer. *) type 'a context (** Type of contexts. Contexts are used to modify an edition buffer. *) val context : ?check : bool -> 'a t -> Zed_cursor.t -> 'a context (** [context ?check edit cursor] creates a new context with given parameters. [cursor] is the cursor that will be used for all modification of the text. If [check] is [true] (the default) then all modification of the text will be checked with the [editable] function of the engine. *) val edit : 'a context -> 'a t (** [edit ctx] returns the edition engine used by the given context. *) val cursor : 'a context -> Zed_cursor.t (** [cursor ctx] returns the cursor used by this context. *) val check : 'a context -> bool (** [check ctx] returns whether the context has been created with the [check] flag. *) val with_check : bool -> 'a context -> 'a context (** [with_check check ctx] retuns [ctx] with the check flag set to [check]. *) val goto : 'a context -> ?set_wanted_column : bool -> int -> unit (** [goto ctx ?set_column position] moves the cursor to the given position. It raises {!Zed_cursor.Out_of_bounds} if the position is outside the bounds of the text. If [set_wanted_column] is [true], the wanted column of the cursor is set to the new column. *) val move : 'a context -> ?set_wanted_column : bool -> int -> unit (** [move ctx ?set_wanted_column delta] moves the cursor by the given number of characters. It raises {!Zed_cursor.Out_of_bounds} if the current plus [delta] is outside the bounds of the text. *) val move_line : 'a context -> int -> unit (** [move_line ctx ?set_wanted_column delta] moves the cursor by the given number of lines. *) val position : 'a context -> int (** [position ctx] returns the position of the cursor. *) val line : 'a context -> int (** [line ctx] returns the line of the cursor. *) val column : 'a context -> int (** [column ctx] returns the column of the cursor. *) val at_bol : 'a context -> bool (** [at_bol ctx] returns [true] iff the cursor is at the beginning of the current line. *) val at_eol : 'a context -> bool (** [at_eol ctx] returns [true] iff the cursor is at the end of the current line. *) val at_bot : 'a context -> bool (** [at_bot ctx] returns [true] iff the cursor is at the beginning of the text. *) val at_eot : 'a context -> bool (** [at_eot ctx] returns [true] iff the cursor is at the end of the text. *) val insert : 'a context -> Zed_rope.t -> unit (** [insert ctx rope] inserts the given rope at current position. *) val insert_no_erase : 'a context -> Zed_rope.t -> unit (** [insert ctx rope] inserts the given rope at current position but do not erase text if the buffer is currently in erase mode. *) val remove_next : 'a context -> int -> unit (** [remove_next ctx n] removes [n] characters at current position. If there is less than [n] characters at current position, it removes everything until the end of the text. *) val remove_prev : 'a context -> int -> unit (** [remove_prev ctx n] removes [n] characters before current position. If there is less than [n] characters before current position, it removes everything until the beginning of the text. *) val remove : 'a context -> int -> unit (** Alias for {!remove_next} *) val replace : 'a context -> int -> Zed_rope.t -> unit (** [replace ctx n rope] does the same as: {[ remove ctx n; insert_no_erase ctx rope ]} but in one atomic operation. *) val newline : 'a context -> unit (** Insert a newline character. *) val next_char : 'a context -> unit (** [next_char ctx] moves the cursor to the next character. It does nothing if the cursor is at the end of the text. *) val prev_char : 'a context -> unit (** [prev_char ctx] moves the cursor to the previous character. It does nothing if the cursor is at the beginning of the text. *) val next_line : 'a context -> unit (** [next_line ctx] moves the cursor to the next line. If the cursor is on the last line, it is moved to the end of the buffer. *) val prev_line : 'a context -> unit (** [prev_line ctx] moves the cursor to the previous line. If the cursor is on the first line, it is moved to the beginning of the buffer. *) val goto_bol : 'a context -> unit (** [goto_bol ctx] moves the cursor to the beginning of the current line. *) val goto_eol : 'a context -> unit (** [goto_eol ctx] moves the cursor to the end of the current line. *) val goto_bot : 'a context -> unit (** [goto_bot ctx] moves the cursor to the beginning of the text. *) val goto_eot : 'a context -> unit (** [goto_eot ctx] moves the cursor to the end of the text. *) val delete_next_char : 'a context -> unit (** [delete_next_char ctx] deletes the character after the cursor, if any. *) val delete_prev_char : 'a context -> unit (** [delete_prev_char ctx] delete the character before the cursor. *) val delete_next_line : 'a context -> unit (** [delete_next_line ctx] delete everything until the end of the current line. *) val delete_prev_line : 'a context -> unit (** [delete_next_line ctx] delete everything until the beginning of the current line. *) val kill_next_line : 'a context -> unit (** [kill_next_line ctx] delete everything until the end of the current line and save it to the clipboard. *) val kill_prev_line : 'a context -> unit (** [kill_next_line ctx] delete everything until the beginning of the current line and save it to the clipboard. *) val switch_erase_mode : 'a context -> unit (** [switch_erase_mode ctx] switch the current erase mode. *) val set_mark : 'a context -> unit (** [set_mark ctx] sets the mark at current position. *) val goto_mark : 'a context -> unit (** [goto_mark ctx] moves the cursor to the mark. *) val copy : 'a context -> unit (** [copy ctx] copies the current selectionned region to the clipboard. *) val kill : 'a context -> unit (** [kill ctx] copies the current selectionned region to the clipboard and remove it. *) val yank : 'a context -> unit (** [yank ctx] inserts the contents of the clipboard at current position. *) val capitalize_word : 'a context -> unit (** [capitalize_word ctx] capitalizes the first word after the cursor. *) val lowercase_word : 'a context -> unit (** [lowercase_word ctx] converts the first word after the cursor to lowercase. *) val uppercase_word : 'a context -> unit (** [uppercase_word ctx] converts the first word after the cursor to uppercase. *) val next_word : 'a context -> unit (** [next_word ctx] moves the cursor to the end of the next word. *) val prev_word : 'a context -> unit (** [prev_word ctx] moves the cursor to the beginning of the previous word. *) val delete_next_word : 'a context -> unit (** [delete_next_word ctx] deletes the word after the cursor. *) val delete_prev_word : 'a context -> unit (** [delete_prev_word ctx] deletes the word before the cursor. *) val kill_next_word : 'a context -> unit (** [kill_next_word ctx] deletes the word after the cursor and save it to the clipboard. *) val kill_prev_word : 'a context -> unit (** [kill_prev_word ctx] deletes the word before the cursor and save it to the clipboard. *) val undo : 'a context -> unit (** [undo ctx] reverts the last performed action. *) (** {6 Action by names} *) (** Type of actions. *) type action = | Insert of UChar.t | Newline | Next_char | Prev_char | Next_line | Prev_line | Goto_bol | Goto_eol | Goto_bot | Goto_eot | Delete_next_char | Delete_prev_char | Delete_next_line | Delete_prev_line | Kill_next_line | Kill_prev_line | Switch_erase_mode | Set_mark | Goto_mark | Copy | Kill | Yank | Capitalize_word | Lowercase_word | Uppercase_word | Next_word | Prev_word | Delete_next_word | Delete_prev_word | Kill_next_word | Kill_prev_word | Undo val get_action : action -> ('a context -> unit) (** [get_action action] returns the function associated to the given action. *) val actions : (action * string) list (** List of actions with their names, except {!Insert}. *) val doc_of_action : action -> string (** [doc_of_action action] returns a short description of the action. *) val action_of_name : string -> action (** [action_of_name str] converts the given action name into an action. Action name are the same as function name but with '_' replaced by '-'. It raises [Not_found] if the name does not correspond to an action. [Insert ch] is represented by "insert()" where [] is: - a literal ascii character, such as "a", "b", ... - a unicode character, written "U+< code >", such as "U+0041" *) val name_of_action : action -> string (** [name_of_action act] returns the name of the given action. *) zed-1.4/src/zed_input.ml000066400000000000000000000070241245345107700152750ustar00rootroot00000000000000(* * zed_input.ml * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) module type S = sig type event type +'a t val empty : 'a t val add : event list -> 'a -> 'a t -> 'a t val remove : event list -> 'a t -> 'a t val fold : (event list -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b val bindings : 'a t -> (event list * 'a) list type 'a resolver type 'a pack val pack : ('a -> 'b) -> 'a t -> 'b pack val resolver : 'a pack list -> 'a resolver type 'a result = | Accepted of 'a | Continue of 'a resolver | Rejected val resolve : event -> 'a resolver -> 'a result end module Make (Event : Map.OrderedType) = struct type event = Event.t module Event_map = Map.Make (Event) type 'a t = 'a node Event_map.t and 'a node = | Set of 'a t | Val of 'a let empty = Event_map.empty let rec add events value set = match events with | [] -> invalid_arg "Zed_input.Make.add" | [event] -> Event_map.add event (Val value) set | event :: events -> match try Some (Event_map.find event set) with Not_found -> None with | None | Some (Val _) -> Event_map.add event (Set (add events value empty)) set | Some (Set s) -> Event_map.add event (Set (add events value s)) set let rec remove events set = match events with | [] -> invalid_arg "Zed_input.Make.remove" | [event] -> Event_map.remove event set | event :: events -> match try Some (Event_map.find event set) with Not_found -> None with | None | Some (Val _) -> set | Some (Set s) -> let s = remove events s in if Event_map.is_empty s then Event_map.remove event set else Event_map.add event (Set s) set let fold f set acc = let rec loop prefix set acc = Event_map.fold (fun event node acc -> match node with | Val v -> f (List.rev (event :: prefix)) v acc | Set s -> loop (event :: prefix) s acc) set acc in loop [] set acc let bindings set = List.rev (fold (fun events action l -> (events, action) :: l) set []) module type Pack = sig type a type b val set : a t val map : a -> b end type 'a pack = (module Pack with type b = 'a) type 'a resolver = 'a pack list let pack (type u) (type v) map set = let module Pack = struct type a = u type b = v let set = set let map = map end in (module Pack : Pack with type b = v) let resolver l = l type 'a result = | Accepted of 'a | Continue of 'a resolver | Rejected let rec resolve_rec : 'a. event -> 'a pack list -> 'a pack list -> 'a result = fun (type u) event acc packs -> match packs with | [] -> if acc = [] then Rejected else Continue (List.rev acc) | p :: packs -> let module Pack = (val p : Pack with type b = u) in match try Some (Event_map.find event Pack.set) with Not_found -> None with | Some (Set set) -> resolve_rec event (pack Pack.map set :: acc) packs | Some (Val v) -> Accepted (Pack.map v) | None -> resolve_rec event acc packs let resolve event sets = resolve_rec event [] sets end zed-1.4/src/zed_input.mli000066400000000000000000000041561245345107700154510ustar00rootroot00000000000000(* * zed_input.mli * ------------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Helpers for writing key bindings *) (** Signature for binders. *) module type S = sig type event (** Type of events. *) type +'a t (** Type of set of bindings mapping input sequence to values of type ['a]. *) val empty : 'a t (** The empty set of bindings. *) val add : event list -> 'a -> 'a t -> 'a t (** [add events x bindings] binds [events] to [x]. It raises [Invalid_argument] if [events] is empty. *) val remove : event list -> 'a t -> 'a t (** [remove events bindings] unbinds [events]. It raises [Invalid_argument] if [events] is empty. *) val fold : (event list -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b (** [fold f set acc] executes [f] on all sequence of [set], accumulating a value. *) val bindings : 'a t -> (event list * 'a) list (** [bindings set] returns all bindings of [set]. *) type 'a resolver (** Type of a resolver. A resolver is used to resolve an input sequence, i.e. to find the value associated to one. It returns a value of type ['a] when a matching sequence is found. *) type 'a pack (** A pack is a pair of a set of bindings and a mapping function. *) val pack : ('a -> 'b) -> 'a t -> 'b pack (** [pack f set] creates a pack. *) val resolver : 'a pack list -> 'a resolver (** [resolver packs] creates a resolver from a list of pack. *) (** Result of a resolving operation. *) type 'a result = | Accepted of 'a (** The sequence is terminated and associated to the given value. *) | Continue of 'a resolver (** The sequence is not terminated. *) | Rejected (** None of the sequences is prefixed by the one. *) val resolve : event -> 'a resolver -> 'a result (** [resolve event resolver] tries to resolve [event] using [resolver]. *) end module Make (Event : Map.OrderedType) : S with type event = Event.t (** [Make (Event)] makes a a new binder. *) zed-1.4/src/zed_lines.ml000066400000000000000000000151271245345107700152530ustar00rootroot00000000000000(* * zed_lines.ml * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open CamomileLibraryDyn.Camomile exception Out_of_bounds (* +-----------------------------------------------------------------+ | Representation | +-----------------------------------------------------------------+ *) (* Sets are represented by ropes. *) type t = | String of int (* [String len] is a string of length [len] without newline character. *) | Return (* A newline character. *) | Concat of t * t * int * int * int (* [Concat(t1, t2, len, count, depth)] *) (* +-----------------------------------------------------------------+ | Basic functions | +-----------------------------------------------------------------+ *) let length = function | String len -> len | Return -> 1 | Concat(_, _, len, _, _) -> len let count = function | String _ -> 0 | Return -> 1 | Concat(_, _, _, count, _) -> count let depth = function | String _ | Return -> 0 | Concat(_, _, _, _, d) -> d let is_empty = function | String 0 -> true | _ -> false let empty = String 0 (* +-----------------------------------------------------------------+ | Offset/line resolution | +-----------------------------------------------------------------+ *) let rec line_index_rec set ofs acc = match set with | String _ -> acc | Return -> if ofs = 0 then acc else acc + 1 | Concat(s1, s2, _, _, _) -> let len1 = length s1 in if ofs < len1 then line_index_rec s1 ofs acc else line_index_rec s2 (ofs - len1) (acc + count s1) let line_index set ofs = if ofs < 0 || ofs > length set then raise Out_of_bounds else line_index_rec set ofs 0 let rec line_start_rec set idx acc = match set with | String _ -> acc | Return -> if idx = 0 then acc else acc + 1 | Concat(s1, s2, _, _, _) -> let count1 = count s1 in if idx <= count1 then line_start_rec s1 idx acc else line_start_rec s2 (idx - count1) (acc + length s1) let line_start set idx = if idx < 0 || idx > count set then raise Out_of_bounds else line_start_rec set idx 0 let line_stop set idx = if idx = count set then length set else line_start set (idx + 1) - 1 let line_length set idx = line_stop set idx - line_start set idx (* +-----------------------------------------------------------------+ | Operations on sets | +-----------------------------------------------------------------+ *) let concat set1 set2 = Concat(set1, set2, length set1 + length set2, count set1 + count set2, 1 + max (depth set1) (depth set2)) let append set1 set2 = match set1, set2 with | String 0, _ -> set2 | _, String 0 -> set1 | String len1, String len2 -> String(len1 + len2) | String len1, Concat(String len2, set, len, count, h) -> Concat(String(len1 + len2), set, len + len1, count, h) | Concat(set, String len1, len, count, h), String len2 -> Concat(set, String(len1 + len2), len + len2, count, h) | _ -> let d1 = depth set1 and d2 = depth set2 in if d1 > d2 + 2 then begin match set1 with | String _ | Return -> assert false | Concat(set1_1, set1_2, _, _, _) -> if depth set1_1 >= depth set1_2 then concat set1_1 (concat set1_2 set2) else begin match set1_2 with | String _ | Return -> assert false | Concat(set1_2_1, set1_2_2, _, _, _) -> concat (concat set1_1 set1_2_1) (concat set1_2_2 set2) end end else if d2 > d1 + 2 then begin match set2 with | String _ | Return -> assert false | Concat(set2_1, set2_2, _, _, _) -> if depth set2_2 >= depth set2_1 then concat (concat set1 set2_1) set2_2 else begin match set2_1 with | String _ | Return -> assert false | Concat(set2_1_1, set2_1_2, _, _, _) -> concat (concat set1 set2_1_1) (concat set2_1_2 set2_2) end end else concat set1 set2 let rec unsafe_sub set idx len = match set with | String _ -> String len | Return -> if len = 1 then Return else String 0 | Concat(set_l, set_r, len', _, _) -> let len_l = length set_l in if len = len' then set else if idx >= len_l then unsafe_sub set_r (idx - len_l) len else if idx + len <= len_l then unsafe_sub set_l idx len else append (unsafe_sub set_l idx (len_l - idx)) (unsafe_sub set_r 0 (len - len_l + idx)) let sub set idx len = if idx < 0 || len < 0 || idx + len > length set then raise Out_of_bounds else unsafe_sub set idx len let break set ofs = let len = length set in if ofs < 0 || ofs > len then raise Out_of_bounds else (unsafe_sub set 0 ofs, unsafe_sub set ofs (len - ofs)) let insert set ofs set' = let set1, set2 = break set ofs in append set1 (append set' set2) let remove set ofs len = append (sub set 0 ofs) (sub set (ofs + len) (length set - ofs - len)) let replace set ofs len repl = append (sub set 0 ofs) (append repl (sub set (ofs + len) (length set - ofs - len))) (* +-----------------------------------------------------------------+ | Sets from ropes | +-----------------------------------------------------------------+ *) let of_rope rope = let rec loop zip len acc = if Zed_rope.Zip.at_eos zip then append acc (String len) else let ch, zip = Zed_rope.Zip.next zip in if UChar.code ch = 10 then loop0 zip (append (append acc (String len)) Return) else loop zip (len + 1) acc and loop0 zip acc = if Zed_rope.Zip.at_eos zip then acc else let ch, zip = Zed_rope.Zip.next zip in if UChar.code ch = 10 then loop0 zip (append acc Return) else loop zip 1 acc in loop0 (Zed_rope.Zip.make_f rope 0) empty zed-1.4/src/zed_lines.mli000066400000000000000000000035241245345107700154220ustar00rootroot00000000000000(* * zed_lines.mli * ------------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Sets of line positions. *) (** This module implement sets of line positions. They allow to efficiently find the beginning of a line and to convert offset to line and column number. *) exception Out_of_bounds (** Exception raised when trying to access a position outside the bounds of a set. *) type t (** Type of sets of line positions. *) val length : t -> int (** Returns the length of the set, i.e. the number of characters in the set. *) val count : t -> int (** Returns the number of newlines in the set. *) val of_rope : Zed_rope.t -> t (** [of_rope rope] returns the set of newline positions in [rope]. *) val empty : t (** The empty set. *) val line_index : t -> int -> int (** [line_index set ofs] returns the line number of the line containing [ofs]. *) val line_start : t -> int -> int (** [line_start set idx] returns the offset of the beginning of the [idx]th line of [set] . *) val line_stop : t -> int -> int (** [line_stop set idx] returns the offset of the end of the [idx]th line of [set] . *) val line_length : t -> int -> int (** [line_length set idx] returns the length of the [idx]th line of [set] . *) val append : t -> t -> t (** [append s1 s2] concatenates two sets of line positions. *) val insert : t -> int -> t -> t (** [insert set offset set'] inserts [set] at given positon in [set'].*) val remove : t -> int -> int -> t (** [remove set offet length] removes [length] characters at [offset] in set. *) val replace : t -> int -> int -> t -> t (** [replace set offset length repl] replaces the subset at offset [offset] and length [length] by [repl] in [set]. *) zed-1.4/src/zed_macro.ml000066400000000000000000000031541245345107700152370ustar00rootroot00000000000000(* * zed_macro.ml * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open React type 'a t = { recording : bool signal; set_recording : bool -> unit; mutable tmp_macro : 'a list; mutable macro : 'a list; count : int signal; set_count : int -> unit; counter : int signal; set_counter : int -> unit; } let create macro = let recording, set_recording = S.create false in let count, set_count = S.create 0 in let counter, set_counter = S.create 0 in { recording; set_recording; macro; tmp_macro = []; count; set_count; counter; set_counter; } let recording r = r.recording let get_recording r = S.value r.recording let set_recording r state = match state with | true -> r.tmp_macro <- []; r.set_recording true; r.set_count 0; r.set_counter 0 | false -> if S.value r.recording then begin r.macro <- List.rev r.tmp_macro; r.tmp_macro <- []; r.set_recording false; r.set_count 0 end let cancel r = if S.value r.recording then begin r.tmp_macro <- []; r.set_recording false; r.set_count 0 end let count r = r.count let get_count r = S.value r.count let counter r = r.counter let get_counter r = S.value r.counter let set_counter r v = r.set_counter v let add_counter r v = r.set_counter (S.value r.counter + v) let add r x = if S.value r.recording then begin r.tmp_macro <- x :: r.tmp_macro; r.set_count (S.value r.count + 1) end let contents r = r.macro zed-1.4/src/zed_macro.mli000066400000000000000000000027351245345107700154140ustar00rootroot00000000000000(* * zed_macro.mli * ------------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Macro recorder *) type 'a t (** Type of macro recorders. *) val create : 'a list -> 'a t (** [create macro] create a new macro recorder, with initial contents [macro]. *) val recording : 'a t -> bool React.signal (** Whether the recorder is recording a macro. *) val get_recording : 'a t -> bool (** Returns the current state of the recorder. *) val set_recording : 'a t -> bool -> unit (** Starts or stops the macro recorder. *) val cancel : 'a t -> unit (** Cancels the current macro if recording one. *) val count : 'a t -> int React.signal (** The number of actions in the macro recorder. It is [0] if the recorder is not currently recording. *) val get_count : 'a t -> int (** Returns the current number of actions in the macro recorder. *) val add : 'a t -> 'a -> unit (** [add recorder x] adds [x] to the recorder if it is recording a macro. *) val contents : 'a t -> 'a list (** Returns the currently recorded macro. *) val counter : 'a t -> int React.signal (** The contents of the macro counter. *) val get_counter : 'a t -> int (** Gets the contents of the macro counter. *) val set_counter : 'a t -> int -> unit (** Sets the macro counter to the given value. *) val add_counter : 'a t -> int -> unit (** Adds the given value to the macro counter. *) zed-1.4/src/zed_re.ml000066400000000000000000000024021245345107700145370ustar00rootroot00000000000000(* * zed_re.ml * --------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open CamomileLibraryDyn.Camomile module Re = URe.Make(Zed_rope.Text) type t = Re.compiled_regexp type match_result = (Zed_rope.Zip.t * Zed_rope.Zip.t) option array option let compile = Re.compile let convert_success arr = Array.map (function | Some sub -> let rope, zip1, zip2 = Re.SubText.context sub in Some(zip1, zip2) | None -> None) arr let convert = function | Some arr -> Some(convert_success arr) | None -> None let regexp_match ?sem regexp rope idx = convert (Re.regexp_match ?sem regexp rope (Zed_rope.Zip.make_f rope idx)) let search_forward ?sem regexp rope idx = convert (try Re.search_forward ?sem regexp rope (Zed_rope.Zip.make_f rope idx) with Not_found -> None) let search_backward ?sem regexp rope idx = let rec loop zip = match Re.regexp_match ?sem regexp rope zip with | Some arr -> Some(convert_success arr) | None -> if Zed_rope.Zip.at_bos zip then None else loop (Zed_rope.Zip.move (-1) zip) in loop (Zed_rope.Zip.make_f rope idx) zed-1.4/src/zed_re.mli000066400000000000000000000024701245345107700147150ustar00rootroot00000000000000(* * zed_re.mli * ---------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Regular expressions on ropes *) open CamomileLibrary type t (** Type of compiled regular expressions. *) type match_result = (Zed_rope.Zip.t * Zed_rope.Zip.t) option array option (** Type of a match result. If the match fail, [None] is returned. Otherwise an array of matched sub-strings is returned, the index [0] corresponding to the full match, and other indexes to matched groups. *) val compile : URe.regexp -> t (** [compile regexp] compiles the given regular expression. *) val regexp_match : ?sem : URe.match_semantics -> t -> Zed_rope.t -> int -> match_result (** [regexp_match ?sem regexp rope pos] tries to match [regexp] on given rope, starting at [pos]. *) val search_forward : ?sem : URe.match_semantics -> t -> Zed_rope.t -> int -> match_result (** [search_forward ?sem regexp rope pos] searches the given regular expression in [rope] starting at [pos]. *) val search_backward : ?sem : URe.match_semantics -> t -> Zed_rope.t -> int -> match_result (** [search_backward ?sem regexp rope pos] searches the given regular expression in [rope] starting at [pos], in reverse order. *) zed-1.4/src/zed_rope.ml000066400000000000000000000522671245345107700151140ustar00rootroot00000000000000(* * zed_rope.ml * ----------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open CamomileLibraryDyn.Camomile (* Maximum length of a leaf *) let max_leaf_size = 256 exception Out_of_bounds (* +-----------------------------------------------------------------+ | Ropes representation | +-----------------------------------------------------------------+ *) type t = | Leaf of Zed_utf8.t * int (* [Leaf(str, len)] *) | Node of int * int * t * int * t (* [Node(depth, length_left, left, length_right, right)] *) type rope = t type code_point = int let empty = Leaf("", 0) (* +-----------------------------------------------------------------+ | Basic operations | +-----------------------------------------------------------------+ *) let rec length = function | Leaf(_, len) -> len | Node(_, len_l, _, len_r, _) -> len_l + len_r let rec depth = function | Leaf _ -> 0 | Node(d, _, _, _, _) -> d let is_empty = function | Leaf(_, 0) -> true | _ -> false (* +-----------------------------------------------------------------+ | Balancing | +-----------------------------------------------------------------+ *) let rec make_fibo acc a b = let c = a + b in if c < b then (* overflow *) acc else make_fibo (c :: acc) b c let fibo = let l = make_fibo [1; 1; 0] 1 1 in let n = List.length l in let fibo = Array.make n 0 in let rec loop i = function | [] -> fibo | x :: l -> fibo.(i) <- x; loop (i - 1) l in loop (n - 1) l let max_depth = Array.length fibo let unsafe_concat rope1 rope2 = match rope1, rope2 with | Leaf(_, 0), _ -> rope2 | _, Leaf(_, 0) -> rope1 | _ -> Node(1 + max (depth rope1) (depth rope2), length rope1, rope1, length rope2, rope2) let rec insert_to_forest forest acc idx = let acc = unsafe_concat forest.(idx) acc in if length acc < fibo.(idx + 1) then forest.(idx) <- acc else begin forest.(idx) <- empty; insert_to_forest forest acc (idx + 1) end let rec concat_forest_until forest acc idx rope = if length rope < fibo.(idx + 1) then insert_to_forest forest (unsafe_concat acc rope) idx else begin let acc = unsafe_concat forest.(idx) acc in forest.(idx) <- empty; concat_forest_until forest acc (idx + 1) rope end let rec balance_rec forest rope = match rope with | Leaf _ -> concat_forest_until forest empty 2 rope | Node(depth, len_l, rope_l, len_r, rope_r) -> balance_rec forest rope_l; balance_rec forest rope_r let rec concat_forest forest acc idx = if idx = max_depth then acc else concat_forest forest (unsafe_concat forest.(idx) acc) (idx + 1) let balance rope = match length rope with | 0 | 1 -> rope | len when len >= fibo.(depth rope + 2) -> rope | len -> let forest = Array.make max_depth empty in balance_rec forest rope; concat_forest forest empty 2 (* +-----------------------------------------------------------------+ | Leaf operations | +-----------------------------------------------------------------+ *) let append rope1 rope2 = match rope1, rope2 with | Leaf(_, 0), _ -> rope2 | _, Leaf(_, 0) -> rope1 | Leaf(text1, len1), Leaf(text2, len2) when len1 + len2 <= max_leaf_size -> Leaf(text1 ^ text2, len1 + len2) | Node(d, len_l, rope_l, _, Leaf(text1, len1)), Leaf(text2, len2) when len1 + len2 <= max_leaf_size -> Node(d, len_l, rope_l, len1 + len2, Leaf(text1 ^ text2, len1 + len2)) | Leaf(text1, len1), Node(d, _, Leaf(text2, len2), len_r, rope_r) when len1 + len2 <= max_leaf_size -> Node(d, len1 + len2, Leaf(text1 ^ text2, len1 + len2), len_r, rope_r) | _ -> balance (Node(1 + max (depth rope1) (depth rope2), length rope1, rope1, length rope2, rope2)) let concat sep l = let rec loop acc = function | [] -> acc | x :: l -> loop (append (append acc sep) x) l in match l with | [] -> empty | x :: l -> loop x l let rec unsafe_get idx rope = match rope with | Leaf(text, _) -> Zed_utf8.get text idx | Node(_, len_l, rope_l, len_r, rope_r) -> if idx < len_l then unsafe_get idx rope_l else unsafe_get (idx - len_l) rope_r let get rope idx = if idx < 0 || idx >= length rope then raise Out_of_bounds else unsafe_get idx rope let rec unsafe_sub rope idx len = match rope with | Leaf(text, _) -> Leaf(Zed_utf8.sub text idx len, len) | Node(_, len_l, rope_l, len_r, rope_r) -> if len = len_l + len_r then rope else if idx >= len_l then unsafe_sub rope_r (idx - len_l) len else if idx + len <= len_l then unsafe_sub rope_l idx len else append (unsafe_sub rope_l idx (len_l - idx)) (unsafe_sub rope_r 0 (len - len_l + idx)) let sub rope idx len = if idx < 0 || len < 0 || idx + len > length rope then raise Out_of_bounds else unsafe_sub rope idx len let make length char = if length < max_leaf_size then Leaf(Zed_utf8.make length char, length) else begin let text = Zed_utf8.make max_leaf_size char in let chunk = Leaf(text, max_leaf_size) in let rec loop acc n = if n = 0 then acc else if n < max_leaf_size then append acc (Leaf(Zed_utf8.sub text 0 n, n)) else loop (append acc chunk) (n - max_leaf_size) in loop empty length end let singleton ch = Leaf(Zed_utf8.singleton ch, 1) let break rope pos = let len = length rope in if pos < 0 || pos > len then raise Out_of_bounds; (unsafe_sub rope 0 pos, unsafe_sub rope pos (len - pos)) let before rope pos = sub rope 0 pos let after rope pos = sub rope pos (length rope - pos) let insert rope pos sub = let before, after = break rope pos in append before (append sub after) let remove rope pos len = append (sub rope 0 pos) (sub rope (pos + len) (length rope - pos - len)) let replace rope pos len repl = append (sub rope 0 pos) (append repl (sub rope (pos + len) (length rope - pos - len))) let lchop = function | Leaf(_, 0) -> empty | rope -> sub rope 1 (length rope - 1) let rchop = function | Leaf(_, 0) -> empty | rope -> sub rope 0 (length rope - 1) (* +-----------------------------------------------------------------+ | Iterating, folding and mapping | +-----------------------------------------------------------------+ *) let rec iter f = function | Leaf(text, _) -> Zed_utf8.iter f text | Node(_, _, rope_l, _, rope_r) -> iter f rope_l; iter f rope_r let rec rev_iter f = function | Leaf(text, _) -> Zed_utf8.rev_iter f text | Node(_, _, rope_l, _, rope_r) -> rev_iter f rope_r; rev_iter f rope_l let rec fold f rope acc = match rope with | Leaf(text, _) -> Zed_utf8.fold f text acc | Node(_, _, rope_l, _, rope_r) -> fold f rope_r (fold f rope_l acc) let rec rev_fold f rope acc = match rope with | Leaf(text, _) -> Zed_utf8.rev_fold f text acc | Node(_, _, rope_l, _, rope_r) -> rev_fold f rope_l (rev_fold f rope_r acc) let rec map f = function | Leaf(txt, len) -> Leaf(Zed_utf8.map f txt, len) | Node(depth, length_l, rope_l, length_r, rope_r) -> let rope_l' = map f rope_l in let rope_r' = map f rope_r in Node(depth, length_l, rope_l', length_r, rope_r') let rec rev_map f = function | Leaf(txt, len) -> Leaf(Zed_utf8.rev_map f txt, len) | Node(depth, length_l, rope_l, length_r, rope_r) -> let rope_l' = rev_map f rope_l in let rope_r' = rev_map f rope_r in Node(depth, length_r, rope_r', length_l, rope_l') let rec iter_leaf f = function | Leaf(text, _) -> f text | Node(_, _, rope_l, _, rope_r) -> iter_leaf f rope_l; iter_leaf f rope_r let rec rev_iter_leaf f = function | Leaf(text, _) -> f text | Node(_, _, rope_l, _, rope_r) -> rev_iter_leaf f rope_r; rev_iter_leaf f rope_l let rec fold_leaf f rope acc = match rope with | Leaf(text, _) -> f text acc | Node(_, _, rope_l, _, rope_r) -> fold_leaf f rope_r (fold_leaf f rope_l acc) let rec rev_fold_leaf f rope acc = match rope with | Leaf(text, _) -> f text acc | Node(_, _, rope_l, _, rope_r) -> rev_fold_leaf f rope_l (rev_fold_leaf f rope_r acc) (* +-----------------------------------------------------------------+ | Zippers | +-----------------------------------------------------------------+ *) module Zip = struct type rope_zipper = { str : string; (* The string of the current leaf. *) ofs : int; (* The offset of the current leaf in the whole rope. *) leaf : t; (* The current leaf. *) rest_b : t list; rest_f : t list; } type t = { idx : int; (* The index in byte of the zipper in the current leaf. *) pos : int; (* The index in character of the zipper in the current leaf. *) zip : rope_zipper; } let rec move_utf8_f str idx len = if len = 0 then idx else move_utf8_f str (Zed_utf8.unsafe_next str idx) (len - 1) let rec make_f_rec ofs rope pos rest_b rest_f = match rope with | Leaf(str, _) -> { idx = move_utf8_f str 0 pos; pos = pos; zip = { str; ofs = ofs - pos; leaf = rope; rest_b; rest_f } } | Node(_, _, r1, _, r2) -> let len1 = length r1 in if pos < len1 then make_f_rec ofs r1 pos rest_b (r2 :: rest_f) else make_f_rec ofs r2 (pos - len1) (r1 :: rest_b) rest_f let make_f rope pos = if pos < 0 || pos > length rope then raise Out_of_bounds; make_f_rec pos rope pos [] [] let rec move_utf8_b str idx len = if len = 0 then idx else move_utf8_b str (Zed_utf8.unsafe_prev str idx) (len - 1) let rec make_b_rec ofs rope pos rest_b rest_f = match rope with | Leaf(str, len) -> { idx = move_utf8_b str (String.length str) (len - pos); pos = pos; zip = { str; ofs = ofs - pos; leaf = rope; rest_b; rest_f } } | Node(_, _, r1, _, r2) -> let len1 = length r1 in if pos < len1 then make_b_rec ofs r1 pos rest_b (r2 :: rest_f) else make_b_rec ofs r2 (pos - len1) (r1 :: rest_b) rest_f let make_b rope pos = let len = length rope in if pos < 0 || pos > length rope then raise Out_of_bounds; let pos = len - pos in make_b_rec pos rope pos [] [] let offset zip = zip.zip.ofs + zip.pos let rec next_leaf ofs rope rest_b rest_f = match rope with | Leaf(str, _) -> let chr, idx = Zed_utf8.unsafe_extract_next str 0 in (chr, { idx = idx; pos = 1; zip = { str; ofs; leaf = rope; rest_b; rest_f } }) | Node(_, _, r1, _, r2) -> next_leaf ofs r1 rest_b (r2 :: rest_f) let next zip = if zip.idx = String.length zip.zip.str then match zip.zip.rest_f with | [] -> raise Out_of_bounds | rope :: rest -> next_leaf (zip.zip.ofs + length zip.zip.leaf) rope (zip.zip.leaf :: zip.zip.rest_b) rest else let chr, idx = Zed_utf8.unsafe_extract_next zip.zip.str zip.idx in (chr, { zip with idx; pos = zip.pos + 1 }) let rec prev_leaf ofs rope rest_b rest_f = match rope with | Leaf(str, len) -> let chr, idx = Zed_utf8.unsafe_extract_prev str (String.length str) in (chr, { idx = idx; pos = len - 1; zip = { str; ofs = ofs - len; leaf = rope; rest_b; rest_f } }) | Node(_, _, r1, _, r2) -> prev_leaf ofs r2 (r1 :: rest_b) rest_f let prev zip = if zip.idx = 0 then match zip.zip.rest_b with | [] -> raise Out_of_bounds | rope :: rest -> prev_leaf zip.zip.ofs rope rest (zip.zip.leaf :: zip.zip.rest_f) else let chr, idx = Zed_utf8.unsafe_extract_prev zip.zip.str zip.idx in (chr, { zip with idx; pos = zip.pos - 1 }) let rec move_f n ofs rope rest_b rest_f = match rope with | Leaf(str, len) -> if n <= len then { idx = move_utf8_f str 0 n; pos = n; zip = { str; ofs; leaf = rope; rest_b; rest_f } } else begin match rest_f with | [] -> raise Out_of_bounds | rope' :: rest_f -> move_f (n - len) (ofs + len) rope' (rope :: rest_b) rest_f end | Node(_, _, r1, _, r2) -> move_f n ofs r1 rest_b (r2 :: rest_f) let rec move_b n ofs rope rest_b rest_f = match rope with | Leaf(str, len) -> if n <= len then { idx = move_utf8_b str (String.length str) n; pos = len - n; zip = { str; ofs; leaf = rope; rest_b; rest_f } } else begin match rest_b with | [] -> raise Out_of_bounds | rope' :: rest_b -> move_b (n - len) (ofs - len) rope' rest_b (rope :: rest_f) end | Node(_, _, r1, _, r2) -> move_b n ofs r2 (r1 :: rest_b) rest_f let move n zip = if n > 0 then let len = length zip.zip.leaf in if zip.pos + n <= len then { zip with idx = move_utf8_f zip.zip.str zip.idx n; pos = zip.pos + n } else match zip.zip.rest_f with | [] -> raise Out_of_bounds | rope :: rest_f -> move_f (n - (len - zip.pos)) (zip.zip.ofs + len) rope (zip.zip.leaf :: zip.zip.rest_b) rest_f else if zip.pos + n >= 0 then { zip with idx = move_utf8_b zip.zip.str zip.idx (-n); pos = zip.pos + n } else match zip.zip.rest_b with | [] -> raise Out_of_bounds | rope :: rest_b -> move_b (n - zip.pos) zip.zip.ofs rope rest_b (zip.zip.leaf :: zip.zip.rest_f) let at_bos zip = zip.zip.rest_b = [] && zip.idx = 0 let at_eos zip = zip.zip.rest_f = [] && zip.idx = String.length zip.zip.str let rec sub_rec acc ropes len = match ropes with | [] -> if len > 0 then raise Out_of_bounds else acc | rope :: rest -> let len' = length rope in if len <= len' then append acc (sub rope 0 len) else sub_rec (append acc rope) rest (len - len') let unsafe_sub str ofs len = let res = Bytes.create len in String.unsafe_blit str ofs res 0 len; res let sub zip len = if len < 0 then raise Out_of_bounds else let len' = length zip.zip.leaf - zip.pos in if len <= len' then Leaf(unsafe_sub zip.zip.str zip.idx (move_utf8_f zip.zip.str zip.idx len - zip.idx), len) else sub_rec (Leaf(unsafe_sub zip.zip.str zip.idx (String.length zip.zip.str - zip.idx), len')) zip.zip.rest_f (len - len') let slice zip1 zip2 = let ofs1 = offset zip1 and ofs2 = offset zip2 in if ofs1 <= ofs2 then sub zip1 (ofs2 - ofs1) else sub zip2 (ofs1 - ofs2) let rec find_f f zip = if at_eos zip then zip else let ch, zip' = next zip in if f ch then zip else find_f f zip' let rec find_b f zip = if at_bos zip then zip else let ch, zip' = prev zip in if f ch then zip else find_b f zip' end (* +-----------------------------------------------------------------+ | Comparison | +-----------------------------------------------------------------+ *) let rec cmp_loop str1 ofs1 str2 ofs2 rest1 rest2 = if ofs1 = String.length str1 then match rest1 with | [] -> if ofs2 = String.length str2 && rest2 = [] then 0 else -1 | rope1 :: rest1 -> cmp_search1 rope1 str2 ofs2 rest1 rest2 else if ofs2 = String.length str2 then match rest2 with | [] -> 1 | rope2 :: rest2 -> cmp_search2 rope2 str1 ofs1 rest1 rest2 else let chr1, ofs1 = Zed_utf8.unsafe_extract_next str1 ofs1 and chr2, ofs2 = Zed_utf8.unsafe_extract_next str2 ofs2 in let d = UChar.code chr1 - UChar.code chr2 in if d = 0 then cmp_loop str1 ofs1 str2 ofs2 rest1 rest2 else d and cmp_search1 rope1 str2 ofs2 rest1 rest2 = match rope1 with | Leaf(str1, _) -> cmp_loop str1 0 str2 ofs2 rest1 rest2 | Node(_, _, rope1_l, _, rope1_r) -> cmp_search1 rope1_l str2 ofs2 (rope1_r :: rest1) rest2 and cmp_search2 rope2 str1 ofs1 rest1 rest2 = match rope2 with | Leaf(str2, _) -> cmp_loop str1 ofs1 str2 0 rest1 rest2 | Node(_, _, rope2_l, _, rope2_r) -> cmp_search2 rope2_l str1 ofs1 rest1 (rope2_r :: rest2) let rec cmp_init rope1 rope2 rest1 = match rope1 with | Leaf(str1, _) -> cmp_search2 rope2 str1 0 rest1 [] | Node(_, _, rope1_l, _, rope1_r) -> cmp_init rope1_l rope2 (rope1_r :: rest1) let compare r1 r2 = cmp_init r1 r2 [] let equal r1 r2 = length r1 = length r2 && compare r1 r2 = 0 (* +-----------------------------------------------------------------+ | Buffers | +-----------------------------------------------------------------+ *) module String_buffer = Buffer module Buffer = struct type t = { mutable acc : rope; mutable buf : String_buffer.t; mutable idx : int; } let create () = { acc = empty; buf = String_buffer.create 1024; idx = 0; } let add buffer x = if buffer.idx = max_leaf_size then begin buffer.acc <- append buffer.acc (Leaf(String_buffer.contents buffer.buf, max_leaf_size)); String_buffer.reset buffer.buf; String_buffer.add_string buffer.buf (Zed_utf8.singleton x); buffer.idx <- 1 end else begin String_buffer.add_string buffer.buf (Zed_utf8.singleton x); buffer.idx <- buffer.idx + 1 end let contents buffer = if buffer.idx = 0 then buffer.acc else append buffer.acc (Leaf(String_buffer.contents buffer.buf, buffer.idx)) let reset buffer = String_buffer.reset buffer.buf; buffer.acc <- empty; buffer.idx <- 0 end (* +-----------------------------------------------------------------+ | Init | +-----------------------------------------------------------------+ *) let init n f = let buf = Buffer.create () in for i = 0 to n - 1 do Buffer.add buf (f i) done; Buffer.contents buf let rev_init n f = let buf = Buffer.create () in for i = n - 1 downto 0 do Buffer.add buf (f i) done; Buffer.contents buf (* +-----------------------------------------------------------------+ | To/from strings | +-----------------------------------------------------------------+ *) let of_string str = let len = Zed_utf8.validate str in Leaf(str, len) let rec byte_length rope acc = match rope with | Leaf (text, _) -> acc + String.length text | Node (_, _, rope_l, _, rope_r) -> byte_length rope_r (byte_length rope_l acc) let rec blit_rope str ofs rope = match rope with | Leaf (text, _) -> let len = String.length text in String.unsafe_blit text 0 str ofs len; ofs + len | Node (_, _, rope_l, _, rope_r) -> blit_rope str (blit_rope str ofs rope_l) rope_r let to_string rope = let str = Bytes.create (byte_length rope 0) in ignore (blit_rope str 0 rope); str (* +-----------------------------------------------------------------+ | Camomile compatible interface | +-----------------------------------------------------------------+ *) module Text = struct type t = rope let get = get let init = init let length = length type index = Zip.t let look rope zip = fst (Zip.next zip) let nth rope idx = Zip.make_f rope idx let next rope zip = Zip.move 1 zip let prev rope zip = Zip.move (-1) zip let out_of_range rope zip = Zip.at_eos zip let iter = iter let compare = compare let first rope = Zip.make_f rope 0 let last rope = Zip.make_b rope 1 let move rope zip delta = Zip.move delta zip let compare_index rope zip1 zip2 = Zip.offset zip1 - Zip.offset zip2 module Buf = struct type buf = Buffer.t let create n = Buffer.create () let contents = Buffer.contents let clear = Buffer.reset let reset = Buffer.reset let add_char = Buffer.add let add_string buf rope = iter (Buffer.add buf) rope let add_buffer buf buf' = add_string buf (Buffer.contents buf') end end zed-1.4/src/zed_rope.mli000066400000000000000000000203771245345107700152620ustar00rootroot00000000000000(* * zed_rope.mli * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** Unicode ropes *) open CamomileLibrary type t (** Type of unicode ropes. *) type rope = t (** Alias. *) exception Out_of_bounds (** Exception raised when trying to access a character which is outside the bounds of a rope. *) (** {6 Construction} *) val empty : t (** The empty rope. *) val make : int -> UChar.t -> t (** [make length char] creates a rope of length [length] containing only [char]. *) val init : int -> (int -> UChar.t) -> t (** [init n f] returns the contenation of [singleton (f 0)], [singleton (f 1)], ..., [singleton (f (n - 1))]. *) val rev_init : int -> (int -> UChar.t) -> t (** [rev_init n f] returns the contenation of [singleton (f (n - 1))], ..., [singleton (f 1)], [singleton (f 0)]. *) val singleton : UChar.t -> t (** [singleton ch] creates a rope of length 1 containing only [ch]. *) (** {6 Informations} *) val length : t -> int (** Returns the length of the given rope. *) val is_empty : t -> bool (** [is_empty rope] returns whether [str] is the empty rope or not. *) val compare : t -> t -> int (** Compares two ropes (in code point order). *) val equal : t -> t -> bool (** [equal r1 r2] retuns [true] iff [r1] is equal to [r2]. *) (** {6 To/from strings} *) val of_string : string -> t (** [of_string str] creates a rope from a string. The string must be UTF-8 encoded and is validated. Note that [str] must not be modified after this operation, if you intend to do so you must copy it before passing it to [of_string]. *) val to_string : t -> string (** [to_string rope] flatten a rope into a string encoded in UTF-8. *) (** {6 Random access} *) val get : t -> int -> UChar.t (** [get str rope] returns the character at index [idx] in [rope]. *) (** {6 Rope manipulation} *) val append : t -> t -> t (** Concatenates the two given ropes. *) val concat : t -> t list -> t (** [concat sep l] concatenates all strings of [l] separating them by [sep]. *) val sub : t -> int -> int -> t (** [sub rope ofs len] Returns the sub-rope of [rope] starting at [ofs] and of length [len]. *) val break : t -> int -> t * t (** [break rope pos] returns the sub-ropes before and after [pos] in [rope]. It is more efficient than creating two sub-ropes with {!sub}. *) val before : t -> int -> t (** [before rope pos] returns the sub-rope before [pos] in [rope]. *) val after : t -> int -> t (** [after rope pos] returns the sub-string after [pos] in [rope]. *) val insert : t -> int -> t -> t (** [insert rope pos sub] inserts [sub] in [rope] at position [pos]. *) val remove : t -> int -> int -> t (** [remove rope pos len] removes the [len] characters at position [pos] in [rope] *) val replace : t -> int -> int -> t -> t (** [replace rope pos len repl] replaces the [len] characters at position [pos] in [rope] by [repl]. *) val lchop : t -> t (** [lchop rope] returns [rope] without is first character. Returns {!empty} if [rope] is empty. *) val rchop : t -> t (** [rchop rope] returns [rope] without is last character. Returns {!empty} if [rope] is empty. *) (** {6 Iteration, folding and mapping} *) val iter : (UChar.t -> unit) -> t-> unit (** [iter f rope] applies [f] on all characters of [rope] starting from the left. *) val rev_iter : (UChar.t -> unit) -> t -> unit (** [rev_iter f rope] applies [f] an all characters of [rope] starting from the right. *) val fold : (UChar.t -> 'a -> 'a) -> t -> 'a -> 'a (** [fold f rope acc] applies [f] on all characters of [rope] starting from the left, accumulating a value. *) val rev_fold : (UChar.t -> 'a -> 'a) -> t -> 'a -> 'a (** [rev_fold f rope acc] applies [f] on all characters of [rope] starting from the right, accumulating a value. *) val map : (UChar.t -> UChar.t) -> t -> t (** [map f rope] maps all characters of [rope] with [f]. *) val rev_map : (UChar.t -> UChar.t) -> t -> t (** [rev_map f str] maps all characters of [rope] with [f] in reverse order. *) (** {6 Iteration and folding on leafs} *) (** Note: for all of the following functions, the leaves must absolutely not be modified. *) val iter_leaf : (Zed_utf8.t -> unit) -> t -> unit (** [iter_leaf f rope] applies [f] on all leaves of [rope] starting from the left. *) val rev_iter_leaf : (Zed_utf8.t -> unit) -> t -> unit (** [iter_leaf f rope] applies [f] on all leaves of [rope] starting from the right. *) val fold_leaf : (Zed_utf8.t -> 'a -> 'a) -> t -> 'a -> 'a (** [fold f rope acc] applies [f] on all leaves of [rope] starting from the left, accumulating a value. *) val rev_fold_leaf : (Zed_utf8.t -> 'a -> 'a) -> t -> 'a -> 'a (** [rev_fold f rope acc] applies [f] on all leaves of [rope] starting from the right, accumulating a value. *) (** {6 Zippers} *) module Zip : sig type t (** Type of zippers. A zipper allow to naviguate in a rope in a convenient and efficient manner. Note that a zipper points to a position between two characters, not to a character, so in a rope of length [len] there is [len + 1] positions. *) val make_f : rope -> int -> t (** [make_f rope pos] creates a new zipper pointing to positon [pos] of [rope]. *) val make_b : rope -> int -> t (** [make_f rope pos] creates a new zipper pointing to positon [length rope - pos] of [rope]. *) val offset : t -> int (** Returns the position of the zipper in the rope. *) val next : t -> UChar.t * t (** [next zipper] returns the code point at the right of the zipper and a zipper to the next position. It raises [Out_of_bounds] if the zipper points to the end of the rope. *) val prev : t -> UChar.t * t (** [prev zipper] returns the code point at the left of the zipper and a zipper to the previous position. It raises [Out_of_bounds] if the zipper points to the beginning of the rope. *) val move : int -> t -> t (** [move n zip] moves the zipper by [n] characters. If [n] is negative it is moved to the left and if it is positive it is moved to the right. It raises [Out_of_bounds] if the result is outside the bounds of the rope. *) val at_bos : t -> bool (** [at_bos zipper] returns [true] iff [zipper] points to the beginning of the rope. *) val at_eos : t -> bool (** [at_eos zipper] returns [true] iff [zipper] points to the end of the rope. *) val find_f : (UChar.t -> bool) -> t -> t (** [find_f f zip] search forward for a character to satisfy [f]. It returns a zipper pointing to the left of the first character to satisfy [f], or a zipper pointing to the end of the rope if no such character exists. *) val find_b : (UChar.t -> bool) -> t -> t (** [find_b f zip] search backward for a character to satisfy [f]. It returns a zipper pointing to the right of the first character to satisfy [f], or a zipper pointing to the beginning of the rope if no such character exists. *) val sub : t -> int -> rope (** [sub zipper len] returns the sub-rope of length [len] pointed by [zipper]. *) val slice : t -> t -> rope (** [slice zipper1 zipper2] returns the rope between [zipper1] and [zipper2]. If [zipper1 > zipper2] then this is the same as [slice zipper2 zipper1]. The result is unspecified if the two zippers do not points to the same rope. *) end (** {6 Buffers} *) module Buffer : sig (** This module is similar of the [Buffer] module of the standard library except that it works with rope. *) type t (** Type of rope buffers. *) val create : unit -> t (** Create a new empty buffer. *) val add : t -> UChar.t -> unit (** [add buffer x] add [x] at the end of [buffer]. *) val contents : t -> rope (** [contents buffer] returns the contents of [buffer] as a rope. *) val reset : t -> unit (** [reset buffer] resets [buffer] to its initial state. *) end (** {6 Camomile compatible interface} *) module Text : UnicodeString.Type with type t = rope and type index = Zip.t zed-1.4/src/zed_utf8.ml000066400000000000000000000741551245345107700150350ustar00rootroot00000000000000(* * zed_utf8.ml * ----------- * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) open CamomileLibraryDyn.Camomile type t = string exception Invalid of string * string exception Out_of_bounds let fail str pos msg = raise (Invalid(Printf.sprintf "at position %d: %s" pos msg, str)) let byte str i = Char.code (String.unsafe_get str i) let set_byte str i n = Bytes.unsafe_set str i (Char.unsafe_chr n) (* +-----------------------------------------------------------------+ | Validation | +-----------------------------------------------------------------+ *) type check_result = | Correct of int | Message of string let next_error s i = let len = String.length s in let rec main i ulen = if i = len then (i, ulen, "") else let ch = String.unsafe_get s i in match ch with | '\x00' .. '\x7f' -> main (i + 1) (ulen + 1) | '\xc0' .. '\xdf' -> if i + 1 >= len then (i, ulen, "premature end of UTF8 sequence") else begin let byte1 = Char.code (String.unsafe_get s (i + 1)) in if byte1 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if ((Char.code ch land 0x1f) lsl 6) lor (byte1 land 0x3f) < 0x80 then (i, ulen, "overlong UTF8 sequence") else main (i + 2) (ulen + 1) end | '\xe0' .. '\xef' -> if i + 2 >= len then (i, ulen, "premature end of UTF8 sequence") else begin let byte1 = Char.code (String.unsafe_get s (i + 1)) and byte2 = Char.code (String.unsafe_get s (i + 2)) in if byte1 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if byte2 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if ((Char.code ch land 0x0f) lsl 12) lor ((byte1 land 0x3f) lsl 6) lor (byte2 land 0x3f) < 0x800 then (i, ulen, "overlong UTF8 sequence") else main (i + 3) (ulen + 1) end | '\xf0' .. '\xf7' -> if i + 3 >= len then (i, ulen, "premature end of UTF8 sequence") else begin let byte1 = Char.code (String.unsafe_get s (i + 1)) and byte2 = Char.code (String.unsafe_get s (i + 2)) and byte3 = Char.code (String.unsafe_get s (i + 3)) in if byte1 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if byte2 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if byte3 land 0xc0 != 0x80 then (i, ulen, "malformed UTF8 sequence") else if ((Char.code ch land 0x07) lsl 18) lor ((byte1 land 0x3f) lsl 12) lor ((byte2 land 0x3f) lsl 6) lor (byte3 land 0x3f) < 0x10000 then (i, ulen, "overlong UTF8 sequence") else main (i + 4) (ulen + 1) end | _ -> (i, ulen, "invalid start of UTF8 sequence") in main i 0 let check str = let ofs, len, msg = next_error str 0 in if ofs = String.length str then Correct len else Message (Printf.sprintf "at position %d: %s" ofs msg) let validate str = let ofs, len, msg = next_error str 0 in if ofs = String.length str then len else fail str ofs msg (* +-----------------------------------------------------------------+ | Unsafe UTF-8 manipulation | +-----------------------------------------------------------------+ *) let unsafe_next str ofs = match String.unsafe_get str ofs with | '\x00' .. '\x7f' -> ofs + 1 | '\xc0' .. '\xdf' -> if ofs + 2 > String.length str then fail str ofs "unterminated UTF-8 sequence" else ofs + 2 | '\xe0' .. '\xef' -> if ofs + 3 > String.length str then fail str ofs "unterminated UTF-8 sequence" else ofs + 3 | '\xf0' .. '\xf7' -> if ofs + 4 > String.length str then fail str ofs "unterminated UTF-8 sequence" else ofs + 4 | _ -> fail str ofs "invalid start of UTF-8 sequence" let unsafe_prev str ofs = match String.unsafe_get str (ofs - 1) with | '\x00' .. '\x7f' -> ofs - 1 | '\x80' .. '\xbf' -> if ofs >= 2 then match String.unsafe_get str (ofs - 2) with | '\xc0' .. '\xdf' -> ofs - 2 | '\x80' .. '\xbf' -> if ofs >= 3 then match String.unsafe_get str (ofs - 3) with | '\xe0' .. '\xef' -> ofs - 3 | '\x80' .. '\xbf' -> if ofs >= 4 then match String.unsafe_get str (ofs - 4) with | '\xf0' .. '\xf7' -> ofs - 4 | _ -> fail str (ofs - 4) "invalid start of UTF-8 sequence" else fail str (ofs - 3) "invalid start of UTF-8 string" | _ -> fail str (ofs - 3) "invalid middle of UTF-8 sequence" else fail str (ofs - 2) "invaild start of UTF-8 string" | _ -> fail str (ofs - 2) "invalid middle of UTF-8 sequence" else fail str (ofs - 1) "invalid start of UTF-8 string" | _ -> fail str (ofs - 1) "invalid end of UTF-8 sequence" let unsafe_extract str ofs = let ch = String.unsafe_get str ofs in match ch with | '\x00' .. '\x7f' -> UChar.of_char ch | '\xc0' .. '\xdf' -> if ofs + 2 > String.length str then fail str ofs "unterminated UTF-8 sequence" else UChar.of_int (((Char.code ch land 0x1f) lsl 6) lor (byte str (ofs + 1) land 0x3f)) | '\xe0' .. '\xef' -> if ofs + 3 > String.length str then fail str ofs "unterminated UTF-8 sequence" else UChar.of_int (((Char.code ch land 0x0f) lsl 12) lor ((byte str (ofs + 1) land 0x3f) lsl 6) lor (byte str (ofs + 2) land 0x3f)) | '\xf0' .. '\xf7' -> if ofs + 4 > String.length str then fail str ofs "unterminated UTF-8 sequence" else UChar.of_int (((Char.code ch land 0x07) lsl 18) lor ((byte str (ofs + 1) land 0x3f) lsl 12) lor ((byte str (ofs + 2) land 0x3f) lsl 6) lor (byte str (ofs + 3) land 0x3f)) | _ -> fail str ofs "invalid start of UTF-8 sequence" let unsafe_extract_next str ofs = let ch = String.unsafe_get str ofs in match ch with | '\x00' .. '\x7f' -> (UChar.of_char ch, ofs + 1) | '\xc0' .. '\xdf' -> if ofs + 2 > String.length str then fail str ofs "unterminated UTF-8 sequence" else (UChar.of_int (((Char.code ch land 0x1f) lsl 6) lor (byte str (ofs + 1) land 0x3f)), ofs + 2) | '\xe0' .. '\xef' -> if ofs + 3 > String.length str then fail str ofs "unterminated UTF-8 sequence" else (UChar.of_int (((Char.code ch land 0x0f) lsl 12) lor ((byte str (ofs + 1) land 0x3f) lsl 6) lor (byte str (ofs + 2) land 0x3f)), ofs + 3) | '\xf0' .. '\xf7' -> if ofs + 4 > String.length str then fail str ofs "unterminated UTF-8 sequence" else (UChar.of_int (((Char.code ch land 0x07) lsl 18) lor ((byte str (ofs + 1) land 0x3f) lsl 12) lor ((byte str (ofs + 2) land 0x3f) lsl 6) lor (byte str (ofs + 3) land 0x3f)), ofs + 4) | _ -> fail str ofs "invalid start of UTF-8 sequence" let unsafe_extract_prev str ofs = let ch1 = String.unsafe_get str (ofs - 1) in match ch1 with | '\x00' .. '\x7f' -> (UChar.of_char ch1, ofs - 1) | '\x80' .. '\xbf' -> if ofs >= 2 then let ch2 = String.unsafe_get str (ofs - 2) in match ch2 with | '\xc0' .. '\xdf' -> (UChar.of_int (((Char.code ch2 land 0x1f) lsl 6) lor (Char.code ch1 land 0x3f)), ofs - 2) | '\x80' .. '\xbf' -> if ofs >= 3 then let ch3 = String.unsafe_get str (ofs - 3) in match ch3 with | '\xe0' .. '\xef' -> (UChar.of_int (((Char.code ch3 land 0x0f) lsl 12) lor ((Char.code ch2 land 0x3f) lsl 6) lor (Char.code ch1 land 0x3f)), ofs - 3) | '\x80' .. '\xbf' -> if ofs >= 4 then let ch4 = String.unsafe_get str (ofs - 4) in match ch4 with | '\xf0' .. '\xf7' -> (UChar.of_int (((Char.code ch4 land 0x07) lsl 18) lor ((Char.code ch3 land 0x3f) lsl 12) lor ((Char.code ch2 land 0x3f) lsl 6) lor (Char.code ch1 land 0x3f)), ofs + 4) | _ -> fail str (ofs - 4) "invalid start of UTF-8 sequence" else fail str (ofs - 3) "invalid start of UTF-8 string" | _ -> fail str (ofs - 3) "invalid middle of UTF-8 sequence" else fail str (ofs - 2) "invaild start of UTF-8 string" | _ -> fail str (ofs - 2) "invalid middle of UTF-8 sequence" else fail str (ofs - 1) "invalid start of UTF-8 string" | _ -> fail str (ofs - 1) "invalid end of UTF-8 sequence" let rec move_l str ofs len = if len = 0 then ofs else if ofs = String.length str then raise Out_of_bounds else move_l str (unsafe_next str ofs) (len - 1) let rec move_r str ofs len = if len = 0 then ofs else if ofs = 0 then raise Out_of_bounds else move_r str (unsafe_prev str ofs) (len - 1) let unsafe_sub str ofs len = let res = Bytes.create len in String.unsafe_blit str ofs res 0 len; res (* +-----------------------------------------------------------------+ | Construction | +-----------------------------------------------------------------+ *) let singleton char = let code = UChar.code char in if code < 0x80 then begin let s = Bytes.create 1 in set_byte s 0 code; s end else if code <= 0x800 then begin let s = Bytes.create 2 in set_byte s 0 ((code lsr 6) lor 0xc0); set_byte s 1 ((code land 0x3f) lor 0x80); s end else if code <= 0x10000 then begin let s = Bytes.create 3 in set_byte s 0 ((code lsr 12) lor 0xe0); set_byte s 1 (((code lsr 6) land 0x3f) lor 0x80); set_byte s 2 ((code land 0x3f) lor 0x80); s end else if code <= 0x10ffff then begin let s = Bytes.create 4 in set_byte s 0 ((code lsr 18) lor 0xf0); set_byte s 1 (((code lsr 12) land 0x3f) lor 0x80); set_byte s 2 (((code lsr 6) land 0x3f) lor 0x80); set_byte s 3 ((code land 0x3f) lor 0x80); s end else (* Camomile allow characters with code-point greater than 0x10ffff *) invalid_arg "Zed_utf8.singleton" let make n code = let str = singleton code in let len = String.length str in let res = Bytes.create (n * len) in let ofs = ref 0 in for i = 1 to n do String.unsafe_blit str 0 res !ofs len; ofs := !ofs + len done; res let init n f = let buf = Buffer.create n in for i = 0 to n - 1 do Buffer.add_string buf (singleton (f i)) done; Buffer.contents buf let rev_init n f = let buf = Buffer.create n in for i = n - 1 downto 0 do Buffer.add_string buf (singleton (f i)) done; Buffer.contents buf (* +-----------------------------------------------------------------+ | Informations | +-----------------------------------------------------------------+ *) let rec length_rec str ofs len = if ofs = String.length str then len else length_rec str (unsafe_next str ofs) (len + 1) let length str = length_rec str 0 0 (* +-----------------------------------------------------------------+ | Comparison | +-----------------------------------------------------------------+ *) let rec compare_rec str1 ofs1 str2 ofs2 = if ofs1 = String.length str1 then if ofs2 = String.length str2 then 0 else -1 else if ofs2 = String.length str2 then 1 else let code1, ofs1 = unsafe_extract_next str1 ofs1 and code2, ofs2 = unsafe_extract_next str2 ofs2 in let d = UChar.code code1 - UChar.code code2 in if d <> 0 then d else compare_rec str1 ofs1 str2 ofs2 let compare str1 str2 = compare_rec str1 0 str2 0 (* +-----------------------------------------------------------------+ | Random access | +-----------------------------------------------------------------+ *) let get str idx = if idx < 0 then raise Out_of_bounds else unsafe_extract str (move_l str 0 idx) (* +-----------------------------------------------------------------+ | Manipulation | +-----------------------------------------------------------------+ *) let sub str idx len = if idx < 0 || len < 0 then raise Out_of_bounds else let ofs1 = move_l str 0 idx in let ofs2 = move_l str ofs1 len in unsafe_sub str ofs1 (ofs2 - ofs1) let break str idx = if idx < 0 then raise Out_of_bounds else let ofs = move_l str 0 idx in (unsafe_sub str 0 ofs, unsafe_sub str ofs (String.length str - ofs)) let before str idx = if idx < 0 then raise Out_of_bounds else let ofs = move_l str 0 idx in unsafe_sub str 0 ofs let after str idx = if idx < 0 then raise Out_of_bounds else let ofs = move_l str 0 idx in unsafe_sub str ofs (String.length str - ofs) let concat3 a b c = let lena = String.length a and lenb = String.length b and lenc = String.length c in let res = Bytes.create (lena + lenb + lenc) in String.unsafe_blit a 0 res 0 lena; String.unsafe_blit b 0 res lena lenb; String.unsafe_blit c 0 res (lena + lenb) lenc; res let insert str idx sub = let a, b = break str idx in concat3 a sub b let remove str idx len = if idx < 0 || len < 0 then raise Out_of_bounds else let ofs1 = move_l str 0 idx in let ofs2 = move_l str ofs1 len in unsafe_sub str 0 ofs1 ^ unsafe_sub str ofs2 (String.length str - ofs2) let replace str idx len repl = if idx < 0 || len < 0 then raise Out_of_bounds else let ofs1 = move_l str 0 idx in let ofs2 = move_l str ofs1 len in concat3 (unsafe_sub str 0 ofs1) repl (unsafe_sub str ofs2 (String.length str - ofs2)) (* +-----------------------------------------------------------------+ | Exploding and imploding | +-----------------------------------------------------------------+ *) let rec rev_rec res str ofs_src ofs_dst = if ofs_src = String.length str then res else begin let ofs_src' = unsafe_next str ofs_src in let len = ofs_src' - ofs_src in let ofs_dst = ofs_dst - len in String.unsafe_blit str ofs_src res ofs_dst len; rev_rec res str ofs_src' ofs_dst end let rev str = let len = String.length str in rev_rec (Bytes.create len) str 0 len let concat sep l = match l with | [] -> "" | x :: l -> let sep_len = String.length sep in let len = List.fold_left (fun len str -> len + sep_len + String.length str) (String.length x) l in let res = Bytes.create len in String.unsafe_blit x 0 res 0 (String.length x); ignore (List.fold_left (fun ofs str -> String.unsafe_blit sep 0 res ofs sep_len; let ofs = ofs + sep_len in let len = String.length str in String.unsafe_blit str 0 res ofs len; ofs + len) (String.length x) l); res let rev_concat sep l = match l with | [] -> "" | x :: l -> let sep_len = String.length sep in let len = List.fold_left (fun len str -> len + sep_len + String.length str) (String.length x) l in let res = Bytes.create len in let ofs = len - String.length x in String.unsafe_blit x 0 res ofs (String.length x); ignore (List.fold_left (fun ofs str -> let ofs = ofs - sep_len in String.unsafe_blit sep 0 res ofs sep_len; let len = String.length str in let ofs = ofs - len in String.unsafe_blit str 0 res ofs len; ofs) ofs l); res let rec explode_rec str ofs acc = if ofs = 0 then acc else let x, ofs = unsafe_extract_prev str ofs in explode_rec str ofs (x :: acc) let explode str = explode_rec str (String.length str) [] let rec rev_explode_rec str ofs acc = if ofs = String.length str then acc else let x, ofs = unsafe_extract_next str ofs in rev_explode_rec str ofs (x :: acc) let rev_explode str = rev_explode_rec str 0 [] let implode l = let l = List.map singleton l in let len = List.fold_left (fun len str -> len + String.length str) 0 l in let res = Bytes.create len in ignore (List.fold_left (fun ofs str -> let len = String.length str in String.unsafe_blit str 0 res ofs len; ofs + len) 0 l); res let rev_implode l = let l = List.map singleton l in let len = List.fold_left (fun len str -> len + String.length str) 0 l in let res = Bytes.create len in ignore (List.fold_left (fun ofs str -> let len = String.length str in let ofs = ofs - len in String.unsafe_blit str 0 res ofs len; ofs) len l); res (* +-----------------------------------------------------------------+ | Text transversal | +-----------------------------------------------------------------+ *) let rec iter_rec f str ofs = if ofs = String.length str then () else begin let chr, ofs = unsafe_extract_next str ofs in f chr; iter_rec f str ofs end let iter f str = iter_rec f str 0 let rec rev_iter_rec f str ofs = if ofs = 0 then () else begin let chr, ofs = unsafe_extract_prev str ofs in f chr; rev_iter_rec f str ofs end let rev_iter f str = rev_iter_rec f str (String.length str) let rec fold_rec f str ofs acc = if ofs = String.length str then acc else begin let chr, ofs = unsafe_extract_next str ofs in fold_rec f str ofs (f chr acc) end let fold f str acc = fold_rec f str 0 acc let rec rev_fold_rec f str ofs acc = if ofs = 0 then acc else begin let chr, ofs = unsafe_extract_prev str ofs in rev_fold_rec f str ofs (f chr acc) end let rev_fold f str acc = rev_fold_rec f str (String.length str) acc let rec map_rec buf f str ofs = if ofs = String.length str then Buffer.contents buf else begin let chr, ofs = unsafe_extract_next str ofs in Buffer.add_string buf (singleton (f chr)); map_rec buf f str ofs end let map f str = map_rec (Buffer.create (String.length str)) f str 0 let rec map_concat_rec buf f str ofs = if ofs = String.length str then Buffer.contents buf else begin let chr, ofs = unsafe_extract_next str ofs in Buffer.add_string buf (f chr); map_concat_rec buf f str ofs end let map_concat f str = map_concat_rec (Buffer.create (String.length str)) f str 0 let rec rev_map_rec buf f str ofs = if ofs = 0 then Buffer.contents buf else begin let chr, ofs = unsafe_extract_prev str ofs in Buffer.add_string buf (singleton (f chr)); rev_map_rec buf f str ofs end let rev_map f str = rev_map_rec (Buffer.create (String.length str)) f str (String.length str) let rec rev_map_concat_rec buf f str ofs = if ofs = 0 then Buffer.contents buf else begin let chr, ofs = unsafe_extract_prev str ofs in Buffer.add_string buf (f chr); rev_map_concat_rec buf f str ofs end let rev_map_concat f str = rev_map_concat_rec (Buffer.create (String.length str)) f str (String.length str) let rec filter_rec buf f str ofs = if ofs = String.length str then Buffer.contents buf else begin let chr, ofs = unsafe_extract_next str ofs in if f chr then Buffer.add_string buf (singleton chr); filter_rec buf f str ofs end let filter f str = filter_rec (Buffer.create (String.length str)) f str 0 let rec rev_filter_rec buf f str ofs = if ofs = 0 then Buffer.contents buf else begin let chr, ofs = unsafe_extract_prev str ofs in if f chr then Buffer.add_string buf (singleton chr); rev_filter_rec buf f str ofs end let rev_filter f str = rev_filter_rec (Buffer.create (String.length str)) f str (String.length str) let rec filter_map_rec buf f str ofs = if ofs = String.length str then Buffer.contents buf else begin let chr, ofs = unsafe_extract_next str ofs in (match f chr with | Some chr -> Buffer.add_string buf (singleton chr) | None -> ()); filter_map_rec buf f str ofs end let filter_map f str = filter_map_rec (Buffer.create (String.length str)) f str 0 let rec filter_map_concat_rec buf f str ofs = if ofs = String.length str then Buffer.contents buf else begin let chr, ofs = unsafe_extract_next str ofs in (match f chr with | Some txt -> Buffer.add_string buf txt | None -> ()); filter_map_concat_rec buf f str ofs end let filter_map_concat f str = filter_map_concat_rec (Buffer.create (String.length str)) f str 0 let rec rev_filter_map_rec buf f str ofs = if ofs = 0 then Buffer.contents buf else begin let chr, ofs = unsafe_extract_prev str ofs in (match f chr with | Some chr -> Buffer.add_string buf (singleton chr) | None -> ()); rev_filter_map_rec buf f str ofs end let rev_filter_map f str = rev_filter_map_rec (Buffer.create (String.length str)) f str (String.length str) let rec rev_filter_map_concat_rec buf f str ofs = if ofs = 0 then Buffer.contents buf else begin let chr, ofs = unsafe_extract_prev str ofs in (match f chr with | Some txt -> Buffer.add_string buf txt | None -> ()); rev_filter_map_concat_rec buf f str ofs end let rev_filter_map_concat f str = rev_filter_map_concat_rec (Buffer.create (String.length str)) f str (String.length str) (* +-----------------------------------------------------------------+ | Scanning | +-----------------------------------------------------------------+ *) let rec for_all_rec f str ofs = if ofs = String.length str then true else let chr, ofs = unsafe_extract_next str ofs in f chr && for_all_rec f str ofs let for_all f str = for_all_rec f str 0 let rec exists_rec f str ofs = if ofs = String.length str then false else let chr, ofs = unsafe_extract_next str ofs in f chr || exists_rec f str ofs let exists f str = exists_rec f str 0 let rec count_rec f str ofs n = if ofs = String.length str then n else let chr, ofs = unsafe_extract_next str ofs in count_rec f str ofs (if f chr then n + 1 else n) let count f str = count_rec f str 0 0 (* +-----------------------------------------------------------------+ | Tests | +-----------------------------------------------------------------+ *) let rec unsafe_sub_equal str ofs sub ofs_sub = if ofs_sub = String.length sub then true else (String.unsafe_get str ofs = String.unsafe_get sub ofs_sub) && unsafe_sub_equal str (ofs + 1) sub (ofs_sub + 1) let rec contains_rec str sub ofs = if ofs + String.length sub > String.length str then false else unsafe_sub_equal str ofs sub 0 || contains_rec str sub (unsafe_next str ofs) let contains str sub = contains_rec str sub 0 let starts_with str prefix = if String.length prefix > String.length str then false else unsafe_sub_equal str 0 prefix 0 let ends_with str suffix = let ofs = String.length str - String.length suffix in if ofs < 0 then false else unsafe_sub_equal str ofs suffix 0 (* +-----------------------------------------------------------------+ | Stripping | +-----------------------------------------------------------------+ *) let rec lfind predicate str ofs = if ofs = String.length str then ofs else let chr, ofs' = unsafe_extract_next str ofs in if predicate chr then lfind predicate str ofs' else ofs let rec rfind predicate str ofs = if ofs = 0 then 0 else let chr, ofs' = unsafe_extract_prev str ofs in if predicate chr then rfind predicate str ofs' else ofs let spaces = UCharInfo.load_property_tbl `White_Space let is_space ch = UCharTbl.Bool.get spaces ch let strip ?(predicate=is_space) str = let lofs = lfind predicate str 0 and rofs = rfind predicate str (String.length str) in if lofs < rofs then unsafe_sub str lofs (rofs - lofs) else "" let lstrip ?(predicate=is_space) str = let lofs = lfind predicate str 0 in unsafe_sub str lofs (String.length str - lofs) let rstrip ?(predicate=is_space) str = let rofs = rfind predicate str (String.length str) in unsafe_sub str 0 rofs let lchop = function | "" -> "" | str -> let ofs = unsafe_next str 0 in unsafe_sub str ofs (String.length str - ofs) let rchop = function | "" -> "" | str -> let ofs = unsafe_prev str (String.length str) in unsafe_sub str 0 ofs (* +-----------------------------------------------------------------+ | Buffers | +-----------------------------------------------------------------+ *) let add buf char = let code = UChar.code char in if code < 0x80 then Buffer.add_char buf (Char.unsafe_chr code) else if code <= 0x800 then begin Buffer.add_char buf (Char.unsafe_chr ((code lsr 6) lor 0xc0)); Buffer.add_char buf (Char.unsafe_chr ((code land 0x3f) lor 0x80)) end else if code <= 0x10000 then begin Buffer.add_char buf (Char.unsafe_chr ((code lsr 12) lor 0xe0)); Buffer.add_char buf (Char.unsafe_chr (((code lsr 6) land 0x3f) lor 0x80)); Buffer.add_char buf (Char.unsafe_chr ((code land 0x3f) lor 0x80)) end else if code <= 0x10ffff then begin Buffer.add_char buf (Char.unsafe_chr ((code lsr 18) lor 0xf0)); Buffer.add_char buf (Char.unsafe_chr (((code lsr 12) land 0x3f) lor 0x80)); Buffer.add_char buf (Char.unsafe_chr (((code lsr 6) land 0x3f) lor 0x80)); Buffer.add_char buf (Char.unsafe_chr ((code land 0x3f) lor 0x80)) end else invalid_arg "Zed_utf8.add" (* +-----------------------------------------------------------------+ | Offset API | +-----------------------------------------------------------------+ *) let extract str ofs = if ofs < 0 || ofs >= String.length str then raise Out_of_bounds else unsafe_extract str ofs let next str ofs = if ofs < 0 || ofs >= String.length str then raise Out_of_bounds else unsafe_next str ofs let extract_next str ofs = if ofs < 0 || ofs >= String.length str then raise Out_of_bounds else unsafe_extract_next str ofs let prev str ofs = if ofs <= 0 || ofs > String.length str then raise Out_of_bounds else unsafe_prev str ofs let extract_prev str ofs = if ofs <= 0 || ofs > String.length str then raise Out_of_bounds else unsafe_extract_prev str ofs (* +-----------------------------------------------------------------+ | Escaping | +-----------------------------------------------------------------+ *) let alphabetic = UCharInfo.load_property_tbl `Alphabetic let escaped_char ch = match UChar.code ch with | 7 -> "\\a" | 8 -> "\\b" | 9 -> "\\t" | 10 -> "\\n" | 11 -> "\\v" | 12 -> "\\f" | 13 -> "\\r" | 27 -> "\\e" | 92 -> "\\\\" | code when code >= 32 && code <= 126 -> String.make 1 (Char.chr code) | _ when UCharTbl.Bool.get alphabetic ch -> singleton ch | code when code <= 127 -> Printf.sprintf "\\x%02x" code | code when code <= 0xffff -> Printf.sprintf "\\u%04x" code | code -> Printf.sprintf "\\U%06x" code let add_escaped_char buf ch = match UChar.code ch with | 7 -> Buffer.add_string buf "\\a" | 8 -> Buffer.add_string buf "\\b" | 9 -> Buffer.add_string buf "\\t" | 10 -> Buffer.add_string buf "\\n" | 11 -> Buffer.add_string buf "\\v" | 12 -> Buffer.add_string buf "\\f" | 13 -> Buffer.add_string buf "\\r" | 27 -> Buffer.add_string buf "\\e" | 92 -> Buffer.add_string buf "\\\\" | code when code >= 32 && code <= 126 -> Buffer.add_char buf (Char.chr code) | _ when UCharTbl.Bool.get alphabetic ch -> add buf ch | code when code <= 127 -> Printf.bprintf buf "\\x%02x" code | code when code <= 0xffff -> Printf.bprintf buf "\\u%04x" code | code -> Printf.bprintf buf "\\U%06x" code let escaped str = let buf = Buffer.create (String.length str) in iter (add_escaped_char buf) str; Buffer.contents buf let add_escaped buf str = iter (add_escaped_char buf) str let add_escaped_string buf enc str = match try Some (CharEncoding.recode_string enc CharEncoding.utf8 str) with CharEncoding.Malformed_code -> None with | Some str -> add_escaped buf str | None -> String.iter (function | '\x20' .. '\x7e' as ch -> Buffer.add_char buf ch | ch -> Printf.bprintf buf "\\y%02x" (Char.code ch)) str let escaped_string enc str = let buf = Buffer.create (String.length str) in add_escaped_string buf enc str; Buffer.contents buf zed-1.4/src/zed_utf8.mli000066400000000000000000000261111245345107700151730ustar00rootroot00000000000000(* * zed_utf8.mli * ------------ * Copyright : (c) 2011, Jeremie Dimino * Licence : BSD3 * * This file is a part of Zed, an editor engine. *) (** UTF-8 enoded strings *) open CamomileLibrary type t = string (** Type of UTF-8 encoded strings. *) exception Invalid of string * string (** [Invalid(error, text)] Exception raised when an invalid UTF-8 encoded string is encountered. [text] is the faulty text and [error] is a description of the first error in [text]. *) exception Out_of_bounds (** Exception raised when trying to access a character which is outside the bounds of a string. *) (** {6 Validation} *) (** Result of cheking a string for correct UTF-8. *) type check_result = | Correct of int (** The string is correctly UTF-8 encoded, and the paramter is the length of the string. *) | Message of string (** The string is invalid and the parameter is an error message. *) val check : t -> check_result (** [check str] checks that [str] is a valid UTF-8 encoded string. *) val validate : t -> int (** Same as check but raises an exception in case the argument is not a valid text, otherwise returns the length of the string. *) val next_error : t -> int -> int * int * string (** [next_error str ofs] returns [(ofs', count, msg)] where [ofs'] is the offset of the start of the first invalid sequence after [ofs] (inclusive) in [str], [count] is the number of unicode character between [ofs] and [ofs'] (exclusive) and [msg] is an error message. If there is no error until the end of string then [ofs] is [String.length str] and [msg] is the empty string. *) (** {6 Construction} *) val singleton : UChar.t -> t (** [singleton ch] creates a string of length 1 containing only the given character. *) val make : int -> UChar.t -> t (** [make n ch] creates a string of length [n] filled with [ch]. *) val init : int -> (int -> UChar.t) -> t (** [init n f] returns the contenation of [singleton (f 0)], [singleton (f 1)], ..., [singleton (f (n - 1))]. *) val rev_init : int -> (int -> UChar.t) -> t (** [rev_init n f] returns the contenation of [singleton (f (n - 1))], ..., [singleton (f 1)], [singleton (f 0)]. *) (** {6 Informations} *) val length : t -> int (** Returns the length of the given string. *) (** {6 Comparison} *) val compare : t -> t -> int (** Compares two strings (in code point order). *) (** {6 Random access} *) val get : t -> int -> UChar.t (** [get str idx] returns the character at index [idx] in [str]. *) (** {6 String manipulation} *) val sub : t -> int -> int -> t (** [sub str ofs len] Returns the sub-string of [str] starting at [ofs] and of length [len]. *) val break : t -> int -> t * t (** [break str pos] returns the sub-strings before and after [pos] in [str]. It is more efficient than creating two sub-strings with {!sub}. *) val before : t -> int -> t (** [before str pos] returns the sub-string before [pos] in [str] *) val after : t -> int -> t (** [after str pos] returns the sub-string after [pos] in [str] *) val insert : t -> int -> t -> t (** [insert str pos sub] inserts [sub] in [str] at position [pos]. *) val remove : t -> int -> int -> t (** [remove str pos len] removes the [len] characters at position [pos] in [str] *) val replace : t -> int -> int -> t -> t (** [replace str pos len repl] replaces the [len] characters at position [pos] in [str] by [repl]. *) (** {6 Tranformation} *) val rev : t -> t (** [rev str] reverses all characters of [str]. *) val concat : t -> t list -> t (** [concat sep l] returns the concatenation of all strings of [l] separated by [sep]. *) val rev_concat : t -> t list -> t (** [concat sep l] returns the concatenation of all strings of [l] in reverse order separated by [sep]. *) val explode : t -> UChar.t list (** [explode str] returns the list of all characters of [str]. *) val rev_explode : t -> UChar.t list (** [rev_explode str] returns the list of all characters of [str] in reverse order. *) val implode : UChar.t list -> t (** [implode l] returns the concatenation of all characters of [l]. *) val rev_implode : UChar.t list -> t (** [rev_implode l] is the same as [implode (List.rev l)] but more efficient. *) (** {6 Text traversals} *) val iter : (UChar.t -> unit) -> t -> unit (** [iter f str] applies [f] an all characters of [str] starting from the left. *) val rev_iter : (UChar.t -> unit) -> t -> unit (** [rev_iter f str] applies [f] an all characters of [str] starting from the right. *) val fold : (UChar.t -> 'a -> 'a) -> t -> 'a -> 'a (** [fold f str acc] applies [f] on all characters of [str] starting from the left, accumulating a value. *) val rev_fold : (UChar.t -> 'a -> 'a) -> t -> 'a -> 'a (** [rev_fold f str acc] applies [f] on all characters of [str] starting from the right, accumulating a value. *) val map : (UChar.t -> UChar.t) -> t -> t (** [map f str] maps all characters of [str] with [f]. *) val rev_map : (UChar.t -> UChar.t) -> t -> t (** [rev_map f str] maps all characters of [str] with [f] in reverse order. *) val map_concat : (UChar.t -> t) -> t -> t (** [map f str] maps all characters of [str] with [f] and concatenate the result. *) val rev_map_concat : (UChar.t -> t) -> t -> t (** [rev_map f str] maps all characters of [str] with [f] in reverse order and concatenate the result. *) val filter : (UChar.t -> bool) -> t -> t (** [filter f str] filters characters of [str] with [f]. *) val rev_filter : (UChar.t -> bool) -> t -> t (** [rev_filter f str] filters characters of [str] with [f] in reverse order. *) val filter_map : (UChar.t -> UChar.t option) -> t -> t (** [filter_map f str] filters and maps characters of [str] with [f]. *) val rev_filter_map : (UChar.t -> UChar.t option) -> t -> t (** [rev_filter_map f str] filters and maps characters of [str] with [f] in reverse order. *) val filter_map_concat : (UChar.t -> t option) -> t -> t (** [filter_map f str] filters and maps characters of [str] with [f] and concatenate the result. *) val rev_filter_map_concat : (UChar.t -> t option) -> t -> t (** [rev_filter_map f str] filters and maps characters of [str] with [f] in reverse order and concatenate the result. *) (** {6 Scanning} *) val for_all : (UChar.t -> bool) -> t -> bool (** [for_all f text] returns whether all characters of [text] verify the predicate [f]. *) val exists : (UChar.t -> bool) -> t -> bool (** [exists f text] returns whether at least one character of [text] verify [f]. *) val count : (UChar.t -> bool) -> t -> int (** [count f text] returhs the number of characters of [text] verifying [f]. *) (** {6 Tests} *) val contains : t -> t -> bool (** [contains text sub] returns whether [sub] appears in [text] *) val starts_with : t -> t -> bool (** [starts_with text prefix] returns [true] iff [s] starts with [prefix]. *) val ends_with : t -> t -> bool (** [ends_with text suffix] returns [true] iff [s] ends with [suffix]. *) (** {6 Stripping} *) val strip : ?predicate : (UChar.t -> bool) -> t -> t (** [strip ?predicate text] returns [text] without its firsts and lasts characters that match [predicate]. [predicate] default to testing whether the given character has the [`White_Space] unicode property. For example: {[ strip "\n foo\n " = "foo" ]} *) val lstrip : ?predicate : (UChar.t -> bool) -> t -> t (** [lstrip ?predicate text] is the same as {!strip} but it only removes characters at the left of [text]. *) val rstrip : ?predicate : (UChar.t -> bool) -> t -> t (** [lstrip ?predicate text] is the same as {!strip} but it only removes characters at the right of [text]. *) val lchop : t -> t (** [lchop t] returns [t] without is first character. Returns [""] if [t = ""] *) val rchop : t -> t (** [rchop t] returns [t] without is last character. Returns [""] if [t = ""]. *) (** {6 Buffers} *) val add : Buffer.t -> UChar.t -> unit (** [add buf ch] is the same as [Buffer.add_string buf (singleton ch)] but is more efficient. *) (** {6 Escaping} *) val escaped_char : UChar.t -> t (** [escaped_char ch] returns a string containg [ch] or an escaped version of [ch] if: - [ch] is a control character (code < 32) - [ch] is the character with code 127 - [ch] is a non-ascii, non-alphabetic character It uses the syntax [\xXX], [\uXXXX], [\UXXXXXX] or a specific escape sequence [\n, \r, ...]. *) val add_escaped_char : Buffer.t -> UChar.t -> unit (** [add_escaped_char buf ch] is the same as [Buffer.add_string buf (escaped_char ch)] but a bit more efficient. *) val escaped : t -> t (** [escaped text] escape all characters of [text] as with [escape_char]. *) val add_escaped : Buffer.t -> t -> unit (** [add_escaped_char buf text] is the same as [Buffer.add_string buf (escaped text)] but a bit more efficient. *) val escaped_string : CamomileLibraryDyn.Camomile.CharEncoding.t -> string -> t (** [escaped_string enc str] escape the string [str] which is encoded with encoding [enc]. If decoding [str] with [enc] fails, it escape all non-printable bytes of [str] with the syntax [\yAB]. *) val add_escaped_string : Buffer.t -> CamomileLibraryDyn.Camomile.CharEncoding.t -> string -> unit (** [add_escaped_char buf enc text] is the same as [Buffer.add_string buf (escaped_string enc text)] but a bit more efficient. *) (** {6 Safe offset API} *) val next : t -> int -> int (** [next str ofs] returns the offset of the next character in [str]. *) val prev : t -> int -> int (** [prev str ofs] returns the offset of the previous character in [str]. *) val extract : t -> int -> UChar.t (** [extract str ofs] returns the code-point at offset [ofs] in [str]. *) val extract_next : t -> int -> UChar.t * int (** [extract_next str ofs] returns the code-point at offset [ofs] in [str] and the offset the next character. *) val extract_prev : t -> int -> UChar.t * int (** [extract_prev str ofs] returns the code-point at the previous offset in [str] and this offset. *) (** {6 Unsafe offset API} *) (** These functions does not check that the given offset is inside the bounds of the given string. *) val unsafe_next : t -> int -> int (** [unsafe_next str ofs] returns the offset of the next character in [str]. *) val unsafe_prev : t -> int -> int (** [unsafe_prev str ofs] returns the offset of the previous character in [str]. *) val unsafe_extract : t -> int -> UChar.t (** [unsafe_extract str ofs] returns the code-point at offset [ofs] in [str]. *) val unsafe_extract_next : t -> int -> UChar.t * int (** [unsafe_extract_next str ofs] returns the code-point at offset [ofs] in [str] and the offset the next character. *) val unsafe_extract_prev : t -> int -> UChar.t * int (** [unsafe_extract_prev str ofs] returns the code-point at the previous offset in [str] and this offset. *) zed-1.4/style.css000066400000000000000000000050361245345107700140260ustar00rootroot00000000000000/* A style for ocamldoc. Daniel C. Buenzli, Jérémie Dimino */ body { padding: 0em; border: 0em; margin: 2em 10% 2em 10%; font-weight: normal; line-height: 130%; text-align: justify; background: white; color : black; min-width: 40ex; } pre, p, div, span, img, table, td, ol, ul, li { padding: 0em; border: 0em; margin: 0em } h1, h2, h3, h4, h5, h6, div.h7, div.h8, div.h9 { fontsize: 100%; margin-bottom: 1em padding: 1ex 0em 0em 0em; border: 0em; margin: 1em 0em 0em 0em; font-weight : bold; text-align: center; } h1 { font-size : 140% } h2, h3, h4, h5, h6, div.h7, div.h8, div.h9 { font-size : 100%; border-top-style : none; margin: 1ex 0em 0em 0em; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px; text-align: center; padding: 2px; } h2 { font-size : 120%; background-color: #90BDFF ; } h3 { background-color: #90DDFF; } h4 { background-color: #90EDFF; } h5 { background-color: #90FDFF; } h6 { background-color: #C0FFFF; } div.h7 { background-color: #E0FFFF; } div.h8 { background-color: #F0FFFF; } div.h9 { background-color: #FFFFFF; } .navbar { padding-bottom : 1em; margin-bottom: 1em; border-bottom: 1px solid #000000; border-bottom-style: dotted; } p { padding: 1em 0ex 0em 0em } a, a:link, a:visited, a:active, a:hover { color : #009; text-decoration: none } a:hover { color : #009; text-decoration : none; background-color: #5FFF88 } hr { border-style: none; } table { font-size : 100% /* Why ? */ } ul li { padding: 1em 0em 0em 0em; margin:0em 0em 0em 2.5ex } ol li { padding: 1em 0em 0em 0em; margin:0em 0em 0em 2em } pre { margin: 3ex 0em 1ex 0em; background-color: #edf0f9; } .keyword { font-weight: bold; color: #a020f0; } .keywordsign { font-weight: bold; color: #a020f0; } .typefieldcomment { color : #b22222; } .keywordsign { color: #a020f0; } .code { font-size: 100%; color: #5f5f5f; } .info { margin: 0em 0em 0em 2em } .comment { color : #b22222; } .constructor { color : #072 } .type { color : #228b22; } .string { color : #bc8f8f; } .warning { color : Red; font-weight : bold } div.sig_block { margin-left: 2em } .typetable { color : #b8860b; border-style : hidden } .indextable { border-style : hidden } .paramstable { border-style : hidden; padding: 5pt 5pt } .superscript { font-size : 80% } .subscript { font-size : 80% } zed-1.4/zed-api.odocl000066400000000000000000000002771245345107700145310ustar00rootroot00000000000000# OASIS_START # DO NOT EDIT (digest: 4f9aca76d1465bf7a340b312763db5f0) src/Zed_utf8 src/Zed_rope src/Zed_edit src/Zed_cursor src/Zed_lines src/Zed_re src/Zed_input src/Zed_macro # OASIS_STOP