source: trunk/AGRIF/LIB/Writedeclarations.c @ 663

/******************************************************************************/
/*                                                                            */
/*     CONV (converter) for Agrif (Adaptive Grid Refinement In Fortran)       */
/*                                                                            */
/* Copyright or   or Copr. Laurent Debreu (Laurent.Debreu@imag.fr)            */
/*                        Cyril Mazauric (Cyril_Mazauric@yahoo.fr)            */
/* This software is governed by the CeCILL-C license under French law and     */
/* abiding by the rules of distribution of free software.  You can  use,      */
/* modify and/ or redistribute the software under the terms of the CeCILL-C   */
/* license as circulated by CEA, CNRS and INRIA at the following URL          */
/* "http://www.cecill.info".                                                  */
/*                                                                            */
/* As a counterpart to the access to the source code and  rights to copy,     */
/* modify and redistribute granted by the license, users are provided only    */
/* with a limited warranty  and the software's author,  the holder of the     */
/* economic rights,  and the successive licensors  have only  limited         */
/* liability.                                                                 */
/*                                                                            */
/* In this respect, the user's attention is drawn to the risks associated     */
/* with loading,  using,  modifying and/or developing or reproducing the      */
/* software by the user in light of its specific status of free software,     */
/* that may mean  that it is complicated to manipulate,  and  that  also      */
/* therefore means  that it is reserved for developers  and  experienced      */
/* professionals having in-depth computer knowledge. Users are therefore      */
/* encouraged to load and test the software's suitability as regards their    */
/* requirements in conditions enabling the security of their systems and/or   */
/* data to be ensured and,  more generally, to use and operate it in the      */
/* same conditions as regards security.                                       */
/*                                                                            */
/* The fact that you are presently reading this means that you have had       */
/* knowledge of the CeCILL-C license and that you accept its terms.           */
/******************************************************************************/
/* version 1.6                                                                */
/******************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "decl.h"

/******************************************************************************/
/*                         WriteBeginDeclaration                              */
/******************************************************************************/
/* This subroutine is used to write the begin of a declaration                */
/* taken in a variable record                                                 */
/*                                                                            */
/******************************************************************************/
/*                                                                            */
/*       integer variable ----------->   INTEGER                              */
/*                                                                            */
/******************************************************************************/
void WriteBeginDeclaration(variable *v,char ligne[LONGLIGNE])
{
  char tmpligne[LONGLIGNE];

  if ( !strcasecmp(v->v_typevar,"") )
  {
     printf("WARNING : The type of the variable %s \n",v->v_nomvar);
     printf("          is unknown. CONV should define a type\n");
  }
  sprintf (ligne, "%s", v->v_typevar);
  if ( v->v_c_star == 1 ) strcat(ligne,"*");
  /* We should give the precision of the variable if it has been given        */
  if ( strcasecmp(v->v_precision,"") )
  {
     sprintf(tmpligne,"(%s)",v->v_precision);
     strcat(ligne,tmpligne);
  }
  if (strcasecmp(v->v_dimchar,""))
  {
     sprintf(tmpligne,"(%s)",v->v_dimchar);
     strcat(ligne,tmpligne);
  }
  if ( strcasecmp(v->v_nameinttypename,"") )
  {
     sprintf(tmpligne,"*%s",v->v_nameinttypename);
     strcat(ligne,tmpligne);
  }
  if (strcasecmp (v->v_IntentSpec, ""))
  {
     sprintf(tmpligne,",INTENT(%s) ",v->v_IntentSpec);
     strcat(ligne,tmpligne);
  }
  if ( v->v_VariableIsParameter == 1 ) strcat(ligne, ", PARAMETER");
  if ( v->v_PublicDeclare       == 1 ) strcat(ligne, ", PUBLIC");
  if ( v->v_PrivateDeclare      == 1 ) strcat(ligne, ", PRIVATE");
  if ( v->v_ExternalDeclare     == 1 ) strcat(ligne, ", EXTERNAL");
  if ( v->v_allocatable         == 1 &&
       v->v_save                == 0 ) strcat(ligne,", ALLOCATABLE");
  if ( v->v_optionaldeclare     == 1 ) strcat(ligne,", OPTIONAL");
  if ( v->v_pointerdeclare      == 1 ) strcat(ligne,", POINTER");
}


/******************************************************************************/
/*                         WriteScalarDeclaration                             */
/******************************************************************************/
/* This subroutine is used to write a scalar declaration                      */
/* taken in a variable record                                                 */
/*                                                                            */
/******************************************************************************/
/*                                                                            */
/*       integer variable ----------->   INTEGER :: VARIABLE                  */
/*                                                                            */
/******************************************************************************/
void WriteScalarDeclaration(variable *v,char ligne[LONGLIGNE])
{

  strcat (ligne, " :: ");
  strcat (ligne, v->v_nomvar);
  if ( strcasecmp(v->v_vallengspec,"") ) strcat(ligne,v->v_vallengspec);
  if ( v->v_VariableIsParameter == 1 )
  {
     strcat(ligne," = ");
     strcat(ligne,v->v_initialvalue);
  }
}


/******************************************************************************/
/*                         WriteTableDeclaration                              */
/******************************************************************************/
/* This subroutine is used to write a Table declaration                       */
/* taken in a variable record                                                 */
/*                                                                            */
/******************************************************************************/
/*                                                                            */
/*  integer variable(nb) ----------->                                         */
/*                      INTEGER, DIMENSION(1:nb) :: variable                  */
/*                                                                            */
/******************************************************************************/
void WriteTableDeclaration(variable * v,char ligne[LONGLIGNE],int tmpok)
{
  char newname[LONGNOM];

  strcat (ligne, ", Dimension(");
  if ( v->v_dimensiongiven == 1 && tmpok == 1 )
                                         strcat(ligne,v->v_readedlistdimension);
  if ( v->v_dimensiongiven == 1 && tmpok == 0 )
  {
     strcpy(newname,ChangeTheInitalvaluebyTabvarsName
                                  (v->v_readedlistdimension,List_Global_Var,0));
     if ( !strcasecmp(newname,v->v_readedlistdimension) )
     {
        strcpy(newname,"");
        strcpy(newname,ChangeTheInitalvaluebyTabvarsName
                                 (v->v_readedlistdimension,List_Common_Var,0));
        if ( !strcasecmp(newname,"") ) strcat(newname,v->v_readedlistdimension);
     }
     if ( !strcasecmp(newname,v->v_readedlistdimension) )
     {
        strcpy(newname,"");
        /* la liste des use de cette subroutine                               */
        strcpy(newname,ChangeTheInitalvaluebyTabvarsName
                              (v->v_readedlistdimension,List_ModuleUsed_Var,0));
        if ( !strcasecmp(newname,"") ) strcat(newname,v->v_readedlistdimension);
     }
     strcat(ligne,newname);
  }
  strcat (ligne, ")");
  strcat (ligne, " :: ");
  strcat (ligne, v->v_nomvar);
  if ( strcasecmp(vallengspec,"") ) strcat(ligne,v->v_vallengspec);
/*  if ( !strcasecmp (v->v_typevar, "character") )
                              strcat(ligne,vargridparam(v,0));*/
  if ( v->v_VariableIsParameter == 1 )
  {
     strcat(ligne," = ");
     strcat(ligne,v->v_initialvalue);
  }
}

/******************************************************************************/
/*                        writevardeclaration                                 */
/******************************************************************************/
/* This subroutine is used to write the initial declaration in the file       */
/* fileout of a variable                                                      */
/*                                                                            */
/******************************************************************************/
/*                                                                            */
/*  integer variable(nb) ----------->                                         */
/*                      INTEGER, DIMENSION(1:nb),Pointer :: variable          */
/*                                                                            */
/******************************************************************************/
void writevardeclaration (listvar * var_record, FILE *fileout, int value)
{
  FILE *filecommon;
  listvar *newvar;
  variable *v;
  char ligne[LONGNOM];

  filecommon=fileout;
  newvar = var_record;

  if ( newvar->var->v_save == 0 || inmodulemeet == 0 )
  {
     v = newvar->var;
     WriteBeginDeclaration(v,ligne);
     if ( v->v_nbdim == 0 ) WriteScalarDeclaration(v,ligne);
     else WriteTableDeclaration(v,ligne,value);

     if ( v->v_VariableIsParameter != 1 && strcasecmp(v->v_initialvalue,"") )
     {
        strcat(ligne," = ");
        strcat(ligne,v->v_initialvalue);
     }
     tofich (filecommon, ligne,1);
  }
}


void WriteLocalParamDeclaration()
{
   listvar *parcours;

   parcours = List_Parameter_Var;
   while ( parcours )
   {
      if ( !strcasecmp(parcours->var->v_subroutinename,subroutinename) )
      {
         writevardeclaration(parcours,fortranout,0);
      }
      parcours = parcours -> suiv;
   }
}

void WriteFunctionDeclaration()
{
   listvar *parcours;

   parcours = List_FunctionType_Var;
   while ( parcours )
   {
      if ( !strcasecmp(parcours->var->v_subroutinename,subroutinename) &&
            strcasecmp(parcours->var->v_typevar,"")
         )
      {
         writevardeclaration(parcours,fortranout,0);
      }
      parcours = parcours -> suiv;
   }
}

void WriteSubroutineDeclaration(int value)
{
   listvar *parcours;

   parcours = List_SubroutineDeclaration_Var;
   while ( parcours )
   {
      if ( !strcasecmp(parcours->var->v_subroutinename,subroutinename) &&
           parcours->var->v_save == 0                                  &&
           parcours->var->v_allocatable == 0                           &&
           parcours->var->v_pointerdeclare == 0                        &&
           parcours->var->v_VariableIsParameter == 0                   &&
           parcours->var->v_common == 0
         )
      {
         writevardeclaration(parcours,fortranout,value);
      }
      else if ( !strcasecmp(parcours->var->v_subroutinename,subroutinename) &&
           parcours->var->v_save == 0                                  &&
           parcours->var->v_VariableIsParameter == 0                   &&
           parcours->var->v_common == 0
              )
      {
         writevardeclaration(parcours,fortranout,value);
      }
      parcours = parcours -> suiv;
   }
}

void WriteArgumentDeclaration_beforecall()
{
   variable *v;
   int position;
   listnom *neededparameter;
   FILE *paramtoamr;
   listvar *newvar;
   char ligne[LONGLIGNE];
   int out;
   int writeit;
   listnom *parcours;

   fprintf(fortranout,"#include \"Param_BeforeCall_%s.h\" \n",subroutinename);
   /*                                                                         */
   sprintf(ligne,"Param_BeforeCall_%s.h",subroutinename);
   paramtoamr = associate (ligne);
   /*                                                                         */
   neededparameter = (listnom * )NULL;
   /*                                                                         */
   position = 1;
   newvar = List_SubroutineArgument_Var;
   while ( newvar )
   {
      if ( !strcasecmp(newvar->var->v_subroutinename,subroutinename) &&
                       newvar->var->v_positioninblock == position
         )
      {
         position = position + 1;
         writevardeclaration(newvar,fortranout,0);
         neededparameter = writedeclarationintoamr(List_Parameter_Var,
                   paramtoamr,newvar->var,newvar->var->v_subroutinename,
                   neededparameter,subroutinename);

         newvar = List_SubroutineArgument_Var;
      }
      else newvar = newvar -> suiv;
   }
   fclose(paramtoamr);
}

void WriteArgumentDeclaration_Sort()
{
   variable *v;
   int position;
/*   listnom *neededparameter;*/
   FILE *paramtoamr;
   listvar *newvar;
   char ligne[LONGLIGNE];
   int out;
   int writeit;
   listnom *parcours;

   /*                                                                         */
   position = 1;
   newvar = List_SubroutineArgument_Var;
   while ( newvar )
   {
      if ( !strcasecmp(newvar->var->v_subroutinename,subroutinename) &&
                       newvar->var->v_positioninblock == position
         )
      {
         position = position + 1;
         writevardeclaration(newvar,fortranout,1);
         /*                                                                   */
         newvar = List_SubroutineArgument_Var;
      }
      else newvar = newvar -> suiv;
   }
   /*                                                                         */
   newvar = List_SubroutineArgument_Var;
   while ( newvar )
   {
      if ( !strcasecmp(newvar->var->v_subroutinename,subroutinename) &&
                       newvar->var->v_positioninblock == 0           &&
                       newvar->var->v_nbdim == 0
         )
      {
         writevardeclaration(newvar,fortranout,1);
      }
      newvar = newvar -> suiv;
   }
   /*                                                                         */
   newvar = List_SubroutineArgument_Var;
   while ( newvar )
   {
      if ( !strcasecmp(newvar->var->v_subroutinename,subroutinename) &&
                       newvar->var->v_positioninblock == 0           &&
                       newvar->var->v_nbdim != 0
         )
      {
         writevardeclaration(newvar,fortranout,1);
      }
      newvar = newvar -> suiv;
   }
}

/******************************************************************************/
/*                      writedeclarationintoamr                               */
/******************************************************************************/
/* This subroutine is used to write the declaration of parameters needed in   */
/*    allocation subroutines creates in toamr.c                               */
/******************************************************************************/
/*                                                                            */
/*                                                                            */
/******************************************************************************/
listnom *writedeclarationintoamr (listvar * deb_common, FILE *fileout,
                              variable *var , char commonname[LONGNOM],
                           listnom *neededparameter, char name_common[LONGNOM])
{
  listvar *newvar;
  variable *v;
  char ligne[LONGLIGNE];
  int changeval;
  char firstmodule[LONGNOM];
  int out;
  int writeit;
  listnom *parcours;
  listnom *parcoursprec;

  parcoursprec = (listnom * )NULL;
  /* we should list the needed parameter                                      */
  if ( !strcasecmp(name_common,commonname) )
     neededparameter = DecomposeTheNameinlistnom(var->v_readedlistdimension,
                                                               neededparameter);
  /*                                                                          */
  parcours = neededparameter;
  while (parcours)
  {
     newvar = deb_common;
     out = 0 ;
     while ( newvar && out == 0 )
     {
        if ( !strcasecmp(parcours->o_nom,newvar->var->v_nomvar) )
        {
           out=1;
        /* add the name to the list of needed parameter                       */
           neededparameter = DecomposeTheNameinlistnom(
                 newvar->var->v_initialvalue,
                 neededparameter );
        }
        else newvar=newvar->suiv;
     }
     parcours=parcours->suiv;
   }
  /*                                                                          */
  parcours = neededparameter;
  while (parcours)
  {
     newvar = deb_common;
     out = 0 ;
     while ( newvar && out == 0 )
     {
        if ( !strcasecmp(parcours->o_nom,newvar->var->v_nomvar) )
        {
           out=1;
        /* add the name to the list of needed parameter                       */
           neededparameter = DecomposeTheNameinlistnom(
                 newvar->var->v_initialvalue,
                 neededparameter );
        }
        else newvar=newvar->suiv;
     }
     parcours=parcours->suiv;
   }
  /*                                                                          */
  strcpy(firstmodule,"");
  tofich (fileout, "",1);
  parcours = neededparameter;
  while (parcours)
  {
     writeit = 0;
     newvar = deb_common;
     while ( newvar && writeit == 0 )
     {
        if ( !strcasecmp(parcours->o_nom,newvar->var->v_nomvar) &&
             parcours->o_val == 0 )
        {
           writeit=1;
           parcours->o_val = 1;
        }
        else newvar = newvar->suiv;
     }

     if ( writeit == 1  )
     {
        changeval = 0;
        v = newvar->var;
        if ( v->v_allocatable == 1  )
        {
           changeval = 1;
           v->v_allocatable = 0;
        }
        WriteBeginDeclaration(v,ligne);
        if ( v->v_nbdim == 0 ) WriteScalarDeclaration(v,ligne);
        else WriteTableDeclaration(v,ligne,1);

        tofich (fileout, ligne,1);
        if ( changeval == 1 )
        {
           v->v_allocatable = 1;
        }
     }
     else
     {
        if (  strncasecmp(parcours->o_nom,"mpi_",4) == 0 &&
              shouldincludempif                     == 1 )
        {
           shouldincludempif = 0;
           fprintf(fileout,"      include \'mpif.h\' \n");
        }
     }
     parcours=parcours->suiv;
  }
  return neededparameter;
}


/******************************************************************************/
/*                       writesub_loopdeclaration_scalar                      */
/******************************************************************************/
/* This subroutine is used to write the declaration part of subloop           */
/*    subroutines                                                             */
/******************************************************************************/
/*                                                                            */
/*  integer variable(nb) ----------->                                         */
/*                                                                            */
/*          INTEGER, DIMENSION(1:nb)         :: variable                      */
/*                                                                            */
/******************************************************************************/
void writesub_loopdeclaration_scalar (listvar * deb_common, FILE *fileout)
{
  listvar *newvar;
  variable *v;
  char ligne[LONGLIGNE];

  tofich (fileout, "",1);
  newvar = deb_common;
  while (newvar)
  {
     if ( newvar->var->v_nbdim == 0 &&
          !strcasecmp(newvar->var->v_subroutinename,subroutinename)  &&
           newvar->var->v_allocatable == 0                           &&
           newvar->var->v_pointerdeclare == 0
         )
     {
        v = newvar->var;

        WriteBeginDeclaration(v,ligne);
        WriteScalarDeclaration(v,ligne);
        tofich (fileout, ligne,1);
     }
     newvar = newvar->suiv;
  }
}

/******************************************************************************/
/*                       writesub_loopdeclaration_tab                         */
/******************************************************************************/
/* This subroutine is used to write the declaration part of subloop           */
/*    subroutines                                                             */
/******************************************************************************/
/*                                                                            */
/*  integer variable(nb) ----------->                                         */
/*                                                                            */
/*          INTEGER, DIMENSION(1:nb)         :: variable                      */
/*                                                                            */
/******************************************************************************/
void writesub_loopdeclaration_tab (listvar * deb_common, FILE *fileout)
{
  listvar *newvar;
  variable *v;
  char ligne[LONGLIGNE];
  int changeval;

  tofich (fileout, "",1);
  newvar = deb_common;
  while (newvar)
  {
     if ( newvar->var->v_nbdim != 0                                 &&
          !strcasecmp(newvar->var->v_subroutinename,subroutinename) &&
          newvar->var->v_allocatable == 0                           &&
          newvar->var->v_pointerdeclare == 0
        )
     {
        changeval = 0;
        v = newvar->var;
        if ( v->v_allocatable == 1 )
        {
           changeval = 1;
           v->v_allocatable = 0;
        }
        WriteBeginDeclaration(v,ligne);
        WriteTableDeclaration(v,ligne,1);
        tofich (fileout, ligne,1);
        if ( changeval == 1 ) v->v_allocatable = 1;
     }
     newvar = newvar->suiv;
  }
}