jadedctrl/Chat-O-Matic
jadedctrl/ Chat-O-Matic
1
0
Disbranĉigi 0
Fontkodo Issues 20 Tirpetoj Actions Packages Projects Eldonoj 2 Wiki Activity
Chat-O-Matic/application/ChatProtocol.h

109 lines
3.2 KiB
C
Raw Permalink Normal View History

Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
/*
Update copyright year.
2011-12-03 16:38:03 -06:00
* Copyright 2009-2011, Andrea Anzani. All rights reserved.
* Copyright 2009-2011, Pier Luigi Fiorini. All rights reserved.
Remove obselete CayaProtocol::SaveLogs(), add ::Commands() With the new use of RoomFlags for signifying whether or not a room's chat should be populated with local logs (ROOM_POPULATE_LOGS), SaveLogs() is redundant. A Commands() method was added to the CayaProtocol class returning a CommandMap, which will be used by Caya when searching for commands. KeyList::AddList() and List::AddList() were also added to libsupport, for convenience.
2021-06-15 14:40:28 -05:00
* Copyright 2021, Jaidyn Levesque. All rights reserved.
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
* Distributed under the terms of the MIT License.
*/
Change class names
2021-06-20 12:44:20 -05:00
#ifndef _APP_PROTOCOL_H
#define _APP_PROTOCOL_H
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
#include <Messenger.h>
Move command/menu-item registration to call Registration of custom chat commands and menu-items for protocols was done by the IM_REGISTER_* messages, and is now done through direct calls to the CayaProtocol object. The new model for call/message for protocols is this: Temporary information (chat messages, roster members, etc.) should be accessed through messages. Relatively static data (protocol name, commands) should be accessed through direct calls to the protocol object.
2021-06-20 01:24:34 -05:00
#include <ObjectList.h>
Include BPath in ChatProtocol
2021-06-30 15:35:40 -05:00
#include <Path.h>
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Allow multiple protocols per add-on Now an add-on can contain multiple protocols, and the protocol API has changed. An add-on must now export protocol_count() and protocol_at(), with the latter replacing protocol(). protocol_count() returning the amount of protocols in a given add-on, and protocol_at(i) giving a new CayaProtocol* "at" the given index. CayaProtocol has also been changed, adding Signature(), FriendlySignature(), Icon(), Path(), and SetPath(). The reasoning is that different protocols (even within a single add-on) will have different signatures and icons, so this data should be accessible from the protocol itself. CayaProtocolAddOn now has CountProtocols() and ProtocolAt(i), allowing the accessing of multiple protocols. A CayaProtocolAddOn can be given a default protocol index in the constructor, whose protocol will be returned with Protocol(). Version() was also moved from CayaProtocol to CayaProtocolAddOn.
2021-05-21 13:33:43 -05:00
class BBitmap;
Remove obselete CayaProtocol::SaveLogs(), add ::Commands() With the new use of RoomFlags for signifying whether or not a room's chat should be populated with local logs (ROOM_POPULATE_LOGS), SaveLogs() is redundant. A Commands() method was added to the CayaProtocol class returning a CommandMap, which will be used by Caya when searching for commands. KeyList::AddList() and List::AddList() were also added to libsupport, for convenience.
2021-06-15 14:40:28 -05:00
Rename Cardie to Chat-O-Matic
2021-08-19 02:28:06 -05:00
// Chat-O-Matic protocol interface version
Change class names
2021-06-20 12:44:20 -05:00
#define APP_VERSION_1_PRE_ALPHA_1 0x00000001
#define APP_VERSION_1_ALPHA_1 0x00000100
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
Protocol message tweaks, bump API version Some chat protocol messages' names have been changed to more fitting or consistent names― e.g., "IM_AVATAR_SET" to "IM_USER_AVATAR_SET", or "IM_CONTACT_LIST_*" to "IM_ROSTER_*" (to agree with Cardie's usage of the word). The API version has been bumped― for the forseeable future (at least several months, I promise!) no compatibility-breaking changes will be introduced. Until then, any new feautures or message slots will be additive and optional.
2021-08-08 21:01:42 -05:00
#define APP_VERSION APP_VERSION_1_ALPHA_1
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
Remove obselete CayaProtocol::SaveLogs(), add ::Commands() With the new use of RoomFlags for signifying whether or not a room's chat should be populated with local logs (ROOM_POPULATE_LOGS), SaveLogs() is redundant. A Commands() method was added to the CayaProtocol class returning a CommandMap, which will be used by Caya when searching for commands. KeyList::AddList() and List::AddList() were also added to libsupport, for convenience.
2021-06-15 14:40:28 -05:00
Change class names
2021-06-20 12:44:20 -05:00
class ChatProtocolMessengerInterface {
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
public:
virtual status_t SendMessage(BMessage* message) = 0;
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
};
Change class names
2021-06-20 12:44:20 -05:00
class ChatProtocol {
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
public:
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Messenger
Change class names
2021-06-20 12:44:20 -05:00
virtual status_t Init(ChatProtocolMessengerInterface*) = 0;
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Called before unloading from memory
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
virtual status_t Shutdown() = 0;
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Process message
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
virtual status_t Process(BMessage*) = 0;
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Change settings
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
virtual status_t UpdateSettings(BMessage*) = 0;
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Reformat ChatProtocol, default own contact to null
2021-07-07 10:59:56 -05:00
/*! Return a settings template
Currently there are four: "account" (used when creating/editing
the user's account), "create_room" & "join_room" (fairly self-evident),
and "roster" (used when adding or editing a roster member. */
Generalize protocol settings' GUI templating A nice templating system is used for account settings dialogues― the required slots are specified by the protocol, and are reflected in the settings dialogue. To generalize this templating system (and eventually use elsewhere), ProtocolSettings was split into two classes― ProtocolSettings and ProtocolTemplate. The CayaProtocol::SettingsTemplate() call was also edited to require a string parameter, naming the specific template that should be returned. "account" is used for the account settings dialogue, and other values are TBA.
2021-06-17 16:51:37 -05:00
virtual BMessage SettingsTemplate(const char* name) = 0;
Generate protocols' settings templates by call
2021-05-20 09:32:52 -05:00
Reformat ChatProtocol, default own contact to null
2021-07-07 10:59:56 -05:00
/*! Custom chat commands― archived ChatCommand objects
Requires: String "_name", String "_desc", Bool "_proto",
Message "_msg", int32s "_argtype",
String "class" = "ChatCommand" */
Move command/menu-item registration to call Registration of custom chat commands and menu-items for protocols was done by the IM_REGISTER_* messages, and is now done through direct calls to the CayaProtocol object. The new model for call/message for protocols is this: Temporary information (chat messages, roster members, etc.) should be accessed through messages. Relatively static data (protocol name, commands) should be accessed through direct calls to the protocol object.
2021-06-20 01:24:34 -05:00
virtual BObjectList<BMessage> Commands() {
return BObjectList<BMessage>();
}
Reformat ChatProtocol, default own contact to null
2021-07-07 10:59:56 -05:00
/*! Custom menu items used in the userlist right-click menu.
Archived BMenuItem with some extra slots.
Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
Bool "x_to_protocol", Bool "x_priority", int32 "x_perms",
int32 "x_target_perms", int32 "x_target_antiperms" */
Sensible defaults for unnecessary ChatProtocol methods
2021-08-09 10:48:45 -05:00
virtual BObjectList<BMessage> UserPopUpItems() {
return BObjectList<BMessage>();
}
Move command/menu-item registration to call Registration of custom chat commands and menu-items for protocols was done by the IM_REGISTER_* messages, and is now done through direct calls to the CayaProtocol object. The new model for call/message for protocols is this: Temporary information (chat messages, roster members, etc.) should be accessed through messages. Relatively static data (protocol name, commands) should be accessed through direct calls to the protocol object.
2021-06-20 01:24:34 -05:00
Reformat ChatProtocol, default own contact to null
2021-07-07 10:59:56 -05:00
/*! Custom menu items used in the conversation-list right-click menu.
Archived BMenuItem with some extra slots.
Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
Bool "x_to_protocol", int32 "x_perms" */
Sensible defaults for unnecessary ChatProtocol methods
2021-08-09 10:48:45 -05:00
virtual BObjectList<BMessage> ChatPopUpItems() {
return BObjectList<BMessage>();
}
Move command/menu-item registration to call Registration of custom chat commands and menu-items for protocols was done by the IM_REGISTER_* messages, and is now done through direct calls to the CayaProtocol object. The new model for call/message for protocols is this: Temporary information (chat messages, roster members, etc.) should be accessed through messages. Relatively static data (protocol name, commands) should be accessed through direct calls to the protocol object.
2021-06-20 01:24:34 -05:00
Reformat ChatProtocol, default own contact to null
2021-07-07 10:59:56 -05:00
/*! Custom menubar items (in the "Protocol" menu).
Archived BMenuItem with some extra slots.
Requires: String "_label", Message "_msg", String "class" = "BMenuItem"
Bool "x_to_protocol" */
Sensible defaults for unnecessary ChatProtocol methods
2021-08-09 10:48:45 -05:00
virtual BObjectList<BMessage> MenuBarItems() {
return BObjectList<BMessage>();
}
Move command/menu-item registration to call Registration of custom chat commands and menu-items for protocols was done by the IM_REGISTER_* messages, and is now done through direct calls to the CayaProtocol object. The new model for call/message for protocols is this: Temporary information (chat messages, roster members, etc.) should be accessed through messages. Relatively static data (protocol name, commands) should be accessed through direct calls to the protocol object.
2021-06-20 01:24:34 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Protocol signature
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
virtual const char* Signature() const = 0;
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Protocol name
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
virtual const char* FriendlySignature() const = 0;
Allow multiple protocols per add-on Now an add-on can contain multiple protocols, and the protocol API has changed. An add-on must now export protocol_count() and protocol_at(), with the latter replacing protocol(). protocol_count() returning the amount of protocols in a given add-on, and protocol_at(i) giving a new CayaProtocol* "at" the given index. CayaProtocol has also been changed, adding Signature(), FriendlySignature(), Icon(), Path(), and SetPath(). The reasoning is that different protocols (even within a single add-on) will have different signatures and icons, so this data should be accessible from the protocol itself. CayaProtocolAddOn now has CountProtocols() and ProtocolAt(i), allowing the accessing of multiple protocols. A CayaProtocolAddOn can be given a default protocol index in the constructor, whose protocol will be returned with Protocol(). Version() was also moved from CayaProtocol to CayaProtocolAddOn.
2021-05-21 13:33:43 -05:00
//! Protocol icon
Sensible defaults for unnecessary ChatProtocol methods
2021-08-09 10:48:45 -05:00
virtual BBitmap* Icon() const { return NULL; }
Allow multiple protocols per add-on Now an add-on can contain multiple protocols, and the protocol API has changed. An add-on must now export protocol_count() and protocol_at(), with the latter replacing protocol(). protocol_count() returning the amount of protocols in a given add-on, and protocol_at(i) giving a new CayaProtocol* "at" the given index. CayaProtocol has also been changed, adding Signature(), FriendlySignature(), Icon(), Path(), and SetPath(). The reasoning is that different protocols (even within a single add-on) will have different signatures and icons, so this data should be accessible from the protocol itself. CayaProtocolAddOn now has CountProtocols() and ProtocolAt(i), allowing the accessing of multiple protocols. A CayaProtocolAddOn can be given a default protocol index in the constructor, whose protocol will be returned with Protocol(). Version() was also moved from CayaProtocol to CayaProtocolAddOn.
2021-05-21 13:33:43 -05:00
Pass relevant cache paths directly to add-ons Now, instead of using Utils.cpp's AccountCachePath and AddOnCachePath, and add-on should implement ChatProtocol::SetAccountCachePath and ChatProtocol::SetAddOnCachePath. In addition, most path-related functions in Utils now return BPaths― and some of interest to chat add-ons can accept the path given by ChatProtocol::SetAccountCachePath as the main argument.
2022-02-18 15:42:06 -06:00
//! Pertinent paths
Create JoinWindow and protocol messages for joining rooms Protocol messages was added to the API to allow joining abstract rooms by their chat_id― IM_JOIN_ROOM and IM_ROOM_JOINED. To make room in anticipation of future room-related calls, some messages' values have been shifted. A JoinWindow was created (found through [Chat→Join Room] or [Alt-J] in the main window), to allow joining a room with this protocol message. The user can select which account the room should be joined from through a drop-down menu in the lower left-hand corner― a design I think could be replicated in other parts of Caya well. Path() and SetPath() in CayaProtocol were renamed to AddOnPath() and SetAddOnPath() respectively. GetName() and SetName() were also added, where "name" is the account name (aka the leaf of the protocols settings path). To Server, a new KeyMap was added for convenience (AccountInstances), to associate these account names with their instance IDs.
2021-06-01 21:43:19 -05:00
virtual BPath AddOnPath() = 0;
Pass relevant cache paths directly to add-ons Now, instead of using Utils.cpp's AccountCachePath and AddOnCachePath, and add-on should implement ChatProtocol::SetAccountCachePath and ChatProtocol::SetAddOnCachePath. In addition, most path-related functions in Utils now return BPaths― and some of interest to chat add-ons can accept the path given by ChatProtocol::SetAccountCachePath as the main argument.
2022-02-18 15:42:06 -06:00
virtual void SetAddOnPath(BPath path) = 0;
virtual void SetAccountCachePath(BPath path) { };
virtual void SetAddOnCachePath(BPath path) { };
Create JoinWindow and protocol messages for joining rooms Protocol messages was added to the API to allow joining abstract rooms by their chat_id― IM_JOIN_ROOM and IM_ROOM_JOINED. To make room in anticipation of future room-related calls, some messages' values have been shifted. A JoinWindow was created (found through [Chat→Join Room] or [Alt-J] in the main window), to allow joining a room with this protocol message. The user can select which account the room should be joined from through a drop-down menu in the lower left-hand corner― a design I think could be replicated in other parts of Caya well. Path() and SetPath() in CayaProtocol were renamed to AddOnPath() and SetAddOnPath() respectively. GetName() and SetName() were also added, where "name" is the account name (aka the leaf of the protocols settings path). To Server, a new KeyMap was added for convenience (AccountInstances), to associate these account names with their instance IDs.
2021-06-01 21:43:19 -05:00
//! Name of account file (leaf)
virtual const char* GetName() = 0;
virtual void SetName(const char* name) = 0;
Allow multiple protocols per add-on Now an add-on can contain multiple protocols, and the protocol API has changed. An add-on must now export protocol_count() and protocol_at(), with the latter replacing protocol(). protocol_count() returning the amount of protocols in a given add-on, and protocol_at(i) giving a new CayaProtocol* "at" the given index. CayaProtocol has also been changed, adding Signature(), FriendlySignature(), Icon(), Path(), and SetPath(). The reasoning is that different protocols (even within a single add-on) will have different signatures and icons, so this data should be accessible from the protocol itself. CayaProtocolAddOn now has CountProtocols() and ProtocolAt(i), allowing the accessing of multiple protocols. A CayaProtocolAddOn can be given a default protocol index in the constructor, whose protocol will be returned with Protocol(). Version() was also moved from CayaProtocol to CayaProtocolAddOn.
2021-05-21 13:33:43 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Preferred encoding of messages
Sensible defaults for unnecessary ChatProtocol methods
2021-08-09 10:48:45 -05:00
virtual uint32 GetEncoding() { return 0xffff; }
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Check protocol add-ons API version
2010-07-10 14:28:29 -05:00
//! Messenger interface used
Change class names
2021-06-20 12:44:20 -05:00
virtual ChatProtocolMessengerInterface* MessengerInterface() const = 0;
Merged multiprotocol branch with trunk.
2010-05-16 16:02:50 -05:00
};
Usual SVN tree (branches, tags, trunk).
2010-05-07 04:47:10 -05:00
Change class names
2021-06-20 12:44:20 -05:00
#endif // _APP_PROTOCOL_H