/[beaver]/beaver/HACKING
ViewVC logotype

Diff of /beaver/HACKING

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.3 by skypher, Sun Mar 16 12:27:24 2003 UTC revision 1.4 by skypher, Mon Mar 17 12:14:03 2003 UTC
# Line 4  Leslie 03/2003 Line 4  Leslie 03/2003
4    
5  This file serves as an overview of and a brief introduction to  This file serves as an overview of and a brief introduction to
6  Beaver's source layout, files as well as the most important  Beaver's source layout, files as well as the most important
7  objects, variables and macros.  objects, global variables and macros.
8  It is therefore not for the end-user but for interested developers.  It is therefore not for the end-user but for interested developers.
9    
10    
11  1. Source layout  1. Source Layout
12    ----------------
13          /          /
14          misc. files          misc. files
15          +-- src          +-- src
# Line 18  It is therefore not for the end-user but Line 19  It is therefore not for the end-user but
19          +-- bl          +-- bl
20                  Beaver language files                  Beaver language files
21          +-- pixmaps          +-- pixmaps
22                  Toolbar icons and the like                  toolbar icons and the like
23          +-- po          +-- po
24                  gettext translation files                  gettext translation files
25            +-- intl
26                    gettext support files
27    
28    
29  2. Files in src/ in alphabetical order  2. Files In src/ In Alphabetical Order
30    --------------------------------------
31    
32  completion.h, completion.c:  completion.h, completion.c:
33          Autocompletion routines.          Autocompletion routines.
# Line 35  conf.h, conf.c: Line 39  conf.h, conf.c:
39    
40  editor.h, editor.c:  editor.h, editor.c:
41          All functions that operate on the main GtkTextView.          All functions that operate on the main GtkTextView.
42            For example: loading of wordfiles, syntax highlighting,
43            auto-indentation.
44    
45  filesops.h, filesops.c:  filesops.h, filesops.c:
46          Callbacks for the 'File' menu. Utility functions for filename          Callbacks for the 'File' menu. Utility functions for filename
# Line 64  toolbar.h, toolbar.c: Line 70  toolbar.h, toolbar.c:
70          the toolbar.          the toolbar.
71    
72  wordfile.h:  wordfile.h:
         Built-in wordfile in a big char*.  
73            Built-in wordfile in a big char*.
74    
75    
76    3. Custom Types
77    ---------------
78    
79    
80    4. Global Variables
81    -------------------
82    
83    
84    5. Macros
85    ---------
86    DEBUG_*, START_FCN, END_FCN:
87            Various debug functions, the two latter ones to measure time.
88    
89    FPROPS:
90            FPROPS(Page, Element) is defined to
91    
92                    g_array_index(FileProperties, t_fprops, Page).Element
93    
94            and g_array_index is prototyped thus:
95            
96                    #define g_array_index(a, t, i) (((t*) (a)->data) [(i)])
97    
98            which means that it fetches the i-th element of an
99            array and casts the result to a pointer of type t.
100            t_fprops is a type representing all important information
101            of an open file. Page represents a tab in the main notebook.
102            So FPROPS(0, ReadOnly) returns a gint telling whether the
103            first file is marked read-only.

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.4

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26