package ecaml

You can search for identifiers within the package.

in-package search v0.2.0

package ecaml

ecaml
- Ecaml
  - Abbrev
  - Advice
    
    On_parse_error
  - Ansi_color
    
    Colors
  - Async_ecaml
    
    Expect_test_config
    
    IO_flush
    
    IO_run
    
    Expect_test_config_allowing_nested_block_on_async
    
    IO_flush
    
    IO_run
    
    Export
    
    Clock
    
    Private
  - Auto_mode_alist
    
    Entry
  - Background
    
    Clock
    
    Private
  - Backup
  - Bookmark
    
    Make_record_function
    
    Return_type
    
    Property
    
    And_value
    
    Record
  - Browse_url
    
    Url
  - Buffer
    
    Blocking
    
    Compare_by_name
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Which_buffers
  - Buffer_local
    
    Private
    
    Wrap
  - Char_code
  - Clipboard
  - Color
    
    Frame
    
    RGB
  - Command
    
    Raw_prefix_argument
  - Comment
    
    Terminated_by
  - Compilation
  - Completing
    
    Collection
    
    Initial_input
    
    Require_match
  - Current_buffer
    
    Coding_system
  - Customization
    
    Enum_arg
    
    Group
    
    Private
    
    Type
    
    Wrap
  - Debugger
  - Defconst
    
    Private
  - Defun
    
    For_testing
    
    Interactive
    
    Let_syntax
    
    Let_syntax
    
    Obsoletes
    
    Since
    
    Open_on_rhs_intf
    
    S
    
    Returns
  - Defvar
    
    Private
  - Directory
  - Display
  - Display_property
    
    Margin
  - Documentation
    
    Special_sequence
  - Ecaml_profile
    
    Private
  - Echo_area
  - Ediff
  - Elisp_gc
  - Elisp_time
  - Emacs_backtrace
  - Emacs_version
  - Eval
  - Evil
    
    Config
    
    Escape
    
    State
  - Face
    
    Attribute
    
    Packed
    
    Attribute_and_value
    
    Background
    
    Box
    
    Font
    
    Font_family
    
    Font_foundry
    
    Foreground
    
    Frame
    
    Height
    
    Inherit
    
    Inverse_video
    
    Overline
    
    Slant
    
    Stipple
    
    Strike_through
    
    Underline
    
    Weight
    
    Width
  - Feature
  - File
  - Filename
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Find_function
  - Frame
    
    Include_minibuffer
  - Grep
    
    Save_buffers
  - Hash_table
    
    Test
  - Help
  - Hook
    
    Function
    
    Hook_type
    
    Where
    
    Wrap
  - Input_event
    
    Basic
    
    Command_or_key
    
    Modifier
  - Key_sequence
  - Keymap
    
    Entry
    
    Kind
  - Kill_ring
  - Line_and_column
  - Load
  - Load_history
    
    Entry
    
    Face
    
    Attribute
    
    Packed
    
    T
    
    Attribute_and_value
    
    Attribute_value
    
    Background
    
    Box
    
    Color_or_unspecified
    
    Font
    
    Font_family
    
    Font_foundry
    
    Foreground
    
    Frame
    
    Height
    
    Inherit
    
    Inverse_video
    
    Line
    
    Overline
    
    Q
    
    Slant
    
    T
    
    Stipple
    
    Strike_through
    
    String_name
    
    Underline
    
    Unimplemented
    
    Value
    
    Weight
    
    T
    
    Width
    
    T
    
    Type
  - Major_mode
    
    Asm
    
    Auto_mode
    
    Compare_by_name
    
    Dired
    
    Emacs_lisp
    
    For_testing
    
    Fundamental
    
    Lisp
    
    Makefile
    
    Name
    
    Prog
    
    S
    
    S_with_lazy_keymap
    
    Scheme
    
    Special
    
    Text
    
    Tuareg
  - Marker
    
    Insertion_type
  - Minibuffer
    
    History
    
    History_length
    
    Y_or_n_with_timeout
  - Minor_mode
    
    Fields
    
    Direct
    
    Private
  - Mode_line
    
    Format
  - Modified_tick
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
  - Obarray
  - Obsolete
  - Ocaml_or_elisp_value
    
    S
  - Org_table
  - Overlay
  - Plist
  - Point
  - Position
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
  - Print
  - Process
    
    Call
    
    Input
    
    Output
    
    Stderr
    
    Stdout
    
    Region_input
    
    Result
    
    Exit_status
    
    Exited
    
    Status
  - Q
    
    K
  - Ref
  - Regexp
    
    Last_match
    
    Private
    
    Location
  - Rx
    
    Char_class
    
    Start_or_end
  - Selected_window
    
    Blocking
  - Symbol
    
    Automatic_migration
    
    New
    
    Compare_name
    
    Make_subtype
    
    Arg
    
    Property
    
    Subtype
  - Symbol_prefix
    
    S
  - Sync_or_async
  - Syntax_table
    
    Class
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Descriptor
    
    Flag
  - System
    
    Var_and_value
  - Tabulated_list
    
    Column
    
    Tabulated_list_mode
  - Terminal
  - Text
    
    Compare_as_string
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Named
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Display_spec
    
    Face_spec
    
    One
    
    Property
    
    Property_name
    
    Create
    
    Packed
  - Thing_at_point
  - Timer
  - User
  - Var
    
    And_value
    
    And_value_option
    
    Fields
    
    Direct
    
    Wrap
  - Variable_watcher
    
    Event
    
    Operation
  - Vector
  - Window
    
    Blocking
    
    Tree
    
    Direction
  - Working_directory
ecaml.bench
- Ecaml_bench
  - Bench_async_ecaml
ecaml.ecaml_test_helpers
- Ecaml_test_helpers
  - Buffer_helper
    
    Region
    
    Sample_input
ecaml.ecaml_value
- Ecaml_value
  - Caml_embed
  - Ecaml_callback
  - Feature
  - Form
    
    Blocking
  - Funcall
    
    Private
    
    Wrap
  - Function
    
    Expert
    
    Fn
  - Symbol
  - Value
    
    Expert
    
    For_testing
    
    Funcall
    
    Make_subtype
    
    Subtype
    
    Make_subtype_arg
    
    Private
    
    Block_on_async
    
    Enqueue_foreground_block_on_async
    
    Run_outside_async
    
    Stat
    
    Subtype
    
    Type
    
    S
  - Valueable
    
    Make
    
    M
    
    S
    
    S1
ecaml.nested_profile
- Nested_profile
  - Profile
    
    Private
    
    Clock
    
    Start_location
    
    Sync_or_async

Legend:
Library
Module
Module type
Parameter
Class
Class type

An Emacs symbol, i.e., an Emacs value that satisfies Value.is_symbol.

(Info-goto-node "(elisp)Symbols")

include module type of struct include Ecaml_value.Symbol end

include Ecaml_value.Value.Subtype

type t = private Ecaml_value.Value.t

We expose private value for free identity conversions when the value is nested in some covariant type, e.g. (symbols : Symbol.t list :> Value.t list) rather than List.map symbols ~f:Symbol.to_value.

val sexp_of_t : t -> Sexplib0.Sexp.t

val eq : t -> t -> bool

eq t1 t2 = Value.eq (to_value t1) (to_value t2), i.e. eq checks whether the Emacs values underlying t1 and t2 are physically equal. This is different than phys_equal t1 t2, because we don't always wrap eq Emacs values in phys_equal OCaml values. I.e. phys_equal t1 t2 implies eq t1 t2, but not the converse.

val is_in_subtype : Ecaml_value.Value.t -> bool

val of_value_exn : Ecaml_value__.Value0.t -> t

val to_value : t -> Ecaml_value__.Value0.t

val type_ : t Ecaml_value.Value.Type.t

val t : t Ecaml_value.Value.Type.t

include Core.Equal.S with type t := t

val equal : t Base.Equal.equal

include Ecaml_value.Value.Funcall with type t := t

val funcall0 : ?should_profile:bool -> t -> Ecaml_value.Value.t

val funcall1 : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t

val funcall2 : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t

val funcall3 : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t

val funcall4 : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t

val funcall5 : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t

val funcallN : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t list ->
  Ecaml_value.Value.t

val funcallN_array : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t array ->
  Ecaml_value.Value.t

val funcall0_i : ?should_profile:bool -> t -> unit

val funcall1_i : ?should_profile:bool -> t -> Ecaml_value.Value.t -> unit

val funcall2_i : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  unit

val funcall3_i : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  unit

val funcall4_i : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  unit

val funcall5_i : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  unit

val funcallN_i : ?should_profile:bool -> t -> Ecaml_value.Value.t list -> unit

val funcallN_array_i : 
  ?should_profile:bool ->
  t ->
  Ecaml_value.Value.t array ->
  unit

val funcall_int_int_value_value_unit : 
  ?should_profile:bool ->
  t ->
  int ->
  int ->
  Ecaml_value.Value.t ->
  Ecaml_value.Value.t ->
  unit

val funcall_int_int_value_unit : 
  ?should_profile:bool ->
  t ->
  int ->
  int ->
  Ecaml_value.Value.t ->
  unit

val intern : string -> t

type symbol := t

Accessors

val name : t -> string

(describe-function 'symbol-name)

val function_exn : t -> Ecaml_value.Value.t

(describe-function 'symbol-function)

val function_is_defined : t -> bool

(describe-function 'fboundp)

val compare_name : t -> t -> int

val create : name:string -> t

(describe-function 'make-symbol).

val gensym : ?prefix:string -> unit -> t

(describe-function 'gensym).

val set_function : t -> Ecaml_value.Value.t -> unit

(describe-function 'fset).

module Automatic_migration : sig ... end

Automatic_migration supports migrating from one symbol-naming convention to another. Use Automatic_migration.add to add a function that maps names from the old convention to the new. Once you've done that, the following functions will automatically migrate their symbol argument, and and an obsolete alias pointing from the old name to the new.

module Property : sig ... end

module type Subtype = sig ... end

module Make_subtype (Arg : sig ... end) : Subtype with type t := Arg.t

module Compare_name : sig ... end