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

/* Given a function_declaration_c, iterate through each

    37

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

    38

 * of each parameter...function_param_iterator_c

    39

 */

    40

    41

    42

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

    43

    44

    45

class function_param_iterator_c : public null_visitor_c {

    46

  public:

    47

    /* A type to specify the type of parameter.

    48

     * VAR_INPUT => direction_in

    49

     * VAR_OUTPUT => direction_out

    50

     * VAR_IN_OUT => direction_inout

    51

     * VAR_EXTERNAL => direction_extref

    52

     *

    53

     * Note that VAR_EXTERNAL declares variables that are in reality references

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

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

    62

     * for a specific instance.

    63

     *

    64

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

    65

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

    66

     * be used to identify these parameters!

    67

     */

    68

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

    69

    70

    71

  private:

    72

    /* a pointer to the function_block_declaration_c

    73

    * or function_declaration_c currently being analysed.

    74

    */

    75

    symbol_c *f_decl;

    76

    int next_param, param_count;

    77

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

    78

    identifier_c *search_param_name;

    79

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

    80

    identifier_c *current_param_name;

    81

    symbol_c *current_param_type;

    82

    symbol_c *current_param_default_value;

    83

    param_direction_t current_param_direction;

    84

    bool en_eno_param_implicit;

    85

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

    86

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

    87

     */

    88

    typedef enum {iterate_op, search_op} operation_t;

    89

    operation_t current_operation;

    90

    91

  private:

    92

    void* handle_param_list(list_c *list);

    93

    void* handle_single_param(symbol_c *var_name);

    94

    95

    void* iterate_list(list_c *list);

    96

    97

  public:

    98

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

    99

    void reset(void);

   100

   101

    /* initialise the iterator object.

   102

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

   103

     *     - function_declaration_c

   104

     *     - function_block_declaration_c

   105

     *     - program_declaration_c

   106

     * that will be analysed...

   107

     */

   108

    function_param_iterator_c(symbol_c *pou_decl);

   109

   110

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

   111

     * the object references on parameter _before_ the first, so

   112

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

   113

     * reference the first parameter...

   114

     *

   115

     * Returns the parameter's name!

   116

     */

   117

    identifier_c *next(void);

   118

   119

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

   120

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

   121

     * to the iterate() function.

   122

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

   123

     * return the param_type() and default_value() of the found parameter.

   124

     */

   125

    identifier_c *search(symbol_c *param_name);

   126

   127

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

   128

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

   129

     */

   130

    symbol_c *default_value(void);

   131

   132

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

   133

    symbol_c *param_type(void);

   134

   135

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

   136

    bool is_en_eno_param_implicit(void);

   137

   138

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

   139

     * i.e. VAR_INPUT, VAR_OUTPUT or VAR_INOUT

   140

     */

   141

    param_direction_t param_direction(void);

   142

   143

    private:

   144

    void *visit(implicit_definition_c *symbol);

   145

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

   146

    /* B 1.4.3 - Declaration & Initialisation */

   147

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

   148

    void *visit(input_declarations_c *symbol);

   149

   150

    void *visit(input_declaration_list_c *symbol);

   151

   152

    void *visit(edge_declaration_c *symbol);

   153

    void *visit(en_param_declaration_c *symbol);

   154

    /* var1_list ':' array_spec_init */

   155

    //SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   156

    void *visit(array_var_init_decl_c *symbol);

   157

   158

    /*  var1_list ':' initialized_structure */

   159

    //SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   160

    void *visit(structured_var_init_decl_c *symbol);

   161

   162

#if 0

   163

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   164

/* structure_initialization -> may be NULL ! */

   165

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

   166

   167

/* name_list ',' fb_name */

   168

SYM_LIST(fb_name_list_c)

   169

#endif

   170

   171

    void *visit(output_declarations_c *symbol);

   172

    void *visit(eno_param_declaration_c *symbol);

   173

    void *visit(input_output_declarations_c *symbol);

   174

    void *visit(var_declaration_list_c *symbol);

   175

   176

   177

    /*  var1_list ':' array_specification */

   178

    //SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   179

    void *visit(array_var_declaration_c *symbol);

   180

   181

    /*  var1_list ':' structure_type_name */

   182

    //SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   183

    void *visit(structured_var_declaration_c *symbol);

   184

   185

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   186

    void *visit(var_declarations_c *symbol);

   187

   188

#if 0

   189

/*  VAR RETAIN var_init_decl_list END_VAR */

   190

SYM_REF2(retentive_var_declarations_c, var_init_decl_list, unused)

   191

   192

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

   193

/* option -> may be NULL ! */

   194

SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   195

   196

/* helper symbol for located_var_declarations */

   197

/* located_var_decl_list located_var_decl ';' */

   198

SYM_LIST(located_var_decl_list_c)

   199

   200

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

   201

/* variable_name -> may be NULL ! */

   202

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

   203

#endif

   204

   205

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   206

    /* option -> may be NULL ! */

   207

    // SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   208

    void *visit(external_var_declarations_c *symbol);

   209

   210

    /* helper symbol for external_var_declarations */

   211

    /*| external_declaration_list external_declaration';' */

   212

    // SYM_LIST(external_declaration_list_c)

   213

    void *visit(external_declaration_list_c *symbol);

   214

   215

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

   216

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   217

    void *visit(external_declaration_c *symbol);

   218

   219

   220

#if 0

   221

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

   222

/* option -> may be NULL ! */

   223

SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   224

   225

/* helper symbol for global_var_declarations */

   226

/*| global_var_decl_list global_var_decl ';' */

   227

SYM_LIST(global_var_decl_list_c)

   228

   229

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

   230

/* type_specification ->may be NULL ! */

   231

SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   232

   233

/*| global_var_name location */

   234

SYM_REF2(global_var_spec_c, global_var_name, location)

   235

   236

/*  AT direct_variable */

   237

SYM_REF2(location_c, direct_variable, unused)

   238

   239

/*| global_var_list ',' global_var_name */

   240

SYM_LIST(global_var_list_c)

   241

   242

/*  var1_list ':' single_byte_string_spec */

   243

SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   244

   245

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

   246

/* integer ->may be NULL ! */

   247

/* single_byte_character_string ->may be NULL ! */

   248

SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   249

   250

/*  var1_list ':' double_byte_string_spec */

   251

SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   252

   253

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

   254

/* integer ->may be NULL ! */

   255

/* double_byte_character_string ->may be NULL ! */

   256

SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   257

   258

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

   259

/* option ->may be NULL ! */

   260

SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)

   261

   262

/* helper symbol for incompl_located_var_declarations */

   263

/*| incompl_located_var_decl_list incompl_located_var_decl ';' */

   264

SYM_LIST(incompl_located_var_decl_list_c)

   265

   266

/*  variable_name incompl_location ':' var_spec */

   267

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

   268

   269

/*  AT incompl_location_token */

   270

SYM_TOKEN(incompl_location_c)

   271

#endif

   272

   273

   274

    void *visit(var1_init_decl_c *symbol);

   275

    void *visit(var1_list_c *symbol);

   276

    void *visit(var_init_decl_list_c *symbol);

   277

   278

   279

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

   280

    /* B 1.5.1 - Functions */

   281

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

   282

    void *visit(function_declaration_c *symbol);

   283

    /* intermediate helper symbol for function_declaration */

   284

    void *visit(var_declarations_list_c *symbol);

   285

    void *visit(function_var_decls_c *symbol);

   286

   287

   288

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

   289

    /* B 1.5.2 - Function Blocks */

   290

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

   291

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   292

    void *visit(function_block_declaration_c *symbol);

   293

   294

    /* intermediate helper symbol for function_declaration */

   295

    /*  { io_var_declarations | other_var_declarations }   */

   296

    /*

   297

     * NOTE: we re-use the var_declarations_list_c

   298

     */

   299

   300

    /*  VAR_TEMP temp_var_decl_list END_VAR */

   301

    void *visit(temp_var_decls_c *symbol);

   302

    void *visit(temp_var_decls_list_c *symbol);

   303

   304

    /*  VAR NON_RETAIN var_init_decl_list END_VAR */

   305

    void *visit(non_retentive_var_decls_c *symbol);

   306

   307

   308

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

   309

    /* B 1.5.3 - Programs */

   310

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

   311

    /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   312

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

   313

    void *visit(program_declaration_c *symbol);

   314

   315

    /* intermediate helper symbol for program_declaration_c */

   316

    /*  { io_var_declarations | other_var_declarations }   */

   317

    /*

   318

     * NOTE: we re-use the var_declarations_list_c

   319

     */

   320

   321

}; // function_param_iterator_c

   322

   323

   324

   325

   326

   327

   328