[GTK][CMake] Generate GObject DOM bindings .symbols files

https://bugs.webkit.org/show_bug.cgi?id=126210

Reviewed by Martin Robinson.

.:

* Source/PlatformGTK.cmake: add checking DOM bindings API as a dependency
for documentation generation.

Source/WebCore:

No new tests. Build change only.

* CMakeLists.txt: list Quota module files and IDLs even if the feature
is disabled, for GTK, since we rely on that for our DOM bindings.
* PlatformGTK.cmake: add a new target to check for DOM symbols API by
running the new python script.
* bindings/gobject/GNUmakefile.am: call the new python script instead
of using a custom rule.

Tools:

* gtk/check-gdom-symbols: Added. Checks symbols compatibility.
(should_update_symbols_file):

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@164076 268f45cc-cd09-0410-ab3c-d52691b4dbfc

diff --git a/ChangeLog b/ChangeLog
index 1a0d702cd8e94eb6c552df0a8b62ff5129e8c84a..e1bb77f42d178de879f85863ade9a2d2ac6d9c86 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,13 @@
+2014-02-04  Gustavo Noronha Silva  <gns@gnome.org>
+
+        [GTK][CMake] Generate GObject DOM bindings .symbols files
+        https://bugs.webkit.org/show_bug.cgi?id=126210
+
+        Reviewed by Martin Robinson.
+
+        * Source/PlatformGTK.cmake: add checking DOM bindings API as a dependency
+        for documentation generation.
+
 2014-02-13  Xabier Rodriguez Calvar  <calvaris@igalia.com>
 
         [GTK] MEDIA_CONTROLS_SCRIPT support

diff --git a/Source/PlatformGTK.cmake b/Source/PlatformGTK.cmake
index 96a27e1ff3cf0bb1e5a8682280da550f0db7f4ea..a51b08f94b4bd081fe5aba6e089cadc5893be5d2 100644 (file)
--- a/Source/PlatformGTK.cmake
+++ b/Source/PlatformGTK.cmake
@@ -4,6 +4,7 @@ add_subdirectory(${WEBCORE_DIR}/platform/gtk/po)
 add_custom_target(gir ALL DEPENDS ${GObjectIntrospectionTargets})
 
 set(DocumentationDependencies
+    generate-gdom-symbols-file
     "${CMAKE_SOURCE_DIR}/Source/WebKit/gtk/docs/webkitenvironment.xml"
 )
 

diff --git a/Source/WebCore/CMakeLists.txt b/Source/WebCore/CMakeLists.txt
index 56b3608d41e9351519d7ac3bb4d493268dfc9f3b..ec21264e7168aa364a3adea45bf8a04262f10864 100644 (file)
--- a/Source/WebCore/CMakeLists.txt
+++ b/Source/WebCore/CMakeLists.txt
@@ -2735,7 +2735,10 @@ if (ENABLE_VIDEO_TRACK)
     )
 endif ()
 
-if (ENABLE_QUOTA)
+# On the GTK+ autotools build we used to add these files even if QUOTA is disabled, and
+# because of that we generate GObject bindings for some of the objects. We need to do
+# the same for the cmake build, for now.
+if (ENABLE_QUOTA OR PORT STREQUAL "GTK")
     list(APPEND WebCore_SOURCES
         Modules/quota/DOMWindowQuota.cpp
         Modules/quota/NavigatorStorageQuota.cpp

diff --git a/Source/WebCore/ChangeLog b/Source/WebCore/ChangeLog
index 22e9ce3113cb40aba045bab9d55795dad863a8e7..621494be0f9ccd1dc7057f4c4ec9214cd0344a37 100644 (file)
--- a/Source/WebCore/ChangeLog
+++ b/Source/WebCore/ChangeLog
@@ -1,3 +1,19 @@
+2014-02-04  Gustavo Noronha Silva  <gns@gnome.org>
+
+        [GTK][CMake] Generate GObject DOM bindings .symbols files
+        https://bugs.webkit.org/show_bug.cgi?id=126210
+
+        Reviewed by Martin Robinson.
+
+        No new tests. Build change only.
+
+        * CMakeLists.txt: list Quota module files and IDLs even if the feature
+        is disabled, for GTK, since we rely on that for our DOM bindings.
+        * PlatformGTK.cmake: add a new target to check for DOM symbols API by
+        running the new python script.
+        * bindings/gobject/GNUmakefile.am: call the new python script instead
+        of using a custom rule.
+
 2014-02-13  Myles C. Maxfield  <mmaxfield@apple.com>
 
         text-decoration-skip: ink skips randomly when using SVG fonts

diff --git a/Source/WebCore/PlatformGTK.cmake b/Source/WebCore/PlatformGTK.cmake
index 266be2843ef89f165f21216bc89066d2fcbcd32a..f53cba2c4876d1ab75a9ea7875a79ff67f72c65f 100644 (file)
--- a/Source/WebCore/PlatformGTK.cmake
+++ b/Source/WebCore/PlatformGTK.cmake
@@ -667,11 +667,15 @@ if (ENABLE_WEBKIT2)
          ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}/webkitdom.h
          ${WEBCORE_DIR}/bindings/gobject/WebKitDOMCustom.h
     )
+    file(GLOB GObjectDOMBindingsSymbolsFiles
+        "${WEBCORE_DIR}/bindings/gobject/WebKitDOM*.symbols"
+    )
 
     foreach (file ${GObjectDOMBindings_IDL_FILES})
         get_filename_component(classname ${file} NAME_WE)
         list(APPEND GObjectDOMBindings_CLASS_LIST ${classname})
         list(APPEND GObjectDOMBindings_INSTALLED_HEADERS ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}/WebKitDOM${classname}.h)
+        list(APPEND GObjectDOMBindingsSymbolsFiles ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}/WebKitDOM${classname}.symbols)
     endforeach ()
 
     # Propagate this variable to the parent scope, so that it can be used in other parts of the build.
@@ -694,7 +698,7 @@ if (ENABLE_WEBKIT2)
     )
 
     add_custom_target(fake-installed-webkitdom-headers
-        COMMAND ln -n -s -f ${WEBCORE_DIR}/bindings/gobject/* ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}
+        COMMAND ln -n -s -f ${WEBCORE_DIR}/bindings/gobject/*.h ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}
     )
 
     GENERATE_BINDINGS(GObjectDOMBindings_SOURCES
@@ -728,5 +732,16 @@ if (ENABLE_WEBKIT2)
                   bindings/gobject/WebKitDOMObject.h
             DESTINATION "${WEBKITGTK_HEADER_INSTALL_DIR}/webkitdom"
     )
+
+    add_custom_command(
+        OUTPUT ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}/webkitdom.symbols
+        DEPENDS ${GObjectDOMBindingsSymbolsFiles} ${CMAKE_SOURCE_DIR}/Tools/gtk/check-gdom-symbols
+        COMMAND ln -n -s -f ${WEBCORE_DIR}/bindings/gobject/WebKitDOM*.symbols ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}
+        COMMAND ${CMAKE_SOURCE_DIR}/Tools/gtk/check-gdom-symbols
+    )
+
+    add_custom_target(generate-gdom-symbols-file
+        DEPENDS GObjectDOMBindings ${DERIVED_SOURCES_GOBJECT_DOM_BINDINGS_DIR}/webkitdom.symbols
+    )
 endif ()
 

diff --git a/Source/WebCore/bindings/gobject/GNUmakefile.am b/Source/WebCore/bindings/gobject/GNUmakefile.am
index 68cdbe5a843d3de6f382fe645718fcd7c6be8b38..1578074f4240b405e2f0eef53c6c85d5c2e87359 100644 (file)
--- a/Source/WebCore/bindings/gobject/GNUmakefile.am
+++ b/Source/WebCore/bindings/gobject/GNUmakefile.am
@@ -501,10 +501,8 @@ $(top_builddir)/DerivedSources/webkitdom/WebKitDOMDeprecated.symbols: $(WebCore)
 DerivedSources/webkitdom/WebKitDOM%.symbols: DerivedSources/webkitdom/WebKitDOM%.h
        @true
 
-DerivedSources/webkitdom/webkitdom.symbols: $(gdom_symbol_files) $(WebCore)/bindings/gobject/webkitdom.symbols $(WebCore)/bindings/scripts/gobject-run-api-break-test
-       $(AM_V_GEN)cat $(gdom_symbol_files) > gdom-gen-symbols \
-       && $(PYTHON) $(WebCore)/bindings/scripts/gobject-run-api-break-test $(WebCore)/bindings/gobject/webkitdom.symbols gdom-gen-symbols \
-       && mv gdom-gen-symbols $@
+DerivedSources/webkitdom/webkitdom.symbols: $(gdom_symbol_files) $(WebCore)/bindings/gobject/webkitdom.symbols $(WebCore)/bindings/scripts/gobject-run-api-break-test $(srcdir)/Tools/gtk/check-gdom-symbols
+       $(AM_V_GEN)$(srcdir)/Tools/gtk/check-gdom-symbols
 
 EXTRA_DIST += \
        $(WebCore)/bindings/gobject/WebKitDOMCustom.symbols \

diff --git a/Tools/ChangeLog b/Tools/ChangeLog
index a0cd67a64ce514b33f47221c0f8f47963c9f1280..690c7d1e2f2dcf81ff5a60f5df3327c7edc3aabd 100644 (file)
--- a/Tools/ChangeLog
+++ b/Tools/ChangeLog
@@ -1,3 +1,13 @@
+2014-02-04  Gustavo Noronha Silva  <gns@gnome.org>
+
+        [GTK][CMake] Generate GObject DOM bindings .symbols files
+        https://bugs.webkit.org/show_bug.cgi?id=126210
+
+        Reviewed by Martin Robinson.
+
+        * gtk/check-gdom-symbols: Added. Checks symbols compatibility.
+        (should_update_symbols_file):
+
 2014-02-13  Brent Fulgham  <bfulgham@apple.com>
 
         Create some latched scrolling tests.

diff --git a/Tools/gtk/check-gdom-symbols b/Tools/gtk/check-gdom-symbols
new file mode 100755 (executable)
index 0000000..f1108b7
--- /dev/null
+++ b/Tools/gtk/check-gdom-symbols
@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+# Copyright (C) 2013 Gustavo Noronha Silva <gns@gnome.org>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+import common
+import glob
+import os
+import subprocess
+import sys
+import tempfile
+
+
+def should_update_symbols_file(new, old):
+    if not os.path.exists(old):
+        return False
+
+    new = open(new).read()
+    old = open(old).read()
+
+    if len(new) != len(old):
+        return False
+
+    for i, byte in enumerate(new):
+        if byte != old[i]:
+            return False
+
+    return True
+
+if __name__ == '__main__':
+    with tempfile.NamedTemporaryFile() as tmp:
+        for file_path in glob.glob(os.path.join(common.build_path('DerivedSources'), 'webkitdom', '*.h')):
+            if not os.path.basename(file_path).startswith('WebKit') or file_path.endswith('Private.h'):
+                continue
+
+            file_path = file_path.replace('.h', '.symbols')
+            with open(file_path) as file_handle:
+                tmp.write(file_handle.read())
+        tmp.flush()
+
+        gdom_source_path = common.top_level_path('Source', 'WebCore', 'bindings')
+        api_break_test_path = os.path.join(gdom_source_path, 'scripts', 'gobject-run-api-break-test')
+        subprocess.call([sys.executable, api_break_test_path, os.path.join(gdom_source_path, 'gobject',  'webkitdom.symbols'), tmp.name])
+
+        generated_gdom_symbols_path = os.path.join(common.build_path('DerivedSources'), 'webkitdom', 'webkitdom.symbols')
+        if not should_update_symbols_file(tmp.name, generated_gdom_symbols_path):
+            source = open(tmp.name, 'r')
+            destination = open(generated_gdom_symbols_path, 'w')
+            destination.write(source.read())
+            destination.close()
+            source.close()