1 /* 2 * Template output. 3 * 4 * Copyright (C) 2019, 2020 Paul Boddie <paul@boddie.org.uk> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation; either version 2 of 9 * the License, or (at your option) any later version. 10 * 11 * This program is distributed in the hope that it will be useful, 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 * 16 * You should have received a copy of the GNU General Public License 17 * along with this program; if not, write to the Free Software 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, 19 * Boston, MA 02110-1301, USA 20 */ 21 22 #pragma once 23 24 /* Filename definitions. */ 25 26 #define client_filename_c "%s/%s_client.c" 27 #define client_filename_cpp "%s/%s_client.cc" 28 #define client_header_filename "%s/%s_client.h" 29 #define compound_interface_type_filename "%s/%s_interface_type.h" 30 #define compound_interfaces_filename "%s/%s_interfaces.h" 31 #define interface_filename "%s/%s_interface.h" 32 #define server_filename_c "%s/%s_server.c" 33 #define server_filename_cpp "%s/%s_server.cc" 34 #define server_header_filename "%s/%s_server.h" 35 36 /* Client templates. */ 37 38 #define client_prologue \ 39 "#include \"%s_client.h\"\n" \ 40 "#include <ipc/message.h>\n" 41 42 #define client_function_body_prologue \ 43 " ipc_message_t msg;\n" \ 44 " long err;\n" 45 46 #define client_function_body_endpoint_conversion_c \ 47 " %s _endp = _self.cap;\n" 48 49 #define client_function_body_call \ 50 "\n ipc_message_request(&msg, %s, %s);\n\n" \ 51 " err = l4_error(msg.tag);\n" \ 52 " if (err)\n" \ 53 " return err;\n" 54 55 /* Client interface definitions for C++. */ 56 57 #define client_interface_prologue_cpp \ 58 " : public %s" 59 60 #define client_interface_endpoint_declaration_cpp \ 61 "\nprotected:\n" \ 62 " %s _endp;\n" 63 64 #define client_interface_constructor_cpp \ 65 "\n %s(%s endp) : _endp(endp) { }\n" 66 67 /* Client interface definitions for C. */ 68 69 #define client_interface_declaration_c \ 70 "\nextern iface_%s client_iface_%s;" 71 72 #define client_interface_prologue_c \ 73 "\niface_%s client_iface_%s = {" 74 75 #define client_interface_member_c \ 76 "\n .%s = %s," 77 78 #define client_interface_epilogue_c \ 79 "\n};\n" 80 81 /* Compound interface dispatcher templates. */ 82 83 #define compound_dispatch_prologue \ 84 "#include \"%s_server.h\"\n" 85 86 #define compound_dispatch_function_prologue \ 87 " switch (l4_msgtag_label(msg->tag))\n" \ 88 " {\n" 89 90 #define compound_dispatch_epilogue \ 91 " default:\n" \ 92 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 93 " ipc_message_reply(msg);\n" \ 94 " break;\n" \ 95 " }\n" 96 97 #define compound_dispatch_header_prologue \ 98 "#pragma once\n\n" \ 99 "#include <ipc/message.h>\n" \ 100 "#include \"%s_interface.h\"\n" 101 102 /* Compound interface class definitions. */ 103 104 #define compound_interface_prologue_cpp \ 105 "#pragma once\n\n" \ 106 "#include \"%s_interfaces.h\"\n\n" \ 107 "#ifdef __cplusplus\n\n" \ 108 "class %s :" 109 110 #define compound_interface_prologue_c \ 111 "#pragma once\n\n" \ 112 "#include \"%s_interface_type.h\"\n\n" \ 113 "typedef struct\n" \ 114 "{\n" 115 116 #define compound_interface_epilogue_cpp \ 117 "\n{\n};\n\n" \ 118 "#endif /* __cplusplus */\n" 119 120 #define compound_interface_epilogue_c \ 121 "\n} iface_%s;\n" 122 123 #define compound_interfaces_prologue \ 124 "#pragma once\n\n" 125 126 #define compound_ref_type_definition_prologue_c \ 127 "#pragma once\n\n" \ 128 "#include <l4/sys/types.h>\n" \ 129 "#include \"%s_interfaces.h\"\n\n" \ 130 "typedef union {\n" \ 131 " %s cap;\n" \ 132 " void *ptr;\n" 133 134 #define compound_ref_type_definition_member_c \ 135 " ref_%s as_%s;\n" 136 137 #define compound_ref_type_definition_epilogue_c \ 138 "} ref_%s;\n" 139 140 #define compound_interface_conversion_c \ 141 "\n#define convert_to_%s(_self) (&((%s) {.iface=_self->iface->to_%s, .ref=_self->ref.as_%s}))\n" 142 143 #define compound_interface_conversion_cpp \ 144 "\n#define convert_to_%s(_self) (_self)\n" 145 146 /* Dispatch functions. */ 147 148 #define dispatch_function_signature \ 149 "\nvoid dispatch_%s(ipc_message_t *msg, %s *_self)" 150 151 /* Message handling functions. */ 152 153 #define handle_function_signature \ 154 "\nvoid handle_%s(ipc_message_t *msg, %s *_self)" 155 156 #define handle_function \ 157 " ipc_message_open(msg);\n" \ 158 " dispatch_%s(msg, _self);\n" \ 159 " ipc_message_discard(msg);\n" 160 161 /* General header template. */ 162 163 #define header_prologue \ 164 "#pragma once\n\n" \ 165 "#include <l4/sys/err.h>\n" \ 166 "#include <l4/sys/types.h>\n" 167 168 /* Server templates. */ 169 170 #define server_header_prologue \ 171 "#pragma once\n\n" \ 172 "#include <ipc/message.h>\n" 173 174 #define server_prologue \ 175 "#include \"%s_server.h\"\n" 176 177 /* Server wrapper function templates. */ 178 179 #define server_function_signature \ 180 "\nlong %s_%s(ipc_message_t *msg, %s *_self)" 181 182 #define server_function_body_prologue \ 183 " long err;\n" 184 185 #define server_function_body_unused_message \ 186 "\n (void) msg;\n" 187 188 #define server_function_body_call \ 189 " if (err)\n" \ 190 " return err;\n" 191 192 #define server_function_body_epilogue \ 193 "\n return L4_EOK;\n" 194 195 #define server_completion_function_signature_prologue \ 196 "\nlong complete_%s(l4_cap_idx_t _endp" 197 198 #define server_completion_function_body_prologue \ 199 " ipc_message_t msg;\n" 200 201 #define server_completion_function_body_epilogue \ 202 "\n ipc_message_send(&msg, %s, %s);\n\n" \ 203 " return l4_error(msg.tag);\n" 204 205 #define server_initiation_function_body_epilogue \ 206 "\n ipc_message_prepare(msg);\n\n" \ 207 " return L4_EOK;\n" 208 209 /* Server dispatch function templates. */ 210 211 #define server_function_dispatcher_body_epilogue \ 212 " default:\n" \ 213 " ipc_message_send_error(msg, -L4_EBADPROTO);\n" \ 214 " ipc_message_reply(msg);\n" \ 215 " break;\n" \ 216 " }\n" 217 218 /* Interface class definitions. */ 219 220 #define interface_prologue_cpp \ 221 "\n#ifdef __cplusplus\n" \ 222 "\nclass %s" 223 224 #define interface_prologue_c \ 225 "\ntypedef struct" \ 226 227 #define interface_body_begin \ 228 "\n{" 229 230 #define interface_signatures_prologue_cpp \ 231 "\npublic:" 232 233 #define interface_epilogue_cpp \ 234 "};\n\n" \ 235 "#endif /* __cplusplus */\n" 236 237 #define interface_epilogue_c \ 238 "\n} iface_%s;\n" 239 240 #define interface_function_signature_prologue \ 241 "\n%slong %s(" 242 243 #define interface_struct_member_function_signature_prologue \ 244 "\n long (*%s)(" 245 246 #define interface_unimplemented_method_prologue_cpp \ 247 "\n {" 248 249 #define interface_unimplemented_method_epilogue_cpp \ 250 " return -L4_EBADPROTO; }\n" 251 252 #define interface_unused_parameter \ 253 " (void) %s;" 254 255 /* Reference and object type definitions for interfaces. */ 256 257 #define ref_type_definition_c \ 258 "\ntypedef union { %s cap; void *ptr; } ref_%s;\n" 259 260 #define object_type_definition_c \ 261 "\ntypedef struct\n" \ 262 "{\n" \ 263 " ref_%s ref;\n" \ 264 " iface_%s *iface;\n" \ 265 "\n} %s;\n" 266 267 #define expected_items_definition \ 268 "\n#define %s_expected_items %d\n" 269 270 /* Opcode definitions. */ 271 272 #define opcode_enumeration_prologue \ 273 "\nenum opcodes_%s\n{\n" 274 275 #define opcode_identifier \ 276 " opcode_%s_%s" 277 278 #define opcode_enumeration_epilogue \ 279 "};\n" 280 281 /* Message structure definitions. */ 282 283 #define structure_prologue \ 284 "\nstruct %s_words_%s\n{\n" 285 286 #define structure_opcode_member \ 287 " %s _op;\n" 288 289 #define structure_epilogue \ 290 "};\n" 291 292 /* Message access templates. */ 293 294 #define message_accessor_declaration \ 295 " struct %s_words_%s *%s_words;\n" 296 297 #define message_accessor_initialisation \ 298 "\n %s_words = (struct %s_words_%s *)" 299 300 #define message_accessor_reading_initialiser \ 301 " ipc_message_get_word_address(%smsg, 0);\n" 302 303 #define message_accessor_writing_initialiser \ 304 " ipc_message_reserve_words(%smsg, sizeof(struct %s_words_%s));\n" 305 306 /* Dispatch templates. */ 307 308 #define dispatch_function_interface_case \ 309 " case %s:\n" \ 310 " dispatch_%s(msg, %s);\n" \ 311 " break;\n\n" 312 313 #define dispatch_function_wrapper_case \ 314 " case %s:\n" \ 315 " ipc_message_send_error(msg, %s_%s(msg, %s));\n" \ 316 " break;\n\n" 317 318 #define dispatch_function_reply_wrapper_case \ 319 " case %s:\n" \ 320 " ipc_message_send_error(msg, %s_%s(msg, %s));\n" \ 321 " ipc_message_reply(msg);\n" \ 322 " break;\n\n" 323 324 /* Tokens. */ 325 326 #define BEGIN_FUNCTION "\n{\n" 327 #define END_FUNCTION "}\n" 328 329 #define COMPLETE_MEMBER ";\n" 330 #define INDENT_MEMBER " " 331 332 #define COMPLETE_SIGNATURE ";\n" 333 #define END_SIGNATURE "\n" 334 335 /* Texts. */ 336 337 #define help_text \ 338 "Usage: %s [ <options> ] <filename> ...\n\n" \ 339 "Generate source code for the interfaces in the supplied files.\n\n" \ 340 "The following options are supported:\n\n" \ 341 "--all or -a Produce all kinds of output for a given language.\n\n" \ 342 "--client or -c Generate client code.\n\n" \ 343 "--comp or -C Generate a compound/composite/component interface using\n" \ 344 " the given filename prefix.\n\n" \ 345 "--dir or -d Create output in the indicated directory.\n\n" \ 346 "--headers or -h Produce header files.\n\n" \ 347 "--help or -? Show this message.\n\n" \ 348 "--interfaces or -i Produce interface header files.\n\n" \ 349 "--language or -l Generate code in the indicated language.\n\n" \ 350 "--comp-name or -N Indicate the compound/composite/component interface name.\n\n" \ 351 "--routines or -r Produce program routines.\n\n" \ 352 "--server or -s Generate server code.\n\n" \ 353 "--verbose or -v Show verbose output reporting the processed interfaces.\n\n" \ 354 "--version or -V Show version information.\n\n"