package ecaml

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

Module Ecaml.Syntax_tableSource

A syntax table specifies the syntactic textual function of each character. This information is used by the parsing functions, the complex movement commands, and others to determine where words, symbols, and other syntactic constructs begin and end.

(Info-goto-node "(elisp)Syntax Tables")

include Ecaml_value.Value.Subtype
Sourcetype 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.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval 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.

Sourceval is_in_subtype : Ecaml_value.Value.t -> bool
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Ecaml_value.Value.Type.t
include Core.Equal.S with type t := t
Sourceval equal : t Base__Equal.equal
Sourceval standard : t

(describe-function 'standard-syntax-table) (Info-goto-node "(elisp)Standard Syntax Tables")

Sourceval create : ?parent:t -> unit -> t

(describe-function 'make-syntax-table) (Info-goto-node "(elisp)Syntax Table Functions")

Sourceval copy : t -> t

(describe-function 'copy-syntax-table) (Info-goto-node "(elisp)Syntax Table Functions")

Sourcemodule Class : sig ... end

(Info-goto-node "(elisp)Syntax Class Table")

Sourcemodule Flag : sig ... end

(Info-goto-node "(elisp)Syntax Flags")

Sourcemodule Descriptor : sig ... end
Sourceval set : t -> Char_code.t -> Class.t -> Flag.t list -> unit

(describe-function 'modify-syntax-entry) (Info-goto-node "(elisp)Syntax Table Functions")

Sourceval set_char : t -> char -> Class.t -> Flag.t list -> unit