]> git.lyx.org Git - lyx.git/blob - src/frontends/xforms/forms/fdfixh.sed
Tidy up a few comments.
[lyx.git] / src / frontends / xforms / forms / fdfixh.sed
1 # file fdfixh.sed
2 # This file is part of LyX, the document processor.
3 # Licence details can be found in the file COPYING.
4 #
5 # author Angus Leeming
6 #
7 # Full author contact details are available in file CREDITS
8 #
9 # Use so:
10 # sed -f fdfixh.sed < somefile.h > fixedfile.h
11 #
12 # It contains the instructions that sed requires to manipulate
13 # the .h files produced by fdesign into a form usable by LyX
14
15 # Pretty formatting; remove trailing whitespace.
16 s/[     ]*$//
17
18
19 # Delete blank lines, "extern void" function declarations and fdesign comments.
20 /^$/d
21 /^extern void/d
22 /Forms and Objects/d
23 /Callbacks, globals/d
24 /generated with fdesign/d
25
26
27 # Pretty formatting; add an empty line before "#endif"
28 /#endif/i\
29
30
31 # Immediately after line "#define FD_xxx_h_" that starts off the header file,
32 # #include "fdesign_base.h" and append the contents of file EXTERN_FUNCS.
33 # This latter is a sorted, unique list of any function declarations.
34 # The actual name of the file is inserted by the parent shell script.
35 /#define FD/{
36 a\
37 \
38 #include "fdesign_base.h"\
39
40 r EXTERN_FUNCS
41 }
42
43
44 # Rewrite FD_form_xxx as FD_xxx.
45 # This is done both for the structs and for the #define bounding the header.
46 s/\(.*\) FD_form_\(.*\)/\1 FD_\2/
47
48
49 # Rename the function create_form_form_xxx(void) as build_xxx(void *).
50 s/extern \(.*\) create_form_form_\(.*\)[(]void[)]/\1 build_\2(void *)/
51
52
53 # Manipulate the structs:
54 #
55 # Rewrite                       as
56 # typedef struct {              struct FD_xxx : public FD_base {
57 #       FL_FORM *form_xxx;              FL_OBJECT * some_obj;
58 #       void *vdata;                    ...
59 #       char *cdata;            };      
60 #       long  ldata;
61 #       FL_OBJECT *some_obj;
62 #       ...
63 # } FD_xxx;
64 #
65 # This is detailed more closely below 
66
67 # We retain only those lines in the struct that start " FL_OBJECT *",
68 # placing them in the hold space until the end of the struct is reached
69 # and we can ascertain the struct's name.
70
71 # All other lines are deleted:
72 /^typedef struct/d
73 /^      /{ /FL_OBJECT/!d; }
74
75
76 # For all lines starting with FL_OBJECT...
77 /^      FL_OBJECT/{
78
79 # 1. Perform a little pretty formatting.
80 s/\(FL_OBJECT \*\)/\1 /
81
82 # 2. Append to the hold space and delete from the pattern space.
83 H; d
84 }
85
86
87 # The struct is ended by "} FD_xxx;", so now's the time to paste back the
88 # contents of the hold space.
89 /^} FD_.*;/{
90
91 # 1. Rewrite "} FD_xxx;" as   "\nstruct FD_xxx : public FD_base {".
92 s/} \(.*\);/\
93 struct \1 : public FD_base {/
94
95 # 2. The hold space contains the FL_OBJECT lines, preceded by a new line.
96 #    To get rid of this new line, we exchange the contents of the hold and
97 #    pattern spaces, remove the new line and then exchange back.
98 x; s/^\n//; x
99
100 # 3. Paste the contents of the hold space beneath the "struct FD_xxx" line.
101 #    and empty the hold space
102 G; h; s/.*//; x
103
104 # 4. Close the struct and append an empty line.
105 a\
106 };\
107
108 }