Mercurial > hg > xemacs-beta
view lisp/obsolete.el @ 665:fdefd0186b75
[xemacs-hg @ 2001-09-20 06:28:42 by ben]
The great integral types renaming.
The purpose of this is to rationalize the names used for various
integral types, so that they match their intended uses and follow
consist conventions, and eliminate types that were not semantically
different from each other.
The conventions are:
-- All integral types that measure quantities of anything are
signed. Some people disagree vociferously with this, but their
arguments are mostly theoretical, and are vastly outweighed by
the practical headaches of mixing signed and unsigned values,
and more importantly by the far increased likelihood of
inadvertent bugs: Because of the broken "viral" nature of
unsigned quantities in C (operations involving mixed
signed/unsigned are done unsigned, when exactly the opposite is
nearly always wanted), even a single error in declaring a
quantity unsigned that should be signed, or even the even more
subtle error of comparing signed and unsigned values and
forgetting the necessary cast, can be catastrophic, as
comparisons will yield wrong results. -Wsign-compare is turned
on specifically to catch this, but this tends to result in a
great number of warnings when mixing signed and unsigned, and
the casts are annoying. More has been written on this
elsewhere.
-- All such quantity types just mentioned boil down to EMACS_INT,
which is 32 bits on 32-bit machines and 64 bits on 64-bit
machines. This is guaranteed to be the same size as Lisp
objects of type `int', and (as far as I can tell) of size_t
(unsigned!) and ssize_t. The only type below that is not an
EMACS_INT is Hashcode, which is an unsigned value of the same
size as EMACS_INT.
-- Type names should be relatively short (no more than 10
characters or so), with the first letter capitalized and no
underscores if they can at all be avoided.
-- "count" == a zero-based measurement of some quantity. Includes
sizes, offsets, and indexes.
-- "bpos" == a one-based measurement of a position in a buffer.
"Charbpos" and "Bytebpos" count text in the buffer, rather than
bytes in memory; thus Bytebpos does not directly correspond to
the memory representation. Use "Membpos" for this.
-- "Char" refers to internal-format characters, not to the C type
"char", which is really a byte.
-- For the actual name changes, see the script below.
I ran the following script to do the conversion. (NOTE: This script
is idempotent. You can safely run it multiple times and it will
not screw up previous results -- in fact, it will do nothing if
nothing has changed. Thus, it can be run repeatedly as necessary
to handle patches coming in from old workspaces, or old branches.)
There are two tags, just before and just after the change:
`pre-integral-type-rename' and `post-integral-type-rename'. When
merging code from the main trunk into a branch, the best thing to
do is first merge up to `pre-integral-type-rename', then apply the
script and associated changes, then merge from
`post-integral-type-change' to the present. (Alternatively, just do
the merging in one operation; but you may then have a lot of
conflicts needing to be resolved by hand.)
Script `fixtypes.sh' follows:
----------------------------------- cut ------------------------------------
files="*.[ch] s/*.h m/*.h config.h.in ../configure.in Makefile.in.in ../lib-src/*.[ch] ../lwlib/*.[ch]"
gr Memory_Count Bytecount $files
gr Lstream_Data_Count Bytecount $files
gr Element_Count Elemcount $files
gr Hash_Code Hashcode $files
gr extcount bytecount $files
gr bufpos charbpos $files
gr bytind bytebpos $files
gr memind membpos $files
gr bufbyte intbyte $files
gr Extcount Bytecount $files
gr Bufpos Charbpos $files
gr Bytind Bytebpos $files
gr Memind Membpos $files
gr Bufbyte Intbyte $files
gr EXTCOUNT BYTECOUNT $files
gr BUFPOS CHARBPOS $files
gr BYTIND BYTEBPOS $files
gr MEMIND MEMBPOS $files
gr BUFBYTE INTBYTE $files
gr MEMORY_COUNT BYTECOUNT $files
gr LSTREAM_DATA_COUNT BYTECOUNT $files
gr ELEMENT_COUNT ELEMCOUNT $files
gr HASH_CODE HASHCODE $files
----------------------------------- cut ------------------------------------
`fixtypes.sh' is a Bourne-shell script; it uses 'gr':
----------------------------------- cut ------------------------------------
#!/bin/sh
# Usage is like this:
# gr FROM TO FILES ...
# globally replace FROM with TO in FILES. FROM and TO are regular expressions.
# backup files are stored in the `backup' directory.
from="$1"
to="$2"
shift 2
echo ${1+"$@"} | xargs global-replace "s/$from/$to/g"
----------------------------------- cut ------------------------------------
`gr' in turn uses a Perl script to do its real work,
`global-replace', which follows:
----------------------------------- cut ------------------------------------
: #-*- Perl -*-
### global-modify --- modify the contents of a file by a Perl expression
## Copyright (C) 1999 Martin Buchholz.
## Copyright (C) 2001 Ben Wing.
## Authors: Martin Buchholz <martin@xemacs.org>, Ben Wing <ben@xemacs.org>
## Maintainer: Ben Wing <ben@xemacs.org>
## Current Version: 1.0, May 5, 2001
# This program 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 2, or (at your option)
# any later version.
#
# This program 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 XEmacs; see the file COPYING. If not, write to the Free
# Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
eval 'exec perl -w -S $0 ${1+"$@"}'
if 0;
use strict;
use FileHandle;
use Carp;
use Getopt::Long;
use File::Basename;
(my $myName = $0) =~ s@.*/@@; my $usage="
Usage: $myName [--help] [--backup-dir=DIR] [--line-mode] [--hunk-mode]
PERLEXPR FILE ...
Globally modify a file, either line by line or in one big hunk.
Typical usage is like this:
[with GNU print, GNU xargs: guaranteed to handle spaces, quotes, etc.
in file names]
find . -name '*.[ch]' -print0 | xargs -0 $0 's/\bCONST\b/const/g'\n
[with non-GNU print, xargs]
find . -name '*.[ch]' -print | xargs $0 's/\bCONST\b/const/g'\n
The file is read in, either line by line (with --line-mode specified)
or in one big hunk (with --hunk-mode specified; it's the default), and
the Perl expression is then evalled with \$_ set to the line or hunk of
text, including the terminating newline if there is one. It should
destructively modify the value there, storing the changed result in \$_.
Files in which any modifications are made are backed up to the directory
specified using --backup-dir, or to `backup' by default. To disable this,
use --backup-dir= with no argument.
Hunk mode is the default because it is MUCH MUCH faster than line-by-line.
Use line-by-line only when it matters, e.g. you want to do a replacement
only once per line (the default without the `g' argument). Conversely,
when using hunk mode, *ALWAYS* use `g'; otherwise, you will only make one
replacement in the entire file!
";
my %options = ();
$Getopt::Long::ignorecase = 0;
&GetOptions (
\%options,
'help', 'backup-dir=s', 'line-mode', 'hunk-mode',
);
die $usage if $options{"help"} or @ARGV <= 1;
my $code = shift;
die $usage if grep (-d || ! -w, @ARGV);
sub SafeOpen {
open ((my $fh = new FileHandle), $_[0]);
confess "Can't open $_[0]: $!" if ! defined $fh;
return $fh;
}
sub SafeClose {
close $_[0] or confess "Can't close $_[0]: $!";
}
sub FileContents {
my $fh = SafeOpen ("< $_[0]");
my $olddollarslash = $/;
local $/ = undef;
my $contents = <$fh>;
$/ = $olddollarslash;
return $contents;
}
sub WriteStringToFile {
my $fh = SafeOpen ("> $_[0]");
binmode $fh;
print $fh $_[1] or confess "$_[0]: $!\n";
SafeClose $fh;
}
foreach my $file (@ARGV) {
my $changed_p = 0;
my $new_contents = "";
if ($options{"line-mode"}) {
my $fh = SafeOpen $file;
while (<$fh>) {
my $save_line = $_;
eval $code;
$changed_p = 1 if $save_line ne $_;
$new_contents .= $_;
}
} else {
my $orig_contents = $_ = FileContents $file;
eval $code;
if ($_ ne $orig_contents) {
$changed_p = 1;
$new_contents = $_;
}
}
if ($changed_p) {
my $backdir = $options{"backup-dir"};
$backdir = "backup" if !defined ($backdir);
if ($backdir) {
my ($name, $path, $suffix) = fileparse ($file, "");
my $backfulldir = $path . $backdir;
my $backfile = "$backfulldir/$name";
mkdir $backfulldir, 0755 unless -d $backfulldir;
print "modifying $file (original saved in $backfile)\n";
rename $file, $backfile;
}
WriteStringToFile ($file, $new_contents);
}
}
----------------------------------- cut ------------------------------------
In addition to those programs, I needed to fix up a few other
things, particularly relating to the duplicate definitions of
types, now that some types merged with others. Specifically:
1. in lisp.h, removed duplicate declarations of Bytecount. The
changed code should now look like this: (In each code snippet
below, the first and last lines are the same as the original, as
are all lines outside of those lines. That allows you to locate
the section to be replaced, and replace the stuff in that
section, verifying that there isn't anything new added that
would need to be kept.)
--------------------------------- snip -------------------------------------
/* Counts of bytes or chars */
typedef EMACS_INT Bytecount;
typedef EMACS_INT Charcount;
/* Counts of elements */
typedef EMACS_INT Elemcount;
/* Hash codes */
typedef unsigned long Hashcode;
/* ------------------------ dynamic arrays ------------------- */
--------------------------------- snip -------------------------------------
2. in lstream.h, removed duplicate declaration of Bytecount.
Rewrote the comment about this type. The changed code should
now look like this:
--------------------------------- snip -------------------------------------
#endif
/* The have been some arguments over the what the type should be that
specifies a count of bytes in a data block to be written out or read in,
using Lstream_read(), Lstream_write(), and related functions.
Originally it was long, which worked fine; Martin "corrected" these to
size_t and ssize_t on the grounds that this is theoretically cleaner and
is in keeping with the C standards. Unfortunately, this practice is
horribly error-prone due to design flaws in the way that mixed
signed/unsigned arithmetic happens. In fact, by doing this change,
Martin introduced a subtle but fatal error that caused the operation of
sending large mail messages to the SMTP server under Windows to fail.
By putting all values back to be signed, avoiding any signed/unsigned
mixing, the bug immediately went away. The type then in use was
Lstream_Data_Count, so that it be reverted cleanly if a vote came to
that. Now it is Bytecount.
Some earlier comments about why the type must be signed: This MUST BE
SIGNED, since it also is used in functions that return the number of
bytes actually read to or written from in an operation, and these
functions can return -1 to signal error.
Note that the standard Unix read() and write() functions define the
count going in as a size_t, which is UNSIGNED, and the count going
out as an ssize_t, which is SIGNED. This is a horrible design
flaw. Not only is it highly likely to lead to logic errors when a
-1 gets interpreted as a large positive number, but operations are
bound to fail in all sorts of horrible ways when a number in the
upper-half of the size_t range is passed in -- this number is
unrepresentable as an ssize_t, so code that checks to see how many
bytes are actually written (which is mandatory if you are dealing
with certain types of devices) will get completely screwed up.
--ben
*/
typedef enum lstream_buffering
--------------------------------- snip -------------------------------------
3. in dumper.c, there are four places, all inside of switch()
statements, where XD_BYTECOUNT appears twice as a case tag. In
each case, the two case blocks contain identical code, and you
should *REMOVE THE SECOND* and leave the first.
| author | ben |
|---|---|
| date | Thu, 20 Sep 2001 06:31:11 +0000 |
| parents | 576fb035e263 |
| children | 29e4e3036b4e |
line wrap: on
line source
;;; obsolete.el --- obsoleteness support ;; Copyright (C) 1985-1994, 1997 Free Software Foundation, Inc. ;; Copyright (C) 1994, 1995 Amdahl Corporation. ;; Copyright (C) 1995 Sun Microsystems. ;; Maintainer: XEmacs Development Team ;; Keywords: internal, dumped ;; This file is part of XEmacs. ;; XEmacs 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 2, or (at your option) ;; any later version. ;; XEmacs 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 XEmacs; see the file COPYING. If not, write to the ;; Free Software Foundation, 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. ;;; Synched up with: Not in FSF. ;;; Commentary: ;; This file is dumped with XEmacs. ;; The obsoleteness support used to be scattered throughout various ;; source files. We put the stuff in one place to remove the junkiness ;; from other source files and to facilitate creating/updating things ;; like sysdep.el. ;;; Code: (defsubst define-obsolete-function-alias (oldfun newfun) "Define OLDFUN as an obsolete alias for function NEWFUN. This makes calling OLDFUN equivalent to calling NEWFUN and marks OLDFUN as obsolete." (define-function oldfun newfun) (make-obsolete oldfun newfun)) (defsubst define-compatible-function-alias (oldfun newfun) "Define OLDFUN as a compatible alias for function NEWFUN. This makes calling OLDFUN equivalent to calling NEWFUN and marks OLDFUN as provided for compatibility only." (define-function oldfun newfun) (make-compatible oldfun newfun)) (defsubst define-obsolete-variable-alias (oldvar newvar) "Define OLDVAR as an obsolete alias for variable NEWVAR. This makes referencing or setting OLDVAR equivalent to referencing or setting NEWVAR and marks OLDVAR as obsolete. If OLDVAR was bound and NEWVAR was not, Set NEWVAR to OLDVAR. Note: Use this before any other references (defvar/defcustom) to NEWVAR." (let ((needs-setting (and (boundp oldvar) (not (boundp newvar)))) (value (and (boundp oldvar) (symbol-value oldvar)))) (defvaralias oldvar newvar) (make-obsolete-variable oldvar newvar) (and needs-setting (set newvar value)))) (defsubst define-compatible-variable-alias (oldvar newvar) "Define OLDVAR as a compatible alias for variable NEWVAR. This makes referencing or setting OLDVAR equivalent to referencing or setting NEWVAR and marks OLDVAR as provided for compatibility only." (defvaralias oldvar newvar) (make-compatible-variable oldvar newvar)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; device stuff (make-compatible-variable 'window-system "use (console-type)") (defun x-display-color-p (&optional device) "Return t if DEVICE is a color device." (eq 'color (device-class device))) (make-compatible 'x-display-color-p 'device-class) (define-function 'x-color-display-p 'x-display-color-p) (make-compatible 'x-display-color-p 'device-class) (defun x-display-grayscale-p (&optional device) "Return t if DEVICE is a grayscale device." (eq 'grayscale (device-class device))) (make-compatible 'x-display-grayscale-p 'device-class) (define-function 'x-grayscale-display-p 'x-display-grayscale-p) (make-compatible 'x-display-grayscale-p 'device-class) (define-compatible-function-alias 'x-display-pixel-width 'device-pixel-width) (define-compatible-function-alias 'x-display-pixel-height 'device-pixel-height) (define-compatible-function-alias 'x-display-planes 'device-bitplanes) (define-compatible-function-alias 'x-display-color-cells 'device-color-cells) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; events (define-obsolete-function-alias 'menu-event-p 'misc-user-event-p) (make-obsolete-variable 'unread-command-char 'unread-command-events) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; extents (make-obsolete 'set-window-dot 'set-window-point) (define-obsolete-function-alias 'extent-buffer 'extent-object) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; frames (defun frame-first-window (frame) "Return the topmost, leftmost window of FRAME. If omitted, FRAME defaults to the currently selected frame." (frame-highest-window frame 0)) (make-compatible 'frame-first-window 'frame-highest-window) (define-obsolete-variable-alias 'initial-frame-alist 'initial-frame-plist) (define-obsolete-variable-alias 'minibuffer-frame-alist 'minibuffer-frame-plist) (define-obsolete-variable-alias 'pop-up-frame-alist 'pop-up-frame-plist) (define-obsolete-variable-alias 'special-display-frame-alist 'special-display-frame-plist) ;; Defined in C. (define-obsolete-variable-alias 'default-frame-alist 'default-frame-plist) (define-obsolete-variable-alias 'default-x-frame-alist 'default-x-frame-plist) (define-obsolete-variable-alias 'default-tty-frame-alist 'default-tty-frame-plist) (make-compatible 'frame-parameters 'frame-property) (defun frame-parameters (&optional frame) "Return the parameters-alist of frame FRAME. It is a list of elements of the form (PARM . VALUE), where PARM is a symbol. The meaningful PARMs depend on the kind of frame. If FRAME is omitted, return information on the currently selected frame. See the variables `default-frame-plist', `default-x-frame-plist', and `default-tty-frame-plist' for a description of the parameters meaningful for particular types of frames." (or frame (setq frame (selected-frame))) ;; #### This relies on a `copy-sequence' of the user properties in ;; `frame-properties'. Removing that would make `frame-properties' more ;; efficient but this function less efficient, as we couldn't be ;; destructive. Since most callers now use `frame-parameters', we'll ;; do it this way. Should probably change this at some point in the ;; future. (destructive-plist-to-alist (frame-properties frame))) (make-compatible 'modify-frame-parameters 'set-frame-properties) (defun modify-frame-parameters (frame alist) "Modify the properties of frame FRAME according to ALIST. ALIST is an alist of properties to change and their new values. Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol. The meaningful PARMs depend on the kind of frame. See `set-frame-properties' for built-in property names." ;; it would be nice to be destructive here but that's not safe. (set-frame-properties frame (alist-to-plist alist))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; faces (define-obsolete-function-alias 'list-faces-display 'edit-faces) (define-obsolete-function-alias 'list-faces 'face-list) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; paths (defvar Info-default-directory-list nil "This used to be the initial value of Info-directory-list. If you want to change the locations where XEmacs looks for info files, set Info-directory-list.") (make-obsolete-variable 'Info-default-directory-list 'Info-directory-list) (defvar init-file-user nil "This used to be the name of the user whose init file was read at startup.") (make-obsolete-variable 'init-file-user 'load-user-init-file-p) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; hooks (make-compatible-variable 'lisp-indent-hook 'lisp-indent-function) (make-compatible-variable 'comment-indent-hook 'comment-indent-function) (make-obsolete-variable 'temp-buffer-show-hook 'temp-buffer-show-function) (make-obsolete-variable 'inhibit-local-variables "use `enable-local-variables' (with the reversed sense).") (make-obsolete-variable 'suspend-hooks 'suspend-hook) (make-obsolete-variable 'first-change-function 'first-change-hook) (make-obsolete-variable 'before-change-function "use before-change-functions; which is a list of functions rather than a single function.") (make-obsolete-variable 'after-change-function "use after-change-functions; which is a list of functions rather than a single function.") ;;;;;;;;;;;;;;;;;;;;;;;;;;;; insertion and deletion (define-compatible-function-alias 'insert-and-inherit 'insert) (define-compatible-function-alias 'insert-before-markers-and-inherit 'insert-before-markers) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; keymaps (defun keymap-parent (keymap) "Return the first parent of the given keymap." (car (keymap-parents keymap))) (make-compatible 'keymap-parent 'keymap-parents) (defun set-keymap-parent (keymap parent) "Make the given keymap have (only) the given parent." (set-keymap-parents keymap (if parent (list parent) '())) parent) (make-compatible 'set-keymap-parent 'set-keymap-parents) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; menu stuff (defun add-menu-item (menu-path item-name function enabled-p &optional before) "Obsolete. See the function `add-menu-button'." (or item-name (error "must specify an item name")) (add-menu-button menu-path (vector item-name function enabled-p) before)) (make-obsolete 'add-menu-item 'add-menu-button) (defun add-menu (menu-path menu-name menu-items &optional before) "See the function `add-submenu'." (or menu-name (error "must specify a menu name")) (or menu-items (error "must specify some menu items")) (add-submenu menu-path (cons menu-name menu-items) before)) ;; Can't make this obsolete. easymenu depends on it. (make-compatible 'add-menu 'add-submenu) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; minibuffer (define-compatible-function-alias 'read-minibuffer 'read-expression) ; misleading name (define-compatible-function-alias 'read-input 'read-string) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; misc ;; (defun user-original-login-name () ;; "Return user's login name from original login. ;; This tries to remain unaffected by `su', by looking in environment variables." ;; (or (getenv "LOGNAME") (getenv "USER") (user-login-name))) (define-obsolete-function-alias 'user-original-login-name 'user-login-name) ; old names (define-obsolete-function-alias 'show-buffer 'set-window-buffer) (define-obsolete-function-alias 'buffer-flush-undo 'buffer-disable-undo) (make-compatible 'eval-current-buffer 'eval-buffer) (define-compatible-function-alias 'byte-code-function-p 'compiled-function-p) ;FSFmacs (define-obsolete-function-alias 'isearch-yank-x-selection 'isearch-yank-selection) (define-obsolete-function-alias 'isearch-yank-x-clipboard 'isearch-yank-clipboard) ;; too bad there's not a way to check for aref, assq, and nconc ;; being called on the values of functions known to return keymaps, ;; or known to return vectors of events instead of strings... (make-obsolete-variable 'executing-macro 'executing-kbd-macro) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; modeline (define-compatible-function-alias 'redraw-mode-line 'redraw-modeline) (define-compatible-function-alias 'force-mode-line-update 'redraw-modeline) ;; FSF compatibility (define-compatible-variable-alias 'mode-line-map 'modeline-map) (define-compatible-variable-alias 'mode-line-buffer-identification 'modeline-buffer-identification) (define-compatible-variable-alias 'mode-line-process 'modeline-process) (define-compatible-variable-alias 'mode-line-modified 'modeline-modified) (make-compatible-variable 'mode-line-inverse-video "use set-face-highlight-p and set-face-reverse-p") (define-compatible-variable-alias 'default-mode-line-format 'default-modeline-format) (define-compatible-variable-alias 'mode-line-format 'modeline-format) (define-compatible-variable-alias 'mode-line-menu 'modeline-menu) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; mouse ;;; (defun mouse-eval-last-sexpr (event) ;;; (interactive "@e") ;;; (save-excursion ;;; (mouse-set-point event) ;;; (eval-last-sexp nil))) (define-obsolete-function-alias 'mouse-eval-last-sexpr 'mouse-eval-sexp) (defun read-mouse-position (frame) (cdr (mouse-position (frame-device frame)))) (make-obsolete 'read-mouse-position 'mouse-position) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; redisplay (defun redraw-display (&optional device) (if (eq device t) (mapcar 'redisplay-device (device-list)) (redisplay-device device))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;; window-system objects ;; the functionality of column.el has been moved into C ;; Function obsoleted for XEmacs 20.0/February 1997. (defalias 'display-column-mode 'column-number-mode) (defun x-color-values (color &optional frame) "Return a description of the color named COLOR on frame FRAME. The value is a list of integer RGB values--(RED GREEN BLUE). These values appear to range from 0 to 65280 or 65535, depending on the system; white is (65280 65280 65280) or (65535 65535 65535). If FRAME is omitted or nil, use the selected frame." (color-instance-rgb-components (make-color-instance color))) (make-compatible 'x-color-values 'color-instance-rgb-components) ;; Two loser functions which shouldn't be used. (make-obsolete 'following-char 'char-after) (make-obsolete 'preceding-char 'char-before) ;; The following several functions are useful in GNU Emacs 20 because ;; of the multibyte "characters" the internal representation of which ;; leaks into Lisp. In XEmacs/Mule they are trivial and unnecessary. ;; We provide them for compatibility reasons solely. (defun string-to-sequence (string type) "Convert STRING to a sequence of TYPE which contains characters in STRING. TYPE should be `list' or `vector'. Multibyte characters are concerned." (ecase type (list (mapcar #'identity string)) (vector (mapvector #'identity string)))) (defun string-to-list (string) "Return a list of characters in STRING." (mapcar #'identity string)) (defun string-to-vector (string) "Return a vector of characters in STRING." (mapvector #'identity string)) (defun store-substring (string idx object) "Embed OBJECT (string or character) at index IDX of STRING." (let* ((str (cond ((stringp object) object) ((characterp object) (char-to-string object)) (t (error "Invalid argument (should be string or character): %s" object)))) (string-len (length string)) (len (length str)) (i 0)) (while (and (< i len) (< idx string-len)) (aset string idx (aref str i)) (setq idx (1+ idx) i (1+ i))) string)) ;; #### This function is not compatible with FSF in some cases. Hard ;; to fix, because it is hard to trace the logic of the FSF function. ;; In case we need the exact behavior, we can always copy the FSF ;; version, which is very long and does lots of unnecessary stuff. (defun truncate-string-to-width (str end-column &optional start-column padding) "Truncate string STR to end at column END-COLUMN. The optional 2nd arg START-COLUMN, if non-nil, specifies the starting column; that means to return the characters occupying columns START-COLUMN ... END-COLUMN of STR. The optional 3rd arg PADDING, if non-nil, specifies a padding character to add at the end of the result if STR doesn't reach column END-COLUMN, or if END-COLUMN comes in the middle of a character in STR. PADDING is also added at the beginning of the result if column START-COLUMN appears in the middle of a character in STR. If PADDING is nil, no padding is added in these cases, so the resulting string may be narrower than END-COLUMN." (or start-column (setq start-column 0)) (let ((len (length str))) (concat (substring str (min start-column len) (min end-column len)) (and padding (> end-column len) (make-string (- end-column len) padding))))) (defalias 'truncate-string 'truncate-string-to-width) (make-obsolete 'truncate-string 'truncate-string-to-width) ;; Keywords already do The Right Thing in XEmacs (make-compatible 'define-widget-keywords "Just use them") (make-obsolete 'function-called-at-point 'function-at-point) (provide 'obsolete) ;;; obsolete.el ends here