package ecaml

  1. Overview
  2. Docs
Library for writing Emacs plugin in OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

v0.17.0.tar.gz
sha256=87e76473915e12d718096100a5c4d15d98aba6f99ecbf21814b7389e8c28bb25

doc/src/ecaml/advice.ml.html

Source file advice.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
open! Core
open! Import

type t = Symbol.t [@@deriving sexp_of]

let add =
  let advice_add =
    Funcall.Wrap.("advice-add" <: Symbol.t @-> Symbol.t @-> Symbol.t @-> return nil)
  in
  fun t ~to_function -> advice_add to_function Q.K.around t
;;

let of_function symbol = symbol

let defun_internal
  advice_name
  here
  ~docstring
  ?interactive
  ?should_profile
  sync_or_async
  f
  =
  Defun.defun
    advice_name
    here
    ~docstring
    ?interactive
    ?should_profile
    (Defun.Returns.returns sync_or_async Value.Type.value)
    (let open Defun.Let_syntax in
     let%map_open () = return ()
     and inner = required "inner" value
     and rest = rest "rest" value in
     f inner rest);
  advice_name
;;

let defun_around_values
  advice_name
  here
  sync_or_async
  ~docstring
  ?interactive
  ?should_profile
  f
  =
  defun_internal
    advice_name
    here
    ~docstring
    ?interactive
    ?should_profile
    sync_or_async
    (fun inner rest -> f (Value.funcallN ?should_profile inner) rest)
;;

module On_parse_error = struct
  type t =
    | Allow_raise
    | Call_inner_function
  [@@deriving sexp_of]
end

let defun_around_funcall
  advice_name
  here
  ~docstring
  ?interactive
  ?(on_parse_error = On_parse_error.Allow_raise)
  ?should_profile
  funcall
  f
  =
  defun_internal
    advice_name
    here
    ~docstring
    ?interactive
    ?should_profile
    Sync
    (fun inner rest ->
    Funcall.Private.apply
      funcall
      (f (Funcall.Private.wrap_unrolled funcall inner))
      rest
      ~on_parse_error:
        (match (on_parse_error : On_parse_error.t) with
         | Allow_raise ->
           fun exn ->
             raise_s
               [%message
                 "Advice failed to parse its arguments"
                   ~_:(here : Source_code_position.t)
                   ~_:(exn : exn)]
         | Call_inner_function ->
           fun exn ->
             Echo_area.inhibit_messages Sync (fun () ->
               message_s
                 [%message
                   "Ignoring advice that failed to parse its arguments"
                     ~_:(here : Source_code_position.t)
                     ~_:(exn : exn)]);
             Value.funcallN inner rest))
;;

let remove =
  let advice_remove =
    Funcall.Wrap.("advice-remove" <: Symbol.t @-> Symbol.t @-> return nil)
  in
  fun t ~from_function -> advice_remove from_function t
;;
OCaml

Innovation. Community. Security.