]>
Commit | Line | Data |
---|---|---|
a65d66c0 | 1 | #!/usr/bin/python3 |
0af91589 UH |
2 | ## |
3 | ## This file is part of the sigrok-util project. | |
4 | ## | |
5 | ## Copyright (C) 2012 Bert Vermeulen <bert@biot.com> | |
6 | ## | |
7 | ## This program is free software: you can redistribute it and/or modify | |
8 | ## it under the terms of the GNU General Public License as published by | |
9 | ## the Free Software Foundation, either version 3 of the License, or | |
10 | ## (at your option) any later version. | |
11 | ## | |
12 | ## This program is distributed in the hope that it will be useful, | |
13 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | ## GNU General Public License for more details. | |
16 | ## | |
17 | ## You should have received a copy of the GNU General Public License | |
18 | ## along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 | ## | |
a65d66c0 BV |
20 | |
21 | import os | |
22 | import sys | |
23 | import tempfile | |
fe85502e | 24 | from subprocess import Popen, PIPE, check_output |
a65d66c0 BV |
25 | import shutil |
26 | import re | |
27 | import socket | |
28 | import datetime | |
29 | ||
fe85502e | 30 | TMPL_AUTOCONF_DRIVER = "SR_DRIVER([${name}], [${short}])\n" |
7d787983 | 31 | |
d51b5323 | 32 | TMPL_HWMAKE_DRIVERLIB = """if HW_${upper} |
68ec5073 | 33 | libsigrok_la_SOURCES += \\ |
6ebf3016 BV |
34 | src/hardware/${short}/protocol.h \\ |
35 | src/hardware/${short}/protocol.c \\ | |
36 | src/hardware/${short}/api.c | |
d51b5323 | 37 | endif |
d51b5323 | 38 | """ |
a65d66c0 BV |
39 | FILE_DRV_API = 'drv-api.c' |
40 | FILE_DRV_PROTOCOL = 'drv-protocol.c' | |
41 | FILE_DRV_PROTOCOL_H = 'drv-protocol.h' | |
42 | ||
43 | def tmpl(template): | |
44 | out = re.sub(r'\${([^}]+)}', lambda x: str(names[x.group(1)]), template) | |
45 | ||
46 | return out | |
47 | ||
48 | ||
49 | def tmpl_file(filename): | |
50 | template = open(TMPLDIR + '/' + filename).read() | |
51 | ||
52 | return tmpl(template) | |
53 | ||
54 | ||
55 | def new_driver(): | |
56 | tmp = tempfile.mkdtemp() | |
57 | try: | |
58 | os.chdir(tmp) | |
e21df210 DD |
59 | process = Popen(['git', 'clone', '--depth=1', LIBSR], |
60 | stdout=PIPE, stderr=PIPE) | |
617f4da0 AJ |
61 | out, err = process.communicate() |
62 | if process.returncode: | |
a65d66c0 BV |
63 | raise Exception(err.decode()) |
64 | gitdir = tmp + '/libsigrok/' | |
3e61a9d8 | 65 | do_autoconf(gitdir) |
3e61a9d8 | 66 | do_automake(gitdir) |
a65d66c0 BV |
67 | do_driverskel(gitdir) |
68 | make_patch(gitdir) | |
69 | except Exception as e: | |
70 | print(e) | |
71 | shutil.rmtree(tmp) | |
72 | ||
73 | ||
d0d6e169 | 74 | # add DRIVER and DRIVER2 entries to configure.ac |
3e61a9d8 | 75 | def do_autoconf(gitdir): |
a65d66c0 BV |
76 | cacpath = gitdir + 'configure.ac' |
77 | configure_ac = open(cacpath).read() | |
78 | ||
a65d66c0 | 79 | out = '' |
3e61a9d8 BV |
80 | state = 'driver' |
81 | active = False | |
a65d66c0 | 82 | for line in configure_ac.split('\n')[:-1]: |
3e61a9d8 | 83 | if state == 'driver': |
fe85502e | 84 | m = re.match(r'SR_DRIVER\(\[([^\]]+)', line) |
a65d66c0 | 85 | if m: |
3e61a9d8 BV |
86 | active = True |
87 | if active: | |
88 | if (m and m.group(1).upper() > names['name'].upper()) or m is None: | |
89 | out += tmpl(TMPL_AUTOCONF_DRIVER) | |
3e61a9d8 | 90 | state = 'done' |
fe85502e | 91 | active = False |
a65d66c0 BV |
92 | out += line + '\n' |
93 | if state != 'done': | |
fe85502e | 94 | raise Exception('No SR_DRIVER entries found in configure.ac') |
3e61a9d8 | 95 | open(cacpath, 'w').write(out) |
a65d66c0 | 96 | |
a65d66c0 | 97 | |
3e61a9d8 BV |
98 | # add HW_ entry to Makefile.am |
99 | def do_automake(gitdir): | |
7d787983 | 100 | path = gitdir + 'Makefile.am' |
a65d66c0 BV |
101 | hwmake = open(path).read() |
102 | ||
a65d66c0 BV |
103 | out = '' |
104 | state = 'copy' | |
105 | for line in hwmake.split('\n')[:-1]: | |
fe85502e | 106 | if state == 'copy' and re.match(r'if\s+HW_\w+$', line): |
3e61a9d8 BV |
107 | state = 'drivers' |
108 | if state == 'drivers': | |
fe85502e | 109 | m = re.match(r'if\s+HW_(\w+)$', line) |
d51b5323 BV |
110 | if m: |
111 | drv_short = m.group(1) | |
112 | if drv_short > names['upper']: | |
113 | out += tmpl(TMPL_HWMAKE_DRIVERLIB) | |
114 | state = 'done' | |
fe85502e | 115 | elif not re.match(r'\s*libsigrok_la_SOURCES\b|\s*src/hardware/|endif\b', line): |
3e61a9d8 BV |
116 | print("[%s]" % line.strip()) |
117 | # we passed the last entry | |
118 | out += tmpl(TMPL_HWMAKE_DRIVERLIB) | |
119 | state = 'done' | |
a65d66c0 | 120 | out += line + '\n' |
7d787983 | 121 | if state != 'done': |
3e61a9d8 BV |
122 | raise Exception('No "if HW_" markers found in Makefile.am') |
123 | open(path, 'w').write(out) | |
a65d66c0 BV |
124 | |
125 | ||
126 | def do_driverskel(gitdir): | |
6ebf3016 | 127 | drvdir = gitdir + 'src/hardware/' + names['short'] |
a65d66c0 | 128 | os.mkdir(drvdir) |
a65d66c0 BV |
129 | open(drvdir + '/api.c', 'w').write(tmpl_file(FILE_DRV_API)) |
130 | open(drvdir + '/protocol.c', 'w').write(tmpl_file(FILE_DRV_PROTOCOL)) | |
131 | open(drvdir + '/protocol.h', 'w').write(tmpl_file(FILE_DRV_PROTOCOL_H)) | |
132 | ||
133 | ||
134 | def make_patch(gitdir): | |
135 | os.chdir(gitdir) | |
e21df210 DD |
136 | command(['git', 'add', 'src/hardware/' + names['short']]) |
137 | cmd = ['git', 'commit', | |
138 | '-m', '%s: Initial driver skeleton.' % names['short'], | |
139 | 'configure.ac', 'Makefile.am', | |
140 | 'src/hardware/' + names['short']] | |
a65d66c0 | 141 | command(cmd) |
e21df210 DD |
142 | cmd = ['git', 'format-patch', 'HEAD~1'] |
143 | out, err = Popen(cmd, stdout=PIPE, stderr=PIPE).communicate() | |
a65d66c0 BV |
144 | if err: |
145 | raise Exception(err.decode()) | |
146 | patch = out.decode().strip() | |
147 | shutil.move(gitdir + '/' + patch, scriptdir + '/' + patch) | |
148 | print(patch) | |
149 | ||
150 | ||
151 | def command(cmd): | |
e21df210 | 152 | out, err = Popen(cmd, stderr=PIPE).communicate() |
a65d66c0 BV |
153 | if err: |
154 | raise Exception(err.decode()) | |
155 | ||
156 | ||
157 | def parse_gitconfig(): | |
fe85502e | 158 | author = email = None |
0af91589 | 159 | try: |
fe85502e DE |
160 | author = check_output(["git", "config", "user.name"]).decode().strip(); |
161 | email = check_output(["git", "config", "user.email"]).decode().strip(); | |
0af91589 | 162 | except: |
fe85502e | 163 | print("Please set your name and email in your git config") |
0af91589 | 164 | sys.exit() |
0af91589 | 165 | return author, email |
a65d66c0 BV |
166 | |
167 | # | |
168 | # main | |
169 | # | |
170 | ||
171 | scriptdir = os.getcwd() | |
87c5b243 BV |
172 | if scriptdir.split('/')[-2:] != ['sigrok-util', 'source']: |
173 | print("Please call this script from the 'source' directory.") | |
174 | sys.exit(1) | |
175 | ||
176 | LIBSR = 'git://sigrok.org/libsigrok' | |
177 | TMPLDIR = scriptdir | |
a65d66c0 BV |
178 | |
179 | if len(sys.argv) < 2: | |
0af91589 | 180 | print("Usage: new-driver <name>") |
a65d66c0 BV |
181 | sys.exit() |
182 | ||
183 | author, email = parse_gitconfig() | |
184 | name = ' '.join(sys.argv[1:]) | |
185 | names = { | |
186 | 'name': name, | |
187 | 'short': re.sub('[^a-z0-9]', '-', name.lower()), | |
188 | 'lib': re.sub('[^a-z0-9]', '_', name.lower()), | |
189 | 'upper': re.sub('[^A-Z0-9]', '_', name.upper()), | |
0af91589 UH |
190 | 'year': datetime.datetime.now().year, |
191 | 'author': author, | |
192 | 'email': email, | |
a65d66c0 BV |
193 | } |
194 | new_driver() | |
195 |