gomuks/interface/ui.go

121 lines
2.7 KiB
Go
Raw Normal View History

2018-03-18 20:24:03 +01:00
// gomuks - A terminal Matrix client written in Go.
// Copyright (C) 2018 Tulir Asokan
//
// 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 3 of the License, or
// (at your option) 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/>.
package ifc
import (
"time"
2018-03-18 20:24:03 +01:00
"maunium.net/go/gomatrix"
"maunium.net/go/gomuks/matrix/pushrules"
"maunium.net/go/gomuks/matrix/rooms"
"maunium.net/go/tcell"
2018-03-18 20:24:03 +01:00
)
type UIProvider func(gmx Gomuks) GomuksUI
2018-03-18 20:24:03 +01:00
type GomuksUI interface {
Render()
2018-05-01 18:17:57 +02:00
OnLogin()
OnLogout()
2018-03-18 20:24:03 +01:00
MainView() MainView
Init()
Start() error
Stop()
Finish()
2018-03-18 20:24:03 +01:00
}
type MainView interface {
GetRoom(roomID string) RoomView
AddRoom(room *rooms.Room)
RemoveRoom(room *rooms.Room)
2018-04-24 15:51:40 +02:00
SetRooms(rooms map[string]*rooms.Room)
2018-03-22 18:51:20 +01:00
SaveAllHistory()
2018-03-18 20:24:03 +01:00
2018-04-24 01:13:17 +02:00
UpdateTags(room *rooms.Room, newTags []rooms.RoomTag)
2018-03-18 20:24:03 +01:00
SetTyping(roomID string, users []string)
ParseEvent(roomView RoomView, evt *gomatrix.Event) Message
NotifyMessage(room *rooms.Room, message Message, should pushrules.PushActionArrayShould)
InitialSyncDone()
2018-03-18 20:24:03 +01:00
}
2018-03-22 22:03:45 +01:00
type MessageDirection int
const (
2018-04-19 10:10:34 +02:00
AppendMessage MessageDirection = iota
PrependMessage
IgnoreMessage
)
type RoomView interface {
MxRoom() *rooms.Room
SaveHistory(dir string) error
LoadHistory(matrix MatrixContainer, dir string) (int, error)
2018-04-21 18:41:19 +02:00
SetCompletions(completions []string)
SetTyping(users []string)
UpdateUserList()
NewMessage(id, sender, msgtype, text string, timestamp time.Time) Message
NewTempMessage(msgtype, text string) Message
AddMessage(message Message, direction MessageDirection)
AddServiceMessage(message string)
}
type MessageMeta interface {
Sender() string
SenderColor() tcell.Color
TextColor() tcell.Color
TimestampColor() tcell.Color
Timestamp() time.Time
FormatTime() string
FormatDate() string
}
// MessageState is an enum to specify if a Message is being sent, failed to send or was successfully sent.
type MessageState int
// Allowed MessageStates.
const (
MessageStateSending MessageState = iota
MessageStateDefault
MessageStateFailed
)
type Message interface {
MessageMeta
SetIsHighlight(isHighlight bool)
IsHighlight() bool
SetIsService(isService bool)
IsService() bool
SetID(id string)
ID() string
SetType(msgtype string)
Type() string
NotificationContent() string
SetState(state MessageState)
State() MessageState
}