sl-chat-log-parser 0.2.2

Parser for SL viewer chat logs (Firestorm in particular but might work for others too)
Documentation 
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

//! Avatar related messages (those sent by an avatar as well as some system messages about an avatar like coming online or entering chat range)

use chumsky::IterParser as _;
use chumsky::Parser;
use chumsky::prelude::{any, choice, just};

/// represents a Second Life avatar related message
#[derive(Debug, Clone, PartialEq)]
pub enum AvatarMessage {
    /// a message about the avatar whispering, saying or shouting something
    Chat {
        /// how "loud" the message was (whisper, say, shout or region say)
        volume: sl_types::chat::ChatVolume,
        /// the chat message
        message: String,
    },
    /// an emote (chat message starting with /me in the log)
    Emote {
        /// how "loud" the message was (whisper, say, shout or region say)
        volume: sl_types::chat::ChatVolume,
        /// the chat message without the /me
        message: String,
    },
    /// a message about an avatar coming online
    CameOnline,
    /// a message about an avatar going offline
    WentOffline,
    /// a message about an avatar entering an area of significance
    EnteredArea {
        /// the area of significance
        area: sl_types::radar::Area,
        /// the distance where the avatar entered the area
        distance: Option<sl_types::map::Distance>,
    },
    /// a message about an avatar leaving an area of significance
    LeftArea {
        /// the area of significance
        area: sl_types::radar::Area,
    },
}

/// parse a Second Life avatar chat message
///
/// # Errors
///
/// returns an error if the parser fails
fn avatar_chat_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    any()
        .repeated()
        .collect::<String>()
        .try_map(|s, _span: chumsky::span::SimpleSpan| {
            let (v, s) = sl_types::chat::ChatVolume::volume_and_message(s.to_string());
            Ok(AvatarMessage::Chat {
                volume: v,
                message: s,
            })
        })
}

/// parse a Second Life avatar emote message
///
/// # Errors
///
/// returns an error if the parser fails
fn avatar_emote_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    just("/me ")
        .ignore_then(any().repeated().collect::<String>())
        .try_map(|s, _span: chumsky::span::SimpleSpan| {
            let (v, s) = sl_types::chat::ChatVolume::volume_and_message(s);
            Ok(AvatarMessage::Emote {
                volume: v,
                message: s,
            })
        })
}

/// parse a message about an avatar coming online
///
/// # Errors
///
/// returns an error if the parser fails
#[must_use]
pub fn avatar_came_online_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    just("is online.").map(|_| AvatarMessage::CameOnline)
}

/// parse a message about an avatar going offline
///
/// # Errors
///
/// returns an error if the parser fails
#[must_use]
pub fn avatar_went_offline_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    just("is offline.").map(|_| AvatarMessage::WentOffline)
}

/// parse a message about an avatar entering an area of significance
///
/// # Errors
///
/// returns an error if the parser fails
#[must_use]
pub fn avatar_entered_area_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    just("entered ")
        .ignore_then(sl_types::radar::area_parser())
        .then(
            just(" (")
                .ignore_then(sl_types::map::distance_parser())
                .then_ignore(just(")"))
                .or_not(),
        )
        .then_ignore(just("."))
        .try_map(|(area, distance), _span: chumsky::span::SimpleSpan| {
            Ok(AvatarMessage::EnteredArea { area, distance })
        })
}

/// parse a message about an avatar leaving an area of significance
///
/// # Errors
///
/// returns an error if the parser fails
#[must_use]
pub fn avatar_left_area_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    just("left ")
        .ignore_then(sl_types::radar::area_parser())
        .then_ignore(just("."))
        .try_map(|area, _span: chumsky::span::SimpleSpan| Ok(AvatarMessage::LeftArea { area }))
}

/// parse a Second Life avatar message
///
/// # Errors
///
/// returns an error if the parser fails
#[must_use]
pub fn avatar_message_parser<'src>()
-> impl Parser<'src, &'src str, AvatarMessage, chumsky::extra::Err<chumsky::error::Rich<'src, char>>>
{
    choice([
        avatar_came_online_message_parser().boxed(),
        avatar_went_offline_message_parser().boxed(),
        avatar_entered_area_message_parser().boxed(),
        avatar_left_area_message_parser().boxed(),
        avatar_emote_message_parser().boxed(),
        avatar_chat_message_parser().boxed(),
    ])
}