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
|
#!/usr/bin/env python
# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2020-2024, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# ------------------------------------------------------------------------------
# Author: Joerg Henrichs, Bureau of Meteorology
"""This file contains an fparser script that parses Fortran files
and output the dependencies between these files suitable for a Makefile.
It assumes that the module name in the use statement corresponds to the
name of the file (adding one of .F90/.f90/.x90). Only files in the current
directory will be tested, so external dependencies will not be listed.
Usage: create_dependencies.py file1.f90 file2.F90 ...
"""
import os
import sys
from fparser.common.readfortran import FortranFileReader
from fparser.two.Fortran2003 import Use_Stmt
from fparser.two.parser import ParserFactory
from fparser.two.utils import walk
# -----------------------------------------------------------------------------
def usage():
"""This function prints the usage information and exits. It is called if
incorrect input parameters are supplied.
"""
print(f"{sys.argv[0]} file1 [file2...]")
sys.exit(-1)
# -----------------------------------------------------------------------------
def get_root(file_name):
"""This function returns the 'root' of a file, which is the filename
without any path component and without an extension. E.g.:
`dir1/dir2/myfile.x90` would return `myfile`.
:param str file_name: the name of the file.
:returns: the root of the name of the file.
:rtype: str
"""
return os.path.splitext(os.path.basename(file_name))[0]
# -----------------------------------------------------------------------------
if __name__ == "__main__":
if len(sys.argv) < 2:
usage()
# Apparently pylint thinks that `all_files` is a constant, and complains
# that it should be capitalised.
# pylint: disable=invalid-name
all_files = sys.argv[1:]
# Create a mapping of filenames without path and extensions to the
# full filename.
lookup_files = {}
for file in all_files:
root = get_root(file)
if root in lookup_files:
print(
f"The file '{file}' has the same root '{root}' as "
f"the file '{lookup_files[root]}'."
)
sys.exit(-1)
lookup_files[root] = file
# Sort the input file names, so that they are output alphabetically
all_files.sort()
parser = ParserFactory().create(std="f2008")
for filename in all_files:
# Parse the current source file:
try:
reader = FortranFileReader(filename)
except IOError:
print(f"Could not open file '{filename}'.", file=sys.stderr)
sys.exit(-1)
parse_tree = parser(reader)
# Collect all used modules in a list
all_use = []
for node in walk(parse_tree, Use_Stmt):
# If you want to implement a specific naming convention,
# you can modify the content of 'use_name' here. For example,
# you could remove a '_mod' at the end if your file names do
# not contains this.
use_name = str(node.items[2])
if use_name not in lookup_files:
# Silently ignore modules we can't find, assuming
# that they are system dependencies (e.g. MPI.mod)
continue
obj_dependency = os.path.splitext(lookup_files[use_name])[0] + ".o"
# Only add dependencies that are not already in the list:
if obj_dependency not in all_use:
all_use.append(obj_dependency)
# Now output all dependencies for this file (if any):
if all_use:
# Sort all module names on which this file depends,
# so they are listed alphabetically
all_use.sort()
# Assemble the output in a list of strings. You start with
# listing this file first:
l_out = [os.path.splitext(filename)[0] + ".o: "]
for dep_name in all_use:
# Start the next line if we would exceed 80 characters:
if len(l_out[-1]) + len(dep_name) > 80:
l_out.append("")
l_out[-1] = l_out[-1] + dep_name
# If this is not the last module, add a space:
if dep_name != all_use[-1]:
l_out[-1] = l_out[-1] + " "
print("\\\n\t".join(l_out))
|
