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