chatmessageparsing.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/chat/chattypes.h"
#include "twitchsdk/core/user/user.h"
#include <vector>
#include <regex>


namespace ttv
{
    namespace chat
    {
        enum TokenRangeEnum
        {
            TOKEN_RANGE_TYPE_URL,
            TOKEN_RANGE_TYPE_MENTION,
            TOKEN_RANGE_TYPE_EMOTICON,
            TOKEN_RANGE_TYPE_BITS
        };

        struct EmoticonRange
        {
            EmoticonId emoticonId;
        };

        struct MentionRange
        {
        };

        struct UrlRange
        {
        };

        struct BitsRange
        {
            uint32_t prefixLength;
            uint32_t numBits;
        };

        struct TokenRange
        {
            TokenRangeEnum type;
            int startIndex;
            int endIndex; // inclusive
            int rangeNum; // To stable sort
            union
            {
                EmoticonRange emoticon;
                MentionRange mention;
                UrlRange url;
                BitsRange bits;
            } data;
        };
        
        bool SortTokenRangesByTypeThenRangeNum(const TokenRange& a, const TokenRange& b);
        bool SortTokenRangesByStartIndex(const TokenRange& a, const TokenRange& b);
        bool SortEmoticonRangesByEmoticonId(const TokenRange& a, const TokenRange& b);

        void RemoveOverlappingRanges(std::vector<TokenRange>& ranges);
        void AdjustByteRangesToUtf8Ranges(std::vector<TokenRange>& ranges, const std::string& message);
        void AdjustUtf8RangesToByteRanges(std::vector<TokenRange>& ranges, const std::string& message);

        struct EmoteRange
        {
            int startIndex;
            int endIndex;
        };

        bool ParseEmotesMessageTag(const std::string& emotesMessageTag, std::map<EmoticonId, std::vector<EmoteRange>>& result);
        bool ParseBadgesMessageTag(const std::string& messageTag, std::vector<std::pair<std::string, std::string>>& result);
        bool GenerateBadgesMessageTag(const std::vector<std::pair<std::string, std::string>>& badges, std::string& result);
        
        bool TokenizeLocalMessage(const std::shared_ptr<User>& user, ChannelId channelId, const std::string& message, std::string& emotesMessageTag, std::string& badgesMessageTag);

        void TokenizeServerMessage(const std::string& message, const TokenizationOptions& tokenizationOptions, const std::string& messageTags, const std::shared_ptr<BitsConfiguration>& bitsConfig, const std::vector<std::string>& localUserNames, MessageInfo& tokenizedMessage);

        void TokenizeServerMessage(const std::string& message, const TokenizationOptions& tokenizationOptions, const std::map<EmoticonId, std::vector<EmoteRange>>& emoticonRanges, const std::vector<std::string>& localUserNames, MessageInfo& tokenizedMessage);
        
        void TokenizeServerMessage(const std::string& message, const TokenizationOptions& tokenizationOptions, const std::map<EmoticonId, std::vector<EmoteRange>>& emoticonRanges, const std::shared_ptr<BitsConfiguration>& bitsConfig, const std::vector<std::string>& localUserNames, MessageInfo& tokenizedMessage);
    }
}