Function: hyrolo-word

hyrolo-word is an autoloaded, interactive and byte-compiled function defined in hyrolo.el.

Signature

(hyrolo-word STRING &optional MAX-MATCHES HYROLO-FILES-OR-BUFS COUNT-ONLY HEADLINE-ONLY NO-DISPLAY)

Documentation

Display rolo entries with whole word match for STRING.

To a maximum of optional prefix arg MAX-MATCHES, in file(s) from optional HYROLO-FILES-OR-BUFS or hyrolo-file-list. Default is to find all matching entries. Each entry is displayed with all of its sub-entries. Optional COUNT-ONLY non-nil skips retrieval of matching entries. Optional HEADLINE-ONLY searches only the first line of entries, not the full text. Optional NO-DISPLAY non-nil retrieves entries but does not display them.

Nil value of MAX-MATCHES means find all matches, t value means find all matches but omit file headers, negative values mean find up to the inverse of that number of entries and omit file headers.

Return number of entries matched. See also documentation for the variable hyrolo-file-list.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/hyperbole-20260414.325/hyrolo.el
;;;###autoload
(defun hyrolo-word (string &optional max-matches hyrolo-files-or-bufs
		    count-only headline-only no-display)
  "Display rolo entries with whole word match for STRING.
To a maximum of optional prefix arg MAX-MATCHES, in file(s) from optional
HYROLO-FILES-OR-BUFS or `hyrolo-file-list'.  Default is to find all matching
entries.  Each entry is displayed with all of its sub-entries.  Optional
COUNT-ONLY non-nil skips retrieval of matching entries.  Optional
HEADLINE-ONLY searches only the first line of entries, not the full text.
Optional NO-DISPLAY non-nil retrieves entries but does not display them.

Nil value of MAX-MATCHES means find all matches, t value means find all matches
but omit file headers, negative values mean find up to the inverse of that
number of entries and omit file headers.

Return number of entries matched.  See also documentation for the variable
`hyrolo-file-list'."
  (interactive (let ((input-and-matching-files
		      (hyrolo-grep-input #'read-string "Find rolo whole word matches of")))
		 (list (car input-and-matching-files)
		       current-prefix-arg
		       (mapcar #'expand-file-name
			       (cadr input-and-matching-files)))))
  (let ((total-matches (hyrolo-grep (format "\\b%s\\b" (regexp-quote string))
				    max-matches
				    hyrolo-files-or-bufs count-only headline-only no-display)))
    (when (called-interactively-p 'interactive)
      (message "%s matching entr%s found in HyRolo."
	       (if (= total-matches 0) "No" total-matches)
	       (if (= total-matches 1) "y" "ies")))
    total-matches))