1

/*

     2

 * (c) 2003 Mario de Sousa

     3

 *

     4

 * Offered to the public under the terms of the GNU General Public License

     5

 * as published by the Free Software Foundation; either version 2 of the

     6

 * License, or (at your option) any later version.

     7

 *

     8

 * This program is distributed in the hope that it will be useful, but

     9

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    10

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    11

 * Public License for more details.

    12

 *

    13

 * This code is made available on the understanding that it will not be

    14

 * used in safety-critical situations without a full and competent review.

    15

 */

    16

    17

/*

    18

 * An IEC 61131-3 IL and ST compiler.

    19

 *

    20

 * Based on the

    21

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    22

 *

    23

 */

    24

    25

    26

/*

    27

 * Function parameter iterator.

    28

 * Iterate through the in/out parameters of a function declaration.

    29

 * Function blocks are also suported.

    30

 *

    31

 * This is part of the 4th stage that generates

    32

 * a c++ source program equivalent to the IL and ST

    33

 * code.

    34

 */

    35

    36

    37

    38

    39

    40

    41

//#include <stdio.h>  /* required for NULL */

    42

//#include <string>

    43

//#include <iostream>

    44

    45

//#include "../../util/symtable.hh"

    46

    47

//#include "generate_c.hh"

    48

    49

    50

#include "../../absyntax/visitor.hh"

    51

    52

    53

/* given a function_declaration_c, iterate through each

    54

 * function in/out/inout parameter, returning the name

    55

 * of each parameter...function_param_iterator_c

    56

 */

    57

class function_param_iterator_c : public null_visitor_c {

    58

  public:

    59

    /* A type to specify the type of parameter.

    60

     * VAR_INPUT => direction_in

    61

     * VAR_OUTPUT => direction_out

    62

     * VAR_IN_OUT => direction_inout

    63

     * VAR_EXTERNAL => direction_extref

    64

     *

    65

     * Note that VAR_EXTERNAL declares variables that are in reality references

    66

     * to global variables. This is used only inside programs!

    67

     * These references to external variables must be correctly initialised to refer

    68

     * to the correct global variable. Note that the user may define which variable is to be

    69

     * referenced in a CONFIGURATION, and that different instantiations of a program

    70

     * may have the same external variable reference diffenrent global variables!

    71

     * The references must therefore be correctly initialised when the program instance

    72

     * is created. This may be done by the PROGRAM class constructor since the ST and IL

    73

     * languages do not allow the VAR_EXTERNAL reference to change at runtime

    74

     * for a specific instance.

    75

     *

    76

     * We therefore need to call a PROGRAM class constructor with the variables

    77

     * that should be refernced by the VAR_EXTERNAL variables. The direction_extref will

    78

     * be used to identify these parameters!

    79

     */

    80

    typedef enum {direction_in, direction_out, direction_inout, direction_extref} param_direction_t ;

    81

    82

    83

  private:

    84

      /* a pointer to the function_block_declaration_c

    85

       * or function_declaration_c currently being analysed.

    86

       */

    87

    symbol_c *f_decl;

    88

    int next_param, param_count;

    89

    identifier_c *current_param_name;

    90

    symbol_c *current_param_type;

    91

    symbol_c *current_param_default_value;

    92

    param_direction_t current_param_direction;

    95

    96

  private:

    97

    void* handle_param_list(list_c *list) {

    98

      if (next_param <= param_count + list->n)

    99

        return list->elements[next_param - param_count - 1];

   100

   101

      /* the desired param is not on this list... */

   102

      param_count += list->n;

   103

     return NULL;

   104

    }

   105

   106

    void* handle_single_param(symbol_c *var_name) {

   107

      param_count++;

   108

      if (next_param == param_count)

   109

        return var_name;

   110

   111

      /* not yet the desired param... */

   112

     return NULL;

   113

    }

   114

   115

    void* iterate_list(list_c *list) {

   116

      void *res;

   117

      for (int i = 0; i < list->n; i++) {

   118

        res = list->elements[i]->accept(*this);

   121

      }

   122

      return NULL;

   123

   }

   124

   125

   126

  public:

   127

    /* start off at the first parameter once again... */

   128

    void reset(void) {

   129

      next_param = param_count = 0;

   130

      current_param_name = NULL;

   131

      current_param_type = current_param_default_value = NULL;

   134

    }

   135

   136

    /* initialise the iterator object.

   137

     * We must be given a reference to the function declaration

   138

     * that will be analysed...

   139

     */

   140

    function_param_iterator_c(function_declaration_c *f_decl) {

   141

      this->f_decl = f_decl;

   142

      reset();

   143

    }

   144

   145

    /* initialise the iterator object.

   146

     * We must be given a reference to the function block declaration

   147

     * that will be analysed...

   148

     */

   149

    function_param_iterator_c(function_block_declaration_c *fb_decl) {

   150

      this->f_decl = fb_decl;

   151

      reset();

   152

    }

   153

   154

    /* initialise the iterator object.

   155

     * We must be given a reference to the program declaration

   156

     * that will be analysed...

   157

     */

   158

    function_param_iterator_c(program_declaration_c *p_decl) {

   159

      this->f_decl = p_decl;

   160

      reset();

   161

    }

   162

   163

    /* Skip to the next parameter. After object creation,

   164

     * the object references on parameter _before_ the first, so

   165

     * this function must be called once to get the object to

   166

     * reference the first parameter...

   167

     *

   168

     * Returns the parameter's name!

   169

     */

   170

    identifier_c *next(void) {

   171

      void *res;

   173

      param_count = 0;

   174

      next_param++;

   175

      res = f_decl->accept(*this);

   191

        return NULL;

   193

      current_param_name = identifier;

   194

      return current_param_name;

   195

    }

   196

   213

    /* Returns the currently referenced parameter's default value,

   214

     * or NULL if none is specified in the function declrataion itself.

   215

     */

   216

    symbol_c *default_value(void) {

   217

      return current_param_default_value;

   218

    }

   219

   220

    /* Returns the currently referenced parameter's type name. */

   221

    symbol_c *param_type(void) {

   222

      return current_param_type;

   223

    }

   224

   225

    /* Returns the currently referenced parameter's data passing direction.

   226

     * i.e. VAR_INPUT, VAR_OUTPUT or VAR_INOUT

   227

     */

   228

    param_direction_t param_direction(void) {

   229

      return current_param_direction;

   230

    }

   231

   232

/******************************************/

   233

/* B 1.4.3 - Declaration & Initialisation */

   234

/******************************************/

   235

    void *visit(input_declarations_c *symbol) {

   236

      TRACE("input_declarations_c");

   237

      current_param_direction = direction_in;

   238

      return symbol->input_declaration_list->accept(*this);

   239

    }

   240

    void *visit(input_declaration_list_c *symbol) {TRACE("input_declaration_list_c"); return iterate_list(symbol);}

   241

    void *visit(edge_declaration_c *symbol) {TRACE("edge_declaration_c"); return symbol->var1_list->accept(*this);}

   247

#if 0

   248

/* var1_list ':' array_spec_init */

   249

SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   250

   251

/*  var1_list ':' initialized_structure */

   252

SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   253

   254

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   255

/* structure_initialization -> may be NULL ! */

   256

SYM_REF4(fb_name_decl_c, fb_name_list, function_block_type_name, structure_initialization, unused)

   257

   258

/* name_list ',' fb_name */

   259

SYM_LIST(fb_name_list_c)

   260

#endif

   261

   262

    void *visit(output_declarations_c *symbol) {

   263

      TRACE("output_declarations_c");

   264

      current_param_direction = direction_out;

   265

      return symbol->var_init_decl_list->accept(*this);

   266

    }

   272

    void *visit(input_output_declarations_c *symbol) {

   273

      TRACE("input_output_declarations_c");

   274

      current_param_direction = direction_inout;

   275

      return symbol->var_declaration_list->accept(*this);

   276

    }

   277

    void *visit(var_declaration_list_c *symbol) {TRACE("var_declaration_list_c"); return iterate_list(symbol);}

   278

   279

#if 0

   280

/*  var1_list ':' array_specification */

   281

SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   282

   283

/*  var1_list ':' structure_type_name */

   284

SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   285

#endif

   286

   287

/* VAR [CONSTANT] var_init_decl_list END_VAR */

   288

    void *visit(var_declarations_c *symbol) {TRACE("var_declarations_c"); return NULL;}

   289

   290

#if 0

   291

/*  VAR RETAIN var_init_decl_list END_VAR */

   292

SYM_REF2(retentive_var_declarations_c, var_init_decl_list, unused)

   293

   294

/*  VAR [CONSTANT|RETAIN|NON_RETAIN] located_var_decl_list END_VAR */

   295

/* option -> may be NULL ! */

   296

SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   297

   298

/* helper symbol for located_var_declarations */

   299

/* located_var_decl_list located_var_decl ';' */

   300

SYM_LIST(located_var_decl_list_c)

   301

   302

/*  [variable_name] location ':' located_var_spec_init */

   303

/* variable_name -> may be NULL ! */

   304

SYM_REF4(located_var_decl_c, variable_name, location, located_var_spec_init, unused)

   305

#endif

   306

   307

/*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   308

/* option -> may be NULL ! */

   309

// SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   310

    void *visit(external_var_declarations_c *symbol) {

   311

      TRACE("external_var_declarations_c");

   312

      current_param_direction = direction_extref;

   313

      return symbol->external_declaration_list->accept(*this);

   314

    }

   315

   316

/* helper symbol for external_var_declarations */

   317

/*| external_declaration_list external_declaration';' */

   318

// SYM_LIST(external_declaration_list_c)

   319

    void *visit(external_declaration_list_c *symbol) {TRACE("external_declaration_list_c"); return iterate_list(symbol);}

   320

   321

/*  global_var_name ':' (simple_specification|subrange_specification|enumerated_specification|array_specification|prev_declared_structure_type_name|function_block_type_name */

   322

//SYM_REF2(external_declaration_c, global_var_name, specification)

   323

    void *visit(external_declaration_c *symbol) {

   324

      TRACE("external_declaration_c");

   325

      /* It is OK to store these values in the current_param_XXX

   326

       * variables, because if the desired parameter is not in the

   327

       * variable list we will be analysing, the current_param_XXXX

   328

       * variables will get overwritten when we visit the next

   329

       * var1_init_decl_c list!

   330

       */

   331

      current_param_default_value = spec_init_sperator_c::get_init(symbol->specification);

   332

      current_param_type = spec_init_sperator_c::get_spec(symbol->specification);

   333

   334

      return handle_single_param(symbol->global_var_name);

   335

    }

   336

   337

   338

#if 0

   339

/*| VAR_GLOBAL [CONSTANT|RETAIN] global_var_decl_list END_VAR */

   340

/* option -> may be NULL ! */

   341

SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   342

   343

/* helper symbol for global_var_declarations */

   344

/*| global_var_decl_list global_var_decl ';' */

   345

SYM_LIST(global_var_decl_list_c)

   346

   347

/*| global_var_spec ':' [located_var_spec_init|function_block_type_name] */

   348

/* type_specification ->may be NULL ! */

   349

SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   350

   351

/*| global_var_name location */

   352

SYM_REF2(global_var_spec_c, global_var_name, location)

   353

   354

/*  AT direct_variable */

   355

SYM_REF2(location_c, direct_variable, unused)

   356

   357

/*| global_var_list ',' global_var_name */

   358

SYM_LIST(global_var_list_c)

   359

   360

/*  var1_list ':' single_byte_string_spec */

   361

SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   362

   363

/*  STRING ['[' integer ']'] [ASSIGN single_byte_character_string] */

   364

/* integer ->may be NULL ! */

   365

/* single_byte_character_string ->may be NULL ! */

   366

SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   367

   368

/*  var1_list ':' double_byte_string_spec */

   369

SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   370

   371

/*  WSTRING ['[' integer ']'] [ASSIGN double_byte_character_string] */

   372

/* integer ->may be NULL ! */

   373

/* double_byte_character_string ->may be NULL ! */

   374

SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   375

   376

/*| VAR [RETAIN|NON_RETAIN] incompl_located_var_decl_list END_VAR */

   377

/* option ->may be NULL ! */

   378

SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)

   379

   380

/* helper symbol for incompl_located_var_declarations */

   381

/*| incompl_located_var_decl_list incompl_located_var_decl ';' */

   382

SYM_LIST(incompl_located_var_decl_list_c)

   383

   384

/*  variable_name incompl_location ':' var_spec */

   385

SYM_REF4(incompl_located_var_decl_c, variable_name, incompl_location, var_spec, unused)

   386

   387

/*  AT incompl_location_token */

   388

SYM_TOKEN(incompl_location_c)

   389

#endif

   390

   391

   392

    void *visit(var1_init_decl_c *symbol) {

   393

      TRACE("var1_init_decl_c");

   394

      /* It is OK to store these values in the current_param_XXX

   395

       * variables, because if the desired parameter is not in the

   396

       * variable list we will be analysing, the current_param_XXXX

   397

       * variables will get overwritten when we visit the next

   398

       * var1_init_decl_c list!

   399

       */

   400

      current_param_default_value = spec_init_sperator_c::get_init(symbol->spec_init);

   401

      current_param_type = spec_init_sperator_c::get_spec(symbol->spec_init);

   402

   403

      return symbol->var1_list->accept(*this);

   404

    }

   405

   406

   407

   408

    void *visit(var1_list_c *symbol) {

   409

      TRACE("var1_list_c");

   410

      return handle_param_list(symbol);

   411

    }

   412

   413

    void *visit(var_init_decl_list_c *symbol) {TRACE("var_init_decl_list_c"); return iterate_list(symbol);}

   414

   415

   416

/***********************/

   417

/* B 1.5.1 - Functions */

   418

/***********************/

   419

    void *visit(function_declaration_c *symbol) {TRACE("function_declaration_c"); return symbol->var_declarations_list->accept(*this);}

   420

    /* intermediate helper symbol for function_declaration */

   421

    void *visit(var_declarations_list_c *symbol) {TRACE("var_declarations_list_c"); return iterate_list(symbol);}

   422

    void *visit(function_var_decls_c *symbol) {TRACE("function_var_decls_c"); /* ignore */ return NULL;}

   423

   424

   425

/*****************************/

   426

/* B 1.5.2 - Function Blocks */

   427

/*****************************/

   428

/*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   429

    void *visit(function_block_declaration_c *symbol) {TRACE("function_block_declaration_c"); return symbol->var_declarations->accept(*this);}

   430

   431

/* intermediate helper symbol for function_declaration */

   432

/*  { io_var_declarations | other_var_declarations }   */

   433

/*

   434

 * NOTE: we re-use the var_declarations_list_c

   435

 */

   436

   437

/*  VAR_TEMP temp_var_decl_list END_VAR */

   438

    void *visit(temp_var_decls_c *symbol) {TRACE("temp_var_decls_c"); /* ignore */ return NULL;}

   439

    void *visit(temp_var_decls_list_c *symbol) {TRACE("temp_var_decls_list_c"); /* ignore */ return NULL;}

   440

   441

/*  VAR NON_RETAIN var_init_decl_list END_VAR */

   442

    void *visit(non_retentive_var_decls_c *symbol) {TRACE("non_retentive_var_decls_c"); /* ignore */ return NULL;}

   443

   444

   445

/**********************/

   446

/* B 1.5.3 - Programs */

   447

/**********************/

   448

/*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   449

// SYM_REF4(program_declaration_c, program_type_name, var_declarations, function_block_body, unused)

   450

    void *visit(program_declaration_c *symbol) {TRACE("program_declaration_c"); return symbol->var_declarations->accept(*this);}

   451

   452

/* intermediate helper symbol for program_declaration_c */

   453

/*  { io_var_declarations | other_var_declarations }   */

   454

/*

   455

 * NOTE: we re-use the var_declarations_list_c

   456

 */

   457

   458

};

   459

   460

   461

   462

   463

   464

   465