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
|
#!/usr/bin/env python
# -*- 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) 2012 Lanedo GmbH
#
import string
import utils
"""
Base class for every variable type defined in the database
"""
class Variable:
"""
Constructor with common variable handling
"""
def __init__(self, dictionary):
"""
Variables can define specific public and private formats to be used.
The public format will be that used in the generated interface file,
while the private one will only be used internally.
"""
self.format = dictionary['format']
self.public_format = None
self.private_format = None
"""
Variables that get allocated in heap need to get properly disposed.
"""
self.needs_dispose = False
"""
Variables may suggest to be passed flagged as 'const' in the get/set
methods generated.
"""
self.pass_constant = False
"""
Emits the code to declare specific new types required by the variable.
"""
def emit_types(self, f):
pass
"""
Emits the code involved in reading the variable from the raw byte stream
into the specific private format.
"""
def emit_buffer_read(self, f, line_prefix, variable_name, buffer_name, buffer_len):
pass
"""
Emits the code involved in writing the variable to the raw byte stream
from the specific private format.
"""
def emit_buffer_write(self, f, line_prefix, variable_name, buffer_name, buffer_len):
pass
"""
Emits the code to get the contents of the given variable as a printable string.
"""
def emit_get_printable(self, f, line_prefix, printable, buffer_name, buffer_len):
pass
"""
Emits the code to copy a variable into another one of the same type.
"""
def emit_copy(self, f, line_prefix, variable_name_from, variable_name_to):
pass
"""
Emits the code to dispose the variable.
"""
def emit_dispose(self, f, line_prefix, variable_name):
pass
|
