org-tag-eldoc-database.el

   1 ;;; org-tag-eldoc-database.el --- org-tag-eldoc database storage -*- lexical-binding: t; -*-
   2 ;; -*- coding: utf-8 -*-
   3
   4 ;; Copyright (C) 2024-2025 Christopher M. Miles, all rights reserved.
   5
   6 ;;; Commentary:
   7
   8
   9
  10 ;;; Code:
  11 \f
  12 (require 'sqlite nil t)
  13 (require 'org-tag-eldoc-common)
  14
  15
  16 (defcustom org-tag-eldoc-database-file
  17   (expand-file-name ".org-tag-eldoc-database.db" user-emacs-directory)
  18   "The location of org-tag-eldoc SQLite3 database."
  19   :type 'string
  20   :safe #'stringp
  21   :group 'org-tags-eldoc)
  22
  23 (defcustom org-tag-eldoc-database-table-name "default"
  24   "The table name in org-tag-eldoc database."
  25   :type 'string
  26   :safe #'stringp
  27   :group 'org-tags-eldoc)
  28
  29 (defmacro org-tag-eldoc-database--execute-with-db (&rest body)
  30   "A macro for execute BODY with database."
  31   `(if (sqlite-available-p)
  32        (let ((db (sqlite-open org-tag-eldoc-database-file)))
  33          (prog1 db
  34            ,@body
  35            (sqlite-close db)))
  36      (error (format "[org-tag-eldoc] Error: database backend SQLite support of Emacs not available!"))))
  37
  38 ;;; TEST: expand the macro
  39 ;; (macroexpand-all
  40 ;;  '(org-tag-eldoc-database--execute-with-db
  41 ;;    (sqlite-select db "SELECT 1+1;")
  42 ;;    (sqlite-execute db "SELECT 1+1;")))
  43
  44 ;;;###autoload
  45 (defun org-tag-eldoc-database--initlize ()
  46   "Initialize the default SQLite3 database file `org-tag-eldoc-database-file'."
  47   ;; Create the empty SQLite3 database file.
  48   (unless (file-exists-p org-tag-eldoc-database-file)
  49     (shell-command
  50      (format "sqlite3 %s \"VACUUM\";" org-tag-eldoc-database-file))
  51     (org-tag-eldoc-database--execute-with-db
  52      (sqlite-execute
  53       db
  54       (format "CREATE TABLE '%s' (tag VARCHAR, explanation TEXT);"
  55               org-tag-eldoc-database-table-name)))))
  56
  57 ;;;###autoload
  58 (org-tag-eldoc-database--initlize)
  59
  60 (defun org-tag-eldoc-database-query (tag)
  61   "Query TAG for explanation in database."
  62   (org-tag-eldoc-database--execute-with-db
  63    (setq org-tag-eldoc--explanation
  64          (caar
  65           (sqlite-select
  66            db
  67            (format "SELECT explanation from '%s' WHERE tag = '%s';"
  68                    org-tag-eldoc-database-table-name tag)))))
  69   org-tag-eldoc--explanation)
  70
  71 (defun org-tag-eldoc-database-save (tag explanation)
  72   "Save TAG and EXPLANATION into database."
  73   (when (and (stringp explanation)
  74              (not (string-empty-p explanation))
  75              (not (string-equal explanation "nil")))
  76     (org-tag-eldoc-database--execute-with-db
  77      (sqlite-execute
  78       db
  79       (format "INSERT INTO '%s' (tag, explanation) VALUES ('%s', '%s');"
  80               org-tag-eldoc-database-table-name
  81               tag explanation)))
  82     (message "[org-tag-eldoc] Saved tag explanation to database.")
  83     ;; Still return the `explanation' after save to database.
  84     explanation))
  85
  86 (defun org-tag-eldoc-database-clean-empty-rows ()
  87   "Clean and delete all empty explanation rows in database."
  88   (interactive)
  89   (org-tag-eldoc-database--execute-with-db
  90    (sqlite-execute
  91     db
  92     (format "DELETE FROM '%s' WHERE explanation is null or explanation = '';"
  93             org-tag-eldoc-database-table-name)))
  94   (message "[org-tag-eldoc] Clean & deleted all empty records in database 'org-tag-eldoc'."))
  95
  96 (defun org-tag-eldoc-database-open-database-file ()
  97   "Open the org-tag-eldoc SQLite3 database file `org-tag-eldoc-database-file'."
  98   (interactive)
  99   (sqlite-mode-open-file org-tag-eldoc-database-file))
 100
 101 \f
 102
 103 (provide 'org-tag-eldoc-database)
 104
 105 ;;; org-tag-eldoc-database.el ends here