1 | # Oracle VM VirtualBox
|
---|
2 | # VirtualBox to Linux kernel coding style conversion script.
|
---|
3 |
|
---|
4 | #
|
---|
5 | # Copyright (C) 2017-2019 Oracle Corporation
|
---|
6 | #
|
---|
7 | # This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
8 | # available from http://www.virtualbox.org. This file is free software;
|
---|
9 | # you can redistribute it and/or modify it under the terms of the GNU
|
---|
10 | # General Public License (GPL) as published by the Free Software
|
---|
11 | # Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
12 | # VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
13 | # hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
14 | #
|
---|
15 |
|
---|
16 | # This script is for converting code inside the vboxvideo module to Linux
|
---|
17 | # kernel coding style. It assumes correct VirtualBox coding style, will break
|
---|
18 | # break if the coding style is wrong (e.g. tab instead of spaces) and is not
|
---|
19 | # indended to be a generic solution: for example, identifiers will be
|
---|
20 | # translated case by case, not algorithmically. It also assumes that any
|
---|
21 | # flexibility in either coding style will be used where possible to make the
|
---|
22 | # code conform to both at once.
|
---|
23 |
|
---|
24 | # Replace up to six leading groups of four spaces with tabs.
|
---|
25 | s/^ */\t\t\t\t\t\t/g
|
---|
26 | s/^ /\t\t\t\t\t/g
|
---|
27 | s/^ /\t\t\t\t/g
|
---|
28 | s/^ /\t\t\t/g
|
---|
29 | s/^ /\t\t/g
|
---|
30 | s/^ /\t/g
|
---|
31 |
|
---|
32 | # Change various symbols and file names to fit kernel conventions.
|
---|
33 |
|
---|
34 | # Miscellaneous:
|
---|
35 | # Remove @file headers.
|
---|
36 | \|/\*\* @file| {
|
---|
37 | :start
|
---|
38 | N
|
---|
39 | s|\*/|\*/|g
|
---|
40 | T start
|
---|
41 | N
|
---|
42 | d
|
---|
43 | }
|
---|
44 | /^\/\* \$Id:.*\*\/$/d
|
---|
45 | /^typedef .* HGSMIOFFSET;/d
|
---|
46 | /^typedef .* HGSMISIZE;/d
|
---|
47 | s/^#\( *\)include <\([^/]*\)>/#\1include "\2"/g
|
---|
48 |
|
---|
49 | # File names:
|
---|
50 | s/\bHGSMIBase\.h\b/vbox_drv.h/g
|
---|
51 | s/\bHGSMIChannels\.h\b/hgsmi_channels.h/g
|
---|
52 | s/\bHGSMIChSetup\.h\b/hgsmi_ch_setup.h/g
|
---|
53 | s/\bHGSMIContext\.h\b/hgsmi_context.h/g
|
---|
54 | s/\bHGSMIDefs\.h\b/hgsmi_defs.h/g
|
---|
55 | s/\bVBoxVideoGuest\.h\b/vboxvideo_guest.h/g
|
---|
56 | s/\bVBoxVideo\.h\b/vboxvideo.h/g
|
---|
57 | s/\bVBoxVideoIPRT\.h\b/vbox_err.h/g
|
---|
58 | s/\bVBoxVideoVBE\.h\b/vboxvideo_vbe.h/g
|
---|
59 |
|
---|
60 | # Function names:
|
---|
61 | s/\btestQueryConf\b/hgsmi_test_query_conf/g
|
---|
62 | s/\bVBoxHGSMIBufferAlloc\b/hgsmi_buffer_alloc/g
|
---|
63 | s/\bVBoxHGSMIBufferFree\b/hgsmi_buffer_free/g
|
---|
64 | s/\bVBoxHGSMIBufferSubmit\b/hgsmi_buffer_submit/g
|
---|
65 | s/\bVBoxHGSMICursorPosition\b/hgsmi_cursor_position/g
|
---|
66 | s/\bVBoxHGSMIGetModeHints\b/hgsmi_get_mode_hints/g
|
---|
67 | s/\bVBoxHGSMIProcessDisplayInfo\b/hgsmi_process_display_info/g
|
---|
68 | s/\bVBoxHGSMIReportFlagsLocation\b/hgsmi_report_flags_location/g
|
---|
69 | s/\bVBoxHGSMISendCapsInfo\b/hgsmi_send_caps_info/g
|
---|
70 | s/\bVBoxHGSMIUpdateInputMapping\b/hgsmi_update_input_mapping/g
|
---|
71 | s/\bVBoxHGSMIUpdatePointerShape\b/hgsmi_update_pointer_shape/g
|
---|
72 | s/\bvboxHwBufferAvail\b/vbva_buffer_available/g
|
---|
73 | s/\bvboxHwBufferEndUpdate\b/vbva_buffer_end_update/g
|
---|
74 | s/\bvboxHwBufferFlush\b/vbva_buffer_flush/g
|
---|
75 | s/\bvboxHwBufferPlaceDataAt\b/vbva_buffer_place_data_at/g
|
---|
76 | s/\bvboxHwBufferWrite\b/vbva_write/g
|
---|
77 | s/\bVBoxQueryConfHGSMI\b/hgsmi_query_conf/g
|
---|
78 | s/\bVBoxVBVABufferBeginUpdate\b/vbva_buffer_begin_update/g
|
---|
79 | s/\bVBoxVBVABufferEndUpdate\b/vbva_buffer_end_update/g
|
---|
80 | s/\bVBoxVBVADisable\b/vbva_disable/g
|
---|
81 | s/\bVBoxVBVAEnable\b/vbva_enable/g
|
---|
82 | s/\bvboxVBVAInformHost\b/vbva_inform_host/g
|
---|
83 | s/\bvboxVBVASetupBufferContext\b/vbva_setup_buffer_context/g
|
---|
84 | s/\bVBVO_PORT_READ_U8\b/inb/g
|
---|
85 | s/\bVBVO_PORT_READ_U16\b/inw/g
|
---|
86 | s/\bVBVO_PORT_READ_U32\b/inl/g
|
---|
87 | s/\bVBVO_PORT_WRITE_U8\b *( *\(\b[^(),]*\b\) *, *\(\b[^(),]*\b\) *)/outb(\2, \1)/g
|
---|
88 | s/\bVBVO_PORT_WRITE_U16\b *( *\(\b[^(),]*\b\) *, *\(\b[^(),]*\b\) *)/outw(\2, \1)/g
|
---|
89 | s/\bVBVO_PORT_WRITE_U32\b *( *\(\b[^(),]*\b\) *, *\(\b[^(),]*\b\) *)/outl(\2, \1)/g
|
---|
90 | s/\bVBVO_PORT_WRITE_U[0-9]*\b/VBVO_PORT_WRITE_statement_should_be_on_one_line/g
|
---|
91 |
|
---|
92 | # Macros:
|
---|
93 | s/\b_1K\b/1024/g
|
---|
94 | s/\b_4M\b/4*1024*1024/g
|
---|
95 | s/\bAssert\b\([^;]*\);/WARN_ON_ONCE(!(\1));/g
|
---|
96 | s/\bAssertCompile\b/assert_compile/g
|
---|
97 | s/\bAssertCompileSize\b/assert_compile_size/g
|
---|
98 | s/\bAssertPtr\b\([^;]*\);/WARN_ON_ONCE(!(\1));/g
|
---|
99 | s/\bAssertPtrReturn\b/assert_ptr_return/g
|
---|
100 | /AssertPtrNullReturnVoid/d
|
---|
101 | s/\bAssertRC\b\([^;]*\);/WARN_ON_ONCE(RT_FAILURE\1);/g
|
---|
102 | s/\bAssertRC\b/Assert_RC_statement_should_be_on_one_line/g
|
---|
103 | s/\bDECLCALLBACK\b(\([^)]*\))/\1/g
|
---|
104 | s/\bDECLCALLBACKMEMBER\b(\([^,)]*\), *\([^,)]*\))/\1 (*\2)/g
|
---|
105 | s/^\bDECLHIDDEN\b(\([^)]*\))/\1/g
|
---|
106 | s/\bDECLINLINE\b(\([^)]*\))/static inline \1/g
|
---|
107 | s/\bRT_BIT\b/BIT/g
|
---|
108 | s/\bRT_BOOL\b(\([^)]*\))/(!!(\1))/g
|
---|
109 | /RT_C_DECLS/d
|
---|
110 | s/\bUINT16_MAX\b/U16_MAX/g
|
---|
111 | s/\bUINT32_MAX\b/U32_MAX/g
|
---|
112 | s/\bUINT32_C\b(\(.*\))/\1u/g
|
---|
113 | s/!VALID_PTR(/WARN_ON(!/g
|
---|
114 | s/\bRT_UNTRUSTED_VOLATILE_HOST\b//g
|
---|
115 | s/\bRT_UNTRUSTED_VOLATILE_GUEST\b//g
|
---|
116 | s/\bRT_UNTRUSTED_VOLATILE_HSTGST\b//g
|
---|
117 |
|
---|
118 | # Type names:
|
---|
119 | s/\bint32_t\b/s32/g
|
---|
120 | s/\buint8_t\b/u8/g
|
---|
121 | s/\buint16_t\b/u16/g
|
---|
122 | s/\buint32_t\b/u32/g
|
---|
123 | s/(HGSMIBUFFERLOCATION \*)//g # Remove C++ casts from void.
|
---|
124 | s/typedef struct HGSMIBUFFERLOCATION/struct hgsmi_buffer_location/g
|
---|
125 | s/struct HGSMIBUFFERLOCATION/struct hgsmi_buffer_location/g
|
---|
126 | s/} HGSMIBUFFERLOCATION/}/g
|
---|
127 | s/\bHGSMIBUFFERLOCATION\b/struct hgsmi_buffer_location/g
|
---|
128 | s/\([^*] *\)\bPHGSMIGUESTCOMMANDCONTEXT\b/\1struct gen_pool */g
|
---|
129 | s/(HGSMIHOSTFLAGS \*)//g # Remove C++ casts from void.
|
---|
130 | s/typedef struct HGSMIHOSTFLAGS/struct hgsmi_host_flags/g
|
---|
131 | s/struct HGSMIHOSTFLAGS/struct hgsmi_host_flags/g
|
---|
132 | s/} HGSMIHOSTFLAGS/}/g
|
---|
133 | s/\bHGSMIHOSTFLAGS\b/struct hgsmi_host_flags/g
|
---|
134 | s/\bHGSMIOFFSET\b/u32/g
|
---|
135 | s/\bHGSMISIZE\b/u32/g
|
---|
136 | s/\bRTRECT\b/void/g
|
---|
137 | s/(VBVABUFFERCONTEXT \*)//g # Remove C++ casts from void.
|
---|
138 | s/struct VBVABUFFERCONTEXT/struct vbva_buf_context/g
|
---|
139 | s/} VBVABUFFERCONTEXT/} vbva_buf_context/g
|
---|
140 | s/\bVBVABUFFERCONTEXT\b/struct vbva_buf_context/g
|
---|
141 | s/\([^*] *\)\bPVBVABUFFERCONTEXT\b/\1struct vbva_buf_context */g
|
---|
142 | s/(VBVACAPS \*)//g # Remove C++ casts from void.
|
---|
143 | s/struct VBVACAPS/struct vbva_caps/g
|
---|
144 | s/} VBVACAPS/} vbva_caps/g
|
---|
145 | s/\bVBVACAPS\b/struct vbva_caps/g
|
---|
146 | s/(VBVACONF32 \*)//g # Remove C++ casts from void.
|
---|
147 | s/struct VBVACONF32/struct vbva_conf32/g
|
---|
148 | s/} VBVACONF32/} vbva_conf32/g
|
---|
149 | s/\bVBVACONF32\b/struct vbva_conf32/g
|
---|
150 | s/(VBVACURSORPOSITION \*)//g # Remove C++ casts from void.
|
---|
151 | s/struct VBVACURSORPOSITION/struct vbva_cursor_position/g
|
---|
152 | s/} VBVACURSORPOSITION/} vbva_cursor_position/g
|
---|
153 | s/\bVBVACURSORPOSITION\b/struct vbva_cursor_position/g
|
---|
154 | s/(VBVAENABLE_EX \*)//g # Remove C++ casts from void.
|
---|
155 | s/struct VBVAENABLE_EX/struct vbva_enable_ex/g
|
---|
156 | s/} VBVAENABLE_EX/} vbva_enable_ex/g
|
---|
157 | s/\bVBVAENABLE_EX\b/struct vbva_enable_ex/g
|
---|
158 | s/(VBVAMOUSEPOINTERSHAPE \*)//g # Remove C++ casts from void.
|
---|
159 | s/struct VBVAMOUSEPOINTERSHAPE/struct vbva_mouse_pointer_shape/g
|
---|
160 | s/} VBVAMOUSEPOINTERSHAPE/} vbva_mouse_pointer_shape/g
|
---|
161 | s/\bVBVAMOUSEPOINTERSHAPE\b/struct vbva_mouse_pointer_shape/g
|
---|
162 | s/(VBVAMODEHINT \*)//g # Remove C++ casts from void.
|
---|
163 | s/struct VBVAMODEHINT/struct vbva_modehint/g
|
---|
164 | s/} VBVAMODEHINT/} vbva_modehint/g
|
---|
165 | s/\bVBVAMODEHINT\b/struct vbva_modehint/g
|
---|
166 | s/(VBVAQUERYMODEHINTS \*)//g # Remove C++ casts from void.
|
---|
167 | s/struct VBVAQUERYMODEHINTS/struct vbva_query_mode_hints/g
|
---|
168 | s/} VBVAQUERYMODEHINTS/} vbva_query_mode_hints/g
|
---|
169 | s/\bVBVAQUERYMODEHINTS\b/struct vbva_query_mode_hints/g
|
---|
170 | s/(VBVAREPORTINPUTMAPPING \*)//g # Remove C++ casts from void.
|
---|
171 | s/struct VBVAREPORTINPUTMAPPING/struct vbva_report_input_mapping/g
|
---|
172 | s/} VBVAREPORTINPUTMAPPING/} vbva_report_input_mapping/g
|
---|
173 | s/\bVBVAREPORTINPUTMAPPING\b/struct vbva_report_input_mapping/g
|
---|
174 |
|
---|
175 | # Variable and parameter names:
|
---|
176 | s/\baRecords\b/records/g
|
---|
177 | s/\bau8Data\b/data/g
|
---|
178 | s/\bau32Reserved\b/reserved/g
|
---|
179 | s/\bBase\b/base/g
|
---|
180 | s/\bbEnable\b/enable/g
|
---|
181 | s/\bbRc\b/ret/g
|
---|
182 | s/\bcb\b/len/g
|
---|
183 | s/\bcbBuffer\b/buffer_length/g
|
---|
184 | s/\bcbChunk\b/chunk/g
|
---|
185 | s/\bcbData\b/data_len/g
|
---|
186 | s/\bcbHintsStructureGuest\b/hints_structure_guest_size/g
|
---|
187 | s/\bcbHwBufferAvail\b/available/g
|
---|
188 | s/\bcbLength\b/len/g
|
---|
189 | s/\bcbLocation\b/buf_len/g
|
---|
190 | s/\bcbPartialWriteThreshold\b/partial_write_tresh/g ## @todo fix this?
|
---|
191 | s/\bcbPitch\b/pitch/g
|
---|
192 | s/\bcbPixels\b/pixel_len/g
|
---|
193 | s/\bcBPP\b/bpp/g
|
---|
194 | s/\bcbRecord\b/len_and_flags/g ## @todo fix this?
|
---|
195 | s/\bcDisplay\b/display/g
|
---|
196 | s/\bcHeight\b/height/g
|
---|
197 | s/\bcHintsQueried\b/hints_queried_count/g
|
---|
198 | s/\bcHotX\b/hot_x/g
|
---|
199 | s/\bcHotY\b/hot_y/g
|
---|
200 | s/\bcOriginX\b/origin_x/g
|
---|
201 | s/\bcOriginY\b/origin_y/g
|
---|
202 | s/\bcScreen\b/screen/g
|
---|
203 | s/\bcScreens\b/screens/g
|
---|
204 | s/\bcWidth\b/width/g
|
---|
205 | s/\bfCaps\b/caps/g
|
---|
206 | s/\bfFlags\b/flags/g
|
---|
207 | s/\bfHwBufferOverflow\b/buffer_overflow/g
|
---|
208 | s/\bfReportPosition\b/report_position/g
|
---|
209 | s/\bfu32Flags\b/flags/g
|
---|
210 | s/\bhostFlags\b/host_flags/g
|
---|
211 | s/\bi32Diff\b/diff/g
|
---|
212 | s/\bi32OriginX\b/origin_x/g
|
---|
213 | s/\bi32OriginY\b/origin_y/g
|
---|
214 | s/\bi32Result\b/result/g
|
---|
215 | s/\bindexRecordFirst\b/first_record_index/g
|
---|
216 | s/\bindexRecordFree\b/free_record_index/g
|
---|
217 | s/\bindexRecordNext\b/next/g
|
---|
218 | s/\boff32Data\b/data_offset/g
|
---|
219 | s/\boff32Free\b/free_offset/g
|
---|
220 | s/\boffLocation\b/location/g
|
---|
221 | s/\boffStart\b/start_offset/g
|
---|
222 | s/\boffVRAMBuffer\b/buffer_offset/g
|
---|
223 | s/\bpaHints\b/hints/g
|
---|
224 | s/\bpCtx\b/ctx/g
|
---|
225 | s/\bpPixels\b/pixels/g
|
---|
226 | s/\bpRecord\b/record/g
|
---|
227 | s/\bpulValue\b/value_ret/g
|
---|
228 | s/\bpVBVA\b/vbva/g
|
---|
229 | s/\bpxHost\b/x_host/g
|
---|
230 | s/\bpyHost\b/y_host/g
|
---|
231 | s/\bu16BitsPerPixel\b/bits_per_pixel/g
|
---|
232 | s/\bu16Flags\b/flags/g
|
---|
233 | s/\bu32BytesTillBoundary\b/bytes_till_boundary/g
|
---|
234 | s/\bu32Flags\b/flags/g
|
---|
235 | s/\bu32Height\b/height/g
|
---|
236 | s/\bu32HostEvents\b/host_events/g
|
---|
237 | s/\bu32HostFlags\b/host_flags/g
|
---|
238 | s/\bu32HotX\b/hot_x/g
|
---|
239 | s/\bu32HotY\b/hot_y/g
|
---|
240 | s/\bu32Index\b/index/g
|
---|
241 | s/\bu32LineSize\b/line_size/g
|
---|
242 | s/\bu32Offset\b/offset/g
|
---|
243 | s/\bu32Reserved\b/reserved/g
|
---|
244 | s/\bu32ScreenId\b/screen_id/g
|
---|
245 | s/\bu32StartOffset\b/start_offset/g
|
---|
246 | s/\bu32SupportedOrders\b/supported_orders/g
|
---|
247 | s/\bu32Value\b/value/g
|
---|
248 | s/\bu32ViewIndex\b/view_index/g
|
---|
249 | s/\bu32Width\b/width/g
|
---|
250 | s/\bulValue\b/value/g
|
---|
251 |
|
---|
252 | # Header file guard:
|
---|
253 | s/__HGSMIChannels_h__/__HGSMI_CHANNELS_H__/g
|
---|
254 | s/___VBox_Graphics_HGSMIChSetup_h/__HGSMI_CH_SETUP_H__/g
|
---|
255 |
|
---|
256 | # And move braces. This must be the last expression as it jumps to the next
|
---|
257 | # line.
|
---|
258 | /..*$/ {
|
---|
259 | N
|
---|
260 | s/^\([\t ][\t ]*\)} *\n[\t ]*else/\1} else/g
|
---|
261 | t continue_else
|
---|
262 | b try_brace
|
---|
263 | :continue_else
|
---|
264 | N
|
---|
265 | :try_brace
|
---|
266 | s/^\([\t ].*\)\n[\t ][\t ]*{/\1 {/g
|
---|
267 | s/^\([^#()]*\)\n[\t ]*{/\1 {/g
|
---|
268 | t done_brace
|
---|
269 | P
|
---|
270 | D
|
---|
271 | :done_brace
|
---|
272 | p
|
---|
273 | d
|
---|
274 | }
|
---|