package ocaml-webworker

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

OCaml commandline parsing
Findlib configuration
Merlin high-level settings
Main configuration

ocaml-webworker
- Ocaml_webworker
  - Browse_misc
  - Browse_raw
  - Browse_tree
  - Builtin_attributes
  - Cmt_cache
  - Code_execution_webworker
  - Completion
  - Destruct
    
    Predef_types
  - Env_compat
  - Expansion
  - Extend_helper
  - Extend_protocol
    
    Reader
    
    V0
  - File_cache
    
    Make
    
    Input
  - Location_aux
  - Logger
  - Longident2
  - Marg
  - Mbrowse
  - Mconfig
  - Misc2
    
    File_exists
    
    HookSig
    
    Int_literal_converter
    
    LongString
    
    MakeHooks
    
    M
    
    StringMap
    
    StringSet
  - Mreader
  - Msource
    
    Trace2
  - Msupport
  - Ocamldoc
  - Outline
  - Parmatch2
    
    Conv
    
    IdSet
  - Path_aux
    
    Map
    
    Ord
    
    Set
    
    Tbl
  - Pprintast2
  - Ppxsetup
    
    StringMap
  - Printf_compat
  - Query_json
  - Query_protocol
    
    Compl
  - Raw_compat
  - Saved_parts
  - Stat_cache
  - Std
    
    Char
    
    Either
    
    Format
    
    Glob
    
    Hashtbl
    
    Json
    
    Lexing
    
    List
    
    Lazy
    
    Obj
    
    Option
    
    Infix
    
    Shell
    
    String
    
    Map
    
    Set
  - String_compat
  - Sturgeon_stub
    
    Cursor
    
    Widget
    
    Nav
  - Syntaxerr_compat
  - Tail_analysis
  - Tast_helper
    
    Pat
  - Track_definition
    
    Fallback
    
    File
    
    File_switching
    
    Preferences
    
    Utils
  - Type_utils
    
    Printtyp
  - Typedtrie
    
    Trie
  - Untypeast2

Legend:
Library
Module
Module type
Parameter
Class
Class type

OCaml commandline parsing

type ocaml = {

include_dirs : string list;
no_std_include : bool;
unsafe : bool;
classic : bool;
principal : bool;
real_paths : bool;
threads : [ `None | `Threads | `Vmthreads ];
recursive_types : bool;
strict_sequence : bool;
applicative_functors : bool;
unsafe_string : bool;
nopervasives : bool;
strict_formats : bool;
open_modules : string list;
ppx : string list;
pp : string;
warnings : Warnings.state;

}

val dump_ocaml : 
  ocaml ->
  [> `Assoc of
       (string
        * [> `Bool of bool
          | `List of [> `String of string ] list
          | `String of string ])
         list ]

Some paths can be resolved relative to a current working directory

val cwd : string option Pervasives.ref

val resolve_relative_path : ?cwd:string -> (unit -> 'a) -> 'a

val canonicalize_filename : 'a -> string

val marg_path : (string -> 'a -> 'a) -> 'a Marg.t

val marg_exec_path : (string -> 'a -> 'a) -> 'a Marg.t

Findlib configuration

type findlib = {

conf : string option;
path : string list;

}

val dump_findlib : 
  findlib ->
  [> `Assoc of
       (string
        * [> `List of [> `String of string ] list | `Null | `String of string ])
         list ]

val findlib_flags : (string * findlib Marg.t * string) list

Merlin high-level settings

type flag_list = {

flag_cwd : string option;
flag_list : string list;

}

val flag_list : ?cwd:string option -> string list -> flag_list

type merlin = {

build_path : string list;
source_path : string list;
cmi_path : string list;
cmt_path : string list;
extensions : string list;
suffixes : (string * string) list;
stdlib : string option;
reader : string list;
protocol : [ `Json | `Sexp ];
log_file : string option;
trace : bool;
flags_to_apply : flag_list list;
dotmerlin_to_load : string list;
packages_to_load : string list;
flags_applied : flag_list list;
dotmerlin_loaded : string list;
packages_loaded : string list;
packages_path : string list;
failures : string list;

}

val dump_merlin : 
  merlin ->
  [> `Assoc of
       (string
        * [> `Bool of bool
          | `List of
            [> `Assoc of
                 (string
                  * [> `List of [> `String of string ] list
                    | `Null
                    | `String of string ])
                   list
            | `String of string ]
              list
          | `Null
          | `String of string ])
         list ]

val merlin_flags : (string * merlin Marg.t * string) list

type query = {

filename : string;
directory : string;
printer_width : int;
verbosity : int;

}

val dump_query : 
  query ->
  [> `Assoc of (string * [> `Int of int | `String of string ]) list ]

val query_flags : (string * query Marg.t * string) list

type t = {

ocaml : ocaml;
findlib : findlib;
merlin : merlin;
query : query;

}

val ocaml_ignored_flags : string list

val ocaml_ignored_parametrized_flags : string list

val ocaml_warnings_spec : error:bool -> ocaml Marg.t

val ocaml_flags : (string * ocaml Marg.t * string) list

Main configuration

val initial : t

val dump : 
  t ->
  [> `Assoc of
       (string
        * [> `Assoc of
               (string
                * [> `Bool of bool
                  | `Int of int
                  | `List of
                    [> `Assoc of
                         (string
                          * [> `List of [> `String of string ] list
                            | `Null
                            | `String of string ])
                           list
                    | `String of string ]
                      list
                  | `Null
                  | `String of string ])
                 list ])
         list ]

val stdlib : t -> string

val arguments_table : (string, t Marg.t) Std.Hashtbl.t

val flags_for_completion : unit -> string list

val try_parse_argument : 
  warning:(string -> 'a) ->
  string list ->
  t ->
  (string list * t) option

val parse_arguments : warning:(string -> 'a) -> string list -> t -> t

val document_arguments : Pervasives.out_channel -> unit

val source_path : t -> string list

val build_path : t -> string list

val cmt_path : t -> string list

val is_normalized : t -> bool