XEmacs Lisp Reference Manual: Table of Contents

GNU GENERAL PUBLIC LICENSE
- Preamble
- How to Apply These Terms to Your New Programs
1. Introduction
- 1.1 Caveats
- 1.2 Lisp History
- 1.3 Conventions
- 1.4 Acknowledgements
2. The XEmacs Packaging System
3. An overview of the XEmacs Packaging System
- 3.1 The User View
- 3.2 The Library Maintainer View
- 3.3 What You Can Do With Source Packages
4. ‘Makefile’ targets
- 4.1 The targets that most people would be interested in would be:
5. Creating Packages:
6. package-info.in
7. ‘Makefile’
- 7.1 ‘package-compile.el’
- 7.2 Issues
8. Lisp Data Types
- 8.1 Printed Representation and Read Syntax
- 8.2 Comments
- 8.3 Primitive Types
- 8.4 Programming Types
- 8.5 Editing Types
- 8.6 Window-System Types
- 8.7 Type Predicates
- 8.8 Equality Predicates
9. Numbers
- 9.1 Integer Basics
- 9.2 Rational Basics
- 9.3 Floating Point Basics
- 9.4 The Bignum Extension
- 9.5 Type Predicates for Numbers
- 9.6 Comparison of Numbers
- 9.7 Numeric Conversions
- 9.8 Arithmetic Operations
- 9.9 Rounding Operations
- 9.10 Bitwise Operations on Integers
- 9.11 Standard Mathematical Functions
- 9.12 Random Numbers
10. Strings and Characters
- 10.1 String and Character Basics
- 10.2 The Predicates for Strings
- 10.3 Creating Strings
- 10.4 The Predicates for Characters
- 10.5 Character Codes
- 10.6 Comparison of Characters and Strings
- 10.7 Conversion of Characters and Strings
- 10.8 Modifying Strings
- 10.9 String Properties
- 10.10 Formatting Strings
- 10.11 Character Case
- 10.12 The Case Table
- 10.13 The Char Table
  - 10.13.1 Char Table Types
  - 10.13.2 Working With Char Tables
11. Lists
- 11.1 Lists and Cons Cells
- 11.2 Lists as Linked Pairs of Boxes
- 11.3 Predicates on Lists
- 11.4 Accessing Elements of Lists
- 11.5 Building Cons Cells and Lists
- 11.6 Modifying Existing List Structure
- 11.7 Using Lists as Sets
- 11.8 Association Lists
- 11.9 Property Lists
- 11.10 Weak Lists
12. Sequences, Arrays, and Vectors
- 12.1 Sequences
- 12.2 Arrays
- 12.3 Functions that Operate on Arrays
- 12.4 Vectors
- 12.5 Functions That Operate on Vectors
- 12.6 Bit Vectors
- 12.7 Functions That Operate on Bit Vectors
13. Symbols
- 13.1 Symbol Components
- 13.2 Defining Symbols
- 13.3 Creating and Interning Symbols
- 13.4 Symbol Properties
14. Evaluation
- 14.1 Eval
- 14.2 Kinds of Forms
- 14.3 Quoting
- 14.4 Multiple values
15. Control Structures
- 15.1 Sequencing
- 15.2 Conditionals
- 15.3 Constructs for Combining Conditions
- 15.4 Iteration
- 15.5 Nonlocal Exits
16. Variables
- 16.1 Global Variables
- 16.2 Variables That Never Change
- 16.3 Local Variables
- 16.4 When a Variable is “Void”
- 16.5 Defining Global Variables
- 16.6 Accessing Variable Values
- 16.7 How to Alter a Variable Value
- 16.8 Scoping Rules for Variable Bindings
- 16.9 Buffer-Local Variables
- 16.10 Variable Aliases
17. Functions and Commands
- 17.1 What Is a Function?
- 17.2 Lambda Expressions
- 17.3 Naming a Function
- 17.4 Defining Functions
- 17.5 Calling Functions
- 17.6 Mapping Functions
- 17.7 Anonymous Functions
- 17.8 Accessing Function Cell Contents
- 17.9 Inline Functions
- 17.10 Other Topics Related to Functions
18. Macros
- 18.1 A Simple Example of a Macro
- 18.2 Expansion of a Macro Call
- 18.3 Macros and Byte Compilation
- 18.4 Defining Macros
- 18.5 Backquote
- 18.6 Common Problems Using Macros
19. Writing Customization Definitions
- 19.1 Common Keywords for All Kinds of Items
- 19.2 Defining Custom Groups
- 19.3 Defining Customization Variables
- 19.4 Face Definitions
- 19.5 Customization Types
- 19.6 Enabling Behavior
20. Loading
- 20.1 How Programs Do Loading
- 20.2 Autoload
- 20.3 Repeated Loading
- 20.4 Features
- 20.5 Unloading
- 20.6 Hooks for Loading
21. Byte Compilation
- 21.1 Performance of Byte-Compiled Code
- 21.2 The Compilation Functions
- 21.3 Options for the Byte Compiler
- 21.4 Documentation Strings and Compilation
- 21.5 Evaluation During Compilation
- 21.6 Compiled-Function Objects
- 21.7 Disassembled Byte-Code
- 21.8 Different Behavior
22. Debugging Lisp Programs
- 22.1 The Lisp Debugger
- 22.2 Debugging Invalid Lisp Syntax
  - 22.2.1 Excess Open Parentheses
  - 22.2.2 Excess Close Parentheses
- 22.3 Debugging Problems in Compilation
- 22.4 Edebug
23. Reading and Printing Lisp Objects
- 23.1 Introduction to Reading and Printing
- 23.2 Input Streams
- 23.3 Input Functions
- 23.4 Output Streams
- 23.5 Output Functions
- 23.6 Variables Affecting Output
24. Minibuffers
- 24.1 Introduction to Minibuffers
- 24.2 Reading Text Strings with the Minibuffer
- 24.3 Reading Lisp Objects with the Minibuffer
- 24.4 Minibuffer History
- 24.5 Completion
- 24.6 Yes-or-No Queries
- 24.7 Asking Multiple Y-or-N Questions
- 24.8 Reading a Password
- 24.9 Minibuffer Miscellany
25. Command Loop
- 25.1 Command Loop Overview
- 25.2 Defining Commands
- 25.3 Interactive Call
- 25.4 Information from the Command Loop
- 25.5 Events
- 25.6 Reading Input
- 25.7 Waiting for Elapsed Time or Input
- 25.8 Quitting
- 25.9 Prefix Command Arguments
- 25.10 Recursive Editing
- 25.11 Disabling Commands
- 25.12 Command History
- 25.13 Keyboard Macros
26. Keymaps
- 26.1 Keymap Terminology
- 26.2 Format of Keymaps
- 26.3 Creating Keymaps
- 26.4 Inheritance and Keymaps
- 26.5 Key Sequences
- 26.6 Prefix Keys
- 26.7 Active Keymaps
- 26.8 Key Lookup
- 26.9 Functions for Key Lookup
- 26.10 Changing Key Bindings
- 26.11 Commands for Binding Keys
- 26.12 Scanning Keymaps
- 26.13 Remapping commands
- 26.14 Other Keymap Functions
27. Menus
- 27.1 Format of Menus
- 27.2 Format of the Menubar
- 27.3 Menubar
- 27.4 Modifying Menus
- 27.5 Menu Filters
- 27.6 Pop-Up Menus
- 27.7 Menu Accelerators
- 27.8 Buffers Menu
28. Dialog Boxes
- 28.1 Dialog Box Format
- 28.2 Dialog Box Functions
29. Toolbar
- 29.1 Toolbar Intro
- 29.2 Creating Toolbar
- 29.3 Toolbar Descriptor Format
- 29.4 Specifying the Toolbar
- 29.5 Other Toolbar Variables
30. Gutter
- 30.1 Gutter Intro
- 30.2 Creating Gutters
- 30.3 Specifying a Gutter
- 30.4 Other Gutter Variables
- 30.5 Common Gutter Widgets
  - 30.5.1 Buffer Tabs
  - 30.5.2 Progress Bars
31. Scrollbars
32. Drag and Drop
- 32.1 Supported Protocols
- 32.2 Drop Interface
- 32.3 Drag Interface
33. Major and Minor Modes
- 33.1 Major Modes
- 33.2 Minor Modes
  - 33.2.1 Conventions for Writing Minor Modes
  - 33.2.2 Keymaps and Minor Modes
- 33.3 Modeline Format
- 33.4 Hooks
34. Documentation
- 34.1 Documentation Basics
- 34.2 Access to Documentation Strings
- 34.3 Substituting Key Bindings in Documentation
- 34.4 Describing Characters for Help Messages
- 34.5 Help Functions
- 34.6 Obsoleteness
35. Files
- 35.1 Visiting Files
  - 35.1.1 Functions for Visiting Files
  - 35.1.2 Subroutines of Visiting
- 35.2 Saving Buffers
- 35.3 Reading from Files
- 35.4 Writing to Files
- 35.5 File Locks
- 35.6 Information about Files
- 35.7 Changing File Names and Attributes
- 35.8 File Names
- 35.9 Contents of Directories
- 35.10 Creating and Deleting Directories
- 35.11 Making Certain File Names “Magic”
- 35.12 Partial Files
- 35.13 File Format Conversion
- 35.14 Files and MS-DOS
36. Backups and Auto-Saving
- 36.1 Backup Files
- 36.2 Auto-Saving
- 36.3 Reverting
37. Buffers
- 37.1 Buffer Basics
- 37.2 The Current Buffer
- 37.3 Buffer Names
- 37.4 Buffer File Name
- 37.5 Buffer Modification
- 37.6 Comparison of Modification Time
- 37.7 Read-Only Buffers
- 37.8 The Buffer List
- 37.9 Creating Buffers
- 37.10 Killing Buffers
- 37.11 Indirect Buffers
38. Windows
- 38.1 Basic Concepts of Emacs Windows
- 38.2 Splitting Windows
- 38.3 Deleting Windows
- 38.4 Selecting Windows
- 38.5 Cyclic Ordering of Windows
- 38.6 Buffers and Windows
- 38.7 Displaying Buffers in Windows
- 38.8 Choosing a Window for Display
- 38.9 Windows and Point
- 38.10 The Window Start Position
- 38.11 Vertical Scrolling
- 38.12 Horizontal Scrolling
- 38.13 The Size of a Window
- 38.14 The Position of a Window
- 38.15 Changing the Size of a Window
- 38.16 Window Configurations
39. Frames
- 39.1 Creating Frames
- 39.2 Frame Properties
- 39.3 Frame Titles
- 39.4 Deleting Frames
- 39.5 Finding All Frames
- 39.6 Frames and Windows
- 39.7 Minibuffers and Frames
- 39.8 Input Focus
- 39.9 Visibility of Frames
- 39.10 Raising and Lowering Frames
- 39.11 Frame Configurations
- 39.12 Hooks for Customizing Frame Behavior
40. Consoles and Devices
- 40.1 Basic Console Functions
- 40.2 Basic Device Functions
- 40.3 Console Types and Device Classes
- 40.4 Connecting to a Console or Device
- 40.5 The Selected Console and Device
- 40.6 Console and Device I/O
41. Positions
- 41.1 Point
- 41.2 Motion
- 41.3 Excursions
- 41.4 Narrowing
42. Markers
- 42.1 Overview of Markers
- 42.2 Predicates on Markers
- 42.3 Functions That Create Markers
- 42.4 Information from Markers
- 42.5 Changing Marker Positions
- 42.6 The Mark
- 42.7 The Region
43. Text
- 43.1 Examining Text Near Point
- 43.2 Examining Buffer Contents
- 43.3 Comparing Text
- 43.4 Inserting Text
- 43.5 User-Level Insertion Commands
- 43.6 Deleting Text
- 43.7 User-Level Deletion Commands
- 43.8 The Kill Ring
  - 43.8.1 Kill Ring Concepts
  - 43.8.2 Functions for Killing
  - 43.8.3 Functions for Yanking
  - 43.8.4 Low-Level Kill Ring
  - 43.8.5 Internals of the Kill Ring
- 43.9 Undo
- 43.10 Maintaining Undo Lists
- 43.11 Filling
- 43.12 Margins for Filling
- 43.13 Auto Filling
- 43.14 Sorting Text
- 43.15 Counting Columns
- 43.16 Indentation
  - 43.16.1 Indentation Primitives
  - 43.16.2 Indentation Controlled by Major Mode
  - 43.16.3 Indenting an Entire Region
  - 43.16.4 Indentation Relative to Previous Lines
  - 43.16.5 Adjustable “Tab Stops”
  - 43.16.6 Indentation-Based Motion Commands
- 43.17 Case Changes
- 43.18 Text Properties
  - 43.18.1 Examining Text Properties
  - 43.18.2 Changing Text Properties
  - 43.18.3 Property Search Functions
  - 43.18.4 Properties with Special Meanings
  - 43.18.5 Saving Text Properties in Files
  - 43.18.6 Fields
- 43.19 Substituting for a Character Code
- 43.20 Registers
- 43.21 Transposition of Text
- 43.22 Change Hooks
- 43.23 Textual transformations—MD5 and base64 support
44. Searching and Matching
- 44.1 Searching for Strings
- 44.2 Regular Expressions
- 44.3 Regular Expression Searching
- 44.4 POSIX Regular Expression Searching
- 44.5 Search and Replace
- 44.6 The Match Data
- 44.7 Searching and Case
- 44.8 Standard Regular Expressions Used in Editing
45. Syntax Tables
- 45.1 Syntax Table Concepts
- 45.2 Syntax Descriptors
  - 45.2.1 Table of Syntax Classes
  - 45.2.2 Syntax Flags
- 45.3 Syntax Table Functions
- 45.4 Motion and Syntax
- 45.5 Parsing Balanced Expressions
- 45.6 Some Standard Syntax Tables
- 45.7 Syntax Table Internals
46. Abbrevs And Abbrev Expansion
- 46.1 Setting Up Abbrev Mode
- 46.2 Abbrev Tables
- 46.3 Defining Abbrevs
- 46.4 Saving Abbrevs in Files
- 46.5 Looking Up and Expanding Abbreviations
- 46.6 Standard Abbrev Tables
47. Extents
- 47.1 Introduction to Extents
- 47.2 Creating and Modifying Extents
- 47.3 Extent Endpoints
- 47.4 Finding Extents
- 47.5 Mapping Over Extents
- 47.6 Properties of Extents
- 47.7 Detached Extents
- 47.8 Extent Parents
- 47.9 Duplicable Extents
- 47.10 Interaction of Extents with Keyboard and Mouse Events
- 47.11 Atomic Extents
48. Specifiers
- 48.1 Introduction to Specifiers
- 48.2 Simple Specifier Usage
- 48.3 In-Depth Overview of a Specifier
- 48.4 How a Specifier Is Instantiated
- 48.5 Specifier Types
- 48.6 Adding specifications to a Specifier
- 48.7 Retrieving the Specifications from a Specifier
- 48.8 Working With Specifier Tags
- 48.9 Functions for Instantiating a Specifier
- 48.10 Examples of Specifier Usage
- 48.11 Creating New Specifier Objects
- 48.12 Functions for Checking the Validity of Specifier Components
- 48.13 Other Functions for Working with Specifications in a Specifier
- 48.14 Specifier Compatibility Notes
  - 48.14.1 Compatibility with GNU Emacs
  - 48.14.2 Backwards Compatibility with XEmacs 21.4
49. Faces and Window-System Objects
- 49.1 Faces
- 49.2 Fonts
- 49.3 Colors
50. Glyphs
- 50.1 Glyph Introduction
- 50.2 Images
- 50.3 Using Glyphs
- 50.4 Manipulating Glyphs
- 50.5 Glyph Examples
51. Annotations
- 51.1 Annotation Basics
- 51.2 Annotation Primitives
- 51.3 Annotation Properties
- 51.4 Locating Annotations
- 51.5 Margin Primitives
- 51.6 Annotation Hooks
52. Emacs Display
- 52.1 Refreshing the Screen
- 52.2 Truncation
- 52.3 The Echo Area
  - 52.3.1 Customizing Message Display
- 52.4 Warnings
- 52.5 Invisible Text
- 52.6 Selective Display
- 52.7 The Overlay Arrow
- 52.8 Temporary Displays
- 52.9 Blinking Parentheses
- 52.10 Usual Display Conventions
- 52.11 Display Tables
- 52.12 Beeping
53. Hash Tables
- 53.1 Introduction to Hash Tables
- 53.2 Working With Hash Tables
- 53.3 Weak Hash Tables
54. Range Tables
- 54.1 Introduction to Range Tables
- 54.2 Working With Range Tables
55. Databases
- 55.1 Connecting to a Database
- 55.2 Working With a Database
- 55.3 Other Database Functions
56. Processes
- 56.1 Functions that Create Subprocesses
- 56.2 Creating a Synchronous Process
- 56.3 MS-DOS Subprocesses
- 56.4 Creating an Asynchronous Process
- 56.5 Deleting Processes
- 56.6 Process Information
- 56.7 Sending Input to Processes
- 56.8 Sending Signals to Processes
- 56.9 Receiving Output from Processes
- 56.10 Sentinels: Detecting Process Status Changes
- 56.11 Process Window Size
- 56.12 Transaction Queues
- 56.13 Network Connections
57. Operating System Interface
- 57.1 Starting Up XEmacs
- 57.2 Getting out of XEmacs
  - 57.2.1 Killing XEmacs
  - 57.2.2 Suspending XEmacs
- 57.3 Operating System Environment
- 57.4 User Identification
- 57.5 Time of Day
- 57.6 Time Conversion
- 57.7 Timers for Delayed Execution
- 57.8 Terminal Input
- 57.9 Terminal Output
- 57.10 Flow Control
- 57.11 Batch Mode
58. Functions Specific to the X Window System
- 58.1 X Selections
- 58.2 X Server
- 58.3 Miscellaneous X Functions and Variables
59. ToolTalk Support
- 59.1 XEmacs ToolTalk API Summary
- 59.2 Sending Messages
  - 59.2.1 Example of Sending Messages
  - 59.2.2 Elisp Interface for Sending Messages
- 59.3 Receiving Messages
  - 59.3.1 Example of Receiving Messages
  - 59.3.2 Elisp Interface for Receiving Messages
60. LDAP Support
- 60.1 Building XEmacs with LDAP support
- 60.2 XEmacs LDAP API
- 60.3 Syntax of Search Filters
61. PostgreSQL Support
- 61.1 Building XEmacs with PostgreSQL support
- 61.2 XEmacs PostgreSQL libpq API
- 61.3 XEmacs PostgreSQL libpq Examples
62. Internationalization
- 62.1 I18N Levels 1 and 2
- 62.2 I18N Level 3
- 62.3 I18N Level 4
63. MULE
- 63.1 Internationalization Terminology
- 63.2 Charsets
- 63.3 MULE Characters
- 63.4 Composite Characters
- 63.5 Coding Systems
  - 63.5.1 Coding System Types
- 63.6 ISO 2022
- 63.7 CCL
- 63.8 Category Tables
- 63.9 Unicode Support
- 63.10 Character Set Unification
  - 63.10.1 An Overview of Unification
  - 63.10.2 Operation of Unification
- 63.11 Basic Functionality
- 63.12 Interactive Usage
A. Tips and Standards
- A.1 Writing Clean Lisp Programs
- A.2 Tips for Making Compiled Code Fast
- A.3 Tips for Documentation Strings
- A.4 Tips on Writing Comments
- A.5 Conventional Headers for XEmacs Libraries
B. Building XEmacs; Allocation of Objects
- B.1 Building XEmacs
- B.2 Garbage Collection
C. Standard Errors
D. Buffer-Local Variables
E. Standard Keymaps
F. Standard Hooks
Index