guild.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2004-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * This program 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
 * any later version.
 *
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GUILD_H
#define GUILD_H
 
#include "gui/models/avatarlistmodel.h"
 
#include "utils/cast.h"
#include "utils/dtor.h"
#include "utils/stringvector.h"
 
#include <map>
 
class Guild;
 
typedef std::map<unsigned, std::string> PositionsMap;
 
class GuildMember final : public Avatar
{
 public:
 A_DELETE_COPY(GuildMember)
 
 const Guild *getGuild() const noexcept2 A_WARN_UNUSED
 { return mGuild; }
 
 int getPos() const noexcept2 A_WARN_UNUSED
 { return mPos; }
 
 void setPos(const int pos)
 { mPos = pos; }
 
 std::string getAdditionString() const override final A_WARN_UNUSED;
 
 protected:
 friend class Guild;
 
 GuildMember(Guild *const guild,
 const BeingId accountId,
 const int charId,
 const std::string &name);
 
 GuildMember(Guild *const guild, const std::string &name);
 
 Guild *mGuild;
 int mPos;
};
 
class Guild final : public AvatarListModel
{
 public:
 A_DELETE_COPY(Guild)
 
 ~Guild() override final;
 
 void setName(const std::string &name)
 { mName = name; }
 
 GuildMember *addMember(const BeingId accountId,
 const int charId,
 const std::string &name);
 
 GuildMember *addMember(const std::string &name);
 
 GuildMember *getMember(const BeingId id) const;
 
 GuildMember *getMember(const BeingId accountId,
 const int charId)
 const A_WARN_UNUSED;
 
 GuildMember *getMemberByCharId(const int charId) const A_WARN_UNUSED;
 
 GuildMember *getMember(const std::string &name) const A_WARN_UNUSED;
 
 const std::string &getName() const noexcept2 A_WARN_UNUSED
 { return mName; }
 
 int16_t getId() const noexcept2 A_WARN_UNUSED
 { return mId; }
 
 void removeMember(const GuildMember *const member);
 
 void removeMember(const BeingId id);
 
 void removeMember(const std::string &name);
 
 void removeFromMembers();
 
 void clearMembers()
 { delete_all(mMembers); mMembers.clear(); }
 
 int getNumberOfElements() override final A_WARN_UNUSED
 { return CAST_S32(mMembers.size()); }
 
 Avatar *getAvatarAt(const int index) override final A_WARN_UNUSED;
 
 bool getInviteRights() const noexcept2 A_WARN_UNUSED
 { return mCanInviteUsers; }
 
 void setRights(const int16_t rights);
 
 bool isMember(const GuildMember *const member) const A_WARN_UNUSED;
 
 bool isMember(const BeingId id) const A_WARN_UNUSED;
 
 bool isMember(const std::string &name) const A_WARN_UNUSED;
 
 void getNames(StringVect &names) const;
 
 void addPos(const int id, const std::string &name);
 
 void sort();
 
 std::string getPos(const int id) const A_WARN_UNUSED;
 
 static Guild *getGuild(const int16_t id) A_WARN_UNUSED;
 
 const PositionsMap &getPositions() const noexcept2 A_WARN_UNUSED
 { return mPositions; }
 
 void setEmblemId(const int id)
 { mEmblemId = id; }
 
 int getEmblemId() const noexcept2 A_WARN_UNUSED
 { return mEmblemId; }
 
 static void clearGuilds();
 
 void setServerGuild(const bool b)
 { mServerGuild = b; }
 
 bool getServerGuild() const noexcept2 A_WARN_UNUSED
 { return mServerGuild; }
 
 typedef STD_VECTOR<GuildMember*> MemberList;
 
 const MemberList *getMembers() const RETURNS_NONNULL A_WARN_UNUSED
 { return &mMembers; }
 
 private:
 typedef std::map<int, Guild*> GuildMap;
 static GuildMap guilds;
 
 explicit Guild(const int16_t id);
 
 MemberList mMembers;
 PositionsMap mPositions;
 std::string mName;
 int mEmblemId;
 int16_t mId;
 bool mCanInviteUsers;
 bool mServerGuild;
};
 
#endif // GUILD_H