tools/widl/typegen.h

   1 /*
   2  * Format String Generator for IDL Compiler
   3  *
   4  * Copyright 2005-2006 Eric Kohl
   5  * Copyright 2005 Robert Shearman
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library 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 GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #include <stdarg.h>
  23
  24 enum pass
  25 {
  26     PASS_IN,
  27     PASS_OUT,
  28     PASS_RETURN
  29 };
  30
  31 enum remoting_phase
  32 {
  33     PHASE_BUFFERSIZE,
  34     PHASE_MARSHAL,
  35     PHASE_UNMARSHAL,
  36     PHASE_FREE
  37 };
  38
  39 enum typegen_detect_flags
  40 {
  41     TDT_ALL_TYPES =      1 << 0,
  42     TDT_IGNORE_STRINGS = 1 << 1,
  43     TDT_IGNORE_RANGES =  1 << 2,
  44 };
  45
  46 enum typegen_type
  47 {
  48     TGT_INVALID,
  49     TGT_USER_TYPE,
  50     TGT_CTXT_HANDLE,
  51     TGT_CTXT_HANDLE_POINTER,
  52     TGT_STRING,
  53     TGT_POINTER,
  54     TGT_ARRAY,
  55     TGT_IFACE_POINTER,
  56     TGT_BASIC,
  57     TGT_ENUM,
  58     TGT_STRUCT,
  59     TGT_UNION,
  60     TGT_RANGE,
  61 };
  62
  63 typedef int (*type_pred_t)(const type_t *);
  64
  65 void write_formatstringsdecl(FILE *f, int indent, const statement_list_t *stmts, type_pred_t pred);
  66 void write_procformatstring(FILE *file, const statement_list_t *stmts, type_pred_t pred);
  67 void write_typeformatstring(FILE *file, const statement_list_t *stmts, type_pred_t pred);
  68 void write_procformatstring_offsets( FILE *file, const type_t *iface );
  69 void print_phase_basetype(FILE *file, int indent, const char *local_var_prefix, enum remoting_phase phase,
  70                           enum pass pass, const var_t *var, const char *varname);
  71 void write_parameter_conf_or_var_exprs(FILE *file, int indent, const char *local_var_prefix,
  72                                        enum remoting_phase phase, const var_t *var, int valid_variance);
  73 void write_remoting_arguments(FILE *file, int indent, const var_t *func, const char *local_var_prefix,
  74                               enum pass pass, enum remoting_phase phase);
  75 unsigned int get_size_procformatstring_func(const type_t *iface, const var_t *func);
  76 unsigned int get_size_procformatstring(const statement_list_t *stmts, type_pred_t pred);
  77 unsigned int get_size_typeformatstring(const statement_list_t *stmts, type_pred_t pred);
  78 void assign_stub_out_args( FILE *file, int indent, const var_t *func, const char *local_var_prefix );
  79 void declare_stub_args( FILE *file, int indent, const var_t *func );
  80 void write_func_param_struct( FILE *file, const type_t *iface, const type_t *func,
  81                               const char *var_decl, int add_retval );
  82 void write_pointer_checks( FILE *file, int indent, const var_t *func );
  83 int write_expr_eval_routines(FILE *file, const char *iface);
  84 void write_expr_eval_routine_list(FILE *file, const char *iface);
  85 void write_user_quad_list(FILE *file);
  86 void write_endpoints( FILE *f, const char *prefix, const str_list_t *list );
  87 void write_client_call_routine( FILE *file, const type_t *iface, const var_t *func,
  88                                 const char *prefix, unsigned int proc_offset );
  89 void write_exceptions( FILE *file );
  90 unsigned int type_memsize(const type_t *t);
  91 int decl_indirect(const type_t *t);
  92 int is_interpreted_func(const type_t *iface, const var_t *func);
  93 void write_parameters_init(FILE *file, int indent, const var_t *func, const char *local_var_prefix);
  94 void print(FILE *file, int indent, const char *format, va_list ap);
  95 expr_t *get_size_is_expr(const type_t *t, const char *name);
  96 int is_full_pointer_function(const var_t *func);
  97 void write_full_pointer_init(FILE *file, int indent, const var_t *func, int is_server);
  98 void write_full_pointer_free(FILE *file, int indent, const var_t *func);
  99 unsigned char get_basic_fc(const type_t *type);
 100 unsigned char get_pointer_fc(const type_t *type, const attr_list_t *attrs, int toplevel_param);
 101 unsigned char get_struct_fc(const type_t *type);
 102 enum typegen_type typegen_detect_type(const type_t *type, const attr_list_t *attrs, unsigned int flags);