Brian Daniels / mbed-tools

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-tools by Morpheus

dev/rpc_classes.py@0:4a2e5f0422d6, 2016-03-30 (annotated)

Committer:
screamer
Date:
Wed Mar 30 16:23:44 2016 +0000
Revision:
0:4a2e5f0422d6
Child:
2:5f044fef8f98
Initial revision

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:4a2e5f0422d6 1 """
screamer 0:4a2e5f0422d6 2 mbed SDK
screamer 0:4a2e5f0422d6 3 Copyright (c) 2011-2013 ARM Limited
screamer 0:4a2e5f0422d6 4
screamer 0:4a2e5f0422d6 5 Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:4a2e5f0422d6 6 you may not use this file except in compliance with the License.
screamer 0:4a2e5f0422d6 7 You may obtain a copy of the License at
screamer 0:4a2e5f0422d6 8
screamer 0:4a2e5f0422d6 9 http://www.apache.org/licenses/LICENSE-2.0
screamer 0:4a2e5f0422d6 10
screamer 0:4a2e5f0422d6 11 Unless required by applicable law or agreed to in writing, software
screamer 0:4a2e5f0422d6 12 distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:4a2e5f0422d6 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:4a2e5f0422d6 14 See the License for the specific language governing permissions and
screamer 0:4a2e5f0422d6 15 limitations under the License.
screamer 0:4a2e5f0422d6 16 """
screamer 0:4a2e5f0422d6 17 from os.path import join
screamer 0:4a2e5f0422d6 18 from jinja2 import Template
screamer 0:4a2e5f0422d6 19
screamer 0:4a2e5f0422d6 20 from workspace_tools.paths import TOOLS_DATA, MBED_RPC
screamer 0:4a2e5f0422d6 21
screamer 0:4a2e5f0422d6 22 RPC_TEMPLATES_PATH = join(TOOLS_DATA, "rpc")
screamer 0:4a2e5f0422d6 23
screamer 0:4a2e5f0422d6 24 RPC_TEMPLATE = "RPCClasses.h"
screamer 0:4a2e5f0422d6 25 CLASS_TEMPLATE = "class.cpp"
screamer 0:4a2e5f0422d6 26 RPC_CLASSES_PATH = join(MBED_RPC, RPC_TEMPLATE)
screamer 0:4a2e5f0422d6 27
screamer 0:4a2e5f0422d6 28
screamer 0:4a2e5f0422d6 29 def get_template(name):
screamer 0:4a2e5f0422d6 30 return Template(open(join(RPC_TEMPLATES_PATH, name)).read())
screamer 0:4a2e5f0422d6 31
screamer 0:4a2e5f0422d6 32
screamer 0:4a2e5f0422d6 33 def write_rpc_classes(classes):
screamer 0:4a2e5f0422d6 34 template = get_template(RPC_TEMPLATE)
screamer 0:4a2e5f0422d6 35 open(RPC_CLASSES_PATH, "w").write(template.render({"classes":classes}))
screamer 0:4a2e5f0422d6 36
screamer 0:4a2e5f0422d6 37
screamer 0:4a2e5f0422d6 38 RPC_CLASSES = (
screamer 0:4a2e5f0422d6 39 {
screamer 0:4a2e5f0422d6 40 "name": "DigitalOut",
screamer 0:4a2e5f0422d6 41 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 42 "methods": [
screamer 0:4a2e5f0422d6 43 (None , "write", ["int"]),
screamer 0:4a2e5f0422d6 44 ("int", "read" , []),
screamer 0:4a2e5f0422d6 45 ]
screamer 0:4a2e5f0422d6 46 },
screamer 0:4a2e5f0422d6 47 {
screamer 0:4a2e5f0422d6 48 "name": "DigitalIn",
screamer 0:4a2e5f0422d6 49 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 50 "methods": [
screamer 0:4a2e5f0422d6 51 ("int", "read" , []),
screamer 0:4a2e5f0422d6 52 ]
screamer 0:4a2e5f0422d6 53 },
screamer 0:4a2e5f0422d6 54 {
screamer 0:4a2e5f0422d6 55 "name": "DigitalInOut",
screamer 0:4a2e5f0422d6 56 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 57 "methods": [
screamer 0:4a2e5f0422d6 58 ("int", "read" , []),
screamer 0:4a2e5f0422d6 59 (None , "write" , ["int"]),
screamer 0:4a2e5f0422d6 60 (None , "input" , []),
screamer 0:4a2e5f0422d6 61 (None , "output", []),
screamer 0:4a2e5f0422d6 62 ]
screamer 0:4a2e5f0422d6 63 },
screamer 0:4a2e5f0422d6 64 {
screamer 0:4a2e5f0422d6 65 "name": "AnalogIn",
screamer 0:4a2e5f0422d6 66 "required": "ANALOGIN",
screamer 0:4a2e5f0422d6 67 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 68 "methods": [
screamer 0:4a2e5f0422d6 69 ("float" , "read" , []),
screamer 0:4a2e5f0422d6 70 ("unsigned short", "read_u16", []),
screamer 0:4a2e5f0422d6 71 ]
screamer 0:4a2e5f0422d6 72 },
screamer 0:4a2e5f0422d6 73 {
screamer 0:4a2e5f0422d6 74 "name": "AnalogOut",
screamer 0:4a2e5f0422d6 75 "required": "ANALOGOUT",
screamer 0:4a2e5f0422d6 76 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 77 "methods": [
screamer 0:4a2e5f0422d6 78 ("float", "read" , []),
screamer 0:4a2e5f0422d6 79 (None , "write" , ["float"]),
screamer 0:4a2e5f0422d6 80 (None , "write_u16", ["unsigned short"]),
screamer 0:4a2e5f0422d6 81 ]
screamer 0:4a2e5f0422d6 82 },
screamer 0:4a2e5f0422d6 83 {
screamer 0:4a2e5f0422d6 84 "name": "PwmOut",
screamer 0:4a2e5f0422d6 85 "required": "PWMOUT",
screamer 0:4a2e5f0422d6 86 "cons_args": ["PinName"],
screamer 0:4a2e5f0422d6 87 "methods": [
screamer 0:4a2e5f0422d6 88 ("float", "read" , []),
screamer 0:4a2e5f0422d6 89 (None , "write" , ["float"]),
screamer 0:4a2e5f0422d6 90 (None , "period" , ["float"]),
screamer 0:4a2e5f0422d6 91 (None , "period_ms" , ["int"]),
screamer 0:4a2e5f0422d6 92 (None , "pulsewidth" , ["float"]),
screamer 0:4a2e5f0422d6 93 (None , "pulsewidth_ms", ["int"]),
screamer 0:4a2e5f0422d6 94 ]
screamer 0:4a2e5f0422d6 95 },
screamer 0:4a2e5f0422d6 96 {
screamer 0:4a2e5f0422d6 97 "name": "SPI",
screamer 0:4a2e5f0422d6 98 "required": "SPI",
screamer 0:4a2e5f0422d6 99 "cons_args": ["PinName", "PinName", "PinName"],
screamer 0:4a2e5f0422d6 100 "methods": [
screamer 0:4a2e5f0422d6 101 (None , "format" , ["int", "int"]),
screamer 0:4a2e5f0422d6 102 (None , "frequency", ["int"]),
screamer 0:4a2e5f0422d6 103 ("int", "write" , ["int"]),
screamer 0:4a2e5f0422d6 104 ]
screamer 0:4a2e5f0422d6 105 },
screamer 0:4a2e5f0422d6 106 {
screamer 0:4a2e5f0422d6 107 "name": "Serial",
screamer 0:4a2e5f0422d6 108 "required": "SERIAL",
screamer 0:4a2e5f0422d6 109 "cons_args": ["PinName", "PinName"],
screamer 0:4a2e5f0422d6 110 "methods": [
screamer 0:4a2e5f0422d6 111 (None , "baud" , ["int"]),
screamer 0:4a2e5f0422d6 112 ("int", "readable" , []),
screamer 0:4a2e5f0422d6 113 ("int", "writeable", []),
screamer 0:4a2e5f0422d6 114 ("int", "putc" , ["int"]),
screamer 0:4a2e5f0422d6 115 ("int", "getc" , []),
screamer 0:4a2e5f0422d6 116 ("int", "puts" , ["const char *"]),
screamer 0:4a2e5f0422d6 117 ]
screamer 0:4a2e5f0422d6 118 },
screamer 0:4a2e5f0422d6 119 {
screamer 0:4a2e5f0422d6 120 "name": "Timer",
screamer 0:4a2e5f0422d6 121 "cons_args": [],
screamer 0:4a2e5f0422d6 122 "methods": [
screamer 0:4a2e5f0422d6 123 (None , "start" , []),
screamer 0:4a2e5f0422d6 124 (None , "stop" , []),
screamer 0:4a2e5f0422d6 125 (None , "reset" , []),
screamer 0:4a2e5f0422d6 126 ("float", "read" , []),
screamer 0:4a2e5f0422d6 127 ("int" , "read_ms", []),
screamer 0:4a2e5f0422d6 128 ("int" , "read_us", []),
screamer 0:4a2e5f0422d6 129 ]
screamer 0:4a2e5f0422d6 130 }
screamer 0:4a2e5f0422d6 131 )
screamer 0:4a2e5f0422d6 132
screamer 0:4a2e5f0422d6 133
screamer 0:4a2e5f0422d6 134 def get_args_proto(args_types, extra=None):
screamer 0:4a2e5f0422d6 135 args = ["%s a%d" % (s, n) for n, s in enumerate(args_types)]
screamer 0:4a2e5f0422d6 136 if extra:
screamer 0:4a2e5f0422d6 137 args.extend(extra)
screamer 0:4a2e5f0422d6 138 return ', '.join(args)
screamer 0:4a2e5f0422d6 139
screamer 0:4a2e5f0422d6 140
screamer 0:4a2e5f0422d6 141 def get_args_call(args):
screamer 0:4a2e5f0422d6 142 return ', '.join(["a%d" % (n) for n in range(len(args))])
screamer 0:4a2e5f0422d6 143
screamer 0:4a2e5f0422d6 144
screamer 0:4a2e5f0422d6 145 classes = []
screamer 0:4a2e5f0422d6 146 class_template = get_template(CLASS_TEMPLATE)
screamer 0:4a2e5f0422d6 147
screamer 0:4a2e5f0422d6 148 for c in RPC_CLASSES:
screamer 0:4a2e5f0422d6 149 c_args = c['cons_args']
screamer 0:4a2e5f0422d6 150 data = {
screamer 0:4a2e5f0422d6 151 'name': c['name'],
screamer 0:4a2e5f0422d6 152 'cons_type': ', '.join(c_args + ['const char*']),
screamer 0:4a2e5f0422d6 153 "cons_proto": get_args_proto(c_args, ["const char *name=NULL"]),
screamer 0:4a2e5f0422d6 154 "cons_call": get_args_call(c_args)
screamer 0:4a2e5f0422d6 155 }
screamer 0:4a2e5f0422d6 156
screamer 0:4a2e5f0422d6 157 c_name = "Rpc" + c['name']
screamer 0:4a2e5f0422d6 158
screamer 0:4a2e5f0422d6 159 methods = []
screamer 0:4a2e5f0422d6 160 rpc_methods = []
screamer 0:4a2e5f0422d6 161 for r, m, a in c['methods']:
screamer 0:4a2e5f0422d6 162 ret_proto = r if r else "void"
screamer 0:4a2e5f0422d6 163 args_proto = "void"
screamer 0:4a2e5f0422d6 164
screamer 0:4a2e5f0422d6 165 ret_defin = "return " if r else ""
screamer 0:4a2e5f0422d6 166 args_defin = ""
screamer 0:4a2e5f0422d6 167
screamer 0:4a2e5f0422d6 168 if a:
screamer 0:4a2e5f0422d6 169 args_proto = get_args_proto(a)
screamer 0:4a2e5f0422d6 170 args_defin = get_args_call(a)
screamer 0:4a2e5f0422d6 171
screamer 0:4a2e5f0422d6 172 proto = "%s %s(%s)" % (ret_proto, m, args_proto)
screamer 0:4a2e5f0422d6 173 defin = "{%so.%s(%s);}" % (ret_defin, m, args_defin)
screamer 0:4a2e5f0422d6 174 methods.append("%s %s" % (proto, defin))
screamer 0:4a2e5f0422d6 175
screamer 0:4a2e5f0422d6 176 rpc_method_type = [r] if r else []
screamer 0:4a2e5f0422d6 177 rpc_method_type.append(c_name)
screamer 0:4a2e5f0422d6 178 rpc_method_type.extend(a)
screamer 0:4a2e5f0422d6 179 rpc_methods.append('{"%s", rpc_method_caller<%s, &%s::%s>}' % (m, ', '.join(rpc_method_type), c_name, m))
screamer 0:4a2e5f0422d6 180
screamer 0:4a2e5f0422d6 181 data['methods'] = "\n ".join(methods)
screamer 0:4a2e5f0422d6 182 data['rpc_methods'] = ",\n ".join(rpc_methods)
screamer 0:4a2e5f0422d6 183
screamer 0:4a2e5f0422d6 184 class_decl = class_template.render(data)
screamer 0:4a2e5f0422d6 185 if 'required' in c:
screamer 0:4a2e5f0422d6 186 class_decl = "#if DEVICE_%s\n%s\n#endif" % (c['required'], class_decl)
screamer 0:4a2e5f0422d6 187
screamer 0:4a2e5f0422d6 188 classes.append(class_decl)
screamer 0:4a2e5f0422d6 189
screamer 0:4a2e5f0422d6 190 write_rpc_classes('\n\n'.join(classes))