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

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

    27

 * function block instances.

    28

 * A reference to the relevant variable declaration is returned.

    29

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

    30

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

    31

 *

    32

 * example:

    33

 *    window.points[1].coordinate.x

    34

 *    window.points[1].colour

    35

 *    etc... ARE NOT ALLOWED!

    36

 *

    37

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

    38

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

    39

 *   'window' !!

    40

 *

    41

 *

    42

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

    43

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

    44

 */

    45

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

    46

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

    47

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

    48

 * x : AAA;

    49

 * where the AAA type is previously declared as whatever.

    50

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

    51

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

    52

 *

    53

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

    54

 * we return a reference to the declaration!!

    55

 */

    56

    57

    58

class search_var_instance_decl_c: public search_visitor_c {

    59

    60

  private:

    61

    symbol_c *search_scope;

    62

    symbol_c *search_name;

    63

    symbol_c *current_type_decl;

    64

    65

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

    66

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

    67

    unsigned int current_vartype;

    68

    69

  public:

    70

    search_var_instance_decl_c(symbol_c *search_scope);

    71

    symbol_c *get_decl(symbol_c *variable_instance_name);

    72

    unsigned int get_vartype();

    73

    74

  public:

    75

    76

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

    77

    static const unsigned int none_vt     = 0x0000;

    78

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

    79

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

    80

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

    81

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

    82

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

    83

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

    84

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

    85

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

    86

    87

  private:

    88

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

    89

    /* B 0 - Programming Model */

    90

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

    91

    void *visit(library_c *symbol);

    92

    93

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

    94

    /* B 1.4.3 - Declaration & Initialisation */

    95

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

    96

    97

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

    98

    // SYM_REF2(edge_declaration_c, edge, var1_list)

    99

    // TODO

   100

    void *visit(input_declarations_c *symbol);

   101

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

   102

    /* option -> may be NULL ! */

   103

    void *visit(output_declarations_c *symbol);

   104

    /*  VAR_IN_OUT var_declaration_list END_VAR */

   105

    void *visit(input_output_declarations_c *symbol);

   106

    /* ENO : BOOL */

   107

    void *visit(eno_param_declaration_c *symbol);

   108

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   109

    /* option -> may be NULL ! */

   110

    /* helper symbol for input_declarations */

   111

    void *visit(var_declarations_c *symbol);

   112

    /*  VAR RETAIN var_init_decl_list END_VAR */

   113

    void *visit(retentive_var_declarations_c *symbol);

   114

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

   115

    /* option -> may be NULL ! */

   116

    //SYM_REF2(located_var_declarations_c, option, located_var_decl_list)

   117

    void *visit(located_var_declarations_c *symbol);

   118

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   119

    /* option -> may be NULL ! */

   120

    //SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   121

    void *visit(external_var_declarations_c *symbol);

   122

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

   123

    /* option -> may be NULL ! */

   124

    //SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   125

    void *visit(global_var_declarations_c *symbol);

   126

    /* var1_list is one of the following...

   127

     *    simple_spec_init_c *

   128

     *    subrange_spec_init_c *

   129

     *    enumerated_spec_init_c *

   130

     */

   131

    // SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   132

    void *visit(var1_init_decl_c *symbol);

   133

    /* var1_list ',' variable_name */

   134

    // SYM_LIST(var1_list_c)

   135

    void *visit(var1_list_c *symbol);

   136

    /* name_list ':' function_block_type_name ASSIGN structure_initialization */

   137

    /* structure_initialization -> may be NULL ! */

   138

    void *visit(fb_name_decl_c *symbol);

   139

    /* name_list ',' fb_name */

   140

    void *visit(fb_name_list_c *symbol);

   141

    /* var1_list ':' array_spec_init */

   142

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   143

    void *visit(array_var_init_decl_c *symbol);

   144

    /*  var1_list ':' initialized_structure */

   145

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   146

    void *visit(structured_var_init_decl_c *symbol);

   147

    /*  var1_list ':' array_specification */

   148

    // SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   149

    void *visit(array_var_declaration_c *symbol);

   150

    /*  var1_list ':' structure_type_name */

   151

    // SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   152

    void *visit(structured_var_declaration_c *symbol);

   153

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

   154

    /* variable_name -> may be NULL ! */

   155

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

   156

    // TODO!!

   157

   158

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

   159

    // SYM_REF2(external_declaration_c, global_var_name, specification)

   160

    void *visit(external_declaration_c *symbol);

   161

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

   162

    /* type_specification ->may be NULL ! */

   163

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   164

    void *visit(global_var_decl_c *symbol);

   165

    /*| global_var_name location */

   166

    //SYM_REF2(global_var_spec_c, global_var_name, location)

   167

    void *visit(global_var_spec_c *symbol);

   168

    /*| global_var_list ',' global_var_name */

   169

    //SYM_LIST(global_var_list_c)

   170

    void *visit(global_var_list_c *symbol);

   171

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

   172

    /* variable_name -> may be NULL ! */

   173

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

   174

    void *visit(located_var_decl_c *symbol);

   175

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

   176

    /* type_specification ->may be NULL ! */

   177

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   178

    // TODO!!

   179

    /*  AT direct_variable */

   180

    // SYM_REF2(location_c, direct_variable, unused)

   181

    void *visit(location_c *symbol);

   182

    /*| global_var_list ',' global_var_name */

   183

    // SYM_LIST(global_var_list_c)

   184

    // TODO!!

   185

    /*  var1_list ':' single_byte_string_spec */

   186

    // SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   187

    void *visit(single_byte_string_var_declaration_c *symbol);

   188

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

   189

    /* integer ->may be NULL ! */

   190

    /* single_byte_character_string ->may be NULL ! */

   191

    // SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   192

    // TODO!!

   193

   194

    /*  var1_list ':' double_byte_string_spec */

   195

    // SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   196

    void *visit(double_byte_string_var_declaration_c *symbol);

   197

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

   198

    /* integer ->may be NULL ! */

   199

    /* double_byte_character_string ->may be NULL ! */

   200

    // SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   201

    // TODO!!

   202

   203

    /*  variable_name incompl_location ':' var_spec */

   204

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

   205

    // TODO!!

   206

   207

    /*  AT incompl_location_token */

   208

    // SYM_TOKEN(incompl_location_c)

   209

    // TODO!!

   210

   211

   212

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

   213

    /* B.1.5 - Program organization units */

   214

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

   215

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

   216

    /* B 1.5.1 - Functions */

   217

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

   218

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

   219

    void *visit(function_declaration_c *symbol);

   220

   221

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

   222

    /* B 1.5.2 - Function Blocks */

   223

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

   224

    void *visit(function_block_declaration_c *symbol);

   225

   226

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

   227

    /* B 1.5.3 - Programs */

   228

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

   229

    void *visit(program_declaration_c *symbol);

   230

   231

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

   232

    /* B 1.7 Configuration elements */

   233

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

   234

   235

    /*

   236

    CONFIGURATION configuration_name

   237

       optional_global_var_declarations

   238

       (resource_declaration_list | single_resource_declaration)

   239

       optional_access_declarations

   240

       optional_instance_specific_initializations

   241

    END_CONFIGURATION

   242

    */

   243

    /*

   244

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

   245

    */                                                                                                            

   246

    void *visit(configuration_declaration_c *symbol);

   247

    /*

   248

    RESOURCE resource_name ON resource_type_name

   249

       optional_global_var_declarations

   250

       single_resource_declaration

   251

    END_RESOURCE

   252

    */

   253

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

   254

    void *visit(resource_declaration_c *symbol);

   255

   256

    /* task_configuration_list program_configuration_list */

   257

    // SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   258

    void *visit(single_resource_declaration_c *symbol);

   259

   260

#if 0

   261

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

   262

/* B 1.4 - Variables */

   263

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

   264

SYM_REF2(symbolic_variable_c, var_name, unused)

   265

   266

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

   267

/* B.1.4.1   Directly Represented Variables */

   268

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

   269

SYM_TOKEN(direct_variable_c)

   270

   271

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

   272

/* B.1.4.2   Multi-element Variables */

   273

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

   274

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

   275

SYM_REF2(array_variable_c, subscripted_variable, subscript_list)

   276

   277

/* subscript_list ',' subscript */

   278

SYM_LIST(subscript_list_c)

   279

   280

/*  record_variable '.' field_selector */

   281

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

   282

 *           may be accessed as fields of a tructured variable!

   283

 *           Code handling a structured_variable_c must take

   284

 *           this into account!

   285

 */

   286

SYM_REF2(structured_variable_c, record_variable, field_selector)

   287

#endif

   288

   289

}; // search_var_instance_decl_c

   290