1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# -*- Mode: python; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
#
# This program 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 program 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 program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright (C) 2013 - 2014 Aleksander Morgado <aleksander@aleksander.es>
#
import string
from Message import Message
from Struct import Struct
import utils
"""
Check field to see if it holds a struct
"""
def set_struct_usage(struct, fields):
for field in fields:
if field['format'] == 'struct' and field['struct-type'] == struct.name:
struct.single_member = True
break
if field['format'] == 'ref-struct-array' and field['struct-type'] == struct.name:
struct.array_member = True
break
if field['format'] == 'struct-array' and field['struct-type'] == struct.name:
struct.array_member = True
break
"""
The ObjectList class handles the generation of all commands and types for a given
specific service
"""
class ObjectList:
"""
Constructor
"""
def __init__(self, objects_dictionary):
self.command_list = []
self.struct_list = []
self.service = ''
# Loop items in the list, creating Message objects for the messages
for object_dictionary in objects_dictionary:
if object_dictionary['type'] == 'Command':
self.command_list.append(Message(object_dictionary))
elif object_dictionary['type'] == 'Struct':
self.struct_list.append(Struct(object_dictionary))
elif object_dictionary['type'] == 'Service':
self.service = object_dictionary['name']
else:
raise ValueError('Cannot handle object type \'%s\'' % object_dictionary['type'])
if self.service == '':
raise ValueError('Service name not specified')
# Populate struct usages
for struct in self.struct_list:
for command in self.command_list:
set_struct_usage(struct, command.query)
set_struct_usage(struct, command.set)
set_struct_usage(struct, command.response)
set_struct_usage(struct, command.notification)
"""
Emit the structs and commands handling implementation
"""
def emit(self, hfile, cfile):
# Emit all structs
for item in self.struct_list:
item.emit(hfile, cfile)
# Emit all commands
for item in self.command_list:
item.emit(hfile, cfile)
"""
Emit the sections
"""
def emit_sections(self, sfile):
translations = { 'service_dashed' : utils.build_dashed_name(self.service),
'service' : self.service }
# Emit section header
template = (
'\n'
'<SECTION>\n'
'<FILE>mbim-${service_dashed}</FILE>\n'
'<TITLE>${service}</TITLE>\n')
sfile.write(string.Template(template).substitute(translations))
# Emit subsection per type
for struct in self.struct_list:
struct.emit_section_content(sfile)
# Emit subsection per command
for command in self.command_list:
command.emit_section_content(sfile)
sfile.write(
'</SECTION>\n')
|
