package calculon

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Plugins

package calculon

calculon
- Calculon
  - Command
  - Config
  - Core
    
    S
    
    I
    
    Io
  - Log
  - Lwt_err
  - Plugin
    
    Set
  - Plugin_factoids
  - Plugin_history
  - Plugin_social
  - Plugin_state
  - Plugin_vote
  - Prelude
    
    Rand_distrib
    
    StrMap
  - Run_main
  - Signal
    
    Send_ref
  - Talk
calculon.extras
- Calculon_extras
  - Irclog
  - Plugin_markcough
    
    Gen
    
    Parse_logs
    
    Table

Legend:
Library
Module
Module type
Parameter
Class
Class type

Plugins

A plugin is a bunch of commands, and optionally some disk-backed state. It will register its commands to the core loop

type json = Yojson.Safe.json

type action =

| Require_reload
(*
Require that we reload everything from on-disk state
*)
| Require_save
(*
Require that the state be saved
*)

type action_callback = action Signal.Send_ref.t

type stateful =

| St : 'st stateful_ -> stateful

A stateful plugin, using a persistent state 'st

and 'st stateful_ = private {

name : string;
commands : 'st -> Command.t list;
on_msg : 'st -> (Core.t -> Irc_message.t -> unit Lwt.t) list;
to_json : 'st -> json option;
of_json : action_callback -> json option -> ('st, string) Result.result Lwt.t;
stop : 'st -> unit Lwt.t;

}

type t =

| Stateful of stateful
| Stateless of Command.t list

A single plugin

type plugin = t

val of_cmd : Command.t -> t

Stateless plugin with 1 command

val of_cmds : Command.t list -> t

Stateless plugin with several commands

raises Invalid_argument
if the list is empty

val stateful : 
  name:string ->
  commands:('st -> Command.t list) ->
  ?on_msg:('st -> (Core.t -> Irc_message.t -> unit Lwt.t) list) ->
  to_json:('st -> json option) ->
  of_json:(action_callback -> json option -> ('st, string) Result.result Lwt.t) ->
  ?stop:('st -> unit Lwt.t) ->
  unit ->
  t

Make a stateful plugin using the given name (for prefixing its storage; this should be unique) and ways to serialize state to Json, deserialize state from Json, and building commands from the state. See stateful_ for more details on each field.

module Set : sig ... end