home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / utilities / zap / !Zap / Docs / E-Flags < prev    next >
Encoding:
Text File  |  1994-01-23  |  3.4 KB  |  81 lines
  1. *************************************************************************
  2. * >E-Flags    Documents the '*_flags' and '*_format' words.        *
  3. *************************************************************************
  4.  
  5. This file documents the bits of the flag/format words. To be specific these
  6. are the word variables named opt_flags, f_flags, w_flags and opt_format,
  7. w_format. The opt_* variables give the default values to use when creating
  8. new file or window blocks and these are saved in the !Config file. See the
  9. file E-Vars on how to change them. The f_* and w_* variable offsets are
  10. documented in E-File and E-Windows.
  11.  
  12. After each bit, I will write an 'o','f' or 'w' depending on whether that bit
  13. has meaning in the opt_flags, f_flags or w_flags words.
  14.  
  15. The flags word:
  16.  
  17. b0    of    Set if undo supported for this file.
  18. b1    ow    0=insert mode 1=overwrite mode
  19. b2    o    0=files auto deleted 1=no auto delete of files
  20. b3    f    Set if file altered
  21. b4    of    Set if file permanently read only (big R in title)
  22. b5    ow    Set if in hex entry mode for this window
  23. b6    ow    Set if auto width option active
  24. b7    f    Indicates file not in buffer list - out of date - do not use
  25. b8    of    Set if file temporarily read only (small r in title)
  26. b9 & 10    ow    Tab mode 00=Unix 01=!Edit 10=coltab mode 11=undefined
  27. b11    ow    Set means insert tabs as spaces.
  28. b12    o    Set if search case sensitive.
  29. b13    ow    Set if wordwrap mode on.
  30. b14    f    Set to unlink input position from input cursor.
  31. b15    o    Set for sideways printing in 'fancy print'.
  32. b16    o    Set for don't add title in 'fancy print'.
  33. b17    ow    Redraw mode low bit - see later
  34. b18    o    Set for don't add title in 'quick print'.
  35. b19    ow    Set for don't use search macros.
  36. b20    ow    Redraw mode medium bit - see later
  37. b21    ow    Redraw mode high bit - see later
  38. b22    o    Set if selections should automatically vanish.
  39. b23    o    Minibuffer permanent if set (popup otherwise).
  40. b24    f    Set to prevent input cursor being drawn after a text change.
  41. b25    o    Set if gain input calls should be ignored - internal use
  42. b26    ow    Set if linewrap mode on.
  43. b27        Reserved
  44. b28        Reserved
  45. b29        Reserved
  46. b30    w    Internal use : Window changed during scrolling.
  47. b31    w    Internal use : Window needs to be altered after mode change.
  48.  
  49. The redraw mode bits can be described by the masks:
  50.     &000000    1 dpp system font
  51.     &020000 system font via vdu
  52.     &100000 scaled system font
  53.     &120000 font via vdu
  54.     &200000 fast font redraw
  55.     &220000 double height system font
  56.     &300000 reserved
  57.     &320000 reserved
  58.  
  59. Now the 'format' word. This word is very important as it contains the mode
  60. number of the window. You should use Zap_NewMode to change it. All bits are
  61. valid in opt_format and w_format. The opt_format mode is the options mode
  62. mentioned in the 'Options.Mode' menu.
  63.  
  64. b0-b7    Mode number (0-255)
  65. b8    0=no line numbers 1=show line numbers
  66. b9    0=line numbers are file offsets 1=line numbers are lines (see b11)
  67. b10    0=line numbers given in decimal 1=line numbers given in hex
  68. b11    0=line numbers are physical 1=line numbers are logical
  69. b12-b13 Tab display format 00=none 01=spaces 10= '->   ' 11='----->'
  70. b14    0=stream edit paradigm 1=line edit paradigm
  71. b15    Set for non standard edit mode
  72. b16    Set for auto indent mode
  73. b17    Set for big endian mode
  74. b18-b30 reserved
  75. b31    Internal use : Set to force default (options) mode on loading a file
  76.  
  77. People writing modes should note that it is their responsibility to save the
  78. current mode options/restore the options on a e_end or e_start call.  Use the
  79. call Zap_RestoreModeWord on your e_start call and Zap_SaveModeWord on your
  80. e_end call to accomplish this.
  81.