Module Ecaml.HookSource

A hook is a variable where you can store a function or functions to be called on a particular occasion by an existing program. Emacs provides hooks for the sake of customization.

Hooks installed through Ecaml are wrapped in an exception handler that prints the error to the *Messages* buffer and exits the function normally.

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

Sourcetype ('a, 'b) t
Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> ('b -> Sexplib0.Sexp.t) -> ('a, 'b) t -> Sexplib0.Sexp.t
Sourcetype after_change = {
  1. beginning_of_changed_region : Position.t;
  2. end_of_changed_region : Position.t;
  3. length_before_change : int;
}
Sourceval sexp_of_after_change : after_change -> Sexplib0.Sexp.t
Sourcetype before_change = {
  1. beginning_of_changed_region : Position.t;
  2. end_of_changed_region : Position.t;
}
Sourceval sexp_of_before_change : before_change -> Sexplib0.Sexp.t
Sourcetype file = {
  1. file : string;
}
Sourceval sexp_of_file : file -> Sexplib0.Sexp.t
Sourcetype normal = unit
Sourceval sexp_of_normal : normal -> Sexplib0.Sexp.t
Sourcetype frame = {
  1. frame : Frame.t;
}
Sourceval sexp_of_frame : frame -> Sexplib0.Sexp.t
Sourcetype window = {
  1. window : Window.t;
  2. start : Position.t;
}
Sourceval sexp_of_window : window -> Sexplib0.Sexp.t
Sourcemodule Hook_type : sig ... end
Sourcemodule Wrap : sig ... end
Sourceval var : (_, _) t -> Ecaml_value.Function.t list Var.t
Sourcemodule Where : sig ... end
Sourcemodule Function : sig ... end
Sourceval add : ?buffer_local:bool -> ?one_shot:bool -> ?where:Where.t -> ('a, 'b) t -> ('a, 'b) Function.t -> unit

(describe-function 'add-hook) (Info-goto-node "(elisp)Setting Hooks")

If one_shot is true, the hook will be removed after the first time it runs.

Sourceval remove : ?buffer_local:bool -> ('a, 'b) t -> ('a, 'b) Function.t -> unit

(describe-function 'remove-hook) (Info-goto-node "(elisp)Setting Hooks")

Sourceval remove_symbol : ?buffer_local:bool -> ('a, 'b) t -> Symbol.t -> unit
Sourceval clear : (_, _) t -> unit
Sourceval run : (normal, unit) t -> unit Async_kernel.Deferred.t

(describe-function 'run-hooks) (Info-goto-node "(elisp)Running Hooks")

Sourceval after_change_functions : (after_change, unit) t

(describe-variable 'after-change-functions) (Info-goto-node "(elisp)Change Hooks")

Sourceval after_load : (file, unit) t

(describe-variable 'after-load-functions) (Info-goto-node "(elisp)Hooks for Loading")

Sourceval after_revert : (normal, unit) t

(describe-variable 'after-revert-hook) (Info-goto-node "(elisp)Reverting")

Sourceval after_save : (normal, unit) t

(describe-variable 'after-save-hook) (Info-goto-node "(elisp)Saving Buffers")

Sourceval before_change_functions : (before_change, unit) t

(describe-variable 'before-change-functions) (Info-goto-node "(elisp)Change Hooks")

Sourceval before_save : (normal, unit) t

(describe-variable 'before-save-hook) (Info-goto-node "(elisp)Saving Buffers")

Sourceval emacs_startup : (normal, unit) t

(describe-variable 'emacs-startup-hook)

Use this instead of (describe-variable 'after-init-hook), since the latter occurs before command-line arguments are handled (and therefore before the OCaml runtime is initialized).

Sourceval focus_in : (normal, unit) t

(describe-variable 'focus-in-hook) (Info-goto-node "(elisp)Input Focus")

Sourceval kill_buffer : (normal, unit) t

(describe-variable 'kill-buffer-hook) (Info-goto-node "(elisp)Killing Buffers")

Sourceval post_command : (normal, unit) t

(describe-variable 'post-command-hook) (Info-goto-node "(elisp)Command Overview")

Sourceval server_after_make_frame : (normal, unit) t

(describe-variable 'server-after-make-frame-hook)

Sourceval window_configuration_change : (normal, unit) t

(describe-variable 'window-configuration-change-hook) (Info-goto-node "(elisp)Window Hooks")

Sourceval window_scroll_functions : (window, unit) t

(describe-variable 'window-scroll-functions) (Info-goto-node "(elisp)Window Hooks")

Sourceval major_mode_hook : Major_mode.t -> (normal, unit) t

(Info-goto-node "(elisp)Major Mode Conventions")