def add_sections(self, sections):
if self.fields is None:
return
translations = { 'name' : self.name,
'camelcase' : utils.build_camelcase_name (self.fullname),
'underscore' : utils.build_underscore_name (self.fullname),
'type_macro' : 'QMI_TYPE_' + utils.remove_prefix(utils.build_underscore_uppercase_name(self.fullname), 'QMI_') }
# Standard
template = (
'${underscore}_get_type\n'
'${type_macro}\n')
sections['standard'] += string.Template(template).substitute(translations)
# Public types
template = (
'${camelcase}\n')
sections['public-types'] += string.Template(template).substitute(translations)
# Public methods
template = '<SUBSECTION ${camelcase}Methods>\n'
if self.readonly == False:
template += (
'${underscore}_new\n')
template += (
'${underscore}_ref\n'
'${underscore}_unref\n')
sections['public-methods'] += string.Template(template).substitute(translations)
for field in self.fields:
field.add_sections(sections)
def add_sections(self, sections):
if self.fields is None:
return
translations = { 'name' : self.name,
'camelcase' : utils.build_camelcase_name (self.fullname),
'underscore' : utils.build_underscore_name (self.fullname),
'type_macro' : 'QMI_TYPE_' + utils.remove_prefix(utils.build_underscore_uppercase_name(self.fullname), 'QMI_') }
# Standard
template = (
'${underscore}_get_type\n'
'${type_macro}\n')
sections['standard'] += string.Template(template).substitute(translations)
# Public types
template = (
'${camelcase}\n')
sections['public-types'] += string.Template(template).substitute(translations)
# Public methods
template = '<SUBSECTION ${camelcase}Methods>\n'
if self.readonly == False:
template += (
'${underscore}_new\n')
template += (
'${underscore}_ref\n'
'${underscore}_unref\n')
sections['public-methods'] += string.Template(template).substitute(translations)
for field in self.fields:
field.add_sections(sections)
def __emit_types(self, hfile, cfile, translations):
translations['type_macro'] = 'QMI_TYPE_' + utils.remove_prefix(
utils.build_underscore_uppercase_name(self.fullname), 'QMI_')
# Emit types header
template = '\n'
if self.static == False:
template += (
'/**\n'
' * ${camelcase}:\n'
' *\n'
' * The #${camelcase} structure contains private data and should only be accessed\n'
' * using the provided API.\n'
' *\n'
' * Since: ${since}\n'
' */\n')
template += (
'typedef struct _${camelcase} ${camelcase};\n'
'${static}GType ${underscore}_get_type (void) G_GNUC_CONST;\n'
'#define ${type_macro} (${underscore}_get_type ())\n')
hfile.write(string.Template(template).substitute(translations))
# Emit types source
template = ('\n'
'struct _${camelcase} {\n'
' volatile gint ref_count;\n')
cfile.write(string.Template(template).substitute(translations))
if self.fields is not None:
for field in self.fields:
if field.variable is not None:
variable_declaration = field.variable.build_variable_declaration(
False, ' ', field.variable_name)
translations['field_variable_name'] = field.variable_name
translations['field_name'] = field.name
template = ('\n'
' /* ${field_name} */\n'
' gboolean ${field_variable_name}_set;\n')
cfile.write(
string.Template(template).substitute(translations))
cfile.write(variable_declaration)
cfile.write('};\n')
def __emit_types(self, hfile, cfile, translations):
translations['type_macro'] = 'QMI_TYPE_' + utils.remove_prefix(utils.build_underscore_uppercase_name(self.fullname), 'QMI_')
# Emit types header
template = (
'\n'
'/**\n'
' * ${camelcase}:\n'
' *\n'
' * The #${camelcase} structure contains private data and should only be accessed\n'
' * using the provided API.\n'
' */\n'
'typedef struct _${camelcase} ${camelcase};\n'
'${static}GType ${underscore}_get_type (void) G_GNUC_CONST;\n'
'#define ${type_macro} (${underscore}_get_type ())\n')
hfile.write(string.Template(template).substitute(translations))
# Emit types source
template = (
'\n'
'struct _${camelcase} {\n'
' volatile gint ref_count;\n')
cfile.write(string.Template(template).substitute(translations))
if self.fields is not None:
for field in self.fields:
if field.variable is not None:
variable_declaration = field.variable.build_variable_declaration(False, ' ', field.variable_name)
translations['field_variable_name'] = field.variable_name
translations['field_name'] = field.name
template = (
'\n'
' /* ${field_name} */\n'
' gboolean ${field_variable_name}_set;\n')
cfile.write(string.Template(template).substitute(translations))
cfile.write(variable_declaration)
cfile.write(
'};\n')
def __emit_class(self, hfile, cfile, message_list):
# Check if we'll have indications
has_indications = False
for message in message_list.list:
if message.type == 'Indication':
has_indications = True
break
translations = {
'underscore':
utils.build_underscore_name(self.name),
'no_prefix_underscore_upper':
utils.build_underscore_name(self.name[4:]).upper(),
'camelcase':
utils.build_camelcase_name(self.name),
'hyphened':
utils.build_dashed_name(self.name),
'service':
self.service.upper()
}
# Emit class header
template = (
'#define QMI_TYPE_${no_prefix_underscore_upper} (${underscore}_get_type ())\n'
'#define QMI_${no_prefix_underscore_upper}(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}))\n'
'#define QMI_${no_prefix_underscore_upper}_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}Class))\n'
'#define QMI_IS_${no_prefix_underscore_upper}(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), QMI_TYPE_${no_prefix_underscore_upper}))\n'
'#define QMI_IS_${no_prefix_underscore_upper}_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), QMI_TYPE_${no_prefix_underscore_upper}))\n'
'#define QMI_${no_prefix_underscore_upper}_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}Class))\n'
'\n'
'typedef struct _${camelcase} ${camelcase};\n'
'typedef struct _${camelcase}Class ${camelcase}Class;\n'
'\n'
'/**\n'
' * ${camelcase}:\n'
' *\n'
' * The #${camelcase} structure contains private data and should only be accessed\n'
' * using the provided API.\n'
' */\n'
'struct _${camelcase} {\n'
' /*< private >*/\n'
' QmiClient parent;\n'
' gpointer priv_unused;\n'
'};\n'
'\n'
'struct _${camelcase}Class {\n'
' /*< private >*/\n'
' QmiClientClass parent;\n'
'};\n'
'\n'
'GType ${underscore}_get_type (void);\n'
'\n')
hfile.write(string.Template(template).substitute(translations))
# Emit class source. Documentation skipped for the CTL service.
template = ''
if self.service != 'CTL':
template += (
'\n'
'/**\n'
' * SECTION: ${hyphened}\n'
' * @title: ${camelcase}\n'
' * @short_description: #QmiClient for the ${service} service.\n'
' *\n'
' * #QmiClient which handles operations in the ${service} service.\n'
' */\n'
'\n')
template += (
'G_DEFINE_TYPE (${camelcase}, ${underscore}, QMI_TYPE_CLIENT);\n')
if has_indications:
template += ('\n' 'enum {\n')
for message in message_list.list:
if message.type == 'Indication':
translations[
'signal_id'] = utils.build_underscore_uppercase_name(
message.name)
inner_template = (' SIGNAL_${signal_id},\n')
template += string.Template(inner_template).substitute(
translations)
template += (' SIGNAL_LAST\n'
'};\n'
'\n'
'static guint signals[SIGNAL_LAST] = { 0 };\n')
template += ('\n'
'static void\n'
'process_indication (QmiClient *self,\n'
' QmiMessage *message)\n'
'{\n'
' switch (qmi_message_get_message_id (message)) {\n')
for message in message_list.list:
if message.type == 'Indication':
translations['enum_name'] = message.id_enum_name
translations[
'message_fullname_underscore'] = utils.build_underscore_name(
message.fullname)
translations['message_name'] = message.name
translations[
'signal_id'] = utils.build_underscore_uppercase_name(
message.name)
inner_template = ''
if message.output is not None and message.output.fields is not None:
# At least one field in the indication
translations[
'output_camelcase'] = utils.build_camelcase_name(
message.output.fullname)
translations[
'output_underscore'] = utils.build_underscore_name(
message.output.fullname)
translations[
'output_underscore'] = utils.build_underscore_name(
message.output.fullname)
inner_template += (
' case ${enum_name}: {\n'
' ${output_camelcase} *output;\n'
' GError *error = NULL;\n'
'\n'
' /* Parse indication */\n'
' output = __${message_fullname_underscore}_indication_parse (message, &error);\n'
' if (!output) {\n'
' g_warning ("Couldn\'t parse \'${message_name}\' indication: %s",\n'
' error ? error->message : "Unknown error");\n'
' if (error)\n'
' g_error_free (error);\n'
' } else {\n'
' g_signal_emit (self, signals[SIGNAL_${signal_id}], 0, output);\n'
' ${output_underscore}_unref (output);\n'
' }\n'
' break;\n'
' }\n')
else:
# No output field in the indication
inner_template += (
' case ${enum_name}: {\n'
' g_signal_emit (self, signals[SIGNAL_${signal_id}], 0, NULL);\n'
' break;\n'
' }\n')
template += string.Template(inner_template).substitute(
translations)
template += (
' default:\n'
' break;\n'
' }\n'
'}\n'
'\n'
'static void\n'
'${underscore}_init (${camelcase} *self)\n'
'{\n'
'}\n'
'\n'
'static void\n'
'${underscore}_class_init (${camelcase}Class *klass)\n'
'{\n'
' QmiClientClass *client_class = QMI_CLIENT_CLASS (klass);\n'
'\n'
' client_class->process_indication = process_indication;\n')
for message in message_list.list:
if message.type == 'Indication':
translations['signal_name'] = utils.build_dashed_name(
message.name)
translations[
'signal_id'] = utils.build_underscore_uppercase_name(
message.name)
translations['message_name'] = message.name
inner_template = ''
if message.output is not None and message.output.fields is not None:
# At least one field in the indication
translations[
'output_camelcase'] = utils.build_camelcase_name(
message.output.fullname)
translations[
'bundle_type'] = 'QMI_TYPE_' + utils.remove_prefix(
utils.build_underscore_uppercase_name(
message.output.fullname), 'QMI_')
translations['service'] = self.service.upper()
translations['message_name_dashed'] = message.name.replace(
' ', '-')
inner_template += (
'\n'
' /**\n'
' * ${camelcase}::${signal_name}:\n'
' * @object: A #${camelcase}.\n'
' * @output: A #${output_camelcase}.\n'
' *\n'
' * The ::${signal_name} signal gets emitted when a \'<link linkend=\"libqmi-glib-${service}-${message_name_dashed}.top_of_page\">${message_name}</link>\' indication is received.\n'
' */\n'
' signals[SIGNAL_${signal_id}] =\n'
' g_signal_new ("${signal_name}",\n'
' G_OBJECT_CLASS_TYPE (G_OBJECT_CLASS (klass)),\n'
' G_SIGNAL_RUN_LAST,\n'
' 0,\n'
' NULL,\n'
' NULL,\n'
' NULL,\n'
' G_TYPE_NONE,\n'
' 1,\n'
' ${bundle_type});\n')
else:
# No output field in the indication
inner_template += (
'\n'
' /**\n'
' * ${camelcase}::${signal_name}:\n'
' * @object: A #${camelcase}.\n'
' *\n'
' * The ::${signal_name} signal gets emitted when a \'${message_name}\' indication is received.\n'
' */\n'
' signals[SIGNAL_${signal_id}] =\n'
' g_signal_new ("${signal_name}",\n'
' G_OBJECT_CLASS_TYPE (G_OBJECT_CLASS (klass)),\n'
' G_SIGNAL_RUN_LAST,\n'
' 0,\n'
' NULL,\n'
' NULL,\n'
' NULL,\n'
' G_TYPE_NONE,\n'
' 0);\n')
template += string.Template(inner_template).substitute(
translations)
template += ('}\n' '\n')
cfile.write(string.Template(template).substitute(translations))
def __emit_class(self, hfile, cfile, message_list):
# Check if we'll have indications
has_indications = False
for message in message_list.list:
if message.type == 'Indication':
has_indications = True
break
translations = { 'underscore' : utils.build_underscore_name(self.name),
'no_prefix_underscore_upper' : utils.build_underscore_name(self.name[4:]).upper(),
'camelcase' : utils.build_camelcase_name(self.name),
'hyphened' : utils.build_dashed_name(self.name),
'service' : self.service.upper() }
# Emit class header
template = (
'#define QMI_TYPE_${no_prefix_underscore_upper} (${underscore}_get_type ())\n'
'#define QMI_${no_prefix_underscore_upper}(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}))\n'
'#define QMI_${no_prefix_underscore_upper}_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}Class))\n'
'#define QMI_IS_${no_prefix_underscore_upper}(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), QMI_TYPE_${no_prefix_underscore_upper}))\n'
'#define QMI_IS_${no_prefix_underscore_upper}_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), QMI_TYPE_${no_prefix_underscore_upper}))\n'
'#define QMI_${no_prefix_underscore_upper}_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), QMI_TYPE_${no_prefix_underscore_upper}, ${camelcase}Class))\n'
'\n'
'typedef struct _${camelcase} ${camelcase};\n'
'typedef struct _${camelcase}Class ${camelcase}Class;\n'
'\n'
'/**\n'
' * ${camelcase}:\n'
' *\n'
' * The #${camelcase} structure contains private data and should only be accessed\n'
' * using the provided API.\n'
' */\n'
'struct _${camelcase} {\n'
' /*< private >*/\n'
' QmiClient parent;\n'
' gpointer priv_unused;\n'
'};\n'
'\n'
'struct _${camelcase}Class {\n'
' /*< private >*/\n'
' QmiClientClass parent;\n'
'};\n'
'\n'
'GType ${underscore}_get_type (void);\n'
'\n')
hfile.write(string.Template(template).substitute(translations))
# Emit class source. Documentation skipped for the CTL service.
template = ''
if self.service != 'CTL':
template += (
'\n'
'/**\n'
' * SECTION: ${hyphened}\n'
' * @title: ${camelcase}\n'
' * @short_description: #QmiClient for the ${service} service.\n'
' *\n'
' * #QmiClient which handles operations in the ${service} service.\n'
' */\n'
'\n')
template += (
'G_DEFINE_TYPE (${camelcase}, ${underscore}, QMI_TYPE_CLIENT);\n')
if has_indications:
template += (
'\n'
'enum {\n')
for message in message_list.list:
if message.type == 'Indication':
translations['signal_id'] = utils.build_underscore_uppercase_name(message.name)
inner_template = (
' SIGNAL_${signal_id},\n')
template += string.Template(inner_template).substitute(translations)
template += (
' SIGNAL_LAST\n'
'};\n'
'\n'
'static guint signals[SIGNAL_LAST] = { 0 };\n')
template += (
'\n'
'static void\n'
'process_indication (QmiClient *self,\n'
' QmiMessage *message)\n'
'{\n'
' switch (qmi_message_get_message_id (message)) {\n')
for message in message_list.list:
if message.type == 'Indication':
translations['enum_name'] = message.id_enum_name
translations['message_fullname_underscore'] = utils.build_underscore_name(message.fullname)
translations['message_name'] = message.name
translations['signal_id'] = utils.build_underscore_uppercase_name(message.name)
inner_template = ''
if message.output is not None and message.output.fields is not None:
# At least one field in the indication
translations['output_camelcase'] = utils.build_camelcase_name(message.output.fullname)
translations['output_underscore'] = utils.build_underscore_name(message.output.fullname)
translations['output_underscore'] = utils.build_underscore_name(message.output.fullname)
inner_template += (
' case ${enum_name}: {\n'
' ${output_camelcase} *output;\n'
' GError *error = NULL;\n'
'\n'
' /* Parse indication */\n'
' output = __${message_fullname_underscore}_indication_parse (message, &error);\n'
' if (!output) {\n'
' g_warning ("Couldn\'t parse \'${message_name}\' indication: %s",\n'
' error ? error->message : "Unknown error");\n'
' if (error)\n'
' g_error_free (error);\n'
' } else {\n'
' g_signal_emit (self, signals[SIGNAL_${signal_id}], 0, output);\n'
' ${output_underscore}_unref (output);\n'
' }\n'
' break;\n'
' }\n')
else:
# No output field in the indication
inner_template += (
' case ${enum_name}: {\n'
' g_signal_emit (self, signals[SIGNAL_${signal_id}], 0, NULL);\n'
' break;\n'
' }\n')
template += string.Template(inner_template).substitute(translations)
template += (
' default:\n'
' break;\n'
' }\n'
'}\n'
'\n'
'static void\n'
'${underscore}_init (${camelcase} *self)\n'
'{\n'
'}\n'
'\n'
'static void\n'
'${underscore}_class_init (${camelcase}Class *klass)\n'
'{\n'
' QmiClientClass *client_class = QMI_CLIENT_CLASS (klass);\n'
'\n'
' client_class->process_indication = process_indication;\n')
for message in message_list.list:
if message.type == 'Indication':
translations['signal_name'] = utils.build_dashed_name(message.name)
translations['signal_id'] = utils.build_underscore_uppercase_name(message.name)
translations['message_name'] = message.name
inner_template = ''
if message.output is not None and message.output.fields is not None:
# At least one field in the indication
translations['output_camelcase'] = utils.build_camelcase_name(message.output.fullname)
translations['bundle_type'] = 'QMI_TYPE_' + utils.remove_prefix(utils.build_underscore_uppercase_name(message.output.fullname), 'QMI_')
translations['service'] = self.service.upper()
translations['message_name_dashed'] = message.name.replace(' ', '-')
inner_template += (
'\n'
' /**\n'
' * ${camelcase}::${signal_name}:\n'
' * @object: A #${camelcase}.\n'
' * @output: A #${output_camelcase}.\n'
' *\n'
' * The ::${signal_name} signal gets emitted when a \'<link linkend=\"libqmi-glib-${service}-${message_name_dashed}.top_of_page\">${message_name}</link>\' indication is received.\n'
' */\n'
' signals[SIGNAL_${signal_id}] =\n'
' g_signal_new ("${signal_name}",\n'
' G_OBJECT_CLASS_TYPE (G_OBJECT_CLASS (klass)),\n'
' G_SIGNAL_RUN_LAST,\n'
' 0,\n'
' NULL,\n'
' NULL,\n'
' NULL,\n'
' G_TYPE_NONE,\n'
' 1,\n'
' ${bundle_type});\n')
else:
# No output field in the indication
inner_template += (
'\n'
' /**\n'
' * ${camelcase}::${signal_name}:\n'
' * @object: A #${camelcase}.\n'
' *\n'
' * The ::${signal_name} signal gets emitted when a \'${message_name}\' indication is received.\n'
' */\n'
' signals[SIGNAL_${signal_id}] =\n'
' g_signal_new ("${signal_name}",\n'
' G_OBJECT_CLASS_TYPE (G_OBJECT_CLASS (klass)),\n'
' G_SIGNAL_RUN_LAST,\n'
' 0,\n'
' NULL,\n'
' NULL,\n'
' NULL,\n'
' G_TYPE_NONE,\n'
' 0);\n')
template += string.Template(inner_template).substitute(translations)
template += (
'}\n'
'\n')
cfile.write(string.Template(template).substitute(translations))
