Diff
Modified: trunk/Source/_javascript_Core/ChangeLog (197657 => 197658)
--- trunk/Source/_javascript_Core/ChangeLog 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/ChangeLog 2016-03-07 03:52:19 UTC (rev 197658)
@@ -1,5 +1,55 @@
2016-03-06 Brian Burg <[email protected]>
+ Web Inspector: the protocol generator should have separate prefix options for Objective-C classes and filenames
+ https://bugs.webkit.org/show_bug.cgi?id=155101
+ <rdar://problem/25000053>
+
+ Reviewed by Timothy Hatcher.
+
+ It should be possible to generate Objective-C protocol types without prefixing all class names.
+ The prefixes are only necessary when the generated files are part of a framework, but this isn't
+ how the generated Objective-C frontend files are used.
+
+ Add a separate framework setting and switch over code to use the 'protocol_group' in filenames,
+ and the 'objc_prefix' for Objective-C enum and class prefixes.
+
+ No tests need to be rebaselined because tests always set the protocol_group and objc_prefix
+ to the same value.
+
+ * inspector/scripts/codegen/generate_objc_backend_dispatcher_header.py:
+ (ObjCBackendDispatcherHeaderGenerator.output_filename):
+ * inspector/scripts/codegen/generate_objc_backend_dispatcher_implementation.py:
+ (ObjCConfigurationImplementationGenerator.output_filename):
+ (ObjCConfigurationImplementationGenerator.generate_output):
+ * inspector/scripts/codegen/generate_objc_configuration_header.py:
+ (ObjCConfigurationHeaderGenerator.output_filename):
+ (ObjCConfigurationHeaderGenerator.generate_output):
+ (ObjCConfigurationHeaderGenerator._generate_configuration_interface_for_domains):
+ * inspector/scripts/codegen/generate_objc_configuration_implementation.py:
+ (ObjCBackendDispatcherImplementationGenerator.output_filename):
+ (ObjCBackendDispatcherImplementationGenerator.generate_output):
+ (ObjCBackendDispatcherImplementationGenerator._generate_configuration_implementation_for_domains):
+ * inspector/scripts/codegen/generate_objc_conversion_helpers.py:
+ (ObjCConversionHelpersGenerator.output_filename):
+ * inspector/scripts/codegen/generate_objc_frontend_dispatcher_implementation.py:
+ (ObjCFrontendDispatcherImplementationGenerator.output_filename):
+ (ObjCFrontendDispatcherImplementationGenerator.generate_output):
+ * inspector/scripts/codegen/generate_objc_header.py:
+ (ObjCHeaderGenerator.output_filename):
+ * inspector/scripts/codegen/generate_objc_internal_header.py:
+ (ObjCInternalHeaderGenerator.output_filename):
+ (ObjCInternalHeaderGenerator.generate_output):
+ * inspector/scripts/codegen/generate_objc_protocol_types_implementation.py:
+ (ObjCProtocolTypesImplementationGenerator.output_filename):
+ (ObjCProtocolTypesImplementationGenerator.generate_output):
+ * inspector/scripts/codegen/models.py:
+ * inspector/scripts/codegen/objc_generator.py:
+ (ObjCGenerator):
+ (ObjCGenerator.protocol_name):
+ (ObjCGenerator.objc_prefix):
+
+2016-03-06 Brian Burg <[email protected]>
+
Unreviewed, rebaseline inspector protocol generator tests after r197563.
* inspector/scripts/tests/expected/commands-with-async-attribute.json-result:
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_header.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_header.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_header.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -44,7 +44,7 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sBackendDispatchers.h' % self.objc_prefix()
+ return '%sBackendDispatchers.h' % self.protocol_name()
def domains_to_generate(self):
return filter(ObjCGenerator.should_generate_domain_command_handler_filter(self.model()), Generator.domains_to_generate(self))
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_implementation.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_implementation.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_backend_dispatcher_implementation.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -44,20 +44,20 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sBackendDispatchers.mm' % self.objc_prefix()
+ return '%sBackendDispatchers.mm' % self.protocol_name()
def domains_to_generate(self):
return filter(ObjCGenerator.should_generate_domain_command_handler_filter(self.model()), Generator.domains_to_generate(self))
def generate_output(self):
secondary_headers = [
- '"%sInternal.h"' % self.objc_prefix(),
- '"%sEnumConversionHelpers.h"' % self.objc_prefix(),
+ '"%sInternal.h"' % self.protocol_name(),
+ '"%sEnumConversionHelpers.h"' % self.protocol_name(),
'<_javascript_Core/InspectorValues.h>',
]
header_args = {
- 'primaryInclude': '"%sBackendDispatchers.h"' % self.objc_prefix(),
+ 'primaryInclude': '"%sBackendDispatchers.h"' % self.protocol_name(),
'secondaryIncludes': '\n'.join(['#include %s' % header for header in secondary_headers]),
}
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_header.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_header.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_header.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -41,11 +41,11 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sConfiguration.h' % self.objc_prefix()
+ return '%sConfiguration.h' % self.protocol_name()
def generate_output(self):
headers = [
- '<WebInspector/%s.h>' % self.objc_prefix(),
+ '<WebInspector/%s.h>' % self.protocol_name(),
]
header_args = {
@@ -66,7 +66,7 @@
def _generate_configuration_interface_for_domains(self, domains):
lines = []
lines.append('__attribute__((visibility ("default")))')
- lines.append('@interface %sConfiguration : NSObject' % self.objc_prefix())
+ lines.append('@interface %sConfiguration : NSObject' % self.protocol_name())
for domain in domains:
lines.extend(self._generate_properties_for_domain(domain))
lines.append('@end')
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_implementation.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_implementation.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_configuration_implementation.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -41,12 +41,12 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sConfiguration.mm' % self.objc_prefix()
+ return '%sConfiguration.mm' % self.protocol_name()
def generate_output(self):
secondary_headers = [
- '"%sInternal.h"' % self.objc_prefix(),
- '"%sBackendDispatchers.h"' % self.objc_prefix(),
+ '"%sInternal.h"' % self.protocol_name(),
+ '"%sBackendDispatchers.h"' % self.protocol_name(),
'<_javascript_Core/AlternateDispatchableAgent.h>',
'<_javascript_Core/AugmentableInspectorController.h>',
'<_javascript_Core/InspectorAlternateBackendDispatchers.h>',
@@ -54,7 +54,7 @@
]
header_args = {
- 'primaryInclude': '"%sConfiguration.h"' % self.objc_prefix(),
+ 'primaryInclude': '"%sConfiguration.h"' % self.protocol_name(),
'secondaryIncludes': '\n'.join(['#import %s' % header for header in secondary_headers]),
}
@@ -71,7 +71,7 @@
def _generate_configuration_implementation_for_domains(self, domains):
lines = []
- lines.append('@implementation %sConfiguration' % self.objc_prefix())
+ lines.append('@implementation %sConfiguration' % self.protocol_name())
lines.append('{')
lines.append(' AugmentableInspectorController* _controller;')
lines.extend(self._generate_ivars(domains))
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_conversion_helpers.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_conversion_helpers.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_conversion_helpers.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -48,7 +48,7 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sEnumConversionHelpers.h' % self.objc_prefix()
+ return '%sEnumConversionHelpers.h' % self.protocol_name()
def domains_to_generate(self):
return filter(ObjCGenerator.should_generate_domain_types_filter(self.model()), Generator.domains_to_generate(self))
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_frontend_dispatcher_implementation.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_frontend_dispatcher_implementation.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_frontend_dispatcher_implementation.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -42,19 +42,19 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sEventDispatchers.mm' % self.objc_prefix()
+ return '%sEventDispatchers.mm' % self.protocol_name()
def domains_to_generate(self):
return filter(ObjCGenerator.should_generate_domain_event_dispatcher_filter(self.model()), Generator.domains_to_generate(self))
def generate_output(self):
secondary_headers = [
- '"%sEnumConversionHelpers.h"' % self.objc_prefix(),
+ '"%sEnumConversionHelpers.h"' % self.protocol_name(),
'<_javascript_Core/InspectorValues.h>',
]
header_args = {
- 'primaryInclude': '"%sInternal.h"' % self.objc_prefix(),
+ 'primaryInclude': '"%sInternal.h"' % self.protocol_name(),
'secondaryIncludes': '\n'.join(['#import %s' % header for header in secondary_headers]),
}
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_header.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_header.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_header.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -48,7 +48,7 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%s.h' % self.objc_prefix()
+ return '%s.h' % self.protocol_name()
def generate_output(self):
headers = set([
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_internal_header.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_internal_header.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_internal_header.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -41,12 +41,12 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sInternal.h' % self.objc_prefix()
+ return '%sInternal.h' % self.protocol_name()
def generate_output(self):
headers = set([
- '"%s.h"' % self.objc_prefix(),
- '"%sJSONObjectPrivate.h"' % self.objc_prefix(),
+ '"%s.h"' % self.protocol_name(),
+ '"%sJSONObjectPrivate.h"' % self.protocol_name(),
'<_javascript_Core/InspectorValues.h>',
'<_javascript_Core/AugmentableInspectorController.h>',
])
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_protocol_types_implementation.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_protocol_types_implementation.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/generate_objc_protocol_types_implementation.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -48,21 +48,21 @@
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
- return '%sTypes.mm' % self.objc_prefix()
+ return '%sTypes.mm' % self.protocol_name()
def domains_to_generate(self):
return filter(ObjCGenerator.should_generate_domain_types_filter(self.model()), Generator.domains_to_generate(self))
def generate_output(self):
secondary_headers = [
- '"%sEnumConversionHelpers.h"' % self.objc_prefix(),
+ '"%sEnumConversionHelpers.h"' % self.protocol_name(),
Generator.string_for_file_include('%sJSONObjectPrivate.h' % ObjCGenerator.OBJC_STATIC_PREFIX, Frameworks.WebInspector, self.model().framework),
'<_javascript_Core/InspectorValues.h>',
'<wtf/Assertions.h>',
]
# The FooProtocolInternal.h header is only needed to declare the backend-side event dispatcher bindings.
- primaryIncludeName = self.objc_prefix()
+ primaryIncludeName = self.protocol_name()
if self.get_generator_setting('generate_backend', False):
primaryIncludeName += 'Internal'
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/models.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/models.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/models.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -46,14 +46,16 @@
"alternate_dispatchers": True,
},
"WebKit": {
- "objc_prefix": "Automation",
+ "protocol_group": "Automation",
},
"WebInspector": {
+ "protocol_group": "RWI",
"objc_prefix": "RWI",
},
# Used for code generator tests.
"Test": {
"alternate_dispatchers": True,
+ "protocol_group": "Test",
"objc_prefix": "Test",
}
}
Modified: trunk/Source/_javascript_Core/inspector/scripts/codegen/objc_generator.py (197657 => 197658)
--- trunk/Source/_javascript_Core/inspector/scripts/codegen/objc_generator.py 2016-03-07 03:37:09 UTC (rev 197657)
+++ trunk/Source/_javascript_Core/inspector/scripts/codegen/objc_generator.py 2016-03-07 03:52:19 UTC (rev 197658)
@@ -92,9 +92,19 @@
def __init__(self, model, input_filepath):
Generator.__init__(self, model, input_filepath)
+ # The 'protocol name' is used to prefix filenames for a protocol group (a set of domains generated together).
+ def protocol_name(self):
+ protocol_group = self.model().framework.setting('protocol_group', '')
+ return '%s%s' % (protocol_group, ObjCGenerator.OBJC_SHARED_PREFIX)
+
+ # The 'ObjC prefix' is used to prefix Objective-C class names and enums with a
+ # framework-specific prefix. It is separate from filename prefixes.
def objc_prefix(self):
- framework_prefix = self.model().framework.setting('objc_prefix', '')
- return '%s%s' % (framework_prefix, ObjCGenerator.OBJC_SHARED_PREFIX)
+ framework_prefix = self.model().framework.setting('objc_prefix', None)
+ if not framework_prefix:
+ return ''
+ else:
+ return '%s%s' % (framework_prefix, ObjCGenerator.OBJC_SHARED_PREFIX)
# Adjust identifier names that collide with ObjC keywords.
