ement.el/ement-structs.el

;;; ement-structs.el --- Ement structs               -*- lexical-binding: t; -*-

;; Copyright (C) 2020  Adam Porter

;; Author: Adam Porter <adam@alphapapa.net>
;; Keywords: comm

;; 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 <https://www.gnu.org/licenses/>.

;;; Commentary:

;;

;;; Code:

;;;; Debugging

;; NOTE: Uncomment this form and `emacs-lisp-byte-compile-and-load' the file to enable
;; `ement-debug' messages.  This is commented out by default because, even though the
;; messages are only displayed when `warning-minimum-log-level' is `:debug' at runtime, if
;; that is so at expansion time, the expanded macro calls format the message and check the
;; log level at runtime, which is not zero-cost.

;; (eval-and-compile
;;   (setq-local warning-minimum-log-level nil)
;;   (setq-local warning-minimum-log-level :debug))

;;;; Requirements

(require 'cl-lib)

;;;; Structs

(cl-defstruct ement-user
  id displayname account-data
  (color nil :documentation "Color in which to display user's name.")
  (message-color nil :documentation "Color in which to display user's messages.")
  (username nil
            ;; NOTE: Not exactly according to spec, I guess, but useful for now.
            :documentation "Username part of user's Matrix ID.")
  (avatar-url nil :documentation "MXC URL to user's avatar.")
  (avatar nil :documentation "One-space string with avatar image in display property.")
  (room-display-names (make-hash-table) :documentation "Hash table mapping rooms to the user's per-room display name."))

(cl-defstruct ement-event
  id sender content origin-server-ts type unsigned state-key
  receipts
  ;; The local slot is an alist used by the local client only.
  local)

(cl-defstruct ement-server
  name uri-prefix)

(cl-defstruct ement-session
  user server token transaction-id rooms next-batch
  device-id initial-device-display-name has-synced-p
  account-data
  ;; Hash table of all seen events, keyed on event ID.
  events)

(cl-defstruct ement-room
  id display-name prev-batch
  summary state timeline ephemeral account-data unread-notifications
  latest-ts topic canonical-alias avatar status type invite-state
  (members (make-hash-table :test #'equal) :documentation "Hash table mapping joined user IDs to user structs.")
  ;; The local slot is an alist used by the local client only.
  local
  (receipts (make-hash-table :test #'equal)))

;;;; Variables


;;;; Customization


;;;; Commands


;;;; Functions


;;;; Footer

(provide 'ement-structs)

;;; ement-structs.el ends here