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

/* Determine the data type of a specific variable instance, including

    35

 * function block instances.

    36

 * A reference to the relevant variable declaration is returned.

    37

 * The variable instance may NOT be a member of a structure of a memeber

    38

 * of a structure of an element of an array of ...

    39

 *

    40

 * example:

    41

 *    window.points[1].coordinate.x

    42

 *    window.points[1].colour

    43

 *    etc... ARE NOT ALLOWED!

    44

 *

    45

 * This class must only be passed the name of the variable that will appear

    46

 * in the variable declaration. In the above examples, this would be

    47

 *   'window' !!

    48

 *

    49

 *

    50

 * If you need to pass a complete name of a variable instance (such as

    51

 * 'window.points[1].coordinate.x') use the search_varfb_instance_type_c instead!

    52

 */

    53

/* Note that current_type_decl that this class returns may reference the

    54

 * name of a type, or the type declaration itself!

    55

 * For an example of the first, consider a variable declared as ...

    56

 * x : AAA;

    57

 * where the AAA type is previously declared as whatever.

    58

 * For an example of the second, consider a variable declared as ...

    59

 * x : array of int [10];  ---->  is allowed

    60

 *

    61

 * If it is the first, we will return a reference to the name, if the second

    62

 * we return a reference to the declaration!!

    63

 */

    64

    65

    66

class search_var_instance_decl_c: public search_visitor_c {

    67

    68

  private:

    69

    symbol_c *search_scope;

    70

    symbol_c *search_name;

    71

    symbol_c *current_type_decl;

    72

    73

    /* variable used to store the type of variable currently being processed... */

    74

    /* Will contain a single value of generate_c_vardecl_c::XXXX_vt */

    75

    unsigned int current_vartype;

    76

    77

  public:

    78

    search_var_instance_decl_c(symbol_c *search_scope);

    79

    symbol_c *get_decl(symbol_c *variable_instance_name);

    80

    unsigned int get_vartype(void);

    81

    82

  public:

    83

    84

    /* the types of variables that need to be processed... */

    85

    static const unsigned int none_vt     = 0x0000;

    86

    static const unsigned int input_vt    = 0x0001;  // VAR_INPUT

    87

    static const unsigned int output_vt   = 0x0002;  // VAR_OUTPUT

    88

    static const unsigned int inoutput_vt = 0x0004;  // VAR_IN_OUT

    89

    static const unsigned int private_vt  = 0x0008;  // VAR

    90

    static const unsigned int temp_vt     = 0x0010;  // VAR_TEMP

    91

    static const unsigned int external_vt = 0x0020;  // VAR_EXTERNAL

    92

    static const unsigned int global_vt   = 0x0040;  // VAR_GLOBAL

    93

    static const unsigned int located_vt  = 0x0080;  // VAR <var_name> AT <location>

    94

    95

  private:

    96

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

    97

    /* B 0 - Programming Model */

    98

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

    99

    void *visit(library_c *symbol);

   100

   101

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

   102

    /* B 1.4.3 - Declaration & Initialisation */

   103

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

   104

   105

    /* edge -> The F_EDGE or R_EDGE directive */

   106

    // SYM_REF2(edge_declaration_c, edge, var1_list)

   107

    // TODO

   108

    void *visit(input_declarations_c *symbol);

   109

    /* VAR_OUTPUT [RETAIN | NON_RETAIN] var_init_decl_list END_VAR */

   110

    /* option -> may be NULL ! */

   111

    void *visit(output_declarations_c *symbol);

   112

    /*  VAR_IN_OUT var_declaration_list END_VAR */

   113

    void *visit(input_output_declarations_c *symbol);

   114

    /* ENO : BOOL */

   115

    void *visit(eno_param_declaration_c *symbol);

   116

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   117

    /* option -> may be NULL ! */

   118

    /* helper symbol for input_declarations */

   119

    void *visit(var_declarations_c *symbol);

   120

    /*  VAR RETAIN var_init_decl_list END_VAR */

   121

    void *visit(retentive_var_declarations_c *symbol);

   122

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

   123

    /* option -> may be NULL ! */

   124

    //SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   125

    void *visit(located_var_declarations_c *symbol);

   126

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   127

    /* option -> may be NULL ! */

   128

    //SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   129

    void *visit(external_var_declarations_c *symbol);

   130

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

   131

    /* option -> may be NULL ! */

   132

    //SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   133

    void *visit(global_var_declarations_c *symbol);

   134

    /* var1_list is one of the following...

   135

     *    simple_spec_init_c *

   136

     *    subrange_spec_init_c *

   137

     *    enumerated_spec_init_c *

   138

     */

   139

    // SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   140

    void *visit(var1_init_decl_c *symbol);

   141

    /* var1_list ',' variable_name */

   142

    // SYM_LIST(var1_list_c)

   143

    void *visit(var1_list_c *symbol);

   144

    /* name_list ':' function_block_type_name ASSIGN structure_initialization */

   145

    /* structure_initialization -> may be NULL ! */

   146

    void *visit(fb_name_decl_c *symbol);

   147

    /* name_list ',' fb_name */

   148

    void *visit(fb_name_list_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

    /*  var1_list ':' initialized_structure */

   153

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   154

    void *visit(structured_var_init_decl_c *symbol);

   155

    /*  var1_list ':' array_specification */

   156

    // SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   157

    void *visit(array_var_declaration_c *symbol);

   158

    /*  var1_list ':' structure_type_name */

   159

    // SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   160

    void *visit(structured_var_declaration_c *symbol);

   161

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

   162

    /* variable_name -> may be NULL ! */

   163

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

   164

    // TODO!!

   165

   166

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

   167

    // SYM_REF2(external_declaration_c, global_var_name, specification)

   168

    void *visit(external_declaration_c *symbol);

   169

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

   170

    /* type_specification ->may be NULL ! */

   171

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   172

    void *visit(global_var_decl_c *symbol);

   173

    /*| global_var_name location */

   174

    //SYM_REF2(global_var_spec_c, global_var_name, location)

   175

    void *visit(global_var_spec_c *symbol);

   176

    /*| global_var_list ',' global_var_name */

   177

    //SYM_LIST(global_var_list_c)

   178

    void *visit(global_var_list_c *symbol);

   179

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

   180

    /* variable_name -> may be NULL ! */

   181

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

   182

    void *visit(located_var_decl_c *symbol);

   183

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

   184

    /* type_specification ->may be NULL ! */

   185

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   186

    // TODO!!

   187

    /*  AT direct_variable */

   188

    // SYM_REF2(location_c, direct_variable, unused)

   189

    void *visit(location_c *symbol);

   190

    /*| global_var_list ',' global_var_name */

   191

    // SYM_LIST(global_var_list_c)

   192

    // TODO!!

   193

    /*  var1_list ':' single_byte_string_spec */

   194

    // SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   195

    void *visit(single_byte_string_var_declaration_c *symbol);

   196

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

   197

    /* integer ->may be NULL ! */

   198

    /* single_byte_character_string ->may be NULL ! */

   199

    // SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   200

    // TODO!!

   201

   202

    /*  var1_list ':' double_byte_string_spec */

   203

    // SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   204

    void *visit(double_byte_string_var_declaration_c *symbol);

   205

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

   206

    /* integer ->may be NULL ! */

   207

    /* double_byte_character_string ->may be NULL ! */

   208

    // SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   209

    // TODO!!

   210

   211

    /*  variable_name incompl_location ':' var_spec */

   212

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

   213

    // TODO!!

   214

   215

    /*  AT incompl_location_token */

   216

    // SYM_TOKEN(incompl_location_c)

   217

    // TODO!!

   218

   219

   220

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

   221

    /* B.1.5 - Program organization units */

   222

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

   223

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

   224

    /* B 1.5.1 - Functions */

   225

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

   226

    // SYM_REF4(function_declaration_c, derived_function_name, type_name, var_declarations_list, function_body)

   227

    void *visit(function_declaration_c *symbol);

   228

   229

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

   230

    /* B 1.5.2 - Function Blocks */

   231

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

   232

    void *visit(function_block_declaration_c *symbol);

   233

   234

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

   235

    /* B 1.5.3 - Programs */

   236

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

   237

    void *visit(program_declaration_c *symbol);

   238

   239

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

   240

    /* B 1.7 Configuration elements */

   241

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

   242

   243

    /*

   244

    CONFIGURATION configuration_name

   245

       optional_global_var_declarations

   246

       (resource_declaration_list | single_resource_declaration)

   247

       optional_access_declarations

   248

       optional_instance_specific_initializations

   249

    END_CONFIGURATION

   250

    */

   251

    /*

   252

    SYM_REF6(configuration_declaration_c, configuration_name, global_var_declarations, resource_declarations, access_declarations, instance_specific_initializations, unused)

   253

    */                                                                                                            

   254

    void *visit(configuration_declaration_c *symbol);

   255

    /*

   256

    RESOURCE resource_name ON resource_type_name

   257

       optional_global_var_declarations

   258

       single_resource_declaration

   259

    END_RESOURCE

   260

    */

   261

    // SYM_REF4(resource_declaration_c, resource_name, resource_type_name, global_var_declarations, resource_declaration)

   262

    void *visit(resource_declaration_c *symbol);

   263

   264

    /* task_configuration_list program_configuration_list */

   265

    // SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   266

    void *visit(single_resource_declaration_c *symbol);

   267

   268

#if 0

   269

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

   270

/* B 1.4 - Variables */

   271

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

   272

SYM_REF2(symbolic_variable_c, var_name, unused)

   273

   274

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

   275

/* B.1.4.1   Directly Represented Variables */

   276

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

   277

SYM_TOKEN(direct_variable_c)

   278

   279

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

   280

/* B.1.4.2   Multi-element Variables */

   281

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

   282

/*  subscripted_variable '[' subscript_list ']' */

   283

SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   284

   285

/* subscript_list ',' subscript */

   286

SYM_LIST(subscript_list_c)

   287

   288

/*  record_variable '.' field_selector */

   289

/*  WARNING: input and/or output variables of function blocks

   290

 *           may be accessed as fields of a tructured variable!

   291

 *           Code handling a structured_variable_c must take

   292

 *           this into account!

   293

 */

   294

SYM_REF2(structured_variable_c, record_variable, field_selector)

   295

#endif

   296

   297

}; // search_var_instance_decl_c

   298