comparison lisp/textmodes/org.el @ 69121:39ec690b89d6

(org-xemacs-p, org-export-html-show-new-buffer, org-table-may-need-update, org-insert-item, org-mhe-get-message-real-folder, org-mhe-get-message-folder-from-index, org-mhe-get-message-folder, org-mhe-get-message-num, org-mhe-get-header, org-make-org-heading-search-string, org-make-org-heading-camel, org-table-sort-lines, org-format-org-table-html, org-format-table-table-html): Fix typos in docstrings.

69120:c25ca738fe29

;; The following two constants are for compatibility with different Emacs
;; versions (Emacs versus XEmacs) and with different versions of outline.el.
;; The compatibility code in org.el is based on these two constants.
(defconst org-xemacs-p (featurep 'xemacs)
  "Are we running xemacs?")
(defconst org-noutline-p (featurep 'noutline)
  "Are we using the new outline mode?")

(defgroup org nil
  "Outline-based notes management and organizer."

Otherwise the buffer will just be saved to a file and stay hidden."
  :group 'org-export
  :type 'boolean)

(defcustom org-export-html-show-new-buffer nil
  "Non-nil means,  popup buffer containing the exported html text.
Otherwise, the buffer will just be saved to a file and stay hidden."
  :group 'org-export
  :type 'boolean)

(defcustom org-combined-agenda-icalendar-file "~/org.ics"

;; We use a before-change function to check if a table might need
;; an update.
(defvar org-table-may-need-update t
  "Indicates that a table might need an update.
This variable is set by `org-before-change-function'. `org-table-align'
sets it back to nil.")
(defvar org-mode-hook nil)
(defvar org-inhibit-startup nil)        ; Dynamically-scoped param.
(defvar org-agenda-keep-modes nil)      ; Dynamically-scoped param.

	(insert " "))
      (run-hooks 'org-insert-heading-hook))))

(defun org-insert-item ()
  "Insert a new item at the current level.
Return t when tings worked, nil when we are not in an item."
  (when (save-excursion
	  (condition-case nil
	      (progn
		(org-beginning-of-item)
		(org-at-item-p)

		   (camel
		    (setq type :camel)
		    (save-excursion
		      (goto-char (point-min))
		      (while (re-search-forward org-todo-line-regexp nil t)
			(push (list 
			       (if org-file-link-context-use-camel-case
				   (org-make-org-heading-camel (match-string 3) t)
				 (org-make-org-heading-search-string
				  (match-string 3) t)))
			      tbl)))

(defun org-mark-ring-push (&optional pos buffer)
  "Put the current position or POS into the mark ring and rotate it."
  (interactive)
  (setq pos (or pos (point)))
  (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  (move-marker (car org-mark-ring) 
	       (or pos (point))
	       (or buffer (current-buffer)))
  (message
   (substitute-command-keys
    "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))

      (error "Message not found"))))

;; mh-e integration based on planner-mode
(defun org-mhe-get-message-real-folder ()
  "Return the name of the current message real folder, so if you use
  sequences, it will now work."
  (save-excursion
    (let* ((folder
            (if (equal major-mode 'mh-folder-mode)
                mh-current-folder
              ;; Refer to the show buffer
              mh-show-folder-buffer))
           (end-index 
            (if (boundp 'mh-index-folder)
                (min (length mh-index-folder) (length folder))))
           )
      ;; a simple test on mh-index-data does not work, because
      ;; mh-index-data is always nil in a show buffer.

        folder
        )
      )))

(defun org-mhe-get-message-folder-from-index ()
  "Returns the name of the message folder in a index folder
  buffer."
  (save-excursion
    (mh-index-previous-folder)
    (if (not (re-search-forward "^\\(+.*\\)$" nil t))
        (message "Problem getting folder from index.")
      (message (match-string 1)))))

(defun org-mhe-get-message-folder ()
  "Return the name of the current message folder. Be careful if you
  use sequences."
  (save-excursion
    (if (equal major-mode 'mh-folder-mode)
        mh-current-folder
      ;; Refer to the show buffer
      mh-show-folder-buffer)))

(defun org-mhe-get-message-num ()
  "Return the number of the current message. Be careful if you
  use sequences."
  (save-excursion
    (if (equal major-mode 'mh-folder-mode)
        (mh-get-msg-num nil)
      ;; Refer to the show buffer
      (mh-show-buffer-message-number))))

(defun org-mhe-get-header (header)
  "Return a header of the message in folder mode. This will create a
  show buffer for the corresponding message. If you have a more clever
  idea..."
  (let* ((folder (org-mhe-get-message-folder))
         (num (org-mhe-get-message-num))
         (buffer (get-buffer-create (concat "show-" folder)))
         (header-field))
  (with-current-buffer buffer

  (let* ((show-buf (concat "show-" folder)))
    (mh-visit-folder folder)
    (get-buffer-create show-buf)
    (mh-show-msg
     (string-to-number
      (car (split-string 
	    (with-temp-buffer
	      (call-process
	       (expand-file-name "pick" mh-progs)
	       nil t nil
	       folder

	    (to-header (org-mhe-get-header "To:"))
	    (subject (org-mhe-get-header "Subject:")))
	(setq cpltxt (concat from-header " on: " subject))
	(setq link (concat cpltxt "\n  "
			   (org-make-link
			    "mhe:" (org-mhe-get-message-real-folder) "#" 
			    (org-remove-angle-brackets
			     (org-mhe-get-header "Message-Id:")))))))

     ((eq major-mode 'rmail-mode)
      (save-excursion

     ((interactive-p)
      (error "Cannot link to a buffer which is not visiting a file"))

     (t (setq link nil)))
    
    (if (and (interactive-p) link)
	(progn
	  (setq org-stored-links
		(cons (cons (or cpltxt link) link) org-stored-links))
	  (message "Stored: %s" (or cpltxt link)))
      link)))

(defun org-make-org-heading-search-string (&optional string heading)
  "Make search string for S or current headline."
  (interactive)
  (let ((s (or string (org-get-heading))))
    (unless (and string (not heading))
      ;; We are using a headline, clean up garbage in there.
      (if (string-match org-todo-regexp s)

      (setq s (replace-match " " t t s)))
    (or string (setq s (concat "*" s)))  ; Add * for headlines
    (mapconcat 'identity (org-split-string s "[ \t]+") " ")))

(defun org-make-org-heading-camel (&optional string heading)
  "Make a CamelCase string for S or the current headline."
  (interactive)
  (let ((s (or string (org-get-heading))))
    (unless (and string (not heading))
      ;; We are using a headline, clean up garbage in there.
      (if (string-match org-todo-regexp s)

  "Sort table lines in region.
Point and mark define the first and last line to include.  Both point and
mark should be in the column that is used for sorting.  For example, to
sort according to column 3, put the mark in the first line to sort, in
table column 3.  Put point into the last line to be included in the sorting,
also in table column 3. The command will prompt for the sorting method (n for
numerical, a for alphanumeric)."
  (interactive "r\nsSorting method: [n]=numeric [a]=alpha: ")
  (setq numericp (string-match "[nN]" numericp))
  (org-table-align) ;; Just to be safe
  (let* (bcol ecol cmp column lns)
    (goto-char beg)

	    (setq c (string-to-char (match-string 1 fmt))
		  n (string-to-number (or (match-string 1 fmt) "")))
	    (if (= c ?p) (setq modes (org-set-calc-mode 'calc-internal-prec n))
	      (setq modes (org-set-calc-mode
			   'calc-float-format
			   (list (cdr (assoc c '((?n. float) (?f. fix)
						 (?s. sci) (?e. eng))))
				 n))))
	    (setq fmt (replace-match "" t t fmt)))
	  (while (string-match "[DRFS]" fmt)
	    (setq modes (org-set-calc-mode (match-string 0 fmt)))
	    (setq fmt (replace-match "" t t fmt)))

	  ;; make targets to anchors
	  (while (string-match "<<<?\\([^<>]*\\)>>>?[ \t]*\n?" line)
	    (setq line (replace-match
			(concat "@<a name=\"" 
				(org-solidify-link-text (match-string 1 line))
				"\">\\nbsp@</a>")
			t t line)))
	  ;; Replace internal links
	  (while (string-match org-bracket-link-regexp line)
	    (setq line (replace-match
			(concat
			    "@<a href=\"#" 
			    (org-solidify-link-text (match-string 1 line))
			    "\">"
			    (match-string (if (match-end 3) 3 1) line)
			    "@</a>")
			t t line)))

	  (org-format-table-table-html lines)
	;; Need to use the code generator in table.el, with the original text.
	(org-format-table-table-html-using-table-generate-source olines)))))

(defun org-format-org-table-html (lines)
  "Format a table into html."
  (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  (setq lines (nreverse lines))
  (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  (setq lines (nreverse lines))
  (when org-export-table-remove-special-lines

			     nil ; ignore this line
			   (and (or (string-match "^[ \t]*|-+\\+" x)
				    (string-match "^[ \t]*|[^|]*|" x))
				(replace-match "|" t t x))))
		       lines))))))
  
  (let ((head (and org-export-highlight-first-table-line
		   (delq nil (mapcar
			      (lambda (x) (string-match "^[ \t]*|-" x))
			      (cdr lines)))))
	line fields html)

      (if (not (eq (aref newstr i) ?|))
	  (aset newstr i ?\ )))
    newstr))

(defun org-format-table-table-html (lines)
  "Format a table generated by table.el into html.
This conversion does *not* use `table-generate-source' from table.el.
This has the advantage that Org-mode's HTML conversions can be used.
But it has the disadvantage, that no cell- or row-spanning is allowed."
  (let (line field-buffer
	     (head org-export-highlight-first-table-line)

69121:39ec690b89d6

;; The following two constants are for compatibility with different Emacs
;; versions (Emacs versus XEmacs) and with different versions of outline.el.
;; The compatibility code in org.el is based on these two constants.
(defconst org-xemacs-p (featurep 'xemacs)
  "Are we running XEmacs?")
(defconst org-noutline-p (featurep 'noutline)
  "Are we using the new outline mode?")

(defgroup org nil
  "Outline-based notes management and organizer."

Otherwise the buffer will just be saved to a file and stay hidden."
  :group 'org-export
  :type 'boolean)

(defcustom org-export-html-show-new-buffer nil
  "Non-nil means, popup buffer containing the exported HTML text.
Otherwise, the buffer will just be saved to a file and stay hidden."
  :group 'org-export
  :type 'boolean)

(defcustom org-combined-agenda-icalendar-file "~/org.ics"

;; We use a before-change function to check if a table might need
;; an update.
(defvar org-table-may-need-update t
  "Indicates that a table might need an update.
This variable is set by `org-before-change-function'.
`org-table-align'sets it back to nil.")
(defvar org-mode-hook nil)
(defvar org-inhibit-startup nil)        ; Dynamically-scoped param.
(defvar org-agenda-keep-modes nil)      ; Dynamically-scoped param.

	(insert " "))
      (run-hooks 'org-insert-heading-hook))))

(defun org-insert-item ()
  "Insert a new item at the current level.
Return t when things worked, nil when we are not in an item."
  (when (save-excursion
	  (condition-case nil
	      (progn
		(org-beginning-of-item)
		(org-at-item-p)

		   (camel
		    (setq type :camel)
		    (save-excursion
		      (goto-char (point-min))
		      (while (re-search-forward org-todo-line-regexp nil t)
			(push (list
			       (if org-file-link-context-use-camel-case
				   (org-make-org-heading-camel (match-string 3) t)
				 (org-make-org-heading-search-string
				  (match-string 3) t)))
			      tbl)))

(defun org-mark-ring-push (&optional pos buffer)
  "Put the current position or POS into the mark ring and rotate it."
  (interactive)
  (setq pos (or pos (point)))
  (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
  (move-marker (car org-mark-ring)
	       (or pos (point))
	       (or buffer (current-buffer)))
  (message
   (substitute-command-keys
    "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))

      (error "Message not found"))))

;; mh-e integration based on planner-mode
(defun org-mhe-get-message-real-folder ()
  "Return the name of the current message real folder, so if you use
sequences, it will now work."
  (save-excursion
    (let* ((folder
            (if (equal major-mode 'mh-folder-mode)
                mh-current-folder
              ;; Refer to the show buffer
              mh-show-folder-buffer))
           (end-index
            (if (boundp 'mh-index-folder)
                (min (length mh-index-folder) (length folder))))
           )
      ;; a simple test on mh-index-data does not work, because
      ;; mh-index-data is always nil in a show buffer.

        folder
        )
      )))

(defun org-mhe-get-message-folder-from-index ()
  "Returns the name of the message folder in a index folder buffer."
  (save-excursion
    (mh-index-previous-folder)
    (if (not (re-search-forward "^\\(+.*\\)$" nil t))
        (message "Problem getting folder from index.")
      (message (match-string 1)))))

(defun org-mhe-get-message-folder ()
  "Return the name of the current message folder.  Be careful if you
use sequences."
  (save-excursion
    (if (equal major-mode 'mh-folder-mode)
        mh-current-folder
      ;; Refer to the show buffer
      mh-show-folder-buffer)))

(defun org-mhe-get-message-num ()
  "Return the number of the current message.  Be careful if you
use sequences."
  (save-excursion
    (if (equal major-mode 'mh-folder-mode)
        (mh-get-msg-num nil)
      ;; Refer to the show buffer
      (mh-show-buffer-message-number))))

(defun org-mhe-get-header (header)
  "Return a header of the message in folder mode.  This will create a
show buffer for the corresponding message.  If you have a more clever
idea..."
  (let* ((folder (org-mhe-get-message-folder))
         (num (org-mhe-get-message-num))
         (buffer (get-buffer-create (concat "show-" folder)))
         (header-field))
  (with-current-buffer buffer

  (let* ((show-buf (concat "show-" folder)))
    (mh-visit-folder folder)
    (get-buffer-create show-buf)
    (mh-show-msg
     (string-to-number
      (car (split-string
	    (with-temp-buffer
	      (call-process
	       (expand-file-name "pick" mh-progs)
	       nil t nil
	       folder

	    (to-header (org-mhe-get-header "To:"))
	    (subject (org-mhe-get-header "Subject:")))
	(setq cpltxt (concat from-header " on: " subject))
	(setq link (concat cpltxt "\n  "
			   (org-make-link
			    "mhe:" (org-mhe-get-message-real-folder) "#"
			    (org-remove-angle-brackets
			     (org-mhe-get-header "Message-Id:")))))))

     ((eq major-mode 'rmail-mode)
      (save-excursion

     ((interactive-p)
      (error "Cannot link to a buffer which is not visiting a file"))

     (t (setq link nil)))

    (if (and (interactive-p) link)
	(progn
	  (setq org-stored-links
		(cons (cons (or cpltxt link) link) org-stored-links))
	  (message "Stored: %s" (or cpltxt link)))
      link)))

(defun org-make-org-heading-search-string (&optional string heading)
  "Make search string for STRING or current headline."
  (interactive)
  (let ((s (or string (org-get-heading))))
    (unless (and string (not heading))
      ;; We are using a headline, clean up garbage in there.
      (if (string-match org-todo-regexp s)

      (setq s (replace-match " " t t s)))
    (or string (setq s (concat "*" s)))  ; Add * for headlines
    (mapconcat 'identity (org-split-string s "[ \t]+") " ")))

(defun org-make-org-heading-camel (&optional string heading)
  "Make a CamelCase string for STRING or the current headline."
  (interactive)
  (let ((s (or string (org-get-heading))))
    (unless (and string (not heading))
      ;; We are using a headline, clean up garbage in there.
      (if (string-match org-todo-regexp s)

  "Sort table lines in region.
Point and mark define the first and last line to include.  Both point and
mark should be in the column that is used for sorting.  For example, to
sort according to column 3, put the mark in the first line to sort, in
table column 3.  Put point into the last line to be included in the sorting,
also in table column 3.  The command will prompt for the sorting method
\(n for numerical, a for alphanumeric)."
  (interactive "r\nsSorting method: [n]=numeric [a]=alpha: ")
  (setq numericp (string-match "[nN]" numericp))
  (org-table-align) ;; Just to be safe
  (let* (bcol ecol cmp column lns)
    (goto-char beg)

	    (setq c (string-to-char (match-string 1 fmt))
		  n (string-to-number (or (match-string 1 fmt) "")))
	    (if (= c ?p) (setq modes (org-set-calc-mode 'calc-internal-prec n))
	      (setq modes (org-set-calc-mode
			   'calc-float-format
			   (list (cdr (assoc c '((?n . float) (?f . fix)
						 (?s . sci) (?e . eng))))
				 n))))
	    (setq fmt (replace-match "" t t fmt)))
	  (while (string-match "[DRFS]" fmt)
	    (setq modes (org-set-calc-mode (match-string 0 fmt)))
	    (setq fmt (replace-match "" t t fmt)))

	  ;; make targets to anchors
	  (while (string-match "<<<?\\([^<>]*\\)>>>?[ \t]*\n?" line)
	    (setq line (replace-match
			(concat "@<a name=\""
				(org-solidify-link-text (match-string 1 line))
				"\">\\nbsp@</a>")
			t t line)))
	  ;; Replace internal links
	  (while (string-match org-bracket-link-regexp line)
	    (setq line (replace-match
			(concat
			    "@<a href=\"#"
			    (org-solidify-link-text (match-string 1 line))
			    "\">"
			    (match-string (if (match-end 3) 3 1) line)
			    "@</a>")
			t t line)))

	  (org-format-table-table-html lines)
	;; Need to use the code generator in table.el, with the original text.
	(org-format-table-table-html-using-table-generate-source olines)))))

(defun org-format-org-table-html (lines)
  "Format a table into HTML."
  (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  (setq lines (nreverse lines))
  (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
  (setq lines (nreverse lines))
  (when org-export-table-remove-special-lines

			     nil ; ignore this line
			   (and (or (string-match "^[ \t]*|-+\\+" x)
				    (string-match "^[ \t]*|[^|]*|" x))
				(replace-match "|" t t x))))
		       lines))))))

  (let ((head (and org-export-highlight-first-table-line
		   (delq nil (mapcar
			      (lambda (x) (string-match "^[ \t]*|-" x))
			      (cdr lines)))))
	line fields html)

      (if (not (eq (aref newstr i) ?|))
	  (aset newstr i ?\ )))
    newstr))

(defun org-format-table-table-html (lines)
  "Format a table generated by table.el into HTML.
This conversion does *not* use `table-generate-source' from table.el.
This has the advantage that Org-mode's HTML conversions can be used.
But it has the disadvantage, that no cell- or row-spanning is allowed."
  (let (line field-buffer
	     (head org-export-highlight-first-table-line)