Chat-O-Matic/protocols/irc/IrcProtocol.h
Jaidyn Ann 8d50a6b9a4 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

162 lines
4.1 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*
* Copyright 2021-2022, Jaidyn Levesque <jadedctrl@teknik.io>
* Copyright 2017, Akshay Agarwal <agarwal.akshay.akshay8@gmail.com>
* All rights reserved. Distributed under the terms of the MIT license.
*/
#ifndef _IRC_PROTOCOL_H
#define _IRC_PROTOCOL_H
#include <String.h>
#include <StringList.h>
#include <libsupport/KeyMap.h>
#include <ChatProtocol.h>
#include "IrcConstants.h"
typedef KeyMap<BString, BString> StringMap;
class BSocket;
class BDataIO;
class IrcProtocol : public ChatProtocol {
public:
IrcProtocol();
~IrcProtocol();
// ChatProtocol inheritance
virtual status_t Init(ChatProtocolMessengerInterface* interface);
virtual status_t Shutdown();
virtual status_t UpdateSettings(BMessage* settings);
virtual status_t Process(BMessage* msg);
virtual BMessage SettingsTemplate(const char* name);
virtual BObjectList<BMessage>
Commands();
virtual const char* Signature() const { return "irc"; }
virtual const char* FriendlySignature() const { return "IRC"; }
virtual BBitmap* Icon() const;
virtual void SetAccountCachepath(BPath path) { fCachePath = path; }
virtual void SetAddOnPath(BPath path) { fAddOnPath = path; }
virtual BPath AddOnPath() { return fAddOnPath; }
virtual const char* GetName() { return fName; }
virtual void SetName(const char* name) { fName = name; }
virtual ChatProtocolMessengerInterface*
MessengerInterface() const { return fMessenger; }
// IRC
status_t Connect();
status_t Loop();
BMessage* fSettings;
private:
void _ProcessLine(BString line);
void _ProcessNumeric(int32 numeric, BString sender,
BStringList params, BString line);
void _ProcessNumericError(int32 numeric, BString sender,
BStringList params, BString line);
void _ProcessCommand(BString command, BString sender,
BStringList params, BString line);
void _MakeReady(BString nick, BString ident);
BString _LineSender(BStringList words);
BString _LineCode(BStringList words);
BStringList _LineParameters(BStringList words, BString line);
void _SendMsg(BMessage* msg);
void _SendIrc(BString cmd);
// Used with "nick!ident"-formatted strings
BString _SenderNick(BString sender);
BString _SenderIdent(BString sender);
BString _IdentNick(BString ident);
BString _NickIdent(BString nick);
bool _IsChannelName(BString name);
void _AddFormatted(BMessage* msg, const char* name,
BString text);
void _FormatToggleFace(BMessage* msg, uint16 face,
int32* start, int32 current);
void _UpdateContact(BString nick, BString ident, bool online);
void _AddContact(BString nick);
void _RemoveContact(BString user_id);
void _RenameContact(BString user_id, BString newNick);
void _LoadContacts();
void _SaveContacts();
int32 _RolePerms(UserRole role);
const char* _RoleTitle(UserRole role);
const char* _ContactsCache();
void _JoinDefaultRooms();
// Read a data stream until newline found; if data found past
// newline, append to given buffer for later use
BString _ReadUntilNewline(BDataIO* data, BString* extraBuffer);
// Trim given string until newline hit, return trimmed part
BString _TrimStringToNewline(BString* str);
// Borrowed from Calendar's ColorConverter
rgb_color _IntToRgb(int rgb);
// GUI templates
BMessage _AccountTemplate();
BMessage _RoomTemplate();
BMessage _RosterTemplate();
BSocket* fSocket;
BString fRemainingBuf;
thread_id fRecvThread;
// Settings
BString fNick;
BString fUser;
BString fIdent;
BString fPartText;
BString fRealName;
BString fPassword;
BString fServer;
int32 fPort;
bool fSsl;
// WHOREPLY is requested by the add-on to populate the user-list, but the
// user might also use the /who command― if the user does, this is true
bool fWhoRequested;
bool fWhoIsRequested;
bool fListRequested;
BString fWhoIm;
bool fWriteLocked;
StringMap fIdentNicks; // User ident → nick
BStringList fChannels;
BStringList fContacts;
BStringList fOfflineContacts;
BPath fAddOnPath;
BPath fCachePath;
BString fName;
ChatProtocolMessengerInterface* fMessenger;
bool fReady;
};
#endif // _IRC_PROTOCOL_H