generate-binding-glue.py

   1 #!/usr/bin/python3
   2
   3 #
   4 # Copyright (C) 2017 Mentor Graphics Development (Deutschland) GmbH
   5 #
   6 # Licensed under the Apache License, Version 2.0 (the "License");
   7 # you may not use this file except in compliance with the License.
   8 # You may obtain a copy of the License at
   9 #
  10 #      http://www.apache.org/licenses/LICENSE-2.0
  11 #
  12 # Unless required by applicable law or agreed to in writing, software
  13 # distributed under the License is distributed on an "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15 # See the License for the specific language governing permissions and
  16 # limitations under the License.
  17 #
  18
  19 import sys
  20
  21 OUT = sys.stdout
  22
  23 def set_output(f):
  24     global OUT
  25     OUT = f
  26
  27 def p(*args):
  28     OUT.write('\n'.join(args))
  29     OUT.write('\n')
  30
  31 def emit_func_impl(api, f):
  32     args = f.get('args', [])
  33     if len(args) > 0:
  34         p('   json_object *jreq = afb_req_json(req);', '')
  35         for arg in args:
  36             arg['jtype'] = arg.get('jtype', arg['type']) # add jtype default
  37             p('   json_object *j_%(name)s = nullptr;' % arg,
  38               '   if (! json_object_object_get_ex(jreq, "%(name)s", &j_%(name)s)) {' % arg,
  39               '      afb_req_fail(req, "failed", "Need %(type)s argument %(name)s");' % arg,
  40               '      return;',
  41               '   }',
  42               '   %(type)s a_%(name)s = json_object_get_%(jtype)s(j_%(name)s);' % arg, '')
  43     p('   auto ret = %(api)s' % api + '%(name)s(' % f + ', '.join(map(lambda x: 'a_' + x['name'], args)) + ');')
  44     p('   if (ret.is_err()) {',
  45       '      afb_req_fail(req, "failed", ret.unwrap_err());',
  46       '      return;',
  47       '   }', '')
  48     p('   afb_req_success(req, ret.unwrap(), "success");')
  49
  50 def emit_func(api, f):
  51     p('void %(impl_name)s(afb_req req) noexcept {' % f)
  52     p('   std::lock_guard<std::mutex> guard(binding_m);')
  53     p('   #ifdef ST')
  54     p('   ST();')
  55     p('   #endif')
  56     p('   if (g_afb_instance == nullptr) {',
  57       '      afb_req_fail(req, "failed", "Binding not initialized, did the compositor die?");',
  58       '      return;',
  59       '   }', '',
  60       '   try {', '   // BEGIN impl')
  61     emit_func_impl(api, f)
  62     p('   // END impl',
  63       '   } catch (std::exception &e) {',
  64       '      afb_req_fail_f(req, "failed", "Uncaught exception while calling %(name)s: %%s", e.what());' % f,
  65       '      return;',
  66       '   }', '')
  67     p('}', '')
  68
  69 def emit_afb_verbs(api):
  70     p('const struct afb_verb_v2 %(name)s_verbs[] = {' % api)
  71     for f in api['functions']:
  72         p('   { "%(name)s", %(impl_name)s, nullptr, nullptr, AFB_SESSION_NONE },' % f)
  73     p('   {}', '};')
  74
  75 def emit_binding(api):
  76     p('namespace {', '')
  77     for func in api['functions']:
  78         emit_func(api, func)
  79     p('} // namespace', '')
  80     emit_afb_verbs(api)
  81
  82 def generate_names(api):
  83     for f in api['functions']:
  84         f['impl_name'] = '%s_%s_thunk' % (api['name'], f['name'])
  85
  86 def emit_afb_api(api):
  87     p('#include "result.hpp"', '')
  88     p('#include <json-c/json.h>', '')
  89     p('namespace wm {', '')
  90     p('struct App;', '')
  91     p('struct binding_api {')
  92     p('   typedef wm::result<json_object *> result_type;')
  93     p('   struct wm::App *app;')
  94     p('   void send_event(char const *evname, char const *label);')
  95     for f in api['functions']:
  96         p('   result_type %(name)s(' % f + ', '.join(map(lambda x: '%(type)s %(name)s' % x, f.get('args', []))) + ');')
  97     p('};', '')
  98     p('} // namespace wm')
  99
 100 # names must always be valid in c and unique for each function (that is its arguments)
 101 # arguments will be looked up from json request, range checking needs to be implemented
 102 # by the actual API call
 103 API = {
 104         'name': 'winman',
 105         'api': 'g_afb_instance->app.api.', # where are our API functions
 106         'functions': [
 107             {
 108                 'name': 'request_surface',
 109                 #'return_type': 'int', # Or do they return all just some json?
 110                 'args': [ # describes the functions arguments, and their names as found in the json request
 111                     { 'name': 'drawing_name', 'type': 'char const*', 'jtype': 'string' },
 112                 ],
 113             },
 114             {
 115                 'name': 'activate_surface',
 116                 'args': [
 117                     { 'name': 'drawing_name', 'type': 'char const*', 'jtype': 'string' },
 118                 ],
 119             },
 120             {
 121                 'name': 'deactivate_surface',
 122                 'args': [
 123                     { 'name': 'drawing_name', 'type': 'char const*', 'jtype': 'string' },
 124                 ],
 125             },
 126             {
 127                 'name': 'enddraw',
 128                 'args': [
 129                     { 'name': 'drawing_name', 'type': 'char const*', 'jtype': 'string' },
 130                 ],
 131             },
 132             { 'name': 'list_drawing_names', },
 133             { 'name': 'ping' },
 134
 135             { 'name': 'debug_status', },
 136             { 'name': 'debug_layers', },
 137             { 'name': 'debug_surfaces', },
 138             { 'name': 'debug_terminate' },
 139         ]
 140 }
 141
 142 def main():
 143     with open('afb_binding_glue.inl', 'w') as out:
 144         set_output(out)
 145         p('// This file was generated, do not edit', '')
 146         generate_names(API)
 147         emit_binding(API)
 148     with open('afb_binding_api.hpp', 'w') as out:
 149         set_output(out)
 150         p('// This file was generated, do not edit', '')
 151         emit_afb_api(API)
 152
 153 __name__ == '__main__' and main()