XEmacs Lisp Programmer's Manual

Third Edition (for XEmacs 19.13), July 1995

by Ben Wing

Based on the GNU Emacs Lisp Reference Manual

by Bil Lewis, Dan LaLiberte, Richard Stallman

and the GNU Manual Group

GNU GENERAL PUBLIC LICENSE
- Preamble
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
- How to Apply These Terms to Your New Programs
Introduction
- Caveats
- Lisp History
- Conventions
- Acknowledgements
Lisp Data Types
- Printed Representation and Read Syntax
- Comments
- Programming Types
- Editing Types
- Window-System Types
- Type Predicates
- Equality Predicates
Numbers
- Integer Basics
- Floating Point Basics
- Type Predicates for Numbers
- Comparison of Numbers
- Numeric Conversions
- Arithmetic Operations
- Rounding Operations
- Bitwise Operations on Integers
- Standard Mathematical Functions
- Random Numbers
Strings and Characters
- String and Character Basics
- The Predicates for Strings
- Creating Strings
- Comparison of Characters and Strings
- Conversion of Characters and Strings
- Formatting Strings
- Character Case
- The Case Table
Lists
- Lists and Cons Cells
- Lists as Linked Pairs of Boxes
- Predicates on Lists
- Accessing Elements of Lists
- Building Cons Cells and Lists
- Modifying Existing List Structure
- Using Lists as Sets
- Association Lists
Sequences, Arrays, and Vectors
- Sequences
- Arrays
- Functions that Operate on Arrays
- Vectors
- Functions That Operate on Vectors
Symbols
- Symbol Components
- Defining Symbols
- Creating and Interning Symbols
- Property Lists
Evaluation
- Eval
- Kinds of Forms
- Quoting
Control Structures
- Sequencing
- Conditionals
- Constructs for Combining Conditions
- Iteration
- Nonlocal Exits
Variables
- Global Variables
- Variables That Never Change
- Local Variables
- When a Variable is "Void"
- Defining Global Variables
- Accessing Variable Values
- How to Alter a Variable Value
- Scoping Rules for Variable Bindings
- Buffer-Local Variables
Functions
- What Is a Function?
- Lambda Expressions
- Naming a Function
- Defining Functions
- Calling Functions
- Mapping Functions
- Anonymous Functions
- Accessing Function Cell Contents
- Inline Functions
- Other Topics Related to Functions
Macros
- A Simple Example of a Macro
- Expansion of a Macro Call
- Macros and Byte Compilation
- Defining Macros
- Backquote
- Common Problems Using Macros
Loading
- How Programs Do Loading
- Autoload
- Repeated Loading
- Features
- Unloading
- Hooks for Loading
Byte Compilation
- Performance of Byte-Compiled Code
- The Compilation Functions
- Documentation Strings and Compilation
- Dynamic Loading of Individual Functions
- Evaluation During Compilation
- Byte-Code Function Objects
- Disassembled Byte-Code
Debugging Lisp Programs
- The Lisp Debugger
- Debugging Invalid Lisp Syntax
  - Excess Open Parentheses
  - Excess Close Parentheses
- Debugging Problems in Compilation
- Edebug
Reading and Printing Lisp Objects
- Introduction to Reading and Printing
- Input Streams
- Input Functions
- Output Streams
- Output Functions
- Variables Affecting Output
Minibuffers
- Introduction to Minibuffers
- Reading Text Strings with the Minibuffer
- Reading Lisp Objects with the Minibuffer
- Minibuffer History
- Completion
- Yes-or-No Queries
- Asking Multiple Y-or-N Questions
- Minibuffer Miscellany
Command Loop
- Command Loop Overview
- Defining Commands
- Interactive Call
- Information from the Command Loop
- Events
- Reading Input
- Waiting for Elapsed Time or Input
- Quitting
- Prefix Command Arguments
- Recursive Editing
- Disabling Commands
- Command History
- Keyboard Macros
Keymaps
- Keymap Terminology
- Format of Keymaps
- Creating Keymaps
- Inheritance and Keymaps
- Prefix Keys
- Active Keymaps
- Key Lookup
- Functions for Key Lookup
- Changing Key Bindings
- Commands for Binding Keys
- Scanning Keymaps
Menus
- Format of Menus
- Format of the Menubar
- Menubar
- Modifying Menus
- Menu Filters
- Pop-Up Menus
- Buffers Menu
Dialog Boxes
- Dialog Box Format
- Dialog Box Functions
Toolbar
- Toolbar Intro
- Toolbar Descriptor Format
- Specifying the Toolbar
- Other Toolbar Variables
scrollbars
Major and Minor Modes
- Major Modes
- Minor Modes
  - Conventions for Writing Minor Modes
  - Keymaps and Minor Modes
- Modeline Format
- Hooks
Documentation
- Documentation Basics
- Access to Documentation Strings
- Substituting Key Bindings in Documentation
- Describing Characters for Help Messages
- Help Functions
Files
- Visiting Files
  - Functions for Visiting Files
  - Subroutines of Visiting
- Saving Buffers
- Reading from Files
- Writing to Files
- File Locks
- Information about Files
- Changing File Names and Attributes
- File Names
- Contents of Directories
- Creating and Deleting Directories
- Making Certain File Names "Magic"
- Partial Files
- File Format Conversion
- Files and MS-DOS
Backups and Auto-Saving
- Backup Files
- Auto-Saving
- Reverting
Buffers
- Buffer Basics
- The Current Buffer
- Buffer Names
- Buffer File Name
- Buffer Modification
- Comparison of Modification Time
- Read-Only Buffers
- The Buffer List
- Creating Buffers
- Killing Buffers
- Indirect Buffers
Windows
- Basic Concepts of Emacs Windows
- Splitting Windows
- Deleting Windows
- Selecting Windows
- Cyclic Ordering of Windows
- Buffers and Windows
- Displaying Buffers in Windows
- Choosing a Window for Display
- Windows and Point
- The Window Start Position
- Vertical Scrolling
- Horizontal Scrolling
- The Size of a Window
- The Position of a Window
- Changing the Size of a Window
- Window Configurations
Frames
- Creating Frames
- Frame Parameters
- Frame Titles
- Deleting Frames
- Finding All Frames
- Frames and Windows
- Minibuffers and Frames
- Input Focus
- Visibility of Frames
- Raising and Lowering Frames
- Hooks for Customizing Frame Behavior
Devices
- Basic Device Functions
- Device Types and Classes
- Connecting to a Device
- The Selected Device
- Device Input
Positions
- Point
- Motion
- Excursions
- Narrowing
Markers
- Overview of Markers
- Predicates on Markers
- Functions That Create Markers
- Information from Markers
- Changing Marker Positions
- The Mark
- The Region
Text
- Examining Text Near Point
- Examining Buffer Contents
- Comparing Text
- Inserting Text
- User-Level Insertion Commands
- Deleting Text
- User-Level Deletion Commands
- The Kill Ring
  - Kill Ring Concepts
  - Functions for Killing
  - Functions for Yanking
  - Low-Level Kill Ring
  - Internals of the Kill Ring
- Undo
- Maintaining Undo Lists
- Filling
- Margins for Filling
- Auto Filling
- Sorting Text
- Counting Columns
- Indentation
  - Indentation Primitives
  - Indentation Controlled by Major Mode
  - Indenting an Entire Region
  - Indentation Relative to Previous Lines
  - Adjustable "Tab Stops"
  - Indentation-Based Motion Commands
- Case Changes
- Text Properties
  - Examining Text Properties
  - Changing Text Properties
  - Property Search Functions
  - Properties with Special Meanings
  - Saving Text Properties in Files
- Substituting for a Character Code
- Registers
- Transposition of Text
- Change Hooks
Searching and Matching
- Searching for Strings
- Regular Expressions
  - Syntax of Regular Expressions
  - Complex Regexp Example
- Regular Expression Searching
- POSIX Regular Expression Searching
- Search and Replace
- The Match Data
- Searching and Case
- Standard Regular Expressions Used in Editing
Syntax Tables
- Syntax Table Concepts
- Syntax Descriptors
  - Table of Syntax Classes
  - Syntax Flags
- Syntax Table Functions
- Motion and Syntax
- Parsing Balanced Expressions
- Some Standard Syntax Tables
- Syntax Table Internals
Abbrevs And Abbrev Expansion
- Setting Up Abbrev Mode
- Abbrev Tables
- Defining Abbrevs
- Saving Abbrevs in Files
- Looking Up and Expanding Abbreviations
- Standard Abbrev Tables
Extents
- Introduction to Extents
- Creating and Modifying Extents
- Extent Endpoints
- Finding Extents
- Properties of Extents
- Detached Extents
- Duplicable Extents
- Extent Replicas
- Interaction of Extents with Keyboard and Mouse Events
- Atomic Extents
Specifiers
- Introduction to Specifiers
- In-Depth Overview of a Specifier
- How a Specifier Is Instanced
- Specifier Types
- Adding specifications to a Specifier
- Retrieving the Specifications from a Specifier
- Working With Specifier Tags
- Functions for Instancing a Specifier
- Example of Specifier Usage
- Creating New Specifier Objects
- Functions for Checking the Validity of Specifier Components
- Other Functions for Working with Specifications in a Specifier
Faces and Window-System Objects
- Faces
- Fonts
- Colors
Glyphs
- Glyph Functions
- Images
- Cursors
Annotations
- Annotation Basics
- Annotation Primitives
- Margin Primitives
- Annotation Hooks
Emacs Display
- Refreshing the Screen
- Truncation
- The Echo Area
- Invisible Text
- Selective Display
- The Overlay Arrow
- Temporary Displays
- Blinking Parentheses
- Usual Display Conventions
- Display Tables
- Beeping
Processes
- Functions that Create Subprocesses
- Creating a Synchronous Process
- MS-DOS Subprocesses
- Creating an Asynchronous Process
- Deleting Processes
- Process Information
- Sending Input to Processes
- Sending Signals to Processes
- Receiving Output from Processes
- Sentinels: Detecting Process Status Changes
- Process Window Size
- Transaction Queues
- Network Connections
Operating System Interface
- Starting Up XEmacs
- Getting out of XEmacs
  - Killing XEmacs
  - Suspending XEmacs
- Operating System Environment
- User Identification
- Time of Day
- Time Conversion
- Timers for Delayed Execution
- Terminal Input
- Terminal Output
- Flow Control
- Batch Mode
Functions Specific to the X Window System
- X Selections
- X Server
- Miscellaneous X Functions and Variables
ToolTalk Support
- XEmacs ToolTalk API Summary
- Sending Messages
  - Example of Sending Messages
  - Elisp Interface for Sending Messages
- Receiving Messages
  - Example of Receiving Messages
  - Elisp Interface for Receiving Messages
Internationalization
- I18N Levels 1 and 2
- I18N Level 3
- I18N Level 4
Tips and Standards
- Writing Clean Lisp Programs
- Tips for Making Compiled Code Fast
- Tips for Documentation Strings
- Tips on Writing Comments
- Conventional Headers for XEmacs Libraries
XEmacs Internals
- Building XEmacs
- Pure Storage
- Garbage Collection
- Writing XEmacs Primitives
- Object Internals
Standard Errors
Buffer-Local Variables
Standard Keymaps
Standard Hooks
Index

This document was generated on 21 January 1996 using the texi2html translator version 1.45.