Changeset 31649 in vbox for trunk/src/VBox

Timestamp:

Aug 13, 2010 1:18:04 PM (14 years ago)

Author:

vboxsync

Message:

webservice: remove obsolete file, add comments

Location:

trunk/src/VBox/Main/webservice

Files:

• Makefile.kmk (modified) (10 diffs)
• websrv-gsoapH.xsl (deleted)

trunk/src/VBox/Main/webservice/Makefile.kmk

@@ -39 +39 @@
 #    This WSDL file ends up in $(VBOXWEB_OUT_DIR)/vboxweb.wsdl.
 #
-# 2) We use xsltproc and websrv-gsoapH.xsl to generate a so-called
-#    "gSoap header file": $(VBOXWEB_OUT_DIR)/gsoapH_from_xslt.h.
+# 2) We use xsltproc and websrv-wsdl2gsoapH.xsl to generate a so-called
+#    "gSoap header file": $(VBOXWEB_OUT_DIR)/gsoapH_from_xslt.h from
+#    the WSDL previously generated.
 #    This file looks like a C header file, but really isn't meant
 #    to be included by a C compiler. Instead, it just happens to be the
@@ -62 +63 @@
 #    code generation via XSLT comes in:
 #
-# 4) We use xsltproc to generate tons of c++ code directly from the XIDL that
+# 4) We use xsltproc to generate tons of C++ code directly from the XIDL that
 #    maps each SOAP method to our COM methods. This large C++ file is
 #    $(VBOXWEB_OUT_DIR)/methodmaps.cpp. The actual webservice executable (vboxwebsrv,
@@ -146 +147 @@
 
 # If this is set, all webservice files are considered out-of-date every time
-# this make file is touched. Otherwise, set this to empty.
+# this makefile is touched. Otherwise, set this to empty.
 RECOMPILE_ON_MAKEFILE_CURRENT := $(MAKEFILE_CURRENT)
 
@@ -154 +155 @@
 PATH_TARGET_WEBTEST           := $(VBOXWEB_OUT_DIR)/webtest
 
+# platform-specific XIDL file generated from $(VBOXWEB_IDL_SRC):
 VBOXWEB_IDL_SRC_ORIG          := $(VBOX_XIDL_FILE)
+# the original XIDL file:
 VBOXWEB_IDL_SRC               := $(VBOXWEB_OUT_DIR)/VirtualBox.xidl
+
 VBOXWEB_WSDL                   = $(VBOX_PATH_SDK)/bindings/webservice/vboxweb.wsdl
 VBOXWEBSERVICE_WSDL            = $(VBOX_PATH_SDK)/bindings/webservice/vboxwebService.wsdl
@@ -407 +411 @@
 ifdef VBOX_ONLY_SDK
  #
- # Global relevant to the SDK.
+ # Globals relevant to the SDK.
  #
  VBOXWEB_GLUE_PYTHON           = $(VBOX_PATH_SDK)/bindings/webservice/python/lib/VirtualBox_wrappers.py
@@ -500 +504 @@
         $(VBOXWEB_IDL_SRC)
 
-
 # generate platform-specific XIDL file from original XIDL file
 $(VBOXWEB_IDL_SRC): $(VBOXWEB_IDL_SRC_ORIG) $(VBOX_PATH_WEBSERVICE)/platform-xidl.xsl | $$(dir $$@)
@@ -553 +556 @@
 
 # generate gsoap pseudo-C header file from that WSDL; once via XSLT...
-# $(VBOXWEB_GSOAPH_FROM_XSLT): $(VBOXWEB_IDL_SRC) $(VBOX_PATH_WEBSERVICE)/websrv-gsoapH.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)
-#       $(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-gsoapH.xsl)
-#       $(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-gsoapH.xsl $<
 $(VBOXWEB_GSOAPH_FROM_XSLT): $(VBOXWEB_WSDL) $(VBOX_PATH_WEBSERVICE)/websrv-wsdl2gsoapH.xsl $(VBOX_PATH_WEBSERVICE)/websrv-shared.inc.xsl $(RECOMPILE_ON_MAKEFILE_CURRENT) | $$(dir $$@)
         $(call MSG_GENERATE,,$@,$(VBOXWEB_WSDL) using websrv-wsdl2gsoapH.xsl)
@@ -565 +565 @@
         $(call MSG_GENERATE,,$@,$(VBOXWEB_IDL_SRC) using websrv-nsmap.xsl)
         $(QUIET)$(VBOX_XSLTPROC) $(VBOXWEB_XSLTPROC_VERBOSE) -o $@ $(VBOX_PATH_WEBSERVICE)/websrv-nsmap.xsl $<
-
-
 
 ifdef VBOX_GSOAP_INSTALLED
@@ -574 +572 @@
         $(VBOX_WSDL2H) $(VBOXWEB_WSDL_VERBOSE) -t$(VBOXWEB_TYPEMAP) -nvbox -o $@ $<
 
+# this sets the gsoap header that we use for further compilation; if stuff works, then the
+# one we generate via XSLT produces the same end result as the one from the gSOAP tool;
+# with this variable we can swap for testing, but shipped code must use VBOXWEB_GSOAPH_FROM_XSLT
 GSOAPH_RELEVANT = $(VBOXWEB_GSOAPH_FROM_XSLT)
 
@@ -592 +593 @@
         $(call MSG_GENERATE,,lots of files,$(GSOAPH_RELEVANT))
         $(RM) -f $@
-        $(REDIRECT) -C $(VBOXWEB_OUT_DIR) -- $(VBOX_SOAPCPP2) $(VBOXWEB_SOAPCPP2_SKIP_FILES) -L -w -I$(VBOX_PATH_GSOAP_IMPORT) $(GSOAPH_RELEVANT)
+        $(REDIRECT) -C $(VBOXWEB_OUT_DIR) -- $(VBOX_SOAPCPP2) $(VBOXWEB_SOAPCPP2_SKIP_FILES) -L -2 -w -I$(VBOX_PATH_GSOAP_IMPORT) $(GSOAPH_RELEVANT)
         $(APPEND) $@ done