]> code.delx.au - gnu-emacs-elpa/blob - packages/ztree/ztree-util.el
Fix some quoting problems in doc strings
[gnu-emacs-elpa] / packages / ztree / ztree-util.el
1 ;;; ztree-util.el --- Auxiliary utilities for the ztree package -*- lexical-binding: t; -*-
2
3 ;; Copyright (C) 2013-2016 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Alexey Veretennikov <alexey.veretennikov@gmail.com>
6 ;;
7 ;; Created: 2013-11-11
8 ;;
9 ;; Keywords: files tools
10 ;; URL: https://github.com/fourier/ztree
11 ;; Compatibility: GNU Emacs 24.x
12 ;;
13 ;; This file is part of GNU Emacs.
14 ;;
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
19 ;;
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
24 ;;
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;
28 ;;; Commentary:
29
30 ;;; Code:
31 (defun ztree-find (where which)
32 "Find element of the list WHERE matching predicate WHICH."
33 (catch 'found
34 (dolist (elt where)
35 (when (funcall which elt)
36 (throw 'found elt)))
37 nil))
38
39 (defun ztree-filter (condp lst)
40 "Filter out elements not satisfying predicate CONDP in the list LST.
41 Taken from http://www.emacswiki.org/emacs/ElispCookbook#toc39"
42 (delq nil
43 (mapcar (lambda (x) (and (funcall condp x) x)) lst)))
44
45
46 (defun ztree-printable-string (string)
47 "Strip newline character from file names, like `Icon\n'.
48 Argument STRING string to process.'."
49 (replace-regexp-in-string "\n" "" string))
50
51 (defun ztree-file-short-name (file)
52 "By given FILE name return base file/directory name.
53 Taken from http://lists.gnu.org/archive/html/emacs-devel/2011-01/msg01238.html"
54 (ztree-printable-string (file-name-nondirectory (directory-file-name file))))
55
56 (defun ztree-car-atom (value)
57 "Return VALUE if value is an atom, otherwise (car value) or nil.
58 Used since `car-safe' returns nil for atoms"
59 (if (atom value) value (car value)))
60
61
62 (defun ztree-insert-with-face (text face)
63 "Insert TEXT with the FACE provided."
64 (let ((start (point)))
65 (insert text)
66 (put-text-property start (point) 'face face)))
67
68 (provide 'ztree-util)
69
70 ;;; ztree-util.el ends here