groupdb.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2016-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 RESOURCES_DB_GROUPDB_H
#define RESOURCES_DB_GROUPDB_H
 
#include "enums/resources/servercommandtype.h"
 
#include "enums/simpletypes/skiperror.h"
 
#include <map>
#include <string>
 
#include "localconsts.h"
 
struct GroupInfo;
 
namespace GroupDb
{
    void load();
 
    void unload();
 
    void loadXmlFile(const std::string &fileName,
                     const SkipError skipError);
    const std::string &getName(const int id) A_WARN_UNUSED;
    const std::string &getLongName(const int id) A_WARN_UNUSED;
    bool getShowBadge(const int id) A_WARN_UNUSED;
    bool getHighlightName(const int id) A_WARN_UNUSED;
    const std::string &getBadge(const int id) A_WARN_UNUSED;
    const GroupInfo *getGroup(const int id) A_WARN_UNUSED RETURNS_NONNULL;
    bool isAllowCommand(const ServerCommandTypeT command);
 
    typedef std::map<int, GroupInfo*> GroupInfos;
    typedef GroupInfos::iterator GroupInfosIter;
 
#ifdef UNITTESTS
    GroupDb::GroupInfos &getGroups();
#endif  // UNITTESTS
}  // namespace GroupDb
 
#endif  // RESOURCES_DB_GROUPDB_H