PyForTool
Python-fortran-tool
Loading...
Searching...
No Matches
scripting.py
1"""
2This module contains functions usefull to build scripts around the pyfortool library
3"""
4
5import sys
6from multiprocessing import cpu_count, Pool
7from multiprocessing.managers import BaseManager
8import re
9import shlex
10import os
11import argparse
12import logging
13import traceback
14
15from pyfortool.pyfortool import PYFT
16from pyfortool.tree import Tree
17from pyfortool.util import isint, PYFTError
18from pyfortool import __version__
19
20
21def task(filename):
22 """
23 Function to use on each file
24 :param clsPYFT: PYFT class to use
25 :param filename: file name
26 """
27 global PYFT
28 global allFileArgs
29 allArgs, orderedOptions = allFileArgs[filename]
30 try:
31 # Opening and reading of the FORTRAN file
32 with PYFT(filename, filename,
33 parserOptions=getParserOptions(allArgs), verbosity=allArgs.logLevel,
34 wrapH=allArgs.wrapH,
35 enableCache=allArgs.enableCache) as pft:
36
37 # apply the transformation in the order they were specified
38 for arg in orderedOptions:
39 logging.debug('Applying %s on %s', arg, filename)
40 applyTransfo(pft, arg, allArgs,
41 filename if filename == allArgs.plotCentralFile else None)
42 logging.debug(' -> Done')
43
44 # Writing
45 if not allArgs.dryRun:
46 pft.write()
47
48 # Reporting
49 return (0, filename)
50
51 except Exception as exc: # pylint: disable=broad-except
52 logging.error("The following error has occurred in the file %s", filename)
53 traceback.print_exception(exc, file=sys.stdout)
54 sys.stdout.flush()
55 return (1, filename)
56
57
59 """
60 Core of the pyfortool_parallel.py command
61 """
62
63 class MyManager(BaseManager):
64 """
65 Custom manager to deal with Tree instances
66 """
67
68 MyManager.register('Tree', Tree)
69
70 def init(cls, afa):
71 """
72 Pool initializer
73 """
74 # After many, many attempts, it seems very difficult (if not impossible)
75 # to do without global variables
76 global PYFT # pylint: disable=global-statement
77 global allFileArgs # pylint: disable=global-statement
78 PYFT = cls
79 allFileArgs = afa
80
81 parser = argparse.ArgumentParser(description='Python FORTRAN tool', allow_abbrev=False,
82 epilog="The argument order matters.")
83
84 updateParser(parser, withInput=False, withOutput=False, withXml=False, withPlotCentralFile=True,
85 treeIsOptional=False, nbPar=True, restrictScope=False)
86 commonArgs, getFileArgs = getArgs(parser)
87
88 # Manager to share the Tree instance
89 with MyManager() as manager:
90 # Set-up the Tree instance
91 sharedTree = getDescTree(commonArgs, manager.Tree)
92
93 # Prepare PYFT to be used in parallel
94 PYFT.setParallel(sharedTree)
95
96 # Set-up the processes
97 allFileArgs = {file: getFileArgs(file) for file in sharedTree.getFiles()}
98 logging.info('Executing in parallel on %i files with a maximum of %i processes',
99 len(allFileArgs), commonArgs.nbPar)
100 with Pool(commonArgs.nbPar, initializer=init, initargs=(PYFT, allFileArgs)) as pool:
101 result = pool.map(task, sharedTree.getFiles())
102
103 # Writting the descTree object
104 sharedTree.toJson(commonArgs.descTree)
105
106 # General error
107 errors = [item[1] for item in result if item[0] != 0]
108 status = len(errors)
109 if status != 0:
110 logging.error('List of files with error:')
111 for error in errors:
112 logging.error(' - %s', error)
113 raise PYFTError(f"Errors have been reported in {status} file(s).")
114
115
116def main():
117 """
118 Core of the pyfortool.py command
119 """
120 parser = argparse.ArgumentParser(description='Python FORTRAN tool', allow_abbrev=False,
121 epilog="The argument order matters.")
122
123 updateParser(parser, withInput=True, withOutput=True, withXml=True, withPlotCentralFile=False,
124 treeIsOptional=True, nbPar=False, restrictScope=True)
125 args, orderedOptions = getArgs(parser)[1]()
126
127 parserOptions = getParserOptions(args)
128 descTree = getDescTree(args)
129
130 try:
131 # Opening and reading of the FORTRAN file
132 pft = PYFT(args.INPUT, args.OUTPUT, parserOptions=parserOptions,
133 verbosity=args.logLevel, wrapH=args.wrapH, tree=descTree,
134 enableCache=args.enableCache)
135 if args.restrictScope != '':
136 pft = pft.getScopeNode(args.restrictScope)
137
138 # apply the transformation in the order they were specified
139 for arg in orderedOptions:
140 logging.debug('Applying %s on %s', arg, args.INPUT)
141 applyTransfo(pft, arg, args, plotCentralFile=args.INPUT)
142 logging.debug(' -> Done')
143
144 # Writing
145 if descTree is not None:
146 descTree.toJson(args.descTree)
147 if args.xml is not None:
148 pft.mainScope.writeXML(args.xml)
149 if not args.dryRun:
150 pft.mainScope.write()
151
152 # Closing
153 pft.mainScope.close()
154
155 except: # noqa E722
156 # 'exept' everything and re-raise error systematically
157 logging.error("The following error has occurred in the file %s", args.INPUT)
158 raise
159
160
161ARG_UPDATE_CNT = ('--alignContinuation', '--addBeginContinuation',
162 '--removeBeginContinuation',
163 '--emoveALLContinuation')
164
165
166def getArgs(parser):
167 """
168 Parse arguments and interpret the --optsByEnv option
169 :param parser: argparse parser
170 :return: a tuple with
171 - an argparse namespace containing common arguments (not using the --optsEnv option)
172 - a function taking a filename as input and returning
173 - an argparse namespace with the common arguments and the ones added by
174 interpreting the --optsEnv option
175 - an ordered list of arguments
176 """
177 args = parser.parse_args()
178
179 def getFileArgs(filename=args.INPUT if hasattr(args, 'INPUT') else None):
180 """
181 :param filename: name of source code file
182 :return: argparse namespace to use with this file and
183 a list given the order in which the arguments were provided
184 """
185 # Decode the --optsByEnv option
186 arguments = sys.argv[1:]
187 if args.optsByEnv is not None:
188 extra = ''
189 for line in [] if args.optsByEnv is None else os.environ[args.optsByEnv].split('\n'):
190 if ':=:' in line:
191 if re.match(line.split(':=:')[0], filename):
192 extra = line.split(':=:')[1]
193 else:
194 extra = line
195 index = arguments.index('--optsByEnv')
196 arguments = arguments[:index] + shlex.split(extra) + arguments[index + 2:] # keep order
197
198 # Compute the ordered list
199 updateCnt = False
200 optList = []
201 for arg in arguments:
202 if arg.startswith('--') and arg not in optList:
203 if arg in ARG_UPDATE_CNT:
204 if not updateCnt:
205 updateCnt = True
206 optList.append(arg)
207 else:
208 optList.append(arg)
209
210 return parser.parse_args(arguments), optList
211
212 return args, getFileArgs
213
214
216 """
217 Get the options to use for the fxtran parser
218 :param args: arguments parsed by the argparse parser
219 """
220 if args.parserOption is None:
221 parserOptions = PYFT.DEFAULT_FXTRAN_OPTIONS.copy()
222 else:
223 parserOptions = [el for elements in args.parserOption for el in elements]
224 if args.addIncludes:
225 parserOptions = [opt for opt in parserOptions if opt not in ('-no-include', '-noinclude')]
226 return parserOptions
227
228
229def getDescTree(args, cls=Tree):
230 """
231 get the Tree object built with the parsed arguments
232 :param args: arguments parsed by the argparse parser
233 :param cls: class to use (usefull for manager)
234 :return: a Tree instance
235 """
236 parserOptions = getParserOptions(args)
237 if args.descTree:
238 descTree = cls(tree=args.tree, descTreeFile=args.descTree,
239 parserOptions=parserOptions,
240 wrapH=args.wrapH, verbosity=args.logLevel)
241 else:
242 descTree = None
243 return descTree
244
245
246def updateParser(parser, withInput, withOutput, withXml, withPlotCentralFile, treeIsOptional,
247 nbPar, restrictScope):
248 """
249 Updates an argparse parser with arguments common to all the different tools
250 :param parser: parser in which arguments are added
251 :param withOutput: do we need the INPUT argument
252 :param withOutput: do we need the OUTPUT argument
253 :param withXml: do we need to be able to define an XML output file
254 :param withPlotCentralFile: to add the --plotCentralFile argument
255 :param treeIsOptional: is the --tree argument optional?
256 :param nbPar: number of parallel processes
257 :param restrictScope: can we specify the scope path
258 """
259
260 # ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
261 # IMPORTANT NOTE
262 # Argument order matters but argparse is not able to give the order
263 # Therefore, arguments are processed twice. The first time by argparse to fully decode them.
264 # The a second pass is made direcly on sys.argv. This mechanism has two implications:
265 # allow_abbrev must be set to False in ArgumentParser
266 # only long argument options are allowed (begining with two dashes)
267 # ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! !
268 assert not parser.allow_abbrev, 'parser must be created with allow_abbrev=False'
269
270 parser.add_argument('--version', action='version',
271 version='%(prog)s {version}'.format(version=__version__))
272 parser.add_argument('--simplify', default=False, action='store_true',
273 help='After a deletion, recursively deletes the code ' +
274 'and variables that have become useless')
275 parser.add_argument('--logLevel', default='warning',
276 help='Provide logging level. Example --logLevel debug (default is warning)')
277 parser.add_argument('--enableCache', default=False, action='store_true',
278 help='Precompute parent of each xml node and store the result')
279 if nbPar:
280 parser.add_argument('--nbPar', default=cpu_count(), type=int,
281 help='Number of parallel processes, 0 to get as many processes ' +
282 'as the number of cores (default=0)')
283 parser.add_argument('--optsByEnv', default=None, type=str,
284 help='Name of the environment variable containing additional arguments ' +
285 'to use. These arguments are processed after all other arguments. ' +
286 'The variable can contain a multi-lines string. The ' +
287 'variable is read line by line and the last applicable line is ' +
288 'used. A line can take one of these two forms: ' +
289 '1) "FILE_DESCRIPTOR:=:OPTIONS" (where FILE_DESCRIPTOR is a ' +
290 'regular expression to test against the filename. If there ' +
291 'is a match, the OPTIONS can be used for the file) and ' +
292 '2) "OPTIONS" (if the line doesn\'t contain the FILE_DESCRIPTOR ' +
293 'part, it applies to all source code).')
294
295 if restrictScope:
296 parser.add_argument('--restrictScope', default='', type=str, metavar='SCOPEPATH',
297 help="Limit the action to this scope path (SUBROUTINE/FUNCTION/" +
298 "MODULE/TYPE). It is '/'-separated path with each element " +
299 "having the form 'module:<name of the module>', " +
300 "'sub:<name of the subroutine>', " +
301 "'func:<name of the function>' or 'type:<name of the type>'.")
302
303 # Inputs and outputs
304 updateParserInputsOutputs(parser, withInput, withOutput, withXml)
305
306 # fxtran
307 updateParserFxtran(parser)
308
309 # Variables
311
312 # Cosmetics
314
315 # Applications
317
318 # openACC
319 updateParserOpenACC(parser)
320
321 # Checks
322 updateParserChecks(parser)
323
324 # Statements
326
327 # Misc
328 updateParserMisc(parser)
329
330 # Tree
331 updateParserTree(parser, withPlotCentralFile, treeIsOptional)
332
333 # Preprocessot
335
336
337def updateParserInputsOutputs(parser, withInput, withOutput, withXml):
338 """
339 Updates an argparse parser with input/output arguments
340 :param parser: parser in which arguments are added
341 :param withOutput: do we need the INPUT argument
342 :param withOutput: do we need the OUTPUT argument
343 :param withXml: do we need to be able to define an XML output file
344 """
345 gInOut = parser.add_argument_group('Input and output')
346 if withInput:
347 gInOut.add_argument('INPUT', help='FORTRAN input file')
348 if withOutput:
349 gInOut.add_argument('OUTPUT', default=None, help='FORTRAN output file', nargs='?')
350 gInOut.add_argument('--renamefF', default=False, action='store_true',
351 help='Put file extension in upper case')
352 gInOut.add_argument('--renameFf', default=False, action='store_true',
353 help='Put file extension in lower case')
354 if withXml:
355 gInOut.add_argument('--xml', default=None, type=str,
356 help='Output file for xml')
357 gInOut.add_argument('--dryRun', default=False, action='store_true',
358 help='Dry run without writing the FORTRAN file (the xml ' +
359 'is still written')
360
361
363 """
364 Updates an argparse parser with fxtran arguments
365 """
366 gParser = parser.add_argument_group('fxtran parser relative options')
367 gParser.add_argument('--parserOption', nargs='*', action='append',
368 help='Option to pass to fxtran, defaults ' +
369 f'to {PYFT.DEFAULT_FXTRAN_OPTIONS}')
370 gParser.add_argument('--wrapH', default=False, action='store_true',
371 help='Wrap .h file content into a MODULE to enable the reading')
372
373
375 """
376 Updates an argparse parser with variables arguments
377 """
378 gVariables = parser.add_argument_group('Options to deal with variables')
379 gVariables.add_argument('--showVariables', default=False, action='store_true',
380 help='Show the declared variables')
381 gVariables.add_argument('--removeVariable', nargs=2, action='append',
382 metavar=('SCOPEPATH', 'VARNAME'),
383 help="Variable to remove from declaration. The first argument " +
384 "is the SUBROUTINE/FUNCTION/MODULE/TYPE where the variable " +
385 "is declared. It is '/'-separated path with each element having " +
386 "the form 'module:<name of the module>', " +
387 "'sub:<name of the subroutine>', " +
388 "'func:<name of the function>' or 'type:<name of the type>'. " +
389 "The second argument is the variable name")
390 gVariables.add_argument('--attachArraySpecToEntity', default=False, action='store_true',
391 help='Find all T-decl-stmt elements that have a child element ' +
392 'attribute with attribute-N=DIMENSION and move the attribute ' +
393 'into EN-N elements')
394 gVariables.add_argument('--addVariable', nargs=4, action='append',
395 metavar=('SCOPEPATH', 'VARNAME', 'DECLARATION', 'POSITION'),
396 help='Add a variable. First argument is the scope path (as for ' +
397 'the --removeVariable option. The second is the variable ' +
398 'name, the third is the declarative statement to insert, ' +
399 'the fourth is the position (python indexing) the new ' +
400 'variable will have in the calling statment of the ' +
401 'routine (non-integer value for a local variable).')
402 gVariables.add_argument('--addModuleVariable', nargs=3, action='append',
403 metavar=('SCOPEPATH', 'MODULENAME', 'VARNAME'),
404 help='Add a USE statement. The first argument is the scope path ' +
405 '(as for the --removeVariable option). The second is the module ' +
406 'name; the third is the variable name.')
407 gVariables.add_argument('--showUnusedVariables', default=False, action='store_true',
408 help='Show a list of unused variables.')
409 gVariables.add_argument('--removeUnusedLocalVariables',
410 help='Remove unused local variables, excluding some variables (comma-' +
411 'separated list or NONE to exclude nothing).')
412 gVariables.add_argument('--removePHYEXUnusedLocalVariables',
413 help='Remove unused local variables, excluding some variables (comma-' +
414 'separated list or NONE to exclude nothing). This option takes ' +
415 'into account the mnh_expand directives to prevent from ' +
416 'removing useful variables.')
417 gVariables.add_argument('--addExplicitArrayBounds', action='store_true',
418 help='Adds explicit bounds to arrays that already have parentheses.')
419 gVariables.add_argument('--addArrayParentheses', action='store_true',
420 help='Adds parentheses to arrays (A => A(:))')
421 gVariables.add_argument('--modifyAutomaticArrays', metavar="DECL#START#END",
422 help='Transform all automatic arrays declaration using the templates.' +
423 ' The DECL part of the template will replace the declaration ' +
424 'statement, the START part will be inserted as the first ' +
425 'executable statement while the END part will be inserted as ' +
426 'the last executable statement. Each part ' +
427 'of the template can use the following place holders: ' +
428 '"{doubledotshape}", "{shape}", "{lowUpList}", "{name}" and ' +
429 '"{type}" which are, respectively modified into ' +
430 '":, :, :", "I, I:J, 0:I", "1, I, I, J, 0, I", "A", "REAL" ' +
431 'if the original declaration statement ' +
432 'was "A(I, I:J, 0:I)". For example, the template ' +
433 '"{type}, DIMENSION({doubledotshape}), ALLOCATABLE :: ' +
434 '{name}#ALLOCATE({name}({shape}))#DEALLOCATE({name})"' +
435 'will replace automatic arrays by allocatables.')
436 gVariables.add_argument('--replaceAutomaticWithAllocatable', action='store_true',
437 help='Replace all automatic arrays with allocatable arrays.')
438 gVariables.add_argument('--addArgInTree', default=None, action='append', nargs=3,
439 metavar=('VARNAME', 'DECLARATION', 'POSITION'),
440 help='Add an argument variable. The first argument is the variable ' +
441 'name, the second one is the declarative statement to insert, ' +
442 'the third one is the position (python indexing) the new ' +
443 'variable will have in the calling statement of the ' +
444 'routine. Needs the --stopScopes argument')
445
446
448 """
449 Updates an argparse parser with cosmetics arguments
450 """
451 gCosmetics = parser.add_argument_group('Cosmetics options')
452 gCosmetics.add_argument('--upperCase', default=False, action='store_true',
453 help='Put FORTRAN code in upper case letters')
454 gCosmetics.add_argument('--lowerCase', default=False, action='store_true',
455 help='Put FORTRAN code in lower case letters')
456 gCosmetics.add_argument('--changeIfStatementsInIfConstructs', default=False,
457 action='store_true',
458 help='Find all if-statement and convert it to if-then-statement')
459 gCosmetics.add_argument('--indent', default=False, action='store_true',
460 help='Correct indentation')
461 gCosmetics.add_argument('--removeIndent', default=False, action='store_true',
462 help='Remove indentation')
463 gCosmetics.add_argument('--removeEmptyLines', default=False, action='store_true',
464 help='Remove empty lines')
465 gCosmetics.add_argument('--removeComments', default=False, action='store_true',
466 help='Remove comments')
467 gCosmetics.add_argument('--updateSpaces', default=False, action='store_true',
468 help='Updates spaces around operators, commas, parenthesis and ' +
469 'at the end of line')
470 gCosmetics.add_argument('--alignContinuation', default=False, action='store_true',
471 help='Align the beginings of continued lines')
472 gCosmetics.add_argument('--addBeginContinuation', default=False, action='store_true',
473 help='Add missing continuation characters (\'&\') at the ' +
474 'begining of lines')
475 gCosmetics.add_argument('--removeBeginContinuation', default=False, action='store_true',
476 help='Remove continuation characters (\'&\') at the begining of lines')
477 gCosmetics.add_argument('--removeALLContinuation', default=False, action='store_true',
478 help='Remove all continuation characters(\'&\')')
479 gCosmetics.add_argument('--prettify', default=False, action='store_true',
480 help='Prettify the source code (indentation, spaces...)')
481 gCosmetics.add_argument('--minify', default=False, action='store_true',
482 help='Simplify the source code (indentation, spaces...)')
483 gCosmetics.add_argument('--removeEmptyCONTAINS', default=False, action='store_true',
484 help='Remove useless CONTAINS statements')
485
486
488 """
489 Updates an argparse parser with applications arguments
490 """
491 gApplications = parser.add_argument_group('Options to apply upper level transformation')
492 gApplications.add_argument('--deleteDrHook', default=False, action='store_true',
493 help='Delete DR HOOK use')
494 gApplications.add_argument('--addDrHook', default=False, action='store_true',
495 help='Add DR HOOK')
496 gApplications.add_argument('--deleteBudgetDDH', default=False, action='store_true',
497 help='Delete Budget/DDH use')
498 gApplications.add_argument('--deleteRoutineCallsMesoNHGPU', default=False, action='store_true',
499 help='Delete parts of the code not compatible with MesoNH-OpenACC' +
500 'such as OCND2 blocks')
501 gApplications.add_argument('--splitModuleRoutineFile', default=False, action='store_true',
502 help='Split a file')
503 gApplications.add_argument('--deleteNonColumnCallsPHYEX', default=False, action='store_true',
504 help='Delete call to PHYEX routines that needs information on ' +
505 'horizontal points (multiple column dependency')
506 gApplications.add_argument('--removeIJDim', default=False, action='store_true',
507 help='Remove I and J dimensions (1, KLON). ' +
508 'Needs the --stopScopes argument.')
509 gApplications.add_argument('--expandAllArraysPHYEX', default=False, action='store_true',
510 help='Expand all array syntax (computing and where block) ' +
511 'using PHYEX conventions')
512 gApplications.add_argument('--expandAllArraysPHYEXConcurrent', default=False,
513 action='store_true',
514 help='Expand all array syntax with DO CONCURRENT loops ' +
515 '(computing and where block) using PHYEX conventions')
516 gApplications.add_argument('--expandAllArrays', default=False, action='store_true',
517 help='Expand all array syntax (computing and where block) ' +
518 'using mnh directives if present')
519 gApplications.add_argument('--expandAllArraysConcurrent', default=False, action='store_true',
520 help='Expand all array syntax with DO CONCURRENT loops ' +
521 '(computing and where block) using mnh directives if present')
522 gApplications.add_argument('--inlineContainedSubroutinesPHYEX', default=False,
523 action='store_true',
524 help='Inline containted subroutines in main routine, using ' +
525 'PHYEX conventions')
526 gApplications.add_argument('--addStack', metavar='MODEL', type=str,
527 help='Add local arrays to the stack. The argument is the ' +
528 'the model name in which stack must be added ("AROME" ' +
529 'or "MESONH"). Needs the --stopScopes argument for AROME.')
530 gApplications.add_argument('--addIncludes', default=False, action='store_true',
531 help='Add .h includes in the file and remove the INCLUDE statement')
532 gApplications.add_argument('--mnhExpand', default=False, action='store_true',
533 help='Apply the mnh_expand directives with DO loops')
534 gApplications.add_argument('--mnhExpandConcurrent', default=False, action='store_true',
535 help='Apply the mnh_expand directives with DO CONCURRENT loops')
536 gApplications.add_argument('--addMPPDB_CHECKS', default=False, action='store_true',
537 help='Add MPPDB_CHEKS bit-repro checking routines of MesoNH for ' +
538 'all in and inout arrays in subroutines')
539 gApplications.add_argument('--addPrints', default=False, action='store_true',
540 help='Add Prints of min/maxval and shape of all in, out, inout ' +
541 'arguments of all scopes')
542 gApplications.add_argument('--shumanFUNCtoCALL', default=False, action='store_true',
543 help='Transform shuman functions to call statements')
544 gApplications.add_argument('--mathFunctoBRFunc', default=False, action='store_true',
545 help='Convert intrinsic math functions **, LOG, ATAN, **2, **3, ' +
546 '**4, EXP, COS, SIN, ATAN2 into a self defined function BR_ ' +
547 'for MesoNH bit-repro.')
548 gApplications.add_argument('--convertTypesInCompute', default=False, action='store_true',
549 help='Use single variable instead of variable contained in ' +
550 'structure in compute statement for optimization issue ')
551 gApplications.add_argument('--buildModi', default=False, action='store_true',
552 help='Builds the corresponding modi_ file')
553
554
556 """
557 Updates an argparse parser with openACC arguments
558 """
559 gOpenACC = parser.add_argument_group('OpenACC')
560 gOpenACC.add_argument('--addACCData', default=False, action='store_true',
561 help='Add !$acc data present and !$acc end data directives')
562 gOpenACC.add_argument('--addACCRoutineSeq', default=False, action='store_true',
563 help='Add "!$acc routine seq" to routines under stopScopes')
564 gOpenACC.add_argument('--craybyPassDOCONCURRENT', default=False, action='store_true',
565 help='remove acc loop independant collapse for BR_ fonctions and ' +
566 'mnh_undef(OPENACC) macro' +
567 ' use DO CONCURRENT with mnh_undef(LOOP)')
568 gOpenACC.add_argument('--removeACC', default=False, action='store_true',
569 help='remove all ACC directives')
570 gOpenACC.add_argument('--removebyPassDOCONCURRENT', default=False, action='store_true',
571 help='remove macro !$mnh_(un)def(OPENACC) and !$mnh_(un)def(LOOP) ' +
572 'directives')
573 gOpenACC.add_argument('--buildACCTypeHelpers', default=False, action='store_true',
574 help='build module files containing helpers to copy user ' +
575 'type structures')
576
577
579 """
580 Updates an argparse parser with checks arguments
581 """
582
583 gChecks = parser.add_argument_group('Check options')
584 gChecks.add_argument('--checkIMPLICIT', choices={'Warn', 'Err'}, default=None,
585 help='Send a warning or raise an error if the "IMPLICIT NONE" ' +
586 'is missing')
587 gChecks.add_argument('--checkINTENT', choices={'Warn', 'Err'}, default=None,
588 help='Send a warning or raise an error if the "INTENT" ' +
589 'attribute is missing for a dummy argument')
590 gChecks.add_argument('--checkOpInCall', choices={'Warn', 'Err'}, default=None,
591 help='Send a warning or raise an error if a call argument is an '
592 'operation.')
593 gChecks.add_argument('--checkUnusedLocalVar', choices={'Warn', 'Err'}, default=None,
594 help='Send a warning or raise an error if some local '
595 'variables are unused.')
596 gChecks.add_argument('--checkPHYEXUnusedLocalVar', choices={'Warn', 'Err'}, default=None,
597 help='Send a warning or raise an error if some local '
598 'variables are unused (excluding variables needed '
599 'for mnh_expand directives).')
600 gChecks.add_argument('--checkEmptyParensInCall', choices={'Warn', 'Err'}, default=None,
601 help='Send a warning or raise an error if a call argument is an '
602 'array with empty parens.')
603
604
606 """
607 Updates an argparse parser with statements arguments
608 """
609
610 gStatement = parser.add_argument_group('Statements options')
611 gStatement.add_argument('--removeCall', action='append',
612 help="Call to remove from the source code. The argument " +
613 "is the subprogram name")
614 gStatement.add_argument('--removePrints', default=False, action='store_true',
615 help="Remove print statements from the source code.")
616 gStatement.add_argument('--inlineContainedSubroutines', default=False, action='store_true',
617 help='Inline containted subroutines in main routine')
618 gStatement.add_argument('--setFalseIfStmt', default=None,
619 help='Replace this value by .FALSE. in if statements')
620
621
623 """
624 Updates an argparse parser with misc arguments
625 """
626 gMisc = parser.add_argument_group('Miscellaneous')
627 gMisc.add_argument('--showScopes', default=False, action='store_true',
628 help='Show the different scopes found in the source code')
629 gMisc.add_argument('--empty', default=False, action='store_true',
630 help='Empty the different scopes')
631
632
633def updateParserTree(parser, withPlotCentralFile, treeIsOptional):
634 """
635 Updates an argparse parser with statements arguments
636 :param withPlotCentralFile: to add the --plotCentralFile argumen
637 :param treeIsOptional: is the --tree argument optional?
638 """
639 gTree = parser.add_argument_group('Tree')
640 gTree.add_argument('--tree', default=None, action='append', required=not treeIsOptional,
641 help='Directories where source code must be searched for')
642 gTree.add_argument('--descTree', default=None, required=not treeIsOptional,
643 help='File to write and/or read the description of the tree.')
644 if withPlotCentralFile:
645 gTree.add_argument('--plotCentralFile', default=None, type=str,
646 help='Central file of the plot')
647 gTree.add_argument('--plotCompilTree', default=None,
648 help='File name for compilation dependency graph (.dot or image extension)')
649 gTree.add_argument('--plotExecTree', default=None,
650 help='File name for execution dependency graph (.dot or image extension)')
651 gTree.add_argument('--plotMaxUpper', default=None, type=int,
652 help='Maximum number of upper elements in the plot tree')
653 gTree.add_argument('--plotMaxLower', default=None, type=int,
654 help='Maximum number of lower elements in the plot tree')
655 gTree.add_argument('--stopScopes', default=None, type=str,
656 help='#-separated list of scopes ' +
657 'where the recursive inclusion of an argument variable ' +
658 'must stop (needed for some transformations).')
659
660
662 """
663 Updates an argparse parser with statements arguments
664 """
665 gCpp = parser.add_argument_group('Preprocessor')
666 gCpp.add_argument('--applyCPPifdef', nargs='*', action='append',
667 help="This option is followed by the list of defined or undefined " +
668 "CPP keys. " +
669 "All #ifdef and #ifndef concerning these keys are evaluated. " +
670 "Undefined keys are preceded by a percentage sign.")
671
672
673def applyTransfo(pft, arg, args, plotCentralFile):
674 """
675 Apply transformation on a PYFT instance
676 :param pft: PYFT instance
677 :param arg: argument to deal with
678 :param args: parsed argparsed arguments
679 :param plotCentralFile: central file for plots
680 """
681 simplify = {'simplify': args.simplify}
682 parserOptions = getParserOptions(args)
683 stopScopes = args.stopScopes.split('#') if args.stopScopes is not None else None
684
685 # File name manipulations
686 applyTransfoFileName(pft, arg)
687
688 # Variables
689 applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes)
690
691 # Applications
692 applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes)
693
694 # OpenACC
695 applyTransfoOpenACC(pft, arg, args, stopScopes)
696
697 # Cosmetics
698 applyTransfoCosmetics(pft, arg, args)
699
700 # Checks
701 applyTransfoChecks(pft, arg, args)
702
703 # Statements
704 applyTransfoStatements(pft, arg, args, simplify)
705
706 # Misc
707 applyTransfoMisc(pft, arg, args, simplify)
708
709 # Tree
710 applyTransfoTree(pft, arg, args, plotCentralFile)
711
712 # Preprocessor
713 applyTransfoPreprocessor(pft, arg, args)
714
715
717 """
718 Apply file name transformations on a PYFT instance
719 :param pft: PYFT instance
720 :param arg: argument to deal with
721 :param args: parsed argparsed arguments
722 """
723
724 # File name manipulations
725 if arg == '--renamefF':
726 pft.renameUpper()
727 elif arg == '--renameFf':
728 pft.renameLower()
729
730
731def applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes):
732 """
733 Apply variables transformations on a PYFT instance
734 :param pft: PYFT instance
735 :param arg: argument to deal with
736 :param args: parsed argparsed arguments
737 :param simplify: kwargs to simplify
738 :param parserOptions: fxtran parser options
739 :param stopScopes: upper limit in call tree for some transformations
740 """
741 if arg == '--showVariables':
742 pft.varList.showVarList()
743 elif arg == '--attachArraySpecToEntity':
744 pft.attachArraySpecToEntity()
745 elif arg == '--removeVariable':
746 pft.removeVar(args.removeVariable, **simplify)
747 elif arg == '--addVariable':
748 pft.addVar([[v[0], v[1], v[2], (int(v[3]) if isint(v[3]) else None)]
749 for v in args.addVariable])
750 elif arg == '--addModuleVariable':
751 pft.addModuleVar([[v[0], v[1], v[2]] for v in args.addModuleVariable])
752 elif arg == '--showUnusedVariables':
753 pft.showUnusedVar()
754 elif arg == '--removeUnusedLocalVariables':
755 pft.removeUnusedLocalVar(
756 [item.strip() for item in args.removeUnusedLocalVariables.split(',')]
757 if args.removeUnusedLocalVariables != 'NONE' else None, **simplify)
758 elif arg == '--removePHYEXUnusedLocalVariables':
759 pft.removePHYEXUnusedLocalVar(
760 [item.strip() for item in args.removePHYEXUnusedLocalVariables.split(',')]
761 if args.removePHYEXUnusedLocalVariables != 'NONE' else None, **simplify)
762 elif arg == '--addExplicitArrayBounds':
763 pft.addExplicitArrayBounds()
764 elif arg == '--addArrayParentheses':
765 pft.addArrayParentheses()
766 elif arg == '--modifyAutomaticArrays':
767 pft.modifyAutomaticArrays(*(args.modifyAutomaticArrays.split('#')))
768 elif arg == '--replaceAutomaticWithAllocatable':
769 pft.modifyAutomaticArrays(
770 "{type}, DIMENSION({doubledotshape}), ALLOCATABLE :: {name}",
771 "ALLOCATE({name}({shape}))", "DEALLOCATE({name})")
772 elif arg == '--addArgInTree':
773 for varName, declStmt, pos in args.addArgInTree:
774 pft.addArgInTree(varName, declStmt, int(pos), stopScopes,
775 parserOptions=parserOptions,
776 wrapH=args.wrapH)
777
778
779def applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes):
780 """
781 Apply applications transformations on a PYFT instance
782 :param pft: PYFT instance
783 :param arg: argument to deal with
784 :param args: parsed argparsed arguments
785 :param simplify: kwargs to simplify
786 :param parserOptions: fxtran parser options
787 :param stopScopes: upper limit in call tree for some transformations
788 """
789 if arg == '--addStack':
790 pft.addStack(args.addStack, stopScopes,
791 parserOptions=parserOptions,
792 wrapH=args.wrapH)
793 elif arg == '--deleteDrHook':
794 pft.deleteDrHook(**simplify)
795 elif arg == '--addDrHook':
796 pft.addDrHook()
797 elif arg == '--deleteBudgetDDH':
798 pft.deleteBudgetDDH(**simplify)
799 elif arg == '--deleteRoutineCallsMesoNHGPU':
800 pft.deleteRoutineCallsMesoNHGPU(**simplify)
801 elif arg == '--deleteNonColumnCallsPHYEX':
802 pft.deleteNonColumnCallsPHYEX(**simplify)
803 elif arg == '--addMPPDB_CHECKS':
804 pft.addMPPDB_CHECKS()
805 elif arg == '--addPrints':
806 pft.addMPPDB_CHECKS(printsMode=True)
807 # mnhExpand must be before inlineContainedSubroutines as inlineContainedSubroutines
808 # can change variable names used by mnh_expand directives
809 assert not (args.mnhExpand and args.mnhExpandConcurrent), \
810 "Only one of --mnhExpand and --mnhExpandConcurrent"
811 if arg == '--mnhExpand':
812 pft.removeArraySyntax(everywhere=False, addAccIndependentCollapse=False)
813 elif arg == '--mnhExpandConcurrent':
814 pft.removeArraySyntax(concurrent=True, everywhere=False)
815 elif arg == '--inlineContainedSubroutines':
816 pft.inlineContainedSubroutines(**simplify)
817 elif arg == '--inlineContainedSubroutinesPHYEX':
818 pft.inlineContainedSubroutinesPHYEX(**simplify)
819 elif arg == '--expandAllArrays':
820 pft.removeArraySyntax()
821 elif arg == '--expandAllArraysConcurrent':
822 pft.removeArraySyntax(concurrent=True)
823 elif arg == '--expandAllArraysPHYEX':
824 pft.expandAllArraysPHYEX()
825 elif arg == '--expandAllArraysPHYEXConcurrent':
826 pft.expandAllArraysPHYEX(concurrent=True)
827 elif arg == '--removeIJDim':
828 pft.removeIJDim(stopScopes,
829 parserOptions=parserOptions,
830 wrapH=args.wrapH, **simplify)
831 elif arg == '--shumanFUNCtoCALL':
832 pft.shumanFUNCtoCALL()
833 elif arg == '--buildACCTypeHelpers':
834 pft.buildACCTypeHelpers()
835 elif arg == '--mathFunctoBRFunc':
836 pft.mathFunctoBRFunc()
837 elif arg == '--convertTypesInCompute':
838 pft.convertTypesInCompute()
839 elif arg == '--buildModi':
840 pft.buildModi()
841 elif arg == '--splitModuleRoutineFile':
842 pft.splitModuleRoutineFile()
843
844
845def applyTransfoOpenACC(pft, arg, args, stopScopes): # pylint: disable=unused-argument
846 """
847 Apply openACC transformations on a PYFT instance
848 :param pft: PYFT instance
849 :param arg: argument to deal with
850 :param args: parsed argparsed arguments
851 :param stopScopes: upper limit in call tree for some transformations
852 """
853 if arg == '--addACCData':
854 pft.addACCData()
855 elif arg == '--craybyPassDOCONCURRENT':
856 pft.craybyPassDOCONCURRENT()
857 elif arg == '--removebyPassDOCONCURRENT':
858 pft.removebyPassDOCONCURRENT()
859 elif arg == '--addACCRoutineSeq':
860 pft.addACCRoutineSeq(stopScopes)
861 elif arg == '--removeACC':
862 pft.removeACC()
863
864
865def applyTransfoCosmetics(pft, arg, args):
866 """
867 Apply cosmetics transformations on a PYFT instance
868 :param pft: PYFT instance
869 :param arg: argument to deal with
870 :param args: parsed argparsed arguments
871 """
872 if arg == '--upperCase':
873 pft.upperCase()
874 elif arg == '--lowerCase':
875 pft.lowerCase()
876 elif arg == '--changeIfStatementsInIfConstructs':
877 pft.changeIfStatementsInIfConstructs()
878 elif arg == '--indent':
879 pft.indent()
880 elif arg == '--removeIndent':
881 pft.indent(indentProgramunit=0, indentBranch=0)
882 elif arg == '--removeEmptyLines':
883 pft.removeEmptyLines()
884 elif arg == '--removeComments':
885 pft.removeComments()
886 elif arg == '--updateSpaces':
887 pft.updateSpaces()
888 elif arg in ARG_UPDATE_CNT:
889 pft.updateContinuation(align=args.alignContinuation,
890 addBegin=args.addBeginContinuation,
891 removeBegin=args.removeBeginContinuation,
892 removeALL=args.removeALLContinuation)
893 elif arg == '--prettify':
894 pft.indent()
895 pft.upperCase()
896 pft.removeEmptyLines()
897 pft.updateSpaces()
898 pft.updateContinuation()
899 elif arg == '--minify':
900 pft.indent(indentProgramunit=0, indentBranch=0)
901 pft.upperCase()
902 pft.removeComments()
903 pft.removeEmptyLines()
904 pft.updateSpaces()
905 pft.updateContinuation(align=False, removeALL=True, addBegin=False)
906 elif arg == '--removeEmptyCONTAINS':
907 pft.removeEmptyCONTAINS()
908
909
910def applyTransfoChecks(pft, arg, args):
911 """
912 Apply checks transformations on a PYFT instance
913 :param pft: PYFT instance
914 :param arg: argument to deal with
915 :param args: parsed argparsed arguments
916 """
917 if arg == '--checkIMPLICIT':
918 pft.checkImplicitNone(args.checkIMPLICIT == 'Err')
919 elif arg == '--checkINTENT':
920 pft.checkIntent(args.checkINTENT == 'Err')
921 elif arg == '--checkOpInCall':
922 pft.checkOpInCall(args.checkOpInCall == 'Err')
923 elif arg == '--checkUnusedLocalVar':
924 pft.checkUnusedLocalVar(args.checkUnusedLocalVar == 'Err')
925 elif arg == '--checkPHYEXUnusedLocalVar':
926 pft.checkPHYEXUnusedLocalVar(args.checkPHYEXUnusedLocalVar == 'Err')
927 elif arg == '--checkEmptyParensInCall':
928 pft.checkEmptyParensInCall(args.checkEmptyParensInCall == 'Err')
929
930
931def applyTransfoStatements(pft, arg, args, simplify):
932 """
933 Apply statements transformations on a PYFT instance
934 :param pft: PYFT instance
935 :param arg: argument to deal with
936 :param args: parsed argparsed arguments
937 :param simplify: kwargs to simplify
938 """
939 if arg == '--removeCall':
940 for rc in args.removeCall:
941 pft.removeCall(rc, **simplify)
942 elif arg == '--removePrints':
943 pft.removePrints(**simplify)
944 elif arg == '--setFalseIfStmt':
945 pft.setFalseIfStmt(args.setFalseIfStmt, **simplify)
946
947
948def applyTransfoMisc(pft, arg, args, simplify): # pylint: disable=unused-argument
949 """
950 Apply misc transformations on a PYFT instance
951 :param pft: PYFT instance
952 :param arg: argument to deal with
953 :param args: parsed argparsed arguments
954 :param simplify: kwargs to simplify
955 """
956 if arg == '--showScopes':
957 pft.showScopesList()
958 elif arg == '--empty':
959 pft.empty(**simplify)
960
961
962def applyTransfoTree(pft, arg, args, plotCentralFile):
963 """
964 Apply tree transformations on a PYFT instance
965 :param pft: PYFT instance
966 :param arg: argument to deal with
967 :param args: parsed argparsed arguments
968 :param plotCentralFile: central file for plots
969 """
970 if arg == '--plotCompilTree' and plotCentralFile is not None:
971 pft.tree.plotCompilTreeFromFile(plotCentralFile, args.plotCompilTree,
972 args.plotMaxUpper, args.plotMaxLower)
973 elif arg == '--plotExecTree' and plotCentralFile is not None:
974 pft.tree.plotExecTreeFromFile(plotCentralFile, args.plotExecTree,
975 args.plotMaxUpper, args.plotMaxLower)
976
977
978def applyTransfoPreprocessor(pft, arg, args):
979 """
980 Apply preprocessor transformations on a PYFT instance
981 :param pft: PYFT instance
982 :param arg: argument to deal with
983 :param args: parsed argparsed arguments
984 """
985 if arg == '--applyCPPifdef':
986 pft.applyCPPifdef([k for aList in args.applyCPPifdef for k in aList])
applyTransfoApplications(pft, arg, args, simplify, parserOptions, stopScopes)
Definition scripting.py:779
updateParserVariables(parser)
Definition scripting.py:374
applyTransfoStatements(pft, arg, args, simplify)
Definition scripting.py:931
applyTransfoTree(pft, arg, args, plotCentralFile)
Definition scripting.py:962
applyTransfoPreprocessor(pft, arg, args)
Definition scripting.py:978
updateParserCosmetics(parser)
Definition scripting.py:447
applyTransfoVariables(pft, arg, args, simplify, parserOptions, stopScopes)
Definition scripting.py:731
updateParserInputsOutputs(parser, withInput, withOutput, withXml)
Definition scripting.py:337
updateParserApplications(parser)
Definition scripting.py:487
updateParserFxtran(parser)
Definition scripting.py:362
updateParserChecks(parser)
Definition scripting.py:578
updateParserOpenACC(parser)
Definition scripting.py:555
updateParserPreprocessor(parser)
Definition scripting.py:661
applyTransfoOpenACC(pft, arg, args, stopScopes)
Definition scripting.py:845
updateParserStatements(parser)
Definition scripting.py:605
applyTransfoChecks(pft, arg, args)
Definition scripting.py:910
applyTransfo(pft, arg, args, plotCentralFile)
Definition scripting.py:673
getDescTree(args, cls=Tree)
Definition scripting.py:229
applyTransfoMisc(pft, arg, args, simplify)
Definition scripting.py:948
updateParser(parser, withInput, withOutput, withXml, withPlotCentralFile, treeIsOptional, nbPar, restrictScope)
Definition scripting.py:247
applyTransfoCosmetics(pft, arg, args)
Definition scripting.py:865
applyTransfoFileName(pft, arg)
Definition scripting.py:716
updateParserTree(parser, withPlotCentralFile, treeIsOptional)
Definition scripting.py:633
updateParserMisc(parser)
Definition scripting.py:622