mirror of
https://github.com/ubf/ubf.git
synced 2026-04-16 09:45:11 +00:00
81 lines
2.7 KiB
Erlang
81 lines
2.7 KiB
Erlang
%%% -*- mode: erlang -*-
|
|
|
|
%%% The MIT License
|
|
%%%
|
|
%%% Copyright (C) 2011-2016 by Joseph Wayne Norton <norton@alum.mit.edu>
|
|
%%% Copyright (C) 2002 by Joe Armstrong
|
|
%%%
|
|
%%% Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
%%% of this software and associated documentation files (the "Software"), to deal
|
|
%%% in the Software without restriction, including without limitation the rights
|
|
%%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
%%% copies of the Software, and to permit persons to whom the Software is
|
|
%%% furnished to do so, subject to the following conditions:
|
|
%%%
|
|
%%% The above copyright notice and this permission notice shall be included in
|
|
%%% all copies or substantial portions of the Software.
|
|
%%%
|
|
%%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
%%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
%%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
%%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
%%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
%%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
%%% THE SOFTWARE.
|
|
|
|
+NAME("irc").
|
|
|
|
+VSN("ubf2.0").
|
|
|
|
+TYPES
|
|
info() :: info;
|
|
description() :: description;
|
|
contract() :: contract;
|
|
|
|
ok() :: ok;
|
|
bool() :: true | false;
|
|
nick() :: ubfstring();
|
|
oldnick() :: nick();
|
|
newnick() :: nick();
|
|
group() :: ubfstring();
|
|
groups() :: [group()];
|
|
|
|
logon() :: logon;
|
|
proceed() :: {ok, nick()};
|
|
listGroups() :: groups;
|
|
joinGroup() :: {join, group()};
|
|
leaveGroup() :: {leave, group()};
|
|
changeNick() :: {nick, nick()};
|
|
msg() :: {msg, group(), string()};
|
|
|
|
msgEvent() :: {msg, nick(), group(), string()};
|
|
joinEvent() :: {joins, nick(), group()};
|
|
leaveEvent() :: {leaves, nick(), group()};
|
|
changeNameEvent() :: {changesName, oldnick(), newnick(), group()}.
|
|
|
|
+STATE start
|
|
logon() => proceed() & active. %% Nick randomly assigned
|
|
|
|
+STATE active
|
|
listGroups() => groups() & active;
|
|
joinGroup() => ok() & active;
|
|
leaveGroup() => ok() & active;
|
|
changeNick() => bool() & active;
|
|
msg() => bool() & active; %% False if you have not joined a group
|
|
|
|
EVENT => msgEvent(); %% Group sends me a message
|
|
EVENT => joinEvent(); %% Nick joins group
|
|
EVENT => leaveEvent(); %% Nick leaves group
|
|
EVENT => changeNameEvent(). %% Nick changes name
|
|
|
|
+ANYSTATE
|
|
info() => string();
|
|
description() => string();
|
|
contract() => term().
|
|
|
|
|
|
|
|
|
|
|
|
|