Free Software Foundation GNU Emacs LISP Reference ManuaL

Caveats......Page 24 nil and t......Page 25 Printing Notation......Page 26 A Sample Function Description......Page 27 Version Information......Page 29 Acknowledgements......Page 30 Printed Representation and Read Syntax......Page 31 Integer Type......Page 32 Basic Char Syntax......Page 33 General Escape Syntax......Page 34 Meta-Character Syntax......Page 35 Symbol Type......Page 36 Cons Cell and List Types......Page 37 Drawing Lists as Box Diagrams......Page 38 Dotted Pair Notation......Page 39 Association List Type......Page 40 Syntax for Strings......Page 41 Nonprinting Characters in Strings......Page 42 Char-Table Type......Page 43 Function Type......Page 44 Byte-Code Function Type......Page 45 Buffer Type......Page 46 Window Type......Page 47 Stream Type......Page 48 Read Syntax for Circular Objects......Page 49 Type Predicates......Page 50 Equality Predicates......Page 53 Integer Basics......Page 55 Floating Point Basics......Page 56 Type Predicates for Numbers......Page 57 Comparison of Numbers......Page 58 Numeric Conversions......Page 59 Arithmetic Operations......Page 61 Rounding Operations......Page 63 Bitwise Operations on Integers......Page 64 Standard Mathematical Functions......Page 67 Random Numbers......Page 68 String and Character Basics......Page 70 Creating Strings......Page 71 Modifying Strings......Page 74 Comparison of Characters and Strings......Page 75 Conversion of Characters and Strings......Page 77 Formatting Strings......Page 79 Case Conversion in Lisp......Page 81 The Case Table......Page 83 Lists and Cons Cells......Page 86 Accessing Elements of Lists......Page 87 Building Cons Cells and Lists......Page 90 Modifying List Variables......Page 94 Altering List Elements with setcar......Page 96 Altering the CDR of a List......Page 97 Functions that Rearrange Lists......Page 98 Using Lists as Sets......Page 101 Association Lists......Page 104 Managing a Fixed-Size Ring of Objects......Page 107 Sequences......Page 110 Arrays......Page 112 Functions that Operate on Arrays......Page 113 Vectors......Page 114 Functions for Vectors......Page 115 Char-Tables......Page 116 Bool-vectors......Page 118 Creating Hash Tables......Page 120 Defining Hash Comparisons......Page 122 Other Hash Table Functions......Page 123 Symbol Components......Page 125 Defining Symbols......Page 126 Creating and Interning Symbols......Page 127 Property Lists and Association Lists......Page 130 Property Lists Outside Symbols......Page 131 Evaluation......Page 133 Symbol Forms......Page 134 Symbol Function Indirection......Page 135 Lisp Macro Evaluation......Page 136 Special Forms......Page 137 Quoting......Page 138 Eval......Page 139 Sequencing......Page 142 Conditionals......Page 143 Constructs for Combining Conditions......Page 145 Iteration......Page 147 Explicit Nonlocal Exits: catch and throw......Page 148 Examples of catch and throw......Page 149 Errors......Page 150 How to Signal an Error......Page 151 Writing Code to Handle Errors......Page 152 Error Symbols and Condition Names......Page 155 Cleaning Up from Nonlocal Exits......Page 156 Variables that Never Change......Page 158 Local Variables......Page 159 When a Variable is ``Void''......Page 161 Defining Global Variables......Page 162 Tips for Defining Variables Robustly......Page 164 How to Alter a Variable Value......Page 166 Scope......Page 168 Implementation of Dynamic Scoping......Page 169 Buffer-Local Variables......Page 170 Introduction to Buffer-Local Variables......Page 171 Creating and Deleting Buffer-Local Bindings......Page 172 The Default Value of a Buffer-Local Variable......Page 175 Frame-Local Variables......Page 176 File Local Variables......Page 178 Variable Aliases......Page 180 Variables with Restricted Values......Page 181 What Is a Function?......Page 183 Lambda Expressions......Page 184 A Simple Lambda-Expression Example......Page 185 Other Features of Argument Lists......Page 186 Documentation Strings of Functions......Page 187 Defining Functions......Page 188 Calling Functions......Page 190 Mapping Functions......Page 191 Anonymous Functions......Page 193 Accessing Function Cell Contents......Page 194 Inline Functions......Page 196 Other Topics Related to Functions......Page 197 Expansion of a Macro Call......Page 199 Macros and Byte Compilation......Page 200 Defining Macros......Page 201 Backquote......Page 202 Evaluating Macro Arguments Repeatedly......Page 203 Evaluating Macro Arguments in Expansion......Page 205 How Many Times is the Macro Expanded?......Page 206 Indenting Macros......Page 207 Common Item Keywords......Page 208 Defining Customization Groups......Page 210 Defining Customization Variables......Page 211 Simple Types......Page 214 Composite Types......Page 217 Splicing into Lists......Page 220 Type Keywords......Page 221 Defining New Types......Page 222 How Programs Do Loading......Page 224 Library Search......Page 226 Loading Non-ASCII Characters......Page 228 Autoload......Page 229 Repeated Loading......Page 231 Features......Page 232 Unloading......Page 234 Hooks for Loading......Page 235 Performance of Byte-Compiled Code......Page 237 The Compilation Functions......Page 238 Documentation Strings and Compilation......Page 240 Dynamic Loading of Individual Functions......Page 241 Evaluation During Compilation......Page 242 Byte-Code Function Objects......Page 243 Disassembled Byte-Code......Page 244 A Simple Advice Example......Page 249 Defining Advice......Page 250 Around-Advice......Page 252 Activation of Advice......Page 253 Preactivation......Page 255 Argument Access in Advice......Page 256 Advising Primitives......Page 257 The Combined Definition......Page 258 Entering the Debugger on an Error......Page 260 Entering the Debugger on a Function Call......Page 262 Using the Debugger......Page 263 Debugger Commands......Page 264 Invoking the Debugger......Page 265 Internals of the Debugger......Page 266 Edebug......Page 268 Using Edebug......Page 269 Edebug Execution Modes......Page 270 Miscellaneous Edebug Commands......Page 272 Edebug Breakpoints......Page 273 Source Breakpoints......Page 274 Edebug Views......Page 275 Evaluation List Buffer......Page 276 Printing in Edebug......Page 277 Trace Buffer......Page 278 Coverage Testing......Page 279 Edebug Display Update......Page 280 Instrumenting Macro Calls......Page 281 Specification List......Page 282 Backtracking in Specifications......Page 285 Edebug Options......Page 286 Excess Open Parentheses......Page 288 Test Coverage......Page 289 Debugging Problems in Compilation......Page 290 Input Streams......Page 291 Output Streams......Page 294 Output Functions......Page 296 Variables Affecting Output......Page 299 Introduction to Minibuffers......Page 301 Reading Text Strings with the Minibuffer......Page 302 Reading Lisp Objects with the Minibuffer......Page 304 Minibuffer History......Page 305 Initial Input......Page 307 Basic Completion Functions......Page 308 Completion and the Minibuffer......Page 311 Minibuffer Commands that Do Completion......Page 312 High-Level Completion Functions......Page 314 Reading File Names......Page 316 Yes-or-No Queries......Page 319 Asking Multiple Y-or-N Questions......Page 321 Reading a Password......Page 322 Minibuffer Windows......Page 323 Minibuffer Contents......Page 324 Minibuffer Miscellany......Page 325 Command Loop Overview......Page 327 Using interactive......Page 328 Code Characters for interactive......Page 330 Examples of Using interactive......Page 332 Interactive Call......Page 333 Information from the Command Loop......Page 335 Keyboard Events......Page 338 Function Keys......Page 339 Mouse Events......Page 340 Click Events......Page 341 Drag Events......Page 342 Repeat Events......Page 343 Motion Events......Page 344 Miscellaneous System Events......Page 345 Classifying Events......Page 347 Accessing Events......Page 349 Putting Keyboard Events in Strings......Page 351 Reading Input......Page 352 Key Sequence Input......Page 353 Reading One Event......Page 354 Modifying and Translating Input Events......Page 356 Invoking the Input Method......Page 357 Miscellaneous Event Input Features......Page 358 Waiting for Elapsed Time or Input......Page 360 Quitting......Page 361 Prefix Command Arguments......Page 363 Recursive Editing......Page 365 Command History......Page 367 Keyboard Macros......Page 368 Key Sequences......Page 370 Format of Keymaps......Page 371 Creating Keymaps......Page 373 Inheritance and Keymaps......Page 374 Prefix Keys......Page 375 Active Keymaps......Page 376 Searching the Active Keymaps......Page 378 Controlling the Active Keymaps......Page 379 Key Lookup......Page 381 Functions for Key Lookup......Page 383 Changing Key Bindings......Page 384 Remapping Commands......Page 387 Keymaps for Translating Sequences of Events......Page 388 Commands for Binding Keys......Page 390 Scanning Keymaps......Page 391 Defining Menus......Page 393 Simple Menu Items......Page 394 Extended Menu Items......Page 395 Menu Separators......Page 397 Menus and the Mouse......Page 398 Menu Example......Page 399 The Menu Bar......Page 400 Tool bars......Page 401 Modifying Menus......Page 404 Hooks......Page 405 Major Mode Basics......Page 407 Major Mode Conventions......Page 408 How Emacs Chooses a Major Mode......Page 411 Getting Help about a Major Mode......Page 413 Defining Derived Modes......Page 414 Generic Modes......Page 415 Mode Hooks......Page 416 Major Mode Examples......Page 417 Conventions for Writing Minor Modes......Page 420 Defining Minor Modes......Page 422 The Data Structure of the Mode Line......Page 425 The Top Level of Mode Line Control......Page 427 Variables Used in the Mode Line......Page 428 %-Constructs in the Mode Line......Page 430 Window Header Lines......Page 432 Imenu......Page 433 Font Lock Mode......Page 435 Font Lock Basics......Page 436 Search-based Fontification......Page 437 Customizing Search-Based Fontification......Page 440 Other Font Lock Variables......Page 441 Faces for Font Lock......Page 442 Syntactic Font Lock......Page 443 Setting Syntax Properties......Page 444 Multiline Font Lock Constructs......Page 445 Region to Fontify after a Buffer Change......Page 446 Desktop Save Mode......Page 447 Documentation Basics......Page 448 Access to Documentation Strings......Page 449 Substituting Key Bindings in Documentation......Page 451 Describing Characters for Help Messages......Page 452 Help Functions......Page 454 Functions for Visiting Files......Page 457 Subroutines of Visiting......Page 459 Saving Buffers......Page 460 Reading from Files......Page 463 Writing to Files......Page 464 File Locks......Page 465 Testing Accessibility......Page 466 Distinguishing Kinds of Files......Page 468 Truenames......Page 469 Other Information about Files......Page 470 How to Locate Files in Standard Places......Page 472 Changing File Names and Attributes......Page 473 File Name Components......Page 476 Absolute and Relative File Names......Page 478 Directory Names......Page 479 Functions that Expand Filenames......Page 480 Generating Unique File Names......Page 482 File Name Completion......Page 484 Contents of Directories......Page 485 Making Certain File Names ``Magic''......Page 487 File Format Conversion......Page 491 Making Backup Files......Page 494 Backup by Renaming or by Copying?......Page 496 Naming Backup Files......Page 497 Auto-Saving......Page 499 Reverting......Page 502 The Current Buffer......Page 504 Buffer Names......Page 507 Buffer File Name......Page 508 Buffer Modification......Page 510 Buffer Modification Time......Page 511 Read-Only Buffers......Page 512 The Buffer List......Page 513 Creating Buffers......Page 515 Killing Buffers......Page 516 Indirect Buffers......Page 517 The Buffer Gap......Page 518 Basic Concepts of Emacs Windows......Page 520 Splitting Windows......Page 521 Deleting Windows......Page 524 Selecting Windows......Page 525 Cyclic Ordering of Windows......Page 526 Buffers and Windows......Page 528 Displaying Buffers in Windows......Page 529 Choosing a Window for Display......Page 531 Windows and Point......Page 534 The Window Start Position......Page 535 Textual Scrolling......Page 538 Horizontal Scrolling......Page 541 The Size of a Window......Page 543 Changing the Size of a Window......Page 545 Coordinates and Windows......Page 547 The Window Tree......Page 548 Window Configurations......Page 549 Hooks for Window Scrolling and Changes......Page 550 Creating Frames......Page 552 Multiple Displays......Page 553 Access to Frame Parameters......Page 554 Initial Frame Parameters......Page 555 Position Parameters......Page 556 Layout Parameters......Page 557 Buffer Parameters......Page 558 Cursor Parameters......Page 559 Color Parameters......Page 560 Frame Size And Position......Page 561 Frame Titles......Page 563 Finding All Frames......Page 564 Frames and Windows......Page 565 Input Focus......Page 566 Visibility of Frames......Page 568 Frame Configurations......Page 569 Mouse Position......Page 570 Pop-Up Menus......Page 571 Dialog Boxes......Page 572 Window System Selections......Page 573 Color Names......Page 575 Text Terminal Colors......Page 577 Display Feature Testing......Page 578 Point......Page 582 Motion by Characters......Page 583 Motion to an End of the Buffer......Page 584 Motion by Text Lines......Page 585 Motion by Screen Lines......Page 587 Moving over Balanced Expressions......Page 589 Skipping Characters......Page 590 Excursions......Page 591 Narrowing......Page 592 Overview of Markers......Page 595 Functions that Create Markers......Page 596 Information from Markers......Page 598 Moving Marker Positions......Page 599 The Mark......Page 600 The Region......Page 602 Examining Text Near Point......Page 604 Examining Buffer Contents......Page 605 Comparing Text......Page 607 Inserting Text......Page 608 User-Level Insertion Commands......Page 609 Deleting Text......Page 610 User-Level Deletion Commands......Page 612 Kill Ring Concepts......Page 614 Yanking......Page 615 Functions for Yanking......Page 616 Low-Level Kill Ring......Page 617 Internals of the Kill Ring......Page 618 Undo......Page 619 Maintaining Undo Lists......Page 621 Filling......Page 622 Margins for Filling......Page 625 Adaptive Fill Mode......Page 626 Auto Filling......Page 627 Sorting Text......Page 628 Indentation......Page 632 Indentation Controlled by Major Mode......Page 633 Indenting an Entire Region......Page 634 Indentation Relative to Previous Lines......Page 635 Case Changes......Page 636 Examining Text Properties......Page 638 Changing Text Properties......Page 639 Text Property Search Functions......Page 641 Properties with Special Meanings......Page 643 Formatted Text Properties......Page 647 Stickiness of Text Properties......Page 648 Saving Text Properties in Files......Page 649 Lazy Computation of Text Properties......Page 650 Defining Clickable Text......Page 651 Links and Mouse-1......Page 652 Defining and Using Fields......Page 653 Why Text Properties are not Intervals......Page 655 Substituting for a Character Code......Page 656 Registers......Page 657 Base 64 Encoding......Page 658 MD5 Checksum......Page 659 Atomic Change Groups......Page 660 Change Hooks......Page 661 Text Representations......Page 663 Converting Text Representations......Page 664 Selecting a Representation......Page 665 Character Codes......Page 666 Character Sets......Page 667 Splitting Characters......Page 668 Scanning for Character Sets......Page 669 Translation of Characters......Page 670 Basic Concepts of Coding Systems......Page 671 Encoding and I/O......Page 672 Coding Systems in Lisp......Page 673 User-Chosen Coding Systems......Page 675 Default Coding Systems......Page 676 Specifying a Coding System for One Operation......Page 678 Explicit Encoding and Decoding......Page 679 Terminal I/O Encoding......Page 680 MS-DOS File Types......Page 681 Input Methods......Page 682 Locales......Page 683 Searching for Strings......Page 684 Syntax of Regular Expressions......Page 686 Special Characters in Regular Expressions......Page 687 Character Classes......Page 690 Backslash Constructs in Regular Expressions......Page 691 Complex Regexp Example......Page 694 Regular Expression Functions......Page 695 Regular Expression Searching......Page 696 Replacing the Text that Matched......Page 699 Simple Match Data Access......Page 700 Accessing the Entire Match Data......Page 702 Saving and Restoring the Match Data......Page 703 Search and Replace......Page 704 Standard Regular Expressions Used in Editing......Page 706 Syntax Descriptors......Page 707 Table of Syntax Classes......Page 708 Syntax Flags......Page 710 Syntax Table Functions......Page 711 Syntax Properties......Page 713 Parsing Expressions......Page 714 Finding the Parse State for a Position......Page 715 Parser State......Page 716 Low-Level Parsing......Page 717 Syntax Table Internals......Page 718 Categories......Page 719 Abbrev Tables......Page 722 Defining Abbrevs......Page 723 Saving Abbrevs in Files......Page 724 Looking Up and Expanding Abbreviations......Page 725 Standard Abbrev Tables......Page 727 Functions that Create Subprocesses......Page 728 Shell Arguments......Page 729 Creating a Synchronous Process......Page 730 Creating an Asynchronous Process......Page 733 Process Information......Page 735 Sending Input to Processes......Page 737 Sending Signals to Processes......Page 738 Process Buffers......Page 740 Process Filter Functions......Page 741 Decoding Process Output......Page 743 Sentinels: Detecting Process Status Changes......Page 744 Transaction Queues......Page 746 Network Connections......Page 747 Datagrams......Page 749 make-network-process......Page 750 Network Options......Page 752 Testing Availability of Network Features......Page 753 Misc Network Facilities......Page 754 Describing Data Layout......Page 755 Functions to Unpack and Pack Bytes......Page 757 Examples of Byte Unpacking and Packing......Page 758 Forcing Redisplay......Page 762 Truncation......Page 763 Displaying Messages in the Echo Area......Page 764 Reporting Operation Progress......Page 766 Logging Messages in *Messages*......Page 767 Reporting Warnings......Page 768 Warning Variables......Page 769 Invisible Text......Page 771 Selective Display......Page 773 Temporary Displays......Page 775 Managing Overlays......Page 777 Overlay Properties......Page 779 Searching for Overlays......Page 782 Width......Page 783 Line Height......Page 784 Faces......Page 785 Defining Faces......Page 786 Face Attributes......Page 788 Face Attribute Functions......Page 790 Displaying Faces......Page 793 Font Selection......Page 794 Functions for Working with Faces......Page 795 Looking Up Fonts......Page 796 Fontsets......Page 797 Fringe Size and Position......Page 799 Fringe Indicators......Page 800 Fringe Bitmaps......Page 802 The Overlay Arrow......Page 803 Scroll Bars......Page 804 Specified Spaces......Page 806 Pixel Specification for Spaces......Page 807 Other Display Specifications......Page 808 Displaying in the Margins......Page 809 Images......Page 810 Image Descriptors......Page 811 XBM Images......Page 814 Other Image Types......Page 815 Defining Images......Page 816 Showing Images......Page 818 Buttons......Page 819 Button Properties......Page 820 Making Buttons......Page 821 Manipulating Buttons......Page 822 Abstract Display......Page 823 Abstract Display Functions......Page 824 Abstract Display Example......Page 826 Blinking Parentheses......Page 828 Usual Display Conventions......Page 829 Display Table Format......Page 830 Glyphs......Page 832 Beeping......Page 833 Window Systems......Page 834 Summary: Sequence of Actions at Startup......Page 835 The Init File, .emacs......Page 836 Terminal-Specific Initialization......Page 837 Command-Line Arguments......Page 838 Suspending Emacs......Page 840 Operating System Environment......Page 842 User Identification......Page 845 Time of Day......Page 847 Time Conversion......Page 848 Parsing and Formatting Times......Page 849 Time Calculations......Page 851 Timers for Delayed Execution......Page 852 Idle Timers......Page 854 Input Modes......Page 855 Recording Input......Page 856 Terminal Output......Page 857 Operating on X11 Keysyms......Page 858 Session Management......Page 859 Old Lisp Features in Emacs 21......Page 861 GNU Free Documentation License......Page 866 ADDENDUM: How to use this License for your documents......Page 872 Preamble......Page 873 Terms and Conditions for Copying, Distribution and Modification......Page 874 How to Apply These Terms to Your New Programs......Page 878 Emacs Lisp Coding Conventions......Page 879 Key Binding Conventions......Page 882 Emacs Programming Tips......Page 883 Tips for Making Compiled Code Fast......Page 884 Tips for Documentation Strings......Page 885 Tips on Writing Comments......Page 888 Conventional Headers for Emacs Libraries......Page 890 Building Emacs......Page 893 Pure Storage......Page 894 Garbage Collection......Page 895 Memory Usage......Page 898 Writing Emacs Primitives......Page 899 Buffer Internals......Page 903 Window Internals......Page 909 Process Internals......Page 912 Standard Errors......Page 914 Buffer-Local Variables......Page 918 Standard Keymaps......Page 922 Standard Hooks......Page 926 Index......Page 931