/usr/include/licq/conversation.h is in licq-dev 1.8.1-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | /*
* This file is part of Licq, an instant messaging client for UNIX.
* Copyright (C) 2010-2012 Licq developers <licq-dev@googlegroups.com>
*
* Licq is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Licq is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Licq; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LICQ_CONVERSATION
#define LICQ_CONVERSATION
#include <boost/noncopyable.hpp>
#include <vector>
namespace Licq
{
class UserId;
typedef std::vector<UserId> ConversationUsers;
/**
* Hold data for an active conversation
*/
class Conversation : private boost::noncopyable
{
public:
/**
* Get id of this conversation
*/
virtual int id() const = 0;
/**
* Get owner that has this conversation
*/
virtual UserId ownerId() const = 0;
/**
* Check if a user is member of this conversation
*
* @param userId User to check
* @return True if user is in this conversation
*/
virtual bool hasUser(const UserId& userId) const = 0;
/**
* Get number of users in conversation
*/
virtual int numUsers() const = 0;
/**
* Convenience function to check if conversation is empty
*/
bool isEmpty() const
{ return (numUsers() == 0); }
/**
* Get list of users in this conversation
*
* @param ret Vector to return users in
*/
virtual void getUsers(ConversationUsers& ret) const = 0;
/**
* Get socket associated with this conversation
*/
virtual int socketId() const = 0;
/**
* Add a user to the conversation
* Note: This should only be called from the protocol plugin owning this conversation
*
* @param userId User to add
* @return True if user was added or false if user was already in conversation
*/
virtual bool addUser(const UserId& userId) = 0;
/**
* Remove a user from the conversation
* Note: This should only be called from the protocol plugin owning this conversation
*
* @param userId User to remove
* @return True if user was remove or false if user was not in conversation
*/
virtual bool removeUser(const UserId& userId) = 0;
protected:
virtual ~Conversation() { /* Empty */ }
};
/**
* Manager to keep track of active conversations
*/
class ConversationManager : private boost::noncopyable
{
public:
/**
* Register a new conversation with the manager
* Note: This should only be called from protocol plugins
*
* @param ownerId Owner for the new conversation
* @param socketId Socket associated with this conversation
* @return The conversation just created
*/
virtual Conversation* add(const UserId& ownerId, int socketId) = 0;
/**
* Drop an existing conversation
* Note: This should only be called from the protocol plugin owning the conversation
*
* @param convoId Conversation to remove
* @return True if conversation was removed, false if conversation not found
*/
virtual bool remove(int convoId) = 0;
/**
* Get a conversation
*
* @param convoId Conversation to fetch
* @return Conversation if found, otherwise NULL
*/
virtual Conversation* get(int convoId) = 0;
/**
* Get a conversation for a socket
*
* @param convoId Socket to get conversation for
* @return Conversation if found, otherwise NULL
*/
virtual Conversation* getFromSocket(int socketId) = 0;
/**
* Get a conversation for a user
*
* @param userId User to find a conversation for
* @return Conversation if found, otherwise NULL
*/
virtual Conversation* getFromUser(const UserId& userId) = 0;
protected:
virtual ~ConversationManager() { /* Empty */ }
};
extern ConversationManager& gConvoManager;
} // namespace Licq
#endif
|