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

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

    85

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

    86

     */

    87

    typedef enum {iterate_op, search_op} operation_t;

    88

    operation_t current_operation;

    89

    90

  private:

    91

    void* handle_param_list(list_c *list);

    92

    void* handle_single_param(symbol_c *var_name);

    93

    94

    void* iterate_list(list_c *list);

    95

    96

  public:

    97

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

    98

    void reset(void);

    99

   100

    /* initialise the iterator object.

   101

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

   102

     *     - function_declaration_c

   103

     *     - function_block_declaration_c

   104

     *     - program_declaration_c

   105

     * that will be analysed...

   106

     */

   107

    function_param_iterator_c(symbol_c *pou_decl);

   108

   109

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

   110

     * the object references on parameter _before_ the first, so

   111

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

   112

     * reference the first parameter...

   113

     *

   114

     * Returns the parameter's name!

   115

     */

   116

    identifier_c *next(void);

   117

   118

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

   119

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

   120

     * to the iterate() function.

   121

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

   122

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

   123

     */

   124

    identifier_c *search(symbol_c *param_name);

   125

   126

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

   127

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

   128

     */

   129

    symbol_c *default_value(void);

   130

   131

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

   132

    symbol_c *param_type(void);

   133

   134

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

   135

     * i.e. VAR_INPUT, VAR_OUTPUT or VAR_INOUT

   136

     */

   137

    param_direction_t param_direction(void);

   138

   139

    private:

   140

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

   141

    /* B 1.4.3 - Declaration & Initialisation */

   142

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

   143

    void *visit(input_declarations_c *symbol);

   144

   145

    void *visit(input_declaration_list_c *symbol);

   146

   147

    void *visit(edge_declaration_c *symbol);

   148

    void *visit(en_param_declaration_c *symbol);

   149

    /* var1_list ':' array_spec_init */

   150

    //SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   151

    void *visit(array_var_init_decl_c *symbol);

   152

   153

    /*  var1_list ':' initialized_structure */

   154

    //SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   155

    void *visit(structured_var_init_decl_c *symbol);

   156

   157

#if 0

   158

/* name_list ':' function_block_type_name ASSIGN structure_initialization */

   159

/* structure_initialization -> may be NULL ! */

   160

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

   161

   162

/* name_list ',' fb_name */

   163

SYM_LIST(fb_name_list_c)

   164

#endif

   165

   166

    void *visit(output_declarations_c *symbol);

   167

    void *visit(eno_param_declaration_c *symbol);

   168

    void *visit(input_output_declarations_c *symbol);

   169

    void *visit(var_declaration_list_c *symbol);

   170

   171

   172

    /*  var1_list ':' array_specification */

   173

    //SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   174

    void *visit(array_var_declaration_c *symbol);

   175

   176

    /*  var1_list ':' structure_type_name */

   177

    //SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   178

    void *visit(structured_var_declaration_c *symbol);

   179

   180

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   181

    void *visit(var_declarations_c *symbol);

   182

   183

#if 0

   184

/*  VAR RETAIN var_init_decl_list END_VAR */

   185

SYM_REF2(retentive_var_declarations_c, var_init_decl_list, unused)

   186

   187

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

   188

/* option -> may be NULL ! */

   189

SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   190

   191

/* helper symbol for located_var_declarations */

   192

/* located_var_decl_list located_var_decl ';' */

   193

SYM_LIST(located_var_decl_list_c)

   194

   195

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

   196

/* variable_name -> may be NULL ! */

   197

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

   198

#endif

   199

   200

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   201

    /* option -> may be NULL ! */

   202

    // SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   203

    void *visit(external_var_declarations_c *symbol);

   204

   205

    /* helper symbol for external_var_declarations */

   206

    /*| external_declaration_list external_declaration';' */

   207

    // SYM_LIST(external_declaration_list_c)

   208

    void *visit(external_declaration_list_c *symbol);

   209

   210

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

   211

    //SYM_REF2(external_declaration_c, global_var_name, specification)

   212

    void *visit(external_declaration_c *symbol);

   213

   214

   215

#if 0

   216

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

   217

/* option -> may be NULL ! */

   218

SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   219

   220

/* helper symbol for global_var_declarations */

   221

/*| global_var_decl_list global_var_decl ';' */

   222

SYM_LIST(global_var_decl_list_c)

   223

   224

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

   225

/* type_specification ->may be NULL ! */

   226

SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   227

   228

/*| global_var_name location */

   229

SYM_REF2(global_var_spec_c, global_var_name, location)

   230

   231

/*  AT direct_variable */

   232

SYM_REF2(location_c, direct_variable, unused)

   233

   234

/*| global_var_list ',' global_var_name */

   235

SYM_LIST(global_var_list_c)

   236

   237

/*  var1_list ':' single_byte_string_spec */

   238

SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   239

   240

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

   241

/* integer ->may be NULL ! */

   242

/* single_byte_character_string ->may be NULL ! */

   243

SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   244

   245

/*  var1_list ':' double_byte_string_spec */

   246

SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   247

   248

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

   249

/* integer ->may be NULL ! */

   250

/* double_byte_character_string ->may be NULL ! */

   251

SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   252

   253

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

   254

/* option ->may be NULL ! */

   255

SYM_REF2(incompl_located_var_declarations_c, option, incompl_located_var_decl_list)

   256

   257

/* helper symbol for incompl_located_var_declarations */

   258

/*| incompl_located_var_decl_list incompl_located_var_decl ';' */

   259

SYM_LIST(incompl_located_var_decl_list_c)

   260

   261

/*  variable_name incompl_location ':' var_spec */

   262

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

   263

   264

/*  AT incompl_location_token */

   265

SYM_TOKEN(incompl_location_c)

   266

#endif

   267

   268

   269

    void *visit(var1_init_decl_c *symbol);

   270

    void *visit(var1_list_c *symbol);

   271

    void *visit(var_init_decl_list_c *symbol);

   272

   273

   274

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

   275

    /* B 1.5.1 - Functions */

   276

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

   277

    void *visit(function_declaration_c *symbol);

   278

    /* intermediate helper symbol for function_declaration */

   279

    void *visit(var_declarations_list_c *symbol);

   280

    void *visit(function_var_decls_c *symbol);

   281

   282

   283

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

   284

    /* B 1.5.2 - Function Blocks */

   285

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

   286

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   287

    void *visit(function_block_declaration_c *symbol);

   288

   289

    /* intermediate helper symbol for function_declaration */

   290

    /*  { io_var_declarations | other_var_declarations }   */

   291

    /*

   292

     * NOTE: we re-use the var_declarations_list_c

   293

     */

   294

   295

    /*  VAR_TEMP temp_var_decl_list END_VAR */

   296

    void *visit(temp_var_decls_c *symbol);

   297

    void *visit(temp_var_decls_list_c *symbol);

   298

   299

    /*  VAR NON_RETAIN var_init_decl_list END_VAR */

   300

    void *visit(non_retentive_var_decls_c *symbol);

   301

   302

   303

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

   304

    /* B 1.5.3 - Programs */

   305

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

   306

    /*  PROGRAM program_type_name program_var_declarations_list function_block_body END_PROGRAM */

   307

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

   308

    void *visit(program_declaration_c *symbol);

   309

   310

    /* intermediate helper symbol for program_declaration_c */

   311

    /*  { io_var_declarations | other_var_declarations }   */

   312

    /*

   313

     * NOTE: we re-use the var_declarations_list_c

   314

     */

   315

   316

}; // function_param_iterator_c

   317

   318

   319

   320

   321

   322

   323