package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Ecaml.Major_modeSource

Sourcemodule Auto_mode : sig ... end
Sourcemodule Name : sig ... end
Sourcetype t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Core.Equal.S with type t := t
Sourceval equal : t Base__Equal.equal
Sourcemodule Compare_by_name : sig ... end
include sig ... end
Sourcemodule type S_with_lazy_keymap = sig ... end
Sourcemodule type S = sig ... end

Accessors

Sourceval symbol : t -> Symbol.t
Sourceval name : t -> Name.t
Sourceval hook : t -> unit Ecaml__.Hook0.t Core.Or_error.t
Sourceval keymap : t -> Keymap.t
Sourceval keymap_var : t -> Keymap.t Var.t
Sourceval syntax_table : t -> Syntax_table.t
Sourceval wrap_existing : string -> Core.Source_code_position.t -> (module S)

wrap_existing mode_name wraps the existing Emacs major mode named mode_name, and stores it in the table of all major modes indexed by symbol. wrap_existing raises if a major mode associated with this symbol was already wrapped.

Sourceval wrap_existing_with_lazy_keymap : string -> Core.Source_code_position.t -> (module S_with_lazy_keymap)

wrap_existing_with_lazy_keymap is like wrap_existing, except the resulting module's keymap value has type Keymap.t Lazy.t rather than Keymap.t. This is needed if the keymap value isn't defined at the point that the major mode is wrapped.

Sourceval find_or_wrap_existing : Core.Source_code_position.t -> Symbol.t -> t

find_or_wrap_existing looks up the major mode associated with this symbol by a previous call to wrap_existing or creates one with the Undistinguished name.

Sourceval change_to : t -> in_:Buffer.t -> unit Async_kernel.Deferred.t

(describe-function 'fundamental-mode) (Info-goto-node "(elisp)Major Modes")

Sourcemodule Prog : S

(describe-function 'prog-mode) (Info-goto-node "(elisp)Basic Major Modes")

Sourcemodule Special : S

(describe-function 'special-mode) (Info-goto-node "(elisp)Basic Major Modes")

Sourcemodule Text : S

(describe-function 'text-mode) (Info-goto-node "(elisp)Basic Major Modes")

(describe-function 'dired-mode)

(describe-function 'tuareg-mode)

(describe-function 'makefile-mode)

Sourcemodule Lisp : S

(describe-function 'lisp-mode)

(describe-function 'scheme-mode)

(describe-function 'emacs-lisp-mode)

(describe-function 'asm-mode)

(describe-function 'python-mode)

Sourceval define_derived_mode : ?auto_mode:Auto_mode.t -> Symbol.t -> Core.Source_code_position.t -> docstring:string -> ?define_keys:(string * Symbol.t) list -> mode_line:string -> ?parent:t -> ?initialize:((unit, 'a) Defun.Returns.t * (unit -> 'a)) -> unit -> (module S)

(describe-function 'define-derived-mode) (Info-goto-node "(elisp)Derived Modes")

Additionally, each key_sequence, symbol in define_keys is added to the new major mode's keymap.

Sourceval is_derived : t -> from:t -> bool
Sourceval major_mode_var : Symbol.t Buffer_local.t

(describe-variable 'major-mode)

Sourcemodule For_testing : sig ... end