1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *

     7

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

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

    13

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

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

    22

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

    23

 */

    24

    25

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

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

    30

 *

    31

 */

    32

    33

    34

/*

    35

 * Function parameter iterator.

    36

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

    37

 * Function blocks are also suported.

    38

 *

    39

 * This is part of the 4th stage that generates

    40

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

    41

 * code.

    42

 */

    43

    44

/* Given a function_declaration_c, iterate through each

    45

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

    46

 * of each parameter...function_param_iterator_c

    47

 */

    48

    49

    50

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

    51

    52

    53

class function_param_iterator_c : public null_visitor_c {

    54

  public:

    55

    /* A type to specify the type of parameter.

    56

     * VAR_INPUT => direction_in

    57

     * VAR_OUTPUT => direction_out

    58

     * VAR_IN_OUT => direction_inout

    59

     * VAR_EXTERNAL => direction_extref

    60

     *

    61

     * Note that VAR_EXTERNAL declares variables that are in reality references

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

     * for a specific instance.

    71

     *

    72

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

    73

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

    74

     * be used to identify these parameters!

    75

     */

    76

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

    77

    78

    79

  private:

    80

    /* a pointer to the function_block_declaration_c

    81

    * or function_declaration_c currently being analysed.

    82

    */

    83

    symbol_c *f_decl;

    84

    int next_param, param_count;

    85

    /* used when called to search() for a parameter by name */

    86

    identifier_c *search_param_name;

    87

    /* used when called to iterate() for a parameter */

    88

    identifier_c *current_param_name;

    89

    symbol_c *current_param_type;

    90

    symbol_c *current_param_default_value;

    91

    param_direction_t current_param_direction;

    92

    bool en_eno_param_implicit;

    93

    /* used when we reach an extensible parameter in the function declaration */

    94

    /* NOTE: this will handle syntax that is not in the standard.

    95

     *       It is used to handle the extensible standard functions

    96

     *       (e.g. AND(word#3, word#55, word#44); )

    97

     *       See absyntax.def or iec.y for more details.

    98

     */

    99

    bool current_param_is_extensible;

   100

    int  current_extensible_param_index;

   101

    int  _first_extensible_param_index;

   102

   103

    /* Which operation of the class was called...

   104

     * Search a parameter, or iterate to the next parameter.

   105

     */

   106

    typedef enum {iterate_op, search_op} operation_t;

   107

    operation_t current_operation;

   108

   109

    /* the last parameter/value returned by search() or next() */

   110

    symbol_c *last_returned_parameter; 

   111

   112

  private:

   113

    int   cmp_extparam_names(const char* s1, const char* s2);

   114

    void* handle_param_list(list_c *list);

   115

    void* handle_single_param(symbol_c *var_name);

   116

   117

    void* iterate_list(list_c *list);

   118

   119

  public:

   120

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

   121

    void reset(void);

   122

   123

    /* initialise the iterator object.

   124

     * We must be given a reference to one of the following

   125

     *     - function_declaration_c

   126

     *     - function_block_declaration_c

   127

     *     - program_declaration_c

   128

     * that will be analysed...

   129

     */

   130

    function_param_iterator_c(symbol_c *pou_decl);

   131

   132

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

   133

     * the object references on parameter _before_ the first, so

   134

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

   135

     * reference the first parameter...

   136

     *

   137

     * Returns the parameter's name!

   138

     */

   139

    identifier_c *next(void);

   140

   141

    /* Search for the parameter named <param_name>...  */

   142

    /* The seach() function does not in any way affect the internal state related 

   143

     * to the iterate() function.

   144

     * It will, however, affect the internal state necessary to correctly

   145

     * return the param_type(), default_value() and is_en_eno_param_implicit()

   146

     * of the found parameter.

   147

     */

   148

    identifier_c *search(symbol_c *param_name);

   149

    identifier_c *search(const char *param_name);

   150

   151

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

   152

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

   153

     */

   154

    symbol_c *default_value(void);

   155

   156

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

   157

    symbol_c *param_type(void);

   158

   159

    /* Returns if currently referenced parameter is an implicit defined EN/ENO parameter. */

   160

    bool is_en_eno_param_implicit(void);

   161

   162

    /* Returns if currently referenced parameter is an extensible parameter. */

   163

    /* extensible paramters only occur in some standard functions, e.g. AND(word#34, word#44, word#65); */

   164

    bool is_extensible_param(void);

   165

    /* Returns the index of the current extensible parameter. */             

   166

    /* If the current parameter is not an extensible paramter, returns -1 */

   167

    int extensible_param_index(void);

   168

    /* Returns the index of the first extensible parameter, or -1 if no extensible parameter found. */             

   169

    /* WARNING: Will only return the correct value _after_ an extensible parameter has been found! */

   170

    int first_extensible_param_index(void);

   171

   172

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

   173

     * i.e. VAR_INPUT, VAR_OUTPUT or VAR_INOUT

   174

     */

   175

    param_direction_t param_direction(void);

   176

   177

    private:

   178

    void *visit(implicit_definition_c *symbol);

   179

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

   180

    /* B 1.4.3 - Declaration & Initialisation */

   181

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

   182

    void *visit(input_declarations_c *symbol);

   183

   184

    void *visit(input_declaration_list_c *symbol);

   185

   186

    void *visit(edge_declaration_c *symbol);

   187

    void *visit(en_param_declaration_c *symbol);

   188

    /* var1_list ':' array_spec_init */

   189

    //SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   190

    void *visit(array_var_init_decl_c *symbol);

   191

   192

    /*  var1_list ':' initialized_structure */

   193

    //SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   194

    void *visit(structured_var_init_decl_c *symbol);

   195

   196

    /* name_list ':' function_block_type_name ASSIGN structure_initialization */

   197

    /* structure_initialization -> may be NULL ! */

   198

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

   199

    void *visit(fb_name_decl_c *symbol);

   200

   201

    /* name_list ',' fb_name */

   202

    // SYM_LIST(fb_name_list_c)

   203

    void *visit(fb_name_list_c *symbol);

   204

   205

    void *visit(output_declarations_c *symbol);

   206

    void *visit(eno_param_declaration_c *symbol);

   207

    void *visit(input_output_declarations_c *symbol);

   208

    void *visit(var_declaration_list_c *symbol);

   209

   210

   211

    /*  var1_list ':' array_specification */

   212

    //SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   213

    void *visit(array_var_declaration_c *symbol);

   214

   215

    /*  var1_list ':' structure_type_name */

   216

    //SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   217

    void *visit(structured_var_declaration_c *symbol);

   218

   219

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   220

    void *visit(var_declarations_c *symbol);

   221

   222

#if 0

   223

/*  VAR RETAIN var_init_decl_list END_VAR */

   224

SYM_REF2(retentive_var_declarations_c, var_init_decl_list, unused)

   225

   226

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

   227

/* option -> may be NULL ! */

   228

SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   229

   230

/* helper symbol for located_var_declarations */

   231

/* located_var_decl_list located_var_decl ';' */

   232

SYM_LIST(located_var_decl_list_c)

   233

   234

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

   235

/* variable_name -> may be NULL ! */

   236

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

   237

#endif

   238

   239

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   240

    /* option -> may be NULL ! */

   241

    // SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   242

    void *visit(external_var_declarations_c *symbol);

   243

   244

    /* helper symbol for external_var_declarations */

   245

    /*| external_declaration_list external_declaration';' */

   246

    // SYM_LIST(external_declaration_list_c)

   247

    void *visit(external_declaration_list_c *symbol);

   248

   249

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

   250

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   251

    void *visit(external_declaration_c *symbol);

   252

   253

   254

#if 0

   255

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

   256

/* option -> may be NULL ! */

   257

SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   258

   259

/* helper symbol for global_var_declarations */

   260

/*| global_var_decl_list global_var_decl ';' */

   261

SYM_LIST(global_var_decl_list_c)

   262

   263

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

   264

/* type_specification ->may be NULL ! */

   265

SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   266

   267

/*| global_var_name location */

   268

SYM_REF2(global_var_spec_c, global_var_name, location)

   269

   270

/*  AT direct_variable */

   271

SYM_REF2(location_c, direct_variable, unused)

   272

   273

/*| global_var_list ',' global_var_name */

   274

SYM_LIST(global_var_list_c)

   275

   276

/*  var1_list ':' single_byte_string_spec */

   277

SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   278

   279

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

   280

/* integer ->may be NULL ! */

   281

/* single_byte_character_string ->may be NULL ! */

   282

SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   283

   284

/*  var1_list ':' double_byte_string_spec */

   285

SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   286

   287

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

   288

/* integer ->may be NULL ! */

   289

/* double_byte_character_string ->may be NULL ! */

   290

SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   291

   292

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

   293

/* option ->may be NULL ! */

   294

SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)

   295

   296

/* helper symbol for incompl_located_var_declarations */

   297

/*| incompl_located_var_decl_list incompl_located_var_decl ';' */

   298

SYM_LIST(incompl_located_var_decl_list_c)

   299

   300

/*  variable_name incompl_location ':' var_spec */

   301

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

   302

   303

/*  AT incompl_location_token */

   304

SYM_TOKEN(incompl_location_c)

   305

#endif

   306

   307

   308

    void *visit(var1_init_decl_c *symbol);

   309

    void *visit(var1_list_c *symbol);

   310

    void *visit(var_init_decl_list_c *symbol);

   311

   312

   313

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

   314

    /* B 1.5.1 - Functions */

   315

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

   316

    void *visit(function_declaration_c *symbol);

   317

    /* intermediate helper symbol for function_declaration */

   318

    void *visit(var_declarations_list_c *symbol);

   319

    void *visit(function_var_decls_c *symbol);

   320

   321

   322

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

   323

    /* B 1.5.2 - Function Blocks */

   324

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

   325

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   326

    void *visit(function_block_declaration_c *symbol);

   327

   328

    /* intermediate helper symbol for function_declaration */

   329

    /*  { io_var_declarations | other_var_declarations }   */

   330

    /*

   331

     * NOTE: we re-use the var_declarations_list_c

   332

     */

   333

   334

    /*  VAR_TEMP temp_var_decl_list END_VAR */

   335

    void *visit(temp_var_decls_c *symbol);

   336

    void *visit(temp_var_decls_list_c *symbol);

   337

   338

    /*  VAR NON_RETAIN var_init_decl_list END_VAR */

   339

    void *visit(non_retentive_var_decls_c *symbol);

   340

   341

   342

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

   343

    /* B 1.5.3 - Programs */

   344

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

   345

    /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   346

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

   347

    void *visit(program_declaration_c *symbol);

   348

   349

    /* intermediate helper symbol for program_declaration_c */

   350

    /*  { io_var_declarations | other_var_declarations }   */

   351

    /*

   352

     * NOTE: we re-use the var_declarations_list_c

   353

     */

   354

   355

}; // function_param_iterator_c

   356

   357

   358

   359

   360

   361

   362