;;; my-org-remark.el -- customization to org-remark -*- lexical-binding: t -*-

;; Copyright (C) 2025  Free Software Foundation, Inc.

;; Author: Yuchen Pei <id@ypei.org>
;; Package-Requires: ((emacs "29.4"))

;; This file is part of dotted.

;; dotted is free software: you can redistribute it and/or modify it under
;; the terms of the GNU Affero General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; dotted 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 Affero General
;; Public License for more details.

;; You should have received a copy of the GNU Affero General Public
;; License along with dotted.  If not, see <https://www.gnu.org/licenses/>.

;;; Commentary:

;; customization to org-remark.

;;; Code:


;;; override `org-remark-highlight-add-or-update-highlight-headline'
(defun my-org-remark-highlight-add-or-update-highlight-headline (highlight source-buf notes-buf)
  "Add a new HIGHLIGHT headlne to the NOTES-BUF or update it.
Return notes-props as a property list.

HIGHLIGHT is an overlay from the SOURCE-BUF.

Assume the current buffer is NOTES-BUF and point is placed on the
beginning of source-headline, which should be one level up."
  ;; Add org-remark-link with updated line-num as a property
  (let (title beg end props id text filename link orgid org-remark-type other-props)
    (with-current-buffer source-buf
      (setq title (org-remark-highlight-get-title)
            beg (overlay-start highlight)
            end (overlay-end highlight)
            props (overlay-properties highlight)
            id (plist-get props 'org-remark-id)
            org-remark-type (overlay-get highlight 'org-remark-type)
            text (org-with-wide-buffer
                  (org-remark-highlight-headline-text highlight org-remark-type))
            filename (org-remark-source-get-file-name
                      (org-remark-source-find-file-name))
            link (run-hook-with-args-until-success
                  'org-remark-highlight-link-to-source-functions filename beg)
            orgid (org-remark-highlight-get-org-id beg)
            other-props (org-remark-highlight-collect-other-props highlight))
      ;; TODO ugly to add the beg end after setq above
      (plist-put props org-remark-prop-source-beg (number-to-string beg))
      (plist-put props org-remark-prop-source-end (number-to-string end))
      (when link (plist-put props "org-remark-link" link))
      (when other-props (setq props (append props other-props))))
    ;;; Make it explicit that we are now in the notes-buf, though it is
    ;;; functionally redundant.
    (with-current-buffer notes-buf
      (let ((highlight-headline (org-find-property org-remark-prop-id id))
            ;; Assume point is at the beginning of the parent headline
            (level (1+ (org-current-level))))
        (if highlight-headline
            (progn
              (goto-char highlight-headline)
              ;; Update the existing headline and position properties
              ;; Don't update the headline text when it already exists.
              ;; Let the user decide how to manage the headlines
              ;; (org-edit-headline text)
              (org-remark-notes-set-properties props))
          ;; No headline with the marginal notes ID property. Create a new one
          ;; at the end of the file's entry
          (org-narrow-to-subtree)
          (goto-char (point-max))
          ;; Ensure to be in the beginning of line to add a new headline
          (when (eolp) (open-line 1) (forward-line 1) (beginning-of-line))
          ;; Create a headline
          ;; Add a properties
          (insert (concat (insert-char (string-to-char "*") level)
                          " " (my-elide-text text fill-column) "\n"))
          ;; org-remark-original-text should be added only when this
          ;; headline is created. No update afterwards
          (plist-put props "org-remark-original-text" text)
          (org-remark-notes-set-properties props)
          (when (and orgid org-remark-use-org-id)
            (insert (concat "[[id:" orgid "]" "[" title "]]"))))
        (list :body (org-remark-notes-get-body)
              :original-text text)))))

(defun my-org-remark-open-or-create ()
  (interactive)
  (if mark-active
      (call-interactively 'org-remark-mark)
    (call-interactively 'org-remark-open)))

(provide 'my-org-remark)
;;; my-org-remark.el ends here