File: format-header.py

package info (click to toggle)
roc-toolkit 0.4.0%2Bdfsg-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,684 kB
  • sloc: cpp: 102,987; ansic: 8,959; python: 6,125; sh: 942; makefile: 16; javascript: 9
file content (204 lines) | stat: -rw-r--r-- 6,207 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
import datetime
import fnmatch
import os
import re
import shutil
import sys
import tempfile
import textwrap

copyright_str = textwrap.dedent('''
    /*
     * Copyright (c) {} Roc Streaming authors
     *
     * This Source Code Form is subject to the terms of the Mozilla Public
     * License, v. 2.0. If a copy of the MPL was not distributed with this
     * file, You can obtain one at http://mozilla.org/MPL/2.0/.
     */
''').format(datetime.datetime.now().year)

def is_header(path):
    return re.search(r'\.h$', path)

def is_test(path):
    _, basename = os.path.split(path)
    for s in [basename, os.path.basename(os.path.dirname(path))]:
        if s.startswith('test_'):
            return True
    return False

def is_public_api(path):
    rootname = os.path.basename(
        os.path.dirname(
            os.path.dirname(
                os.path.abspath(path))))
    return rootname == 'public_api'

def make_guard(path):
    dirpath, basename = os.path.split(path)
    dirname = os.path.basename(dirpath)
    if is_public_api(path):
        if is_test(path):
            arr = ['roc', 'public_api', dirname, basename]
        else:
            arr = ['roc', 'public_api', basename]
    else:
        arr = [dirname, basename]
    while not arr[0].startswith('roc_') and arr[0] != 'roc':
        dirpath = os.path.dirname(dirpath)
        arr = [os.path.basename(dirpath)] + arr
    return '_'.join(arr).replace('.', '_').upper() + '_'

def make_doxygen_path(path):
    path = '/'.join(path.split(os.sep))
    path = re.sub(r'^\.?/', '', path)
    return '@file ' + path

def make_doxygen_brief(text):
    if not text.endswith('.'):
        text += '.'
    return '@brief ' + text

def format_file(output, path):
    def fprint(s):
        output.write(s + '\n')

    with open(path) as fp:
        lines = fp.read().splitlines()

    has_copyright, has_doxygen, has_guard, is_autogen = False, False, False, False

    section = 'copyright'
    brief = 'TODO'

    original_lines = []
    body_start = True

    if is_header(path):
        while re.match(r'^\s*$', lines[-1]):
            lines.pop()

        if re.match(r'^\s*#\s*endif.*$', lines[-1]):
            lines.pop()

        while re.match(r'^\s*$', lines[-1]):
            lines.pop()

        for line in lines:
            m = re.search(r'@brief\s+(.*)', line)
            if m:
                brief = m.group(1)
                break

    while lines:
        line = lines.pop(0)

        if section in ['copyright', 'doxygen', 'guard']:
            if re.match(r'^\s*$', line):
                continue

        if section == 'copyright':
            original_lines += [line]

            if re.match(r'^\s*/?\*', line):
                if re.match(r'^\s*/?\*.*AUTO-GENERATED.*', line):
                    is_autogen = True

                if re.match(r'^\s*/?\*\s*(Copyright|Mozilla)', line):
                    has_copyright = True

                if re.match(r'^\s*\*/', line):
                    if is_autogen or has_copyright:
                        for p in original_lines:
                            fprint(p)
                        fprint('')
                    else:
                        fprint(copyright_str.strip())
                        fprint('')

                        if not has_copyright:
                            for p in original_lines:
                                fprint(p)
                        fprint('')

                    section = 'doxygen' if is_header(path) else 'body'
                    continue
            else:
                fprint(copyright_str.strip())
                fprint('')

                lines = original_lines + lines
                section = 'doxygen' if is_header(path) else 'body'

                continue

        if section == 'doxygen':
            if re.match(r'^\s*/?\*', line) or re.match(r'^\s*//', line):
                continue

            if re.match(r'^\s*//!', line):
                if not is_header(path) or is_test(path) or is_autogen:
                    continue

                if re.match(r'^\s*//!\s*@file', line):
                    fprint('//! {}'.format(make_doxygen_path(path)))
                else:
                    fprint(line)

                has_doxygen = True
                continue
            else:
                if is_public_api(path) or is_test(path) or is_autogen:
                    section = 'guard' if is_header(path) else 'body'
                else:
                    if not has_doxygen:
                        if is_header(path):
                            fprint('//! {}'.format(make_doxygen_path(path)))
                            fprint('//! {}'.format(make_doxygen_brief(brief)))
                            section = 'guard'
                        else:
                            section = 'body'

                    if is_header(path):
                        fprint('')

        if section == 'guard':
            m = re.match(r'#\s*(ifndef|define)', line)
            if m:
                has_guard = True
                fprint('#{} {}'.format(m.group(1), make_guard(path)))
                continue
            else:
                if not has_guard:
                    fprint('#ifndef {}'.format(make_guard(path)))
                    fprint('#define {}'.format(make_guard(path)))
                fprint('')
                section = 'body'

        if section == 'body':
            if body_start and re.match(r'^\s*$', line):
                continue
            body_start = False
            fprint(line)

    if is_header(path):
        fprint('')
        fprint('#endif // {}'.format(make_guard(path)))

def walk_dir(directory, patterns):
    for root, dirs, files in os.walk(directory):
        for basename in files:
            for pattern in patterns:
                if fnmatch.fnmatch(basename, pattern):
                    filename = os.path.join(root, basename)
                    yield filename
                    break

if len(sys.argv) > 1:
    os.chdir(sys.argv[1])

for path in walk_dir('.', ['*.h', '*.cpp']):
    with tempfile.NamedTemporaryFile('w+') as fp:
        format_file(fp, path)
        fp.flush()
        shutil.copy(fp.name, path)