NCAR · dustinswales · Sep 22, 2023 · Oct 11, 2023 · Oct 11, 2023 · Oct 20, 2023
@@ -182,7 +182,7 @@ def parse_fortran_files(filenames, run_env, output_dir, sep, logger):
     for filename in filenames:
         logger.info('Looking for arg_tables from {}'.format(filename))
         reset_standard_name_counter()
-        ftables, _ = parse_fortran_file(filename, run_env)
+        ftables, _, __ = parse_fortran_file(filename, run_env)
         # Create metadata filename
         filepath = '.'.join(os.path.basename(filename).split('.')[0:-1])
         fname = filepath + '.meta'

@@ -280,9 +280,10 @@ def collect_ddt_fields(self, var_dict, var, run_env,
             # end if
             dvtype = dvar.get_prop_value('type')
             if (dvar.is_ddt()) and (dvtype in self):
-                # If DDT in our library, we need to add sub-fields recursively.
+                # If DDT in our library, we need to add sub-fields recursively,
+                # unless sub-fields already added to library previously.
                 subddt = self[dvtype]
-                self.collect_ddt_fields(var_dict, dvar, run_env, parent=var, ddt=subddt)
+                self.collect_ddt_fields(var_dict, dvar, run_env, parent=var, ddt=subddt, skip_duplicates=skip_duplicates)
             # end if
             # add_variable only checks the current dictionary. By default,
             # for a DDT, the variable also cannot be in our parent

@@ -5,6 +5,8 @@
 """
 
 import math
+import sys
+sys.setrecursionlimit(1500)
 
 class FortranWriter:
     """Class to turn output into properly continued and indented Fortran code
@@ -25,7 +27,7 @@ class FortranWriter:
 
     __LINE_FILL = 97      # Target line length
 
-    __LINE_MAX = 130      # Max line length
+    __LINE_MAX = 195      # Max line length
 
     # CCPP copyright statement to be included in all generated Fortran files
     __COPYRIGHT = '''!

@@ -1035,7 +1035,7 @@ def parse_module(pobj, statements, run_env):
     if errors:
         raise CCPPError('\n'.join(errors))
     # end if
-    return statements, mtables, additional_subroutines
+    return statements, mtables, mod_name,additional_subroutines
 
 ########################################################################
 
@@ -1060,14 +1060,14 @@ def parse_fortran_file(filename, run_env):
         elif _MODULE_RE.match(statement) is not None:
             # push statement back so parse_module can use it
             statements.insert(0, statement)
-            statements, ptables, additional_routines = parse_module(pobj, statements, run_env)
+            statements, ptables, mod_name, additional_routines = parse_module(pobj, statements, run_env)
             mtables.extend(ptables)
         # end if
         if (statements is not None) and (len(statements) == 0):
             statements = read_statements(pobj)
         # end if
     # end while
-    return mtables, additional_routines
+    return mtables, mod_name, additional_routines
 
 ########################################################################
 

@@ -26,7 +26,7 @@ def __init__(self, logger, ndict=None, verbose=0, clean=False,
                  preproc_directives=[], generate_docfiles=False, host_name='',
                  kind_types=[], use_error_obj=False, force_overwrite=False,
                  output_root=os.getcwd(), ccpp_datafile="datatable.xml",
-                 debug=False):
+                 debug=False, ccpp_cfgfile=None):
         """Initialize a new CCPPFrameworkEnv object from the input arguments.
         <ndict> is a dict with the parsed command-line arguments (or a
            dictionary created with the necessary arguments).
@@ -199,6 +199,13 @@ def __init__(self, logger, ndict=None, verbose=0, clean=False,
             self.__datatable_file = os.path.join(self.output_dir,
                                                  self.datatable_file)
         # end if
+        # Are we provided a CCPP configuration file?
+        if ndict and ('ccpp_cfgfile' in ndict):
+            self.__ccpp_cfgfile = ndict['ccpp_cfgfile']
+            del ndict['ccpp_cfgfile']
+        else:
+            self.__ccpp_cfgfile = ccpp_cfgfile
+        # endif
         # Enable or disable variable allocation checks
         if ndict and ('debug' in ndict):
             self.__debug = ndict['debug']
@@ -319,6 +326,12 @@ def datatable_file(self):
         CCPPFrameworkEnv object."""
         return self.__datatable_file
 
+    @property
+    def ccpp_cfgfile(self):
+        """Return the <ccpp_cfg_file> property for this
+        CCPPFrameworkEnv object."""
+        return self.__ccpp_cfgfile
+
     @property
     def debug(self):
         """Return the <debug> property for this
@@ -368,6 +381,9 @@ def parse_command_line(args, description, logger=None):
                         default="datatable.xml",
                         help="Filename for information on content generated by the CCPP Framework")
 
+    parser.add_argument('--ccpp-cfgfile', type=str, default=None,
+                        help='path to CCPP prebuild configuration file')
+
     parser.add_argument("--output-root", type=str,
                         metavar='<directory for generated files>',
                         default=os.getcwd(),

@@ -512,8 +512,39 @@ def suite_part_call_list(host_model, const_dict, suite_part, subst_loop_vars,
         # End if
         if stdname not in CCPP_CONSTANT_VARS:
             lname = var_dict.var_call_string(hvar, loop_vars=loop_vars)
+            # DJS2025: Check to see if call_string for variable <hvar> contains any
+            # array references with a standard_name, <sname_sub>. If so, replace
+            # <hvar_sub> with full reference, <var_call_string(<hvar_sub>)>.
+            str_start = 0
+            while True:
+                dimdA = lname.find('(',str_start)
+                dimdB = lname.find(')',str_start)
+                if (dimdA > 0 and dimdB > 0):
+                    if (dimdB > dimdA):
+                        sname_sub = lname[dimdA+1:dimdB]
+                        hvar_sub  = vdict.find_variable(standard_name=sname_sub, any_scope=True)
+                        if (hvar_sub):
+                            lnameA = lname[0:dimdA+1]
+                            lnameB = lname[dimdB::]
+                            lname  = lnameA + var_dict.var_call_string(hvar_sub, loop_vars=loop_vars) + lnameB
+                        # end if
+                    # end if
+                else:
+                    break
+                # end if
+                str_start += dimdB+1
+            # end while
+            # Also check if {sp_lname} has an array reference to a loop varaible, if so,
+            # remove array reference from LHS call_string.
+            if stdname in CCPP_LOOP_VAR_STDNAMES:
+                dimdA = sp_lname.find('(',0)
+                if (dimdA > 0):
+                    sp_lname = sp_lname[0:dimdA]
+                # endif
+            # endif
             hmvars.append(f"{sp_lname}={lname}")
-        # End if
+            # end if
+        # end if
     # End for
     return ', '.join(hmvars)
 
@@ -543,14 +574,23 @@ def write_host_cap(host_model, api, module_name, output_dir, run_env):
             mspc = (maxmod - len(mod[0]))*' '
             cap.write("use {}, {}only: {}".format(mod[0], mspc, mod[1]), 1)
         # End for
+        # Write out any suite part use statements
+        max_suite_len = host_model.ddt_lib.max_mod_name_len
+        for suite in api.suites:
+            max_suite_len = max(max_suite_len, len(suite.module))
+            mspc = (max_suite_len - len(suite.module))*' '
+            for stage in CCPP_STATE_MACH.transitions():
+                spart_list = suite_part_list(suite, stage)
+                for _, spart in sorted(enumerate(spart_list)):
+                    stmt = "use {}, {}only: {}"
+                    cap.write(stmt.format(suite.module, mspc, spart.name), 1)
+                # end for
+            # end for
+        # end for
         mspc = ' '*(maxmod - len(CONST_DDT_MOD))
         cap.write(f"use {CONST_DDT_MOD}, {mspc}only: {CONST_DDT_NAME}", 1)
         cap.write(f"use {CONST_DDT_MOD}, {mspc}only: {CONST_PROP_TYPE}", 1)
         cap.write_preamble()
-        max_suite_len = host_model.ddt_lib.max_mod_name_len
-        for suite in api.suites:
-            max_suite_len = max(max_suite_len, len(suite.module))
-        # End for
         cap.comment("Public Interfaces", 1)
         # CCPP_STATE_MACH.transitions represents the host CCPP interface
         for stage in CCPP_STATE_MACH.transitions():
@@ -667,15 +707,7 @@ def write_host_cap(host_model, api, module_name, output_dir, run_env):
             cap.write(_SUBHEAD.format(api_vars=api_vlist,
                                       host_model=host_model.name,
                                       stage=stage), 1)
-            # Write out any suite part use statements
-            for suite in api.suites:
-                mspc = (max_suite_len - len(suite.module))*' '
-                spart_list = suite_part_list(suite, stage)
-                for _, spart in sorted(enumerate(spart_list)):
-                    stmt = "use {}, {}only: {}"
-                    cap.write(stmt.format(suite.module, mspc, spart.name), 2)
-                # End for
-            # End for
+
             # Write out any host model DDT input var use statements
             host_model.ddt_lib.write_ddt_use_statements(hdvars, cap, 2,
                                                         pad=max_suite_len)

@@ -59,9 +59,13 @@ def __init__(self, meta_tables, name_in, run_env):
                     lname = var.get_prop_value('local_name')
                     self.__var_locations[lname] = modname
                     self.ddt_lib.check_ddt_type(var, header, lname=lname)
+                    # DDTs may be used more than once by the host, so
+                    # skip duplicate sub-field entries. These fields were
+                    # encountered earlier and already added to library.
                     if var.is_ddt():
                         self.ddt_lib.collect_ddt_fields(self.__ddt_dict, var,
-                                                        run_env)
+                                                        run_env,
+                                                        skip_duplicates=True)
                     # End if
                 # End for
             elif header.header_type == 'host':
@@ -73,8 +77,12 @@ def __init__(self, meta_tables, name_in, run_env):
                     self.add_variable(var, run_env)
                     self.ddt_lib.check_ddt_type(var, header)
                     if var.is_ddt():
+                        # DDTs may be used more than once by the host, so
+                        # skip duplicate sub-field entries. These fields were
+                        # encountered earlier and already added to library.
                         self.ddt_lib.collect_ddt_fields(self.__ddt_dict, var,
-                                                        run_env)
+                                                        run_env,
+                                                        skip_duplicates=True)
                     # End if
                 # End for
                 loop_vars = header.variable_list(std_vars=False,

@@ -99,7 +99,7 @@ def convert_to_html(filename_in, outdir, logger, run_env):
     if not os.path.isfile(filename_in):
         raise Exception("Metadata file {} not found".format(filename_in))
     logger.info("Converting file {} to HTML".format(filename_in))
-    metadata_headers = parse_metadata_file(filename_in,
+    metadata_headers, metadata_titles = parse_metadata_file(filename_in,
                                            known_ddts=registered_fortran_ddt_names(),
                                            run_env=run_env)
     for metadata_header in metadata_headers:

@@ -112,7 +112,7 @@ def read_new_metadata(filename, module_name, table_name, scheme_name = None, sub
     if filename in NEW_METADATA_SAVE.keys():
         new_metadata_headers = NEW_METADATA_SAVE[filename]
     else:
-        new_metadata_headers = parse_metadata_file(filename, known_ddts=registered_fortran_ddt_names(),
+        new_metadata_headers, new_metadata_titles = parse_metadata_file(filename, known_ddts=registered_fortran_ddt_names(),
                                                                                 run_env=_DUMMY_RUN_ENV)
         NEW_METADATA_SAVE[filename] = new_metadata_headers
 

@@ -140,6 +140,7 @@
 from parse_tools import check_fortran_ref, check_fortran_id
 from parse_tools import check_fortran_intrinsic
 from parse_tools import register_fortran_ddt_name, unique_standard_name
+from parse_tools import registered_fortran_ddt_name
 
 ########################################################################
 
@@ -222,7 +223,7 @@ def parse_metadata_file(filename, known_ddts, run_env, skip_ddt_check=False, rel
                                    context=parse_obj)
         # end if
     # end while
-    return meta_tables
+    return meta_tables, table_titles
 
 ########################################################################
 
@@ -979,13 +980,18 @@ def parse_variable(self, curr_line, known_ddts, skip_ddt_check=False):
                             if skip_ddt_check:
                                 register_fortran_ddt_name(pval_str)
                             # end if
-                            pval = pval_str.lower()
+                            pval = pval_str
                             pname = 'ddt_type'
                         else:
-                            errmsg = "Unknown DDT type, {}".format(pval_str)
-                            self.__pobj.add_syntax_err(errmsg)
-                            self.__section_valid = False
-                            var_ok = False
+                            if registered_fortran_ddt_name(pval_str):
+                                pval = pval_str.lower()
+                                pname = 'ddt_type'
+                            else:
+                                errmsg = "Unknown DDT type, {}".format(pval_str)
+                                self.__pobj.add_syntax_err(errmsg)
+                                self.__section_valid = False
+                                var_ok = False
+                            # end if
                         # end if
                     else:
                         # Make sure this is a match