Changeset 7869e48 for doc/code.txt
- Timestamp:
- Jan 12, 2013, 1:43:13 PM (11 years ago)
- Children:
- e3a0d71, 4485285
- Parents:
- 4626016
- git-author:
- Jason Gross <jgross@mit.edu> (01/12/13 13:13:18)
- git-committer:
- Jason Gross <jgross@mit.edu> (01/12/13 13:43:13)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/code.txt
rd40ad8b r7869e48 16 16 is owl_function_command("foo"); 17 17 Commands are only active within specific contexts, 18 and attempts to call them from invalid contexts will fail. 18 and attempts to call them from invalid contexts will fail. 19 19 20 context: A context specifies the current state of owl, in terms 20 context: A context specifies the current state of owl, in terms 21 21 of which modal window is active and which point 22 22 in its life owl is in (eg, in startup, or running). 23 This is implemented as a bitmask and there is 23 This is implemented as a bitmask and there is 24 24 some hierarchy. Commands may restrict themselves 25 25 to only running in a limited number of contexts … … 34 34 Sometimes also referred to as typewin. 35 35 36 filter: Patterns which match messages. These may 37 contain multiple filterelements which may be 36 filter: Patterns which match messages. These may 37 contain multiple filterelements which may be 38 38 combined together (eg, by "and" and "or"). 39 40 filterelement: An element of a filter which matches on some 39 40 filterelement: An element of a filter which matches on some 41 41 attribute of a message. 42 42 … … 44 44 These are particularly useful for building up 45 45 text regions that are to be rendered on-screen, 46 as they resize memory as needed, and they have 46 as they resize memory as needed, and they have 47 47 routines for cropping as needed. 48 48 … … 55 55 owl.h defines "g" as a singleton instance of owl_global. 56 56 Where possible/appropriate, most accesses to global data should 57 be from a limited number of files (eg, from owl.c and 57 be from a limited number of files (eg, from owl.c and 58 58 functions.c). Consider whether you really need to before 59 59 adding in uses of global. … … 103 103 Also contains the main loop, which is roughly: 104 104 - handle scheduled resizes, and anything that might result 105 - while zephyrs are pending, grab incoming zephyrs 105 - while zephyrs are pending, grab incoming zephyrs 106 106 and handle them (which includes formatting them 107 107 with either perl extension or default formatter … … 109 109 - updates mainwin display if there are new zephyrs 110 110 - displays and updates popwins and the terminal as necessary 111 - sends characters to the popwin, recwin/mainwin, 111 - sends characters to the popwin, recwin/mainwin, 112 112 or typewin/editwin 113 113 … … 118 118 Created by codelist.pl. 119 119 120 popwin: Modal pop-up window container. 120 popwin: Modal pop-up window container. 121 121 Usually contains a viewwin for read-only scrolling text. 122 122 … … 126 126 127 127 util: Misc utility functions that don't fit anywhere yet: 128 - sepbar rendering 128 - sepbar rendering 129 129 - tokenizing and parsing utilities 130 130 - downstr … … 186 186 something, and this should be the exception to the rule. 187 187 188 Owl should be generally useful out-of-the-box without 189 extensive configuration, for most people's needs. 188 Owl should be generally useful out-of-the-box without 189 extensive configuration, for most people's needs. 190 190 People shouldn't have to spend days tweaking 191 191 with config files before being happy switching to it.
Note: See TracChangeset
for help on using the changeset viewer.