Changeset 267 for trunk/idl-compiler/c/nom-idl-compiler.c

Timestamp:

Mar 25, 2007, 12:33:43 PM (18 years ago)

Author:

cinc

Message:

Output file creation and better option parsing

File:

• trunk/idl-compiler/c/nom-idl-compiler.c (modified) (15 diffs)

trunk/idl-compiler/c/nom-idl-compiler.c

@@ -67 +67 @@
   {"emit-ih", 0, 0, G_OPTION_ARG_NONE, &fOptionEmitIH, "Emmit an include header (*.ih)", NULL},
   {"emit-c", 0, 0, G_OPTION_ARG_NONE, &fOptionEmitC, "Emmit an implementation template (*.c)", NULL},
-  {"output", 'o', 0, G_OPTION_ARG_FILENAME, &chrOutputName, "Output name", NULL},
+  {"output", 'o', 0, G_OPTION_ARG_FILENAME, &chrOutputName, "Output name. Must not be omitted.", NULL},
   {NULL}
 };
 
-static char* chrOutputFileName="";
 
 /* The pointer array holding the interfaces we found */
@@ -91 +90 @@
   {"gchar", IDL_SYMBOL_GCHAR, KIND_TYPESPEC},
   {"void", IDL_SYMBOL_VOID, KIND_TYPESPEC},
+
+  {"boolean", IDL_SYMBOL_BOOLEAN, KIND_TYPESPEC},
+  {"String", IDL_SYMBOL_STRING, KIND_TYPESPEC},
+
   {"in", IDL_SYMBOL_IN, KIND_DIRECTION},
   {"out", IDL_SYMBOL_OUT, KIND_DIRECTION},
@@ -110 +113 @@
 PARSEINFO parseInfo={0};
 
+/**
+   Helper function which scans the array of known interfaces and returns the interface
+   structure for the given name. 
+
+   \PARAM chrName Name of the interface.
+   \Returns If no interface with that name can be found NULL is returned otherwise a
+   pointer to the interface structure..
+ */
 PINTERFACE findInterfaceFromName(gchar* chrName)
 {
@@ -124 +135 @@
 }
 
-
+/**
+   Helper function which returns a copy of the typespec string of the current token.
+   That is e.g. 'gint' or 'gpointer'. Note that this function is only called when the
+   current token is indeed a type specification in the IDL file.
+ */
 gchar* getTypeSpecStringFromCurToken(void)
 {
@@ -159 +174 @@
 }
 
-/*
-  The native keyword is used to introduce new types. That's coming
-  from the Corba spec. Maybe we will change that some time.
-
-The current token is the 'native' keyword.
+/**
+   Parse the declaration of a new type using the 'native' keyword.
+
+  The 'native' keyword is used to introduce new types. That's coming
+  from the Corba spec.
+
+  \Remarks  The current token is the 'native' keyword.
 
   N:= G_TOKEN_SYMBOL IDENT ';'
@@ -229 +246 @@
 
 /**
-   This is the root parse function. Here starts the fun...
+   This is the root parse function. Here starts the fun. When a token is found in the
+   input stream which matches one of the known token types the respective parsing function
+   is called for further processing. In case of an error the parsing function in question 
+   prints an error which describes the problem and exits the application.
+
+   This function scans the input until EOF is hit.
  */
 void parseIt(void)
@@ -306 +328 @@
 }
 
-/* Show help.
-   gContext must be valid.
+/**
+   Support function to show help for the IDL compiler. gContext must be valid.
 */
 static void outputCompilerHelp(GOptionContext *gContext, gchar* chrExeName)
@@ -316 +338 @@
   char** argv2=helpCmd;
   helpCmd[0]=chrExeName;
-  
-  g_option_context_parse (gContext, &argc2, &argv2, &gError); 
+
+  g_printf("An output filename must always be specified. If the name is an absolute path\n\
+it will be used unmodified. Otherwise the output name is built from the given\n\
+name and the directory specification.\n\n\
+-If no directory is specified the output name is built from the current directory\n\
+ path and the given filename.\n\
+-If the directory is a relative path the output name is built from the current\n\
+ directory path, the given directory name (or path) and the filename.\n\
+-If the directory is a full path the output name is built from the directory\n\
+ path and the given filename.\n\n\
+Note that an emitter specific extension will always be appended to the output\n\
+filename\n\n");
+
+  /* This prints the standard option help to screen. */  
+  g_option_context_parse (gContext, &argc2, &argv2, &gError);
 }
 
@@ -334 +369 @@
 };
 
-void funcMsgHandler(GScanner *gScanner,
-                    gchar *message,
-                    gboolean error)
-{
-
+/**
+   Message output handler for the scanner. The default handler isn't used because the preprocessor
+   mangles all include files together and thus the line numbers are not as expected by the user.
+   This function prints the error messages with corrected linenumbers and the source file name
+   in which to find the problem.
+   
+ */
+void funcMsgHandler(GScanner *gScanner, gchar *message, gboolean error)
+{
   g_printf("In file %s, line %d:\n\t%s\n", parseInfo.chrCurrentSourceFile,
            g_scanner_cur_line(gScanner)-parseInfo.uiLineCorrection, message);
 }
 
-/*
-
+/**
+   Main entry point for the idl compiler.
  */
 int main(int argc, char **argv)
@@ -350 +389 @@
   int a;
   int fd;
+  /* Vars for filename building */
+  char* chrOutputFileName="";
 
   GError *gError = NULL;
@@ -382 +423 @@
   }
 #endif
+
+  if(strlen(chrOutputName)==0)
+    {
+      g_printf("No output file name given.\n\n");
+      outputCompilerHelp(gContext, argv[0]);
+    }
   g_option_context_free(gContext);
 
@@ -396 +443 @@
     }
 
-  /* Create output file name */
+  
+  /*** Create output file name ****/
+  if(!g_path_is_absolute(chrOutputName))
+    {
+      if(g_path_is_absolute(chrOutputDir))
+        chrOutputFileName=g_build_filename(chrOutputDir, chrOutputName, NULL);
+      else
+        {
+          /* Yes this is a memory leak but I don't care */
+          chrOutputFileName=g_build_filename(g_get_current_dir(), chrOutputDir, chrOutputName, NULL);
+        }
+    }
+  else
+    chrOutputFileName=chrOutputName;
+
+  //g_message("Output file: %s", chrOutputFileName);
+
+  /* Open input */
   if(!strcmp(argv[1], "-"))
     fd=0; /* Read from stdin */
@@ -408 +472 @@
     }
   
+  /* Open output */
+  parseInfo.outFile=fopen(chrOutputFileName, "w");
+
   g_printf("\n");
-
-
 
   gScanner=g_scanner_new(NULL);
@@ -437 +502 @@
       pSymbols++;
     }
-  //  gScanner->config->symbol_2_token=TRUE;
 
   parseIt();
@@ -446 +510 @@
   g_scanner_destroy(gScanner);
   close(fd);
-
+  fclose(parseInfo.outFile);
   return 0;
 }