summaryrefslogtreecommitdiff
path: root/numpy/f2py/lib/block.py
blob: b9bafdcff427308d53f32c4ad1a0a008676ab132 (plain)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
#!/usr/bin/env python
"""
Defines Block classes.

Permission to use, modify, and distribute this software is given under the
terms of the NumPy License. See http://scipy.org.
NO WARRANTY IS EXPRESSED OR IMPLIED.  USE AT YOUR OWN RISK.

Author: Pearu Peterson <pearu@cens.ioc.ee>
Created: May 2006

"""

__all__ = ['Block','Module','PythonModule','Interface',
           'Subroutine','Function','Type']

import re
import sys

from readfortran import Line
from splitline import split2, string_replace_map

class Block:

    classes = []
    end_re = re.compile(r'\s*end\s*\Z', re.I)

    def __init__(self, parent):
        self.parent = parent
        self.isfix77 = parent.isfix77
        self.reader = parent.reader
        self.get_item = parent.get_item
        self.put_item = parent.put_item
        self.lower = not self.reader.ispyf

        self.content = []
        self.name = None

    def get_name(self):
        if self.__class__ is Block: return '__MAIN__'
        if self.name is None: return ''
        return self.name

    def __str__(self):
        tab = ''
        p = self.parent
        while isinstance(p, Block):
            tab += '  '
            p = p.parent
        name = self.get_name()
        l=[tab+'begin '+self.__class__.__name__ +' '+ name]
        for c in self.content:
            l.append(str(c))
        l.append(tab+'end '+self.__class__.__name__ +' '+ name)
        return '\n'.join(l)

    def isenditem(self, item):
        line,sline = split2(item.get_line())
        if sline: return False # end statement never contains strings 
        if self.__class__ is Block:
            # MAIN block does not define start/end line conditions,
            # so it should never end until all lines are read.
            # However, sometimes F77 programs lack the PROGRAM statement,
            # and here we fix that:
            if self.isfix77:
                m = self.end_re.match(line)
                if m:
                    message = self.reader.format_message(\
                        'WARNING',
                        'assuming the end of undefined PROGRAM statement',
                        item.span[0],item.span[1])
                    print >> sys.stderr, message
                    i = Line('program UNDEFINED',(0,0),None,self.reader)
                    p = Program(self,Program.start_re.match(i.get_line()),i)
                    p.content.extend(self.content)
                    self.content[:] = [p]
                    return None
            return False
        m = self.end_re.match(line)
        if not m: return False
        # check if the block start name matches with the block end name

        if m.groupdict().has_key('name'):
            end_name = m.group('name')
            if end_name: end_name = end_name.strip()
            name = self.get_name()
            if end_name and name != end_name:
                message = self.reader.format_message(\
                        'WARNING',
                        'expected the end of %r block but got end of %r'\
                        % (name, end_name),
                        item.span[0],item.span[1])
                print >> sys.stderr, message
        return True

    def isblock(self, item):
        line = item.get_line()
        for cls in self.classes:
            m = cls.start_re.match(line)
            if m:
                subblock = cls(self, m, item)
                self.content.append(subblock)
                subblock.fill()
                return True
        return False

    def fill(self):
        end_flag = self.__class__ is Block
        item = startitem = self.get_item()
        while item is not None:
            if isinstance(item, Line):
                # handle end of a block
                flag = self.isenditem(item)
                if flag: # end of block
                    end_flag = True
                    break
                if flag is None: # fixing the end of undefined start
                    item = self.get_item()
                    continue
                # handle subblocks
                if self.isblock(item):
                    item = self.get_item()
                    continue                    
                # line contains something else
                self.content.append(item)
            item = self.get_item()
        if not end_flag:
            message = self.reader.format_message(\
                        'WARNING',
                        'failed to find the end of block',
                        self.item.span[0],self.item.span[1])
            print >> sys.stderr, message
            sys.stderr.flush()
        return

class CodeBlock(Block):
    def __init__(self, parent, start_re_match, item):
        Block.__init__(self, parent)
        self.name = start_re_match.group('name')
        self.item = item

class Program(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*program\s*((?P<name>\w+)|)', re.I)
    end_re = re.compile(r'\s*end(\s*program(\s*(?P<name>\w+)|)|)\s*\Z', re.I)


class Module(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*module\s*(?P<name>\w+)\s*\Z', re.I)
    end_re = re.compile(r'\s*end(\s*module(\s*(?P<name>\w+)|)|)\s*\Z', re.I)
    def __init__(self, parent, start_re_match, item):
        Block.__init__(self, parent)
        self.name = start_re_match.group('name')
        self.item = item
        
class Interface(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*interface(\s*(?P<name>\w+)|)', re.I)
    end_re = re.compile(r'\s*end(\s*interface(\s*(?P<name>\w+)|)|)\s*\Z', re.I)

class PythonModule(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*python\s*module\s*(?P<name>\w+)', re.I)
    end_re = re.compile(r'\s*end(\s*python\s*module(\s*(?P<name>\w+)|)|)\s*\Z', re.I)
    
class Subroutine(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*subroutine\s*(?P<name>\w+)', re.I)
    end_re = re.compile(r'\s*end(\s*subroutine(\s*(?P<name>\w+)|)|)\s*\Z', re.I)

class Function(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*(?P<prefix>[\w,\s=()]*)\s*function\s*(?P<name>\w+)', re.I)
    end_re = re.compile(r'\s*end(\s*function(\s*(?P<name>\w+)|)|)\s*\Z')

class Type(CodeBlock):
    classes = []
    start_re = re.compile(r'\s*type(?!\s*\()(.*::|)\s*(?P<name>\w+)\s*\Z', re.I)
    end_re = re.compile(r'\s*end(\s*type(\s*(?P<name>\w+)|)|)\s*\Z', re.I)

class StatementBlock(Block):
    classes = []

    def __init__(self, parent, start_re_match, item):
        Block.__init__(self, parent)
        self.item = item

    def isenditem(self, item):
        line,sline = split2(item.get_line())
        if sline: return False # end statement never contains strings 
        m = self.end_re.match(line)
        if not m: return False
        # check if the block start name matches with the block end name
        if m.groupdict().has_key('name'):
            end_name = m.group('name')
            if end_name: end_name = end_name.strip()
            name = self.get_name()
            if end_name and name != end_name:
                message = self.reader.format_message(\
                        'WARNING',
                        'expected the end of %r block but got end of %r'\
                        % (name, end_name),
                        item.span[0],item.span[1])
                print >> sys.stderr, message
        return True

    def fill(self):
        item = self.get_item()
        while item is not None:
            if isinstance(item, Line):
                # handle end of a block
                flag = self.isenditem(item)
                if flag: # end of block
                    break
                # handle subblocks
                if self.isblock(item):
                    item = self.get_item()
                    continue                    

                # line contains something else
                self.content.append(item)
            item = self.get_item()
        if item is None:
            message = self.reader.format_message(\
                        'WARNING',
                        'failed to find the end of block',
                        self.item.span[0],self.item.span[1])
            print >> sys.stderr, message
            sys.stderr.flush()
        return

class DoBlock(StatementBlock):

    start_re = re.compile(r'\s*do\b\s*(?P<label>\d*)', re.I)
    end_re = re.compile(r'\s*end\s*do(\s*(?P<name>.*)|)\s*\Z', re.I)
    def __init__(self, parent, start_re_match, item):
        StatementBlock.__init__(self, parent, start_re_match, item)
        label = start_re_match.group('label').strip()
        if label.endswith(':'): label = label[:-1].strip()
        self.endlabel = label
        self.name = item.label

    def isenditem(self, item):
        if self.endlabel:
            if item.label==self.endlabel:
                # item may contain computational statemets
                self.content.append(item)
                # the same item label may be used for different block ends
                self.put_item(item)       
                return True
        else:
            return StatementBlock.isenditem(self, item)
        return False

class IfThenBlock(StatementBlock):

    start_re = re.compile(r'\s*if\b.*?\bthen\s*\Z', re.I)
    #start_re = re.compile(r'\s*if\b', re.I)
    end_re = re.compile(r'\s*end\s*if(\s*(?P<name>.*)|)\s*\Z', re.I)
    
    def __init__(self, parent, start_re_match, item):
        StatementBlock.__init__(self, parent, start_re_match, item)
        self.name = item.label


# Initialize classes lists

basic_blocks = [Program,PythonModule,Module,Interface,Subroutine,Function,Type]
stmt_blocks = [DoBlock,IfThenBlock]

Block.classes.extend(basic_blocks + stmt_blocks)
Module.classes.extend(Block.classes[1:])
PythonModule.classes.extend(Module.classes)
Interface.classes.extend(Block.classes[1:])
Subroutine.classes.extend(Block.classes[1:])
Function.classes.extend(Subroutine.classes)
Type.classes.extend(Block.classes[3:])

StatementBlock.classes.extend(stmt_blocks)