Changeset 253

Timestamp:

Mar 11, 2007, 11:31:49 PM (18 years ago)

Author:

cinc

Message:

First attempt on automatic parameter check for methods.

Location:

trunk/ORBit2-2.14.0/src/idl-compiler

Files:

• orbit-idl-c-headers.c (modified) (6 diffs)
• orbit-idl-c-skelimpl.c (modified) (10 diffs)
• orbit-idl2.h (modified) (1 diff)

trunk/ORBit2-2.14.0/src/idl-compiler/orbit-idl-c-headers.c

@@ -636 +636 @@
 }
 
+#if 0
+static gchar* mySkipSpaces(char*  theString)
+{
+  if(!theString) /* Huh???*/
+    return "";
+
+  while(*theString)
+    theString++;
+
+  return theString
+}
+#endif
+
+#include <string.h>
+/*
+  This function extracts the return vlaue from the string which is created by
+  the parameter check macro. The string is of the form:
+
+  "retval, parm1, parm2,..."
+
+ */
+static gchar* VoyagerExtractRetValFromParmCheck(gchar* theString)
+{
+  gchar* ptr, *ptr2;
+
+  if(NULL==(ptr=strchr(theString, ',')))
+    {
+      /* No ',' so no parameters provided */
+      return g_strdup(theString);
+    }
+  *ptr='\0';
+  ptr2=g_strdup(theString);
+  *ptr=',';
+  return ptr2;
+};
+/*
+  This functions puts constants into the header file. For Voyager we
+  use constants to encode some special information e.g. the metaclass name
+  or info about which parameters to check for methods. This information is
+  marked by special strings in the constants name.
+ */
 static void
 ch_output_const_dcl(IDL_tree tree, OIDL_Run_Info *rinfo, OIDL_C_Info *ci)
@@ -642 +683 @@
         IDL_tree ident;
         IDL_tree typespec;
+    gchar *ptr;
 
         ident = IDL_CONST_DCL (tree).ident;
         id = IDL_ns_ident_to_qstring(IDL_IDENT_TO_NS (ident), "_", 0);
 
-        fprintf(ci->fh, "#ifndef %s\n", id);
-        fprintf(ci->fh, "#define %s ", id);
-
-        orbit_cbe_write_const(ci->fh,
-                              IDL_CONST_DCL(tree).const_exp);
-
-        typespec = orbit_cbe_get_typespec (IDL_CONST_DCL(tree).const_type);
-        if (IDL_NODE_TYPE (typespec) == IDLN_TYPE_INTEGER &&
-            !IDL_TYPE_INTEGER (typespec).f_signed)
-                fprintf(ci->fh, "U");
-
-        fprintf(ci->fh, "\n");
-        fprintf(ci->fh, "#endif /* !%s */\n\n", id);
-    
-    /* Get the name of our explicit metaclass if any */
+    ptr=strstr( id , NOM_PARMCHECK_STRING);
+    /* Enable parameter check for a method */
+    if(ptr)
+      {
+        gchar *retVal;
+        *ptr='\0';
+        //printf(" %d    --- > %s %s Params: %s\n",
+        //__LINE__, id, IDL_IDENT(ident).str, IDL_STRING(IDL_CONST_DCL(ski->tree).const_exp).value);
+        fprintf(ci->fh, "/* %s: %s line %d */\n", __FILE__, __FUNCTION__, __LINE__);
+        fprintf(ci->fh, "/* Value: %s */\n", IDL_STRING(IDL_CONST_DCL(tree).const_exp).value);
+        fprintf(ci->fh, "#ifndef %s_ParmCheck_h\n", id);
+        fprintf(ci->fh, "#define %s_ParmCheck_h\n", id);
+        retVal=VoyagerExtractRetValFromParmCheck(IDL_STRING(IDL_CONST_DCL(tree).const_exp).value);
+        fprintf(ci->fh, "#define %s_retval %s\n", id, retVal);
+        g_free(retVal);
+        fprintf(ci->fh, "#endif /* !%s */\n\n", id);
+        *ptr='_';
+      }
+    else
+      {
+        fprintf(ci->fh, "#ifndef %s\n", id);
+        fprintf(ci->fh, "#define %s ", id);
+        
+        orbit_cbe_write_const(ci->fh,
+                              IDL_CONST_DCL(tree).const_exp);
+        
+        typespec = orbit_cbe_get_typespec (IDL_CONST_DCL(tree).const_type);
+        if (IDL_NODE_TYPE (typespec) == IDLN_TYPE_INTEGER &&
+            !IDL_TYPE_INTEGER (typespec).f_signed)
+          fprintf(ci->fh, "U");
+        
+        fprintf(ci->fh, "\n");
+        fprintf(ci->fh, "#endif /* !%s */\n\n", id);
+      }
+
     if(IDLN_STRING==IDL_NODE_TYPE(IDL_CONST_DCL(tree).const_exp))
       {
+        /* Get the name of our explicit metaclass if any */
         /* Our metaclass info is a string */
         if(strstr( IDL_IDENT(ident).str, NOM_METACLASS_STRING))
@@ -671 +734 @@
             //     __LINE__, id, IDL_STRING(IDL_CONST_DCL(ski->tree).const_exp).value, gsMetaClassName[ulCurInterface]);
           }
-      }
+       }
         g_free(id);
 }
@@ -1193 +1256 @@
     /* define method call as a macro */
     fprintf(of, "/* define method call as a macro */\n");
-    fprintf(of, "#define %s(vomSelf, ", id);
+    fprintf(of, "#ifdef %s_ParmCheck_h /* Parameter check */\n", id);
+    /* Forward declaration */
+    fprintf(of, "NOMEXTERN ");                
+    fprintf(of, "gboolean NOMLINK parmCheckFunc_%s(%s *nomSelf, \n",id, id2);
+    op = tree;
+    for(curitem = IDL_OP_DCL(tree).parameter_dcls;
+        curitem; curitem = IDL_LIST(curitem).next) {
+      IDL_tree tr;
+      tr = IDL_LIST(curitem).data;      
+      /*  Write list of params */
+      if(IDL_NODE_TYPE(tr) == IDLN_PARAM_DCL)
+        {
+          fprintf(of, "        ");
+          orbit_cbe_write_param_typespec(of, tr);
+          fprintf(of, " %s,\n", IDL_IDENT(IDL_PARAM_DCL(tr).simple_declarator).str);
+        }
+    }
+    tree=op;
+    fprintf(of, "CORBA_Environment *ev)");
+    fprintf(of, ";\n");
+
+    /* Macro to be used when parameters are checked */
+    fprintf(of, "#define %s(nomSelf, ", id);
     /* add the parms */
-
     op = tree;
     for(curitem = IDL_OP_DCL(tree).parameter_dcls;
@@ -1208 +1292 @@
     }
     tree=op;
-
-    //   fprintf(of, "CORBA_Environment *ev) \\\n");
     fprintf(of, "ev) \\\n");
-    fprintf(of, "        (NOM_Resolve(vomSelf, %s, %s) \\\n", id2, id3);
-    fprintf(of, "        (vomSelf,");
+    fprintf(of, "        (parmCheckFunc_%s(nomSelf, ", id);
+    /* Parameters for call */
+    op = tree;
+    for(curitem = IDL_OP_DCL(tree).parameter_dcls;
+        curitem; curitem = IDL_LIST(curitem).next) {
+      IDL_tree tr;
+      tr = IDL_LIST(curitem).data;      
+      //orbit_cbe_ski_process_piece(&subski);
+      /*  Write list of params */
+      if(IDL_NODE_TYPE(tr) == IDLN_PARAM_DCL)
+        {
+          fprintf(of, " %s,", IDL_IDENT(IDL_PARAM_DCL(tr).simple_declarator).str);
+        }
+    }
+    tree=op;
+
+    fprintf(of, "ev) ? \\\n");
+    fprintf(of, "        (NOM_Resolve(nomSelf, %s, %s) \\\n", id2, id3);
+    fprintf(of, "        (nomSelf,");
 
     /* add the parms */
@@ -1228 +1327 @@
     }
     tree=op;
+    fprintf(of, "ev)) : %s_retval)\n", id);
+    fprintf(of, "#else\n");
+
+    /* Normal macro */
+    fprintf(of, "#define %s(nomSelf, ", id);
+    /* add the parms */
+    op = tree;
+    for(curitem = IDL_OP_DCL(tree).parameter_dcls;
+        curitem; curitem = IDL_LIST(curitem).next) {
+      IDL_tree tr;
+      tr = IDL_LIST(curitem).data;      
+      /*  Write list of params */
+      if(IDL_NODE_TYPE(tr) == IDLN_PARAM_DCL)
+        {
+          fprintf(of, " %s,", IDL_IDENT(IDL_PARAM_DCL(tr).simple_declarator).str);
+        }
+    }
+    tree=op;
+
+    //   fprintf(of, "CORBA_Environment *ev) \\\n");
+    fprintf(of, "ev) \\\n");
+    fprintf(of, "        (NOM_Resolve(nomSelf, %s, %s) \\\n", id2, id3);
+    fprintf(of, "        (nomSelf,");
+
+    /* add the parms */
+    op = tree;
+    for(curitem = IDL_OP_DCL(tree).parameter_dcls;
+        curitem; curitem = IDL_LIST(curitem).next) {
+      IDL_tree tr;
+      tr = IDL_LIST(curitem).data;      
+      //orbit_cbe_ski_process_piece(&subski);
+      /*  Write list of params */
+      if(IDL_NODE_TYPE(tr) == IDLN_PARAM_DCL)
+        {
+          fprintf(of, " %s,", IDL_IDENT(IDL_PARAM_DCL(tr).simple_declarator).str);
+        }
+    }
+    tree=op;
 
     // fprintf(of, "CORBA_Environment *ev))\n");
     fprintf(of, "ev))\n");
+    fprintf(of, "#endif\n");
     /* Method macro */
     fprintf(of, "#define _%s %s", id3 , id);

trunk/ORBit2-2.14.0/src/idl-compiler/orbit-idl-c-skelimpl.c

@@ -43 +43 @@
   FILE *of;
   IDL_tree tree;
-  enum { PASS_VOYAGER_INSTANCE, PASS_VOYAGER_GETDATA, PASS_VOYAGER_CLSDATA,
+  enum { PASS_VOYAGER_INSTANCE, PASS_VOYAGER_GETDATA, PASS_VOYAGER_CLSDATA, PASS_VOYAGER_PARMCHECK,
          PASS_SERVANTS, PASS_PROTOS, PASS_EPVS, PASS_VEPVS,
          PASS_IMPLSTUBS, PASS_VOYAGER_OVERRIDEN_METHODS, PASS_VOYAGER_OVERRIDEN_METHODTAB,
@@ -67 +67 @@
   "Voyager GetData macros ", 
   "Voyager class data structures",
+  "Voyager parameter check",
   "App-specific servant structures",
   "Implementation stub prototypes",
@@ -328 +329 @@
 }
 
+/*
+  The name of our meta class is encoded as a constant. We go over all the constants found during
+  IDL parsing and check for a special marker string in the name.
+ */
 static void
 VoyagerExtractMetaClass(CBESkelImplInfo *ski)
@@ -343 +348 @@
       id = IDL_ns_ident_to_qstring(IDL_IDENT_TO_NS (ident), "_", 0);
 
-#if 0
-      printf(" %d --- > %s %s %s, %s %d\n", __LINE__,
-             id, IDL_IDENT(ident).str, IDL_IDENT(IDL_INTERFACE(intf).ident).str,
-             passnames[ski->pass], IDL_NODE_TYPE(IDL_CONST_DCL(ski->tree).const_exp));
-#endif
-
       if(IDLN_STRING==IDL_NODE_TYPE(IDL_CONST_DCL(ski->tree).const_exp))
         {
+          //  printf(" %d --- > %s\n", __LINE__,IDL_IDENT(ident).str);
           /* Our metaclass info is a string */
           if(strstr( IDL_IDENT(ident).str, NOM_METACLASS_STRING))
@@ -358 +358 @@
               //    printf(" %d    --- > %s %s (%x)\n",
               //     __LINE__, id, IDL_STRING(IDL_CONST_DCL(ski->tree).const_exp).value, gsMetaClassName[ulCurInterface]);
+            }
+        }
+      g_free(id);
+    }/* PASS_VOYAGER_...*/
+}
+
+/*
+  For methods which should have parameter checks (specified by a special macro in the IDL file)
+  a constant string is specified. The method name is encoded in the constants name while the string
+  holds all the info about the parameters to check.
+  We go over all the constants found during IDL parsing and check for a special marker string in the
+  name.
+ */
+static void
+VoyagerCreateParamCheckFunctions(CBESkelImplInfo *ski)
+{
+  char    *id;
+  IDL_tree ident;
+  IDL_tree intf;
+
+
+  if(PASS_VOYAGER_PARMCHECK==ski->pass)
+    {
+      ident = IDL_CONST_DCL (ski->tree).ident;
+      intf = IDL_get_parent_node(ski->tree, IDLN_INTERFACE, NULL);
+
+      id = IDL_ns_ident_to_qstring(IDL_IDENT_TO_NS (ident), "_", 0);
+
+      if(IDLN_STRING==IDL_NODE_TYPE(IDL_CONST_DCL(ski->tree).const_exp))
+        {
+          gchar *ptr;
+          //  printf(" %d --- > %s\n", __LINE__,IDL_IDENT(ident).str);
+          /* Our parameter info is a string */
+          ptr=strstr( id /*IDL_IDENT(ident).str*/, NOM_PARMCHECK_STRING);
+          if(ptr)
+            {
+              *ptr='\0';
+              //printf(" %d    --- > %s %s Params: %s\n",
+              //__LINE__, id, IDL_IDENT(ident).str, IDL_STRING(IDL_CONST_DCL(ski->tree).const_exp).value);
+              fprintf(ski->of, "#ifndef %s_ParmCheck\n", id);
+              fprintf(ski->of, "#define %s_ParmCheck\n", id);
+              fprintf(ski->of, "#endif\n");
+              *ptr='_';
             }
         }
@@ -411 +454 @@
                 break;
     case IDLN_CONST_DCL:
+      /* Find the name of the metaclass for this class if any. */
       VoyagerExtractMetaClass(ski);
+      /* Create support function for parameter checks. */
+      VoyagerCreateParamCheckFunctions(ski);
       break;
         default:
@@ -776 +822 @@
         gstr=g_string_new(IDL_IDENT(IDL_OP_DCL(ski->tree).ident).str);
 
-        /* Check for our specailly marked NOM-only methods. Don't output them here, they are handled
+        /* Check for our specially marked NOM-only methods. Don't output them here, they are handled
            specially. */
           if(!strstr(id, NOM_INSTANCEVAR_STRING) /*&& !strstr(id, NOM_OVERRIDE_STRING)*/)
@@ -954 +1000 @@
             }
 
-            /* Output the parameter info */
+            /* Output the parameter info for runtime type information */
             if(!bOverriden)
               {
@@ -988 +1034 @@
                 fprintf(ski->of, "}};\n");
               }
+
+            /* Output a function for checking the parameters */
+            if(!bOverriden)
+              {
+                fprintf(ski->of, "#ifdef %s_ParmCheck\n", id);
+                fprintf(ski->of, "NOMEXTERN ");                
+                fprintf(ski->of, "gboolean NOMLINK parmCheckFunc_%s_%s(%s *nomSelf,\n",
+                        id2, IDL_IDENT(IDL_OP_DCL(ski->tree).ident).str, id2);                
+                op = ski->tree;
+                for(curitem = IDL_OP_DCL(ski->tree).parameter_dcls;
+                    curitem; curitem = IDL_LIST(curitem).next) {
+                  subski.tree = IDL_LIST(curitem).data;
+                  orbit_cbe_ski_process_piece(&subski);
+                }
+                        
+                if(IDL_OP_DCL(op).context_expr)
+                  fprintf(ski->of, "CORBA_Context ctx,\n");            
+                fprintf(ski->of, "CORBA_Environment *ev)");
+
+                fprintf(ski->of, "{\n");
+                fprintf(ski->of, "  g_message(\"%%s: parameter check for %%s...\", __FUNCTION__, _nomGetClassName(nomSelf, NULLHANDLE));\n");
+                fprintf(ski->of, "if(!_nomIsA(nomSelf , %sClassData.classObject, NULLHANDLE))\n", id2);
+                fprintf(ski->of, "  {\n");
+                fprintf(ski->of, "  g_message(\"Object is not valid\");\n");
+                fprintf(ski->of, "  return FALSE;\n");
+                fprintf(ski->of, "  }\n");
+                fprintf(ski->of, "  return TRUE;\n");
+                fprintf(ski->of, "}\n");
+                fprintf(ski->of, "#endif\n");
+              }
+
 
             if(ptr!=NULL)
@@ -1389 +1466 @@
         break;
       }
+    case PASS_VOYAGER_PARMCHECK:
+      {
+                subski.tree = IDL_INTERFACE(ski->tree).body;
+        cbe_ski_do_list(&subski);
+                IDL_tree_traverse_parents(ski->tree, (GFunc)&cbe_ski_do_inherited_methods, ski);
+        break;
+      }
     case PASS_VOYAGER_CLASSINFO:
       {

trunk/ORBit2-2.14.0/src/idl-compiler/orbit-idl2.h

@@ -33 +33 @@
 #define NOM_INSTANCEVAR_STRING "__INSTANCEVAR__"
 #define NOM_METACLASS_STRING "METACLASS_TO_USE"
+#define NOM_PARMCHECK_STRING "__PARMCHECK__"
 
 #endif