nerix
566 lines
15 KiB
C++
566 lines
15 KiB
C++
#pragma once
|
|
|
|
#include "common/FlagsEnum.hpp"
|
|
#include "messages/ImageSet.hpp"
|
|
#include "messages/Link.hpp"
|
|
#include "messages/MessageColor.hpp"
|
|
#include "providers/links/LinkInfo.hpp"
|
|
#include "singletons/Fonts.hpp"
|
|
|
|
#include <magic_enum/magic_enum.hpp>
|
|
#include <pajlada/signals/signalholder.hpp>
|
|
#include <QRect>
|
|
#include <QString>
|
|
#include <QTime>
|
|
|
|
#include <cstdint>
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
class QJsonObject;
|
|
|
|
namespace chatterino {
|
|
class Channel;
|
|
struct MessageLayoutContainer;
|
|
class MessageLayoutElement;
|
|
|
|
class Image;
|
|
using ImagePtr = std::shared_ptr<Image>;
|
|
|
|
struct Emote;
|
|
using EmotePtr = std::shared_ptr<const Emote>;
|
|
|
|
enum class MessageElementFlag : int64_t {
|
|
None = 0LL,
|
|
Misc = (1LL << 0),
|
|
Text = (1LL << 1),
|
|
|
|
Username = (1LL << 2),
|
|
Timestamp = (1LL << 3),
|
|
|
|
TwitchEmoteImage = (1LL << 4),
|
|
TwitchEmoteText = (1LL << 5),
|
|
TwitchEmote = TwitchEmoteImage | TwitchEmoteText,
|
|
|
|
BttvEmoteImage = (1LL << 6),
|
|
BttvEmoteText = (1LL << 7),
|
|
BttvEmote = BttvEmoteImage | BttvEmoteText,
|
|
|
|
ChannelPointReward = (1LL << 8),
|
|
ChannelPointRewardImage = ChannelPointReward | TwitchEmoteImage,
|
|
|
|
FfzEmoteImage = (1LL << 9),
|
|
FfzEmoteText = (1LL << 10),
|
|
FfzEmote = FfzEmoteImage | FfzEmoteText,
|
|
|
|
SevenTVEmoteImage = (1LL << 34),
|
|
SevenTVEmoteText = (1LL << 35),
|
|
SevenTVEmote = SevenTVEmoteImage | SevenTVEmoteText,
|
|
|
|
EmoteImages =
|
|
TwitchEmoteImage | BttvEmoteImage | FfzEmoteImage | SevenTVEmoteImage,
|
|
EmoteText =
|
|
TwitchEmoteText | BttvEmoteText | FfzEmoteText | SevenTVEmoteText,
|
|
|
|
BitsStatic = (1LL << 11),
|
|
BitsAnimated = (1LL << 12),
|
|
|
|
// Slot 1: Twitch
|
|
// - Staff badge
|
|
// - Admin badge
|
|
// - Global Moderator badge
|
|
BadgeGlobalAuthority = (1LL << 13),
|
|
|
|
// Slot 2: Twitch
|
|
// - Predictions badge
|
|
BadgePredictions = (1LL << 14),
|
|
|
|
// Slot 3: Twitch
|
|
// - VIP badge
|
|
// - Moderator badge
|
|
// - Broadcaster badge
|
|
BadgeChannelAuthority = (1LL << 15),
|
|
|
|
// Slot 4: Twitch
|
|
// - Subscription badges
|
|
BadgeSubscription = (1LL << 16),
|
|
|
|
// Slot 5: Twitch
|
|
// - Turbo badge
|
|
// - Prime badge
|
|
// - Bit badges
|
|
// - Game badges
|
|
BadgeVanity = (1LL << 17),
|
|
|
|
// Slot 6: Chatterino
|
|
// - Chatterino developer badge
|
|
// - Chatterino contributor badge
|
|
// - Chatterino donator badge
|
|
// - Chatterino top donator badge
|
|
// - Chatterino special pepe badge
|
|
// - Chatterino gnome badge
|
|
BadgeChatterino = (1LL << 18),
|
|
|
|
// Slot 7: 7TV
|
|
// - 7TV Admin
|
|
// - 7TV Dungeon Mistress
|
|
// - 7TV Moderator
|
|
// - 7TV Subscriber
|
|
// - 7TV Translator
|
|
// - 7TV Contributor
|
|
BadgeSevenTV = (1LL << 36),
|
|
|
|
// Slot 7: FrankerFaceZ
|
|
// - FFZ developer badge
|
|
// - FFZ bot badge
|
|
// - FFZ donator badge
|
|
BadgeFfz = (1LL << 19),
|
|
|
|
Badges = BadgeGlobalAuthority | BadgePredictions | BadgeChannelAuthority |
|
|
BadgeSubscription | BadgeVanity | BadgeChatterino | BadgeSevenTV |
|
|
BadgeFfz,
|
|
|
|
ChannelName = (1LL << 20),
|
|
|
|
BitsAmount = (1LL << 21),
|
|
|
|
ModeratorTools = (1LL << 22),
|
|
|
|
EmojiImage = (1LL << 23),
|
|
EmojiText = (1LL << 24),
|
|
EmojiAll = EmojiImage | EmojiText,
|
|
|
|
AlwaysShow = (1LL << 25),
|
|
|
|
// used in the ChannelView class to make the collapse buttons visible if
|
|
// needed
|
|
Collapsed = (1LL << 26),
|
|
|
|
// A mention of a username that isn't the author of the message
|
|
Mention = (1LL << 27),
|
|
|
|
// Unused = (1LL << 28),
|
|
|
|
// used to check if links should be lowercased
|
|
LowercaseLinks = (1LL << 29),
|
|
// Unused = (1LL << 30)
|
|
// Unused: (1LL << 31)
|
|
|
|
// for elements of the message reply
|
|
RepliedMessage = (1LL << 32),
|
|
|
|
// for the reply button element
|
|
ReplyButton = (1LL << 33),
|
|
|
|
// (1LL << 34) through (1LL << 36) are occupied by
|
|
// SevenTVEmoteImage, SevenTVEmoteText, and BadgeSevenTV,
|
|
|
|
Default = Timestamp | Badges | Username | BitsStatic | FfzEmoteImage |
|
|
BttvEmoteImage | SevenTVEmoteImage | TwitchEmoteImage |
|
|
BitsAmount | Text | AlwaysShow,
|
|
};
|
|
using MessageElementFlags = FlagsEnum<MessageElementFlag>;
|
|
|
|
class MessageElement
|
|
{
|
|
public:
|
|
virtual ~MessageElement();
|
|
|
|
MessageElement(const MessageElement &) = delete;
|
|
MessageElement &operator=(const MessageElement &) = delete;
|
|
|
|
MessageElement(MessageElement &&) = delete;
|
|
MessageElement &operator=(MessageElement &&) = delete;
|
|
|
|
virtual MessageElement *setLink(const Link &link);
|
|
MessageElement *setTooltip(const QString &tooltip);
|
|
|
|
MessageElement *setTrailingSpace(bool value);
|
|
const QString &getTooltip() const;
|
|
|
|
virtual Link getLink() const;
|
|
bool hasTrailingSpace() const;
|
|
MessageElementFlags getFlags() const;
|
|
void addFlags(MessageElementFlags flags);
|
|
|
|
virtual void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) = 0;
|
|
|
|
virtual QJsonObject toJson() const;
|
|
|
|
protected:
|
|
MessageElement(MessageElementFlags flags);
|
|
bool trailingSpace = true;
|
|
|
|
private:
|
|
Link link_;
|
|
QString tooltip_;
|
|
MessageElementFlags flags_;
|
|
};
|
|
|
|
// contains a simple image
|
|
class ImageElement : public MessageElement
|
|
{
|
|
public:
|
|
ImageElement(ImagePtr image, MessageElementFlags flags);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
ImagePtr image_;
|
|
};
|
|
|
|
// contains a image with a circular background color
|
|
class CircularImageElement : public MessageElement
|
|
{
|
|
public:
|
|
CircularImageElement(ImagePtr image, int padding, QColor background,
|
|
MessageElementFlags flags);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
ImagePtr image_;
|
|
int padding_;
|
|
QColor background_;
|
|
};
|
|
|
|
// contains a text, it will split it into words
|
|
class TextElement : public MessageElement
|
|
{
|
|
public:
|
|
TextElement(const QString &text, MessageElementFlags flags,
|
|
const MessageColor &color = MessageColor::Text,
|
|
FontStyle style = FontStyle::ChatMedium);
|
|
~TextElement() override = default;
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
QStringList words_;
|
|
|
|
MessageColor color_;
|
|
FontStyle style_;
|
|
};
|
|
|
|
// contains a text that will be truncated to one line
|
|
class SingleLineTextElement : public MessageElement
|
|
{
|
|
public:
|
|
SingleLineTextElement(const QString &text, MessageElementFlags flags,
|
|
const MessageColor &color = MessageColor::Text,
|
|
FontStyle style = FontStyle::ChatMedium);
|
|
~SingleLineTextElement() override = default;
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
MessageColor color_;
|
|
FontStyle style_;
|
|
|
|
struct Word {
|
|
QString text;
|
|
int width = -1;
|
|
};
|
|
std::vector<Word> words_;
|
|
};
|
|
|
|
class LinkElement : public TextElement
|
|
{
|
|
public:
|
|
struct Parsed {
|
|
QString lowercase;
|
|
QString original;
|
|
};
|
|
|
|
/// @param parsed The link as it appeared in the message
|
|
/// @param fullUrl A full URL (notably with a protocol)
|
|
LinkElement(const Parsed &parsed, const QString &fullUrl,
|
|
MessageElementFlags flags,
|
|
const MessageColor &color = MessageColor::Text,
|
|
FontStyle style = FontStyle::ChatMedium);
|
|
~LinkElement() override = default;
|
|
LinkElement(const LinkElement &) = delete;
|
|
LinkElement(LinkElement &&) = delete;
|
|
LinkElement &operator=(const LinkElement &) = delete;
|
|
LinkElement &operator=(LinkElement &&) = delete;
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
Link getLink() const override;
|
|
|
|
[[nodiscard]] LinkInfo *linkInfo()
|
|
{
|
|
return &this->linkInfo_;
|
|
}
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
LinkInfo linkInfo_;
|
|
// these are implicitly shared
|
|
QStringList lowercase_;
|
|
QStringList original_;
|
|
};
|
|
|
|
/**
|
|
* @brief Contains a username mention.
|
|
*
|
|
* Examples of mentions:
|
|
* V
|
|
* 13:37 pajlada: hello @forsen
|
|
*
|
|
* V V
|
|
* 13:37 The moderators of this channel are: forsen, nuuls
|
|
*/
|
|
class MentionElement : public TextElement
|
|
{
|
|
public:
|
|
MentionElement(const QString &displayName, QString loginName_,
|
|
MessageColor fallbackColor_, MessageColor userColor_);
|
|
~MentionElement() override = default;
|
|
MentionElement(const MentionElement &) = delete;
|
|
MentionElement(MentionElement &&) = delete;
|
|
MentionElement &operator=(const MentionElement &) = delete;
|
|
MentionElement &operator=(MentionElement &&) = delete;
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
MessageElement *setLink(const Link &link) override;
|
|
Link getLink() const override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
/**
|
|
* The color of the element in case the "Colorize @usernames" is disabled
|
|
**/
|
|
MessageColor fallbackColor;
|
|
|
|
/**
|
|
* The color of the element in case the "Colorize @usernames" is enabled
|
|
**/
|
|
MessageColor userColor;
|
|
|
|
QString userLoginName;
|
|
};
|
|
|
|
// contains emote data and will pick the emote based on :
|
|
// a) are images for the emote type enabled
|
|
// b) which size it wants
|
|
class EmoteElement : public MessageElement
|
|
{
|
|
public:
|
|
EmoteElement(const EmotePtr &data, MessageElementFlags flags_,
|
|
const MessageColor &textElementColor = MessageColor::Text);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags_) override;
|
|
EmotePtr getEmote() const;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
virtual MessageLayoutElement *makeImageLayoutElement(const ImagePtr &image,
|
|
const QSize &size);
|
|
|
|
private:
|
|
std::unique_ptr<TextElement> textElement_;
|
|
EmotePtr emote_;
|
|
};
|
|
|
|
// A LayeredEmoteElement represents multiple Emotes layered on top of each other.
|
|
// This class takes care of rendering animated and non-animated emotes in the
|
|
// correct order and aligning them in the right way.
|
|
class LayeredEmoteElement : public MessageElement
|
|
{
|
|
public:
|
|
struct Emote {
|
|
EmotePtr ptr;
|
|
MessageElementFlags flags;
|
|
};
|
|
|
|
LayeredEmoteElement(
|
|
std::vector<Emote> &&emotes, MessageElementFlags flags,
|
|
const MessageColor &textElementColor = MessageColor::Text);
|
|
|
|
void addEmoteLayer(const Emote &emote);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
// Returns a concatenation of each emote layer's cleaned copy string
|
|
QString getCleanCopyString() const;
|
|
const std::vector<Emote> &getEmotes() const;
|
|
std::vector<Emote> getUniqueEmotes() const;
|
|
const std::vector<QString> &getEmoteTooltips() const;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
MessageLayoutElement *makeImageLayoutElement(
|
|
const std::vector<ImagePtr> &image, const std::vector<QSize> &sizes,
|
|
QSize largestSize);
|
|
|
|
QString getCopyString() const;
|
|
void updateTooltips();
|
|
std::vector<ImagePtr> getLoadedImages(float scale);
|
|
|
|
std::vector<Emote> emotes_;
|
|
std::vector<QString> emoteTooltips_;
|
|
|
|
std::unique_ptr<TextElement> textElement_;
|
|
MessageColor textElementColor_;
|
|
};
|
|
|
|
class BadgeElement : public MessageElement
|
|
{
|
|
public:
|
|
BadgeElement(const EmotePtr &data, MessageElementFlags flags_);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags_) override;
|
|
|
|
EmotePtr getEmote() const;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
virtual MessageLayoutElement *makeImageLayoutElement(const ImagePtr &image,
|
|
const QSize &size);
|
|
|
|
private:
|
|
EmotePtr emote_;
|
|
};
|
|
|
|
class ModBadgeElement : public BadgeElement
|
|
{
|
|
public:
|
|
ModBadgeElement(const EmotePtr &data, MessageElementFlags flags_);
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
MessageLayoutElement *makeImageLayoutElement(const ImagePtr &image,
|
|
const QSize &size) override;
|
|
};
|
|
|
|
class VipBadgeElement : public BadgeElement
|
|
{
|
|
public:
|
|
VipBadgeElement(const EmotePtr &data, MessageElementFlags flags_);
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
MessageLayoutElement *makeImageLayoutElement(const ImagePtr &image,
|
|
const QSize &size) override;
|
|
};
|
|
|
|
class FfzBadgeElement : public BadgeElement
|
|
{
|
|
public:
|
|
FfzBadgeElement(const EmotePtr &data, MessageElementFlags flags_,
|
|
QColor color_);
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
protected:
|
|
MessageLayoutElement *makeImageLayoutElement(const ImagePtr &image,
|
|
const QSize &size) override;
|
|
const QColor color;
|
|
};
|
|
|
|
// contains a text, formated depending on the preferences
|
|
class TimestampElement : public MessageElement
|
|
{
|
|
public:
|
|
TimestampElement();
|
|
TimestampElement(QTime time_);
|
|
~TimestampElement() override = default;
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
TextElement *formatTime(const QTime &time);
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
QTime time_;
|
|
std::unique_ptr<TextElement> element_;
|
|
QString format_;
|
|
};
|
|
|
|
// adds all the custom moderation buttons, adds a variable amount of items
|
|
// depending on settings fourtf: implement
|
|
class TwitchModerationElement : public MessageElement
|
|
{
|
|
public:
|
|
TwitchModerationElement();
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
};
|
|
|
|
// Forces a linebreak
|
|
class LinebreakElement : public MessageElement
|
|
{
|
|
public:
|
|
LinebreakElement(MessageElementFlags flags);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
};
|
|
|
|
// Image element which will pick the quality of the image based on ui scale
|
|
class ScalingImageElement : public MessageElement
|
|
{
|
|
public:
|
|
ScalingImageElement(ImageSet images, MessageElementFlags flags);
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
|
|
private:
|
|
ImageSet images_;
|
|
};
|
|
|
|
class ReplyCurveElement : public MessageElement
|
|
{
|
|
public:
|
|
ReplyCurveElement();
|
|
|
|
void addToContainer(MessageLayoutContainer &container,
|
|
MessageElementFlags flags) override;
|
|
|
|
QJsonObject toJson() const override;
|
|
};
|
|
|
|
} // namespace chatterino
|
|
|
|
template <>
|
|
struct magic_enum::customize::enum_range<chatterino::MessageElementFlag> {
|
|
static constexpr bool is_flags = true; // NOLINT(readability-identifier-*)
|
|
};
|