generate_objc_protocol_types_implementation.py [plain text]
import logging
import string
from string import Template
from generator import Generator, ucfirst
from models import ObjectType, Frameworks
from objc_generator import ObjCGenerator
from objc_generator_templates import ObjCGeneratorTemplates as ObjCTemplates
log = logging.getLogger('global')
def add_newline(lines):
if lines and lines[-1] == '':
return
lines.append('')
class ObjCProtocolTypesImplementationGenerator(ObjCGenerator):
def __init__(self, model, input_filepath):
ObjCGenerator.__init__(self, model, input_filepath)
def output_filename(self):
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 = [
'"%sTypeConversions.h"' % self.protocol_name(),
Generator.string_for_file_include('%sJSONObjectPrivate.h' % ObjCGenerator.OBJC_STATIC_PREFIX, Frameworks.WebInspector, self.model().framework),
'<JavaScriptCore/InspectorValues.h>',
'<wtf/Assertions.h>',
]
primaryIncludeName = self.protocol_name()
if self.get_generator_setting('generate_backend', False):
primaryIncludeName += 'Internal'
header_args = {
'primaryInclude': '"%s.h"' % primaryIncludeName,
'secondaryIncludes': '\n'.join(['#import %s' % header for header in secondary_headers]),
}
domains = self.domains_to_generate()
sections = []
sections.append(self.generate_license())
sections.append(Template(ObjCTemplates.ImplementationPrelude).substitute(None, **header_args))
sections.extend(map(self.generate_type_implementations, domains))
sections.append(Template(ObjCTemplates.ImplementationPostlude).substitute(None, **header_args))
return '\n\n'.join(sections)
def generate_type_implementations(self, domain):
lines = []
for declaration in domain.type_declarations:
if (isinstance(declaration.type, ObjectType)):
add_newline(lines)
lines.append(self.generate_type_implementation(domain, declaration))
return '\n'.join(lines)
def generate_type_implementation(self, domain, declaration):
lines = []
lines.append('@implementation %s' % self.objc_name_for_type(declaration.type))
if self.get_generator_setting('generate_frontend', False):
lines.append('')
lines.append(self._generate_init_method_for_payload(domain, declaration))
lines.append(self._generate_init_method_for_json_object(domain, declaration))
required_members = filter(lambda member: not member.is_optional, declaration.type_members)
if required_members:
lines.append('')
lines.append(self._generate_init_method_for_required_members(domain, declaration, required_members))
for member in declaration.type_members:
lines.append('')
lines.append(self._generate_setter_for_member(domain, declaration, member))
lines.append('')
lines.append(self._generate_getter_for_member(domain, declaration, member))
lines.append('')
lines.append('@end')
return '\n'.join(lines)
def _generate_init_method_for_json_object(self, domain, declaration):
lines = []
lines.append('- (instancetype)initWithJSONObject:(RWIProtocolJSONObject *)jsonObject')
lines.append('{')
lines.append(' if (!(self = [super initWithInspectorObject:[jsonObject toInspectorObject].get()]))')
lines.append(' return nil;')
lines.append('')
lines.append(' return self;')
lines.append('}')
return '\n'.join(lines)
def _generate_init_method_for_payload(self, domain, declaration):
lines = []
lines.append('- (instancetype)initWithPayload:(nonnull NSDictionary<NSString *, id> *)payload')
lines.append('{')
lines.append(' if (!(self = [super init]))')
lines.append(' return nil;')
lines.append('')
for member in declaration.type_members:
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
if not member.is_optional:
lines.append(' THROW_EXCEPTION_FOR_REQUIRED_PROPERTY(payload[@"%s"], @"%s");' % (var_name, var_name))
conversion_expression = self.payload_to_objc_expression_for_member(declaration, member)
lines.append(' self.%s = %s;' % (var_name, conversion_expression))
lines.append('')
lines.append(' return self;')
lines.append('}')
return '\n'.join(lines)
def _generate_init_method_for_required_members(self, domain, declaration, required_members):
pairs = []
for member in required_members:
objc_type = self.objc_type_for_member(declaration, member)
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
pairs.append('%s:(%s)%s' % (var_name, objc_type, var_name))
pairs[0] = ucfirst(pairs[0])
lines = []
lines.append('- (instancetype)initWith%s' % ' '.join(pairs))
lines.append('{')
lines.append(' if (!(self = [super init]))')
lines.append(' return nil;')
lines.append('')
required_pointer_members = filter(lambda member: ObjCGenerator.is_type_objc_pointer_type(member.type), required_members)
if required_pointer_members:
for member in required_pointer_members:
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
lines.append(' THROW_EXCEPTION_FOR_REQUIRED_PROPERTY(%s, @"%s");' % (var_name, var_name))
objc_array_class = self.objc_class_for_array_type(member.type)
if objc_array_class and objc_array_class.startswith(self.objc_prefix()):
lines.append(' THROW_EXCEPTION_FOR_BAD_TYPE_IN_ARRAY(%s, [%s class]);' % (var_name, objc_array_class))
lines.append('')
for member in required_members:
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
lines.append(' self.%s = %s;' % (var_name, var_name))
lines.append('')
lines.append(' return self;')
lines.append('}')
return '\n'.join(lines)
def _generate_setter_for_member(self, domain, declaration, member):
objc_type = self.objc_type_for_member(declaration, member)
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
setter_method = ObjCGenerator.objc_setter_method_for_member(declaration, member)
conversion_expression = self.objc_to_protocol_expression_for_member(declaration, member, var_name)
lines = []
lines.append('- (void)set%s:(%s)%s' % (ucfirst(var_name), objc_type, var_name))
lines.append('{')
objc_array_class = self.objc_class_for_array_type(member.type)
if objc_array_class and objc_array_class.startswith(self.objc_prefix()):
lines.append(' THROW_EXCEPTION_FOR_BAD_TYPE_IN_ARRAY(%s, [%s class]);' % (var_name, objc_array_class))
lines.append(' [super %s:%s forKey:@"%s"];' % (setter_method, conversion_expression, member.member_name))
lines.append('}')
return '\n'.join(lines)
def _generate_getter_for_member(self, domain, declaration, member):
objc_type = self.objc_type_for_member(declaration, member)
var_name = ObjCGenerator.identifier_to_objc_identifier(member.member_name)
getter_method = ObjCGenerator.objc_getter_method_for_member(declaration, member)
basic_expression = '[super %s:@"%s"]' % (getter_method, member.member_name)
conversion_expression = self.protocol_to_objc_expression_for_member(declaration, member, basic_expression)
lines = []
lines.append('- (%s)%s' % (objc_type, var_name))
lines.append('{')
lines.append(' return %s;' % conversion_expression)
lines.append('}')
return '\n'.join(lines)