XEmacs Internals Manual: Table of Contents

1. Introduction
2. Authorship of XEmacs
3. A History of Emacs
- 3.1 Through Version 18
- 3.2 Epoch
- 3.3 Lucid Emacs
- 3.4 GNU Emacs 19
- 3.5 GNU Emacs 20
- 3.6 XEmacs
4. The XEmacs Split
5. XEmacs from the Outside
6. The Lisp Language
7. XEmacs from the Perspective of Building
8. Build-Time Dependencies
9. The Internal Modules of XEmacs
- 9.1 A Summary of the Various XEmacs Internal Modules
- 9.2 Internal Modules for Building XEmacs
- 9.3 Low-Level Internal Modules
- 9.4 Basic Lisp Internal Modules
- 9.5 Internal Modules for Standard Editing Operations
- 9.6 Internal Modules for Interfacing with the File System
- 9.7 Internal Modules for Other Aspects of the Lisp Interpreter and Object System
- 9.8 Internal Modules for Interfacing with the Operating System
10. The Build Configuration System
- 10.1 The version.sh Script
- 10.2 Adding Configurable Features
- 10.3 The configure Script
- 10.4 The Makefile Precursors
11. Rules When Writing New C Code
- 11.1 Introduction to Writing C Code
- 11.2 Writing New Internal Modules
- 11.3 Working with Lisp Objects
- 11.4 Writing Lisp Primitives
- 11.5 Writing Good Comments
- 11.6 Adding Global Lisp Variables
- 11.7 Writing Macros
- 11.8 Proper Use of Unsigned Types
- 11.9 Major Textual Changes
  - 11.9.1 Great Integral Type Renaming
  - 11.9.2 Text/Char Type Renaming
- 11.10 Debugging and Testing
12. Regression Testing XEmacs
- 12.1 How to Regression-Test
- 12.2 Internal Modules for Regression Testing
13. Mercurial Techniques
- 13.1 Preserving Existing Changes with Mercurial Queues
14. CVS Techniques
- 14.1 Creating a Branch
- 14.2 Merging a Branch into the Trunk
15. XEmacs from the Inside
16. Basic Types
17. Numeric Types
- 17.1 Abstract Interface
- 17.2 GMP driver
- 17.3 BSD MP driver
- 17.4 OpenSSL bignum driver
- 17.5 Numeric driver interface
18. Low-Level Allocation
- 18.1 Basic Heap Allocation
- 18.2 Stack Allocation
- 18.3 Dynamic Arrays
- 18.4 Internal Modules for Allocation
19. The XEmacs Object System (Abstractly Speaking)
20. How Lisp Objects Are Represented in C
21. Allocation of Objects in XEmacs Lisp
- 21.1 Introduction to Allocation
- 21.2 Garbage Collection
- 21.3 GCPROing
- 21.4 Garbage Collection - Step by Step
- 21.5 Fixnums and Characters
- 21.6 Allocation from Frob Blocks
- 21.7 lrecords
- 21.8 Low-level allocation
- 21.9 Cons
- 21.10 Vector
- 21.11 Bit Vector
- 21.12 Symbol
- 21.13 Marker
- 21.14 String
- 21.15 Compiled Function
22. The Lisp Reader and Compiler
23. Evaluation; Stack Frames; Bindings
- 23.1 Evaluation
- 23.2 Dynamic Binding; The specbinding Stack; Unwind-Protects
- 23.3 Simple Special Operators
- 23.4 Catch and Throw
- 23.5 Error Trapping
24. Symbols and Variables
- 24.1 Introduction to Symbols
- 24.2 Obarrays
- 24.3 Symbol Values
25. Buffers
- 25.1 Introduction to Buffers
- 25.2 Buffer Lists
- 25.3 Markers and Extents
- 25.4 The Buffer Object
26. Text
- 26.1 The Text in a Buffer
- 26.2 Ibytes and Ichars
- 26.3 Byte-Char Position Conversion
- 26.4 Searching and Matching
27. Multilingual Support
- 27.1 Introduction to Multilingual Issues #1
- 27.2 Introduction to Multilingual Issues #2
- 27.3 Introduction to Multilingual Issues #3
- 27.4 Introduction to Multilingual Issues #4
- 27.5 Character Sets
- 27.6 Encodings
  - 27.6.1 Japanese EUC (Extended Unix Code)
  - 27.6.2 JIS7
- 27.7 Internal Mule Encodings
- 27.8 Byte/Character Types; Buffer Positions; Other Typedefs
- 27.9 Internal Text APIs
- 27.10 Coding for Mule
- 27.11 CCL
- 27.12 Microsoft Windows-Related Multilingual Issues
- 27.13 Internal Modules for Internationalization
- 27.14 The Great Mule Merge of March 2002
28. Consoles; Devices; Frames; Windows
- 28.1 Introduction to Consoles; Devices; Frames; Windows
- 28.2 Point
- 28.3 Window Hierarchy
- 28.4 The Window Object
- 28.5 Internal Modules for the Basic Displayable Lisp Objects
29. Window-System Support
- 29.1 Creating a Window-System Type
30. Window and Frame Geometry
- 30.1 Intro to Window and Frame Geometry
- 30.2 The Frame
- 30.3 The Non-Client Area
- 30.4 The Client Area
- 30.5 The Paned Area
- 30.6 Text Areas, Fringes, Margins
- 30.7 The Displayable Area
- 30.8 Which Functions Use Which?
31. The Redisplay Mechanism
- 31.1 Critical Redisplay Sections
  - 31.1.1 Nasty Bugs due to Reentrancy in Redisplay Structures handling QUIT
- 31.2 Line Start Cache
- 31.3 Redisplay Piece by Piece
- 31.4 pixel_to_glyph_translation
- 31.5 Internal Modules for the Redisplay Mechanism
- 31.6 Internal Modules for other Display-Related Lisp Objects
32. Extents
- 32.1 Introduction to Extents
- 32.2 Extent Ordering
- 32.3 Format of the Extent Info
- 32.4 Zero-Length Extents
- 32.5 Mathematics of Extent Ordering
- 32.6 Extent Fragments
33. Faces
34. Glyphs
- 34.1 Glyph Instantiation
- 34.2 Widget-Glyphs
- 34.3 Widget-Glyphs in the MS-Windows Environment
- 34.4 Widget-Glyphs in the X Environment
35. Specifiers
36. Menus
37. Events and the Event Loop
- 37.1 Introduction to Events
- 37.2 Main Loop
- 37.3 Specifics of the Event Gathering Mechanism
- 37.4 Specifics About the Emacs Event
- 37.5 Event Queues
- 37.6 Event Stream Callback Routines
- 37.7 Other Event Loop Functions
- 37.8 Stream Pairs
- 37.9 Converting Events
- 37.10 Dispatching Events; The Command Builder
- 37.11 Focus Handling
- 37.12 Editor-Level Control Flow Internal Modules
38. Asynchronous Events; Quit Checking
- 38.1 Signal Handling
- 38.2 Control-G (Quit) Checking
  - 38.2.1 Reentrancy Problems due to QUIT Checking
- 38.3 Profiling
- 38.4 Asynchronous Timeouts
- 38.5 Exiting
39. Lstreams
- 39.1 Creating an Lstream
- 39.2 Lstream Types
- 39.3 Lstream Functions
- 39.4 Lstream Methods
40. Subprocesses
- 40.1 Ben’s separate stderr notes (probably obsolete)
41. Interface to MS Windows
- 41.1 Different kinds of Windows environments
- 41.2 Windows Build Flags
- 41.3 Windows I18N Introduction
- 41.4 Internal Modules for Interfacing with MS Windows
- 41.5 CHANGES from 21.4-windows branch (probably obsolete)
42. Interface to the X Window System
- 42.1 Lucid Widget Library
- 42.2 Internal Modules for Interfacing with X Windows
43. Dumping
- 43.1 Dumping Justification
- 43.2 Overview
- 43.3 Data descriptions
- 43.4 Dumping phase
- 43.5 Reloading phase
- 43.6 Dumping and restoring hash tables
44. Future Work
- 44.1 Future Work – General Suggestions
- 44.2 Future Work – Elisp Compatibility Package
- 44.3 Future Work – Drag-n-Drop
- 44.4 Future Work – Standard Interface for Enabling Extensions
- 44.5 Future Work – Better Initialization File Scheme
- 44.6 Future Work – Keyword Parameters
- 44.7 Future Work – Property Interface Changes
- 44.8 Future Work – Toolbars
  - 44.8.1 Future Work – Easier Toolbar Customization
  - 44.8.2 Future Work – Toolbar Interface Changes
- 44.9 Future Work – Menu API Changes
- 44.10 Future Work – Removal of Misc-User Event Type
- 44.11 Future Work – Mouse Pointer
  - 44.11.1 Future Work – Abstracted Mouse Pointer Interface
  - 44.11.2 Future Work – Busy Pointer
- 44.12 Future Work – Version Number and Development Tree Organization
- 44.13 Future Work – Improvements to the xemacs.org Website
- 44.14 Future Work – Keybindings
  - 44.14.1 Future Work – Keybinding Schemes
  - 44.14.2 Future Work – Better Support for Windows Style Key Bindings
  - 44.14.3 Future Work – Misc Key Binding Ideas
- 44.15 Future Work – Byte Code Snippets
  - 44.15.1 Future Work – Autodetection
  - 44.15.2 Future Work – Conversion Error Detection
  - 44.15.3 Future Work – Unicode
  - 44.15.4 Future Work – BIDI Support
  - 44.15.5 Future Work – Localized Text/Messages
  - 44.15.6 Proposal for How This All Ought to Work
- 44.16 Future Work – Lisp Stream API
- 44.17 Future Work – Multiple Values
- 44.18 Future Work – Macros
- 44.19 Future Work – Specifiers
- 44.20 Future Work – Making Elisp Function Calls Faster
- 44.21 Future Work – Lisp Engine Replacement
  - 44.21.1 Future Work – Lisp Engine Discussion
  - 44.21.2 Future Work – Lisp Engine Replacement – Implementation
  - 44.21.3 Future Work – Startup File Modification by Packages
- 44.22 Future Work – Better Rendering Support
  - 44.22.1 Better Rendering Support – Review Criteria
  - 44.22.2 Better Rendering Support – Implementation
  - 44.22.3 Better Rendering Support – Current Status
    - 44.22.3.1 Bugs Reported in sjt-xft
  - 44.22.4 Better Rendering Support – Configuration with the Interim Patches
  - 44.22.5 Better Rendering Support – Modern Font Support
45. Future Work Discussion
- 45.1 Discussion – Garbage Collection
- 45.2 Discussion – Glyphs
- 45.3 Discussion – Dialog Boxes
- 45.4 Discussion – Multilingual Issues
- 45.5 Discussion – Instantiators and Generic Property Accessors
- 45.6 Discussion – Switching to C++
- 45.7 Discussion – Windows External Widget
- 45.8 Discussion – Packages
- 45.9 Discussion – Distribution Layout
46. Old Future Work
- 46.1 Old Future Work – A Portable Unexec Replacement
- 46.2 Old Future Work – Indirect Buffers
- 46.3 Old Future Work – Improvements in support for non-ASCII (European) keysyms under X
- 46.4 Old Future Work – RTF Clipboard Support
- 46.5 Old Future Work – xemacs.org Mailing Address Changes
- 46.6 Old Future Work – Lisp callbacks from critical areas of the C code
- 46.7 Old Future Work – Everything should obey duplicable extents
- 46.8 Old Future Work – Display Tables
- 46.9 Future Work – Keyword Parameters
Index