summaryrefslogtreecommitdiff
path: root/lisp/obarray.el
diff options
context:
space:
mode:
Diffstat (limited to 'lisp/obarray.el')
-rw-r--r--lisp/obarray.el65
1 files changed, 65 insertions, 0 deletions
diff --git a/lisp/obarray.el b/lisp/obarray.el
new file mode 100644
index 00000000000..fb7a333b8b5
--- /dev/null
+++ b/lisp/obarray.el
@@ -0,0 +1,65 @@
+;;; obarray.el --- obarray functions -*- lexical-binding: t -*-
+
+;; Copyright (C) 2015 Free Software Foundation, Inc.
+
+;; Maintainer: emacs-devel@gnu.org
+;; Keywords: obarray functions
+;; Package: emacs
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs 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 General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; This file provides function for working with obarrays.
+
+;;; Code:
+
+(defconst obarray-default-size 59
+ "The value 59 is an arbitrary prime number that gives a good hash.")
+
+(defun obarray-make (&optional size)
+ "Return a new obarray of size SIZE or `obarray-default-size'."
+ (let ((size (or size obarray-default-size)))
+ (if (< 0 size)
+ (make-vector size 0)
+ (signal 'wrong-type-argument '(size 0)))))
+
+(defun obarray-p (object)
+ "Return t if OBJECT is an obarray."
+ (and (vectorp object)
+ (< 0 (length object))))
+
+(defun obarray-get (obarray name)
+ "Return symbol named NAME if it is contained in OBARRAY.
+Return nil otherwise."
+ (intern-soft name obarray))
+
+(defun obarray-put (obarray name)
+ "Return symbol named NAME from OBARRAY.
+Creates and adds the symbol if doesn't exist."
+ (intern name obarray))
+
+(defun obarray-remove (obarray name)
+ "Remove symbol named NAME if it is contained in OBARRAY.
+Return t on success, nil otherwise."
+ (unintern name obarray))
+
+(defun obarray-foreach (fn obarray)
+ "Call function FN on every symbol in OBARRAY and return nil."
+ (mapatoms fn obarray))
+
+(provide 'obarray)
+;;; obarray.el ends here