Skip to content

Commit

Permalink
Merge 164076 - [GTK][CMake] Generate GObject DOM bindings .symbols files
Browse files Browse the repository at this point in the history
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):


Conflicts:
	ChangeLog
	Source/WebCore/ChangeLog
	Tools/ChangeLog
  • Loading branch information
kov committed May 13, 2014
1 parent 209dbfa commit 9a15fc8
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 6 deletions.
1 change: 1 addition & 0 deletions Source/PlatformGTK.cmake
Expand Up @@ -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"
)

Expand Down
5 changes: 4 additions & 1 deletion Source/WebCore/CMakeLists.txt
Expand Up @@ -2736,7 +2736,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
Expand Down
17 changes: 16 additions & 1 deletion Source/WebCore/PlatformGTK.cmake
Expand Up @@ -669,11 +669,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.
Expand All @@ -696,7 +700,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
Expand Down Expand Up @@ -730,5 +734,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 ()

6 changes: 2 additions & 4 deletions Source/WebCore/bindings/gobject/GNUmakefile.am
Expand Up @@ -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 \
Expand Down
63 changes: 63 additions & 0 deletions 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()

0 comments on commit 9a15fc8

Please sign in to comment.