source/new-driver

   1 #!/usr/bin/python3
   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 ##
  20
  21 import os
  22 import sys
  23 import tempfile
  24 from subprocess import Popen, PIPE, check_output
  25 import shutil
  26 import re
  27 import socket
  28 import datetime
  29
  30 TMPL_AUTOCONF_DRIVER = "SR_DRIVER([${name}], [${short}])\n"
  31
  32 TMPL_HWMAKE_DRIVERLIB = """if HW_${upper}
  33 libsigrok_la_SOURCES += \\
  34         src/hardware/${short}/protocol.h \\
  35         src/hardware/${short}/protocol.c \\
  36         src/hardware/${short}/api.c
  37 endif
  38 """
  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(os.path.join(TMPLDIR, filename)).read()
  51
  52     return tmpl(template)
  53
  54
  55 def new_driver():
  56     tmp = tempfile.mkdtemp()
  57     try:
  58         os.chdir(tmp)
  59         process = Popen(['git', 'clone', '--depth=1', LIBSR],
  60                         stdout=PIPE, stderr=PIPE)
  61         out, err = process.communicate()
  62         if process.returncode:
  63             raise Exception(err.decode())
  64         gitdir = os.path.join(tmp, 'libsigrok')
  65         do_autoconf(gitdir)
  66         do_automake(gitdir)
  67         do_driverskel(gitdir)
  68         make_patch(gitdir)
  69     except Exception as e:
  70         print(e)
  71     finally:
  72         shutil.rmtree(tmp)
  73
  74
  75 # add DRIVER and DRIVER2 entries to configure.ac
  76 def do_autoconf(gitdir):
  77     cacpath = os.path.join(gitdir, 'configure.ac')
  78     configure_ac = open(cacpath).read()
  79
  80     out = ''
  81     state = 'driver'
  82     active = False
  83     for line in configure_ac.split('\n')[:-1]:
  84         if state == 'driver':
  85             m = re.match(r'SR_DRIVER\(\[([^\]]+)', line)
  86             if m:
  87                 active = True
  88             if active:
  89                 if (m and m.group(1).upper() > names['name'].upper()) or m is None:
  90                     out += tmpl(TMPL_AUTOCONF_DRIVER)
  91                     state = 'done'
  92                     active = False
  93         out += line + '\n'
  94     if state != 'done':
  95         raise Exception('No SR_DRIVER entries found in configure.ac')
  96     open(cacpath, 'w').write(out)
  97
  98
  99 # add HW_ entry to Makefile.am
 100 def do_automake(gitdir):
 101     path = os.path.join(gitdir, 'Makefile.am')
 102     hwmake = open(path).read()
 103
 104     out = ''
 105     state = 'copy'
 106     for line in hwmake.split('\n')[:-1]:
 107         if state == 'copy' and re.match(r'if\s+HW_\w+$', line):
 108             state = 'drivers'
 109         if state == 'drivers':
 110             m = re.match(r'if\s+HW_(\w+)$', line)
 111             if m:
 112                 drv_short = m.group(1)
 113                 if drv_short > names['upper']:
 114                     out += tmpl(TMPL_HWMAKE_DRIVERLIB)
 115                     state = 'done'
 116             elif not re.match(r'\s*libsigrok_la_SOURCES\b|\s*src/hardware/|endif\b', line):
 117                 print("[%s]" % line.strip())
 118                 # we passed the last entry
 119                 out += tmpl(TMPL_HWMAKE_DRIVERLIB)
 120                 state = 'done'
 121         out += line + '\n'
 122     if state != 'done':
 123         raise Exception('No "if HW_" markers found in Makefile.am')
 124     open(path, 'w').write(out)
 125
 126
 127 def do_driverskel(gitdir):
 128     drvdir = os.path.join(gitdir, 'src', 'hardware', names['short'])
 129     os.mkdir(drvdir)
 130     open(os.path.join(drvdir, 'api.c'), 'w').write(tmpl_file(FILE_DRV_API))
 131     open(os.path.join(drvdir, 'protocol.c'), 'w').write(tmpl_file(FILE_DRV_PROTOCOL))
 132     open(os.path.join(drvdir, 'protocol.h'), 'w').write(tmpl_file(FILE_DRV_PROTOCOL_H))
 133
 134
 135 def make_patch(gitdir):
 136     os.chdir(gitdir)
 137     command(['git', 'add', os.path.join('src', 'hardware', names['short'])])
 138     cmd = ['git', 'commit',
 139            '-m', '%s: Initial driver skeleton.' % names['short'],
 140            'configure.ac', 'Makefile.am',
 141            os.path.join('src', 'hardware', names['short'])]
 142     command(cmd)
 143     cmd = ['git', 'format-patch', 'HEAD~1']
 144     out, err = Popen(cmd, stdout=PIPE, stderr=PIPE).communicate()
 145     if err:
 146         raise Exception(err.decode())
 147     patch = out.decode().strip()
 148     shutil.move(os.path.join(gitdir, patch),
 149                 os.path.join(scriptdir, patch))
 150     print(patch)
 151
 152
 153 def command(cmd):
 154     out, err = Popen(cmd, stderr=PIPE).communicate()
 155     if err:
 156         raise Exception(err.decode())
 157
 158
 159 def parse_gitconfig():
 160     author = email = None
 161     try:
 162         author = check_output(["git", "config", "user.name"]).decode().strip();
 163         email = check_output(["git", "config", "user.email"]).decode().strip();
 164     except:
 165         print("Please set your name and email in your git config")
 166         sys.exit()
 167     return author, email
 168
 169 #
 170 # main
 171 #
 172
 173 scriptdir = os.getcwd()
 174 if scriptdir.split('/')[-2:] != ['sigrok-util', 'source']:
 175         print("Please call this script from the 'source' directory.")
 176         sys.exit(1)
 177
 178 LIBSR = 'git://sigrok.org/libsigrok'
 179 TMPLDIR = scriptdir
 180
 181 if len(sys.argv) < 2:
 182     print("Usage: new-driver <name>")
 183     sys.exit()
 184
 185 author, email = parse_gitconfig()
 186 name = ' '.join(sys.argv[1:])
 187 names = {
 188     'name': name,
 189     'short': re.sub('[^a-z0-9]', '-', name.lower()),
 190     'lib': re.sub('[^a-z0-9]', '_', name.lower()),
 191     'upper': re.sub('[^A-Z0-9]', '_', name.upper()),
 192     'year': datetime.datetime.now().year,
 193     'author': author,
 194     'email': email,
 195 }
 196 new_driver()
 197