/usr/include/licq/contactlist/group.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 159 160 161 162 163 | /*
* 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_CONTACTLIST_GROUP_H
#define LICQ_CONTACTLIST_GROUP_H
#include <boost/noncopyable.hpp>
#include <string>
#include "../thread/lockable.h"
namespace Licq
{
class UserId;
/**
* Class holding data for a user group in the contact list.
* System groups only exists as a bitmask in LicqUser.
*
* Note: LicqGroup objects should only be created, deleted or modified from the
* user manager. If set functions are called directly, plugins will not receive
* any signal notifying them of the change.
*/
class Group : public Lockable, private boost::noncopyable
{
public:
/**
* Get id for group. This is an id used locally by Licq and is persistant for
* each group.
*
* @return Group id
*/
int id() const
{ return myId; }
/**
* Get name of group as should be displayed in the user interface
*
* @return Group name
*/
const std::string& name() const
{ return myName; }
/**
* Get sorting index for the group. This is used by user interface plugins to
* determine sorting order for the groups. Lower numbers should be displayed
* higher in the list.
*
* @return Sorting index for this group
*/
int sortIndex() const
{ return mySortIndex; }
/**
* Group id for this group at the server side
*
* @param ownerId Id of owner to get group id for
* @return Server side group id or 0 if not set or not known
*/
virtual unsigned long serverId(const UserId& ownerId) const = 0;
/**
* Set group name
*
* @param name New group name
*/
void setName(const std::string& name) { myName = name; }
/**
* Set sorting index for group
*
* @param sortIndex Group sorting index
*/
void setSortIndex(int sortIndex) { mySortIndex = sortIndex; }
/**
* Set server side id for this group
*
* @param ownerId Id of owner to set group id for
* @param serverId Id for this group on server side list
*/
virtual void setServerId(const UserId& ownerId, unsigned long serverId) = 0;
/**
* Remove a server side id for this group
*
* @param ownerId Id of owner to clear group id for
*/
virtual void unsetServerId(const UserId& ownerId) = 0;
protected:
virtual ~Group() { /* Empty */ }
int myId;
std::string myName;
int mySortIndex;
};
/**
* Read mutex guard for Licq::Group
*/
class GroupReadGuard : public ReadMutexGuard<Group>
{
public:
/**
* Constructor, will fetch and lock a group based on group id
* Note: Always check that the group was actually fetched before using
*
* @param groupId Id of group to fetch
*/
GroupReadGuard(int groupId);
// Derived constructors
GroupReadGuard(const Group* group, bool locked = false)
: ReadMutexGuard<Group>(group, locked)
{ }
GroupReadGuard(ReadMutexGuard<Group>* guard)
: ReadMutexGuard<Group>(guard)
{ }
};
/**
* Write mutex guard for Licq::Group
*/
class GroupWriteGuard : public WriteMutexGuard<Group>
{
public:
/**
* Constructor, will fetch and lock a group based on group id
* Note: Always check that the group was actually fetched before using
*
* @param groupId Id of group to fetch
*/
GroupWriteGuard(int groupId);
// Derived constructors
GroupWriteGuard(Group* group, bool locked = false)
: WriteMutexGuard<Group>(group, locked)
{ }
GroupWriteGuard(WriteMutexGuard<Group>* guard)
: WriteMutexGuard<Group>(guard)
{ }
};
} // namespace Licq
#endif // LICQ_CONTACTLIST_GROUP_H
|