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

/* Search in a VAR* END_VAR declaration for the delcration of the specified variable instance. 

    35

 * Will return:

    36

 *     - the declaration itself (get_decl() )

    37

 *     - the type of declaration in which the variable was declared (get_vartype() )

    38

 *

    39

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

    40

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

    41

 *

    42

 * For example, considering the following 'variables':

    43

 *    window.points[1].coordinate.x

    44

 *    window.points[1].colour

    45

 *    offset[99]

    46

 *

    47

 *   passing a reference to 'points', 'points[1]', 'points[1].colour', 'colour'

    48

 *    ARE NOT ALLOWED!

    49

 *

    50

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

    51

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

    52

 *   'window.points[1].coordinate.x'

    53

 *   'window.points[1].coordinate'

    54

 *   'window.points[1]'

    55

 *   'window'

    56

 *   'window.points[1].colour'

    57

 *   'offset'

    58

 *   'offset[99]'

    59

 *

    60

 *

    61

 */

    62

    63

/* Note: 

    64

 * Determining the declaration type of a specific variable instance (including

    65

 * function block instances) really means determining whether the variable was declared in a

    66

 *  VAR_INPUT

    67

 *  VAR_OUTPUT

    68

 *  VAR_IN_OUT

    69

 *  VAR

    70

 *  VAR_TEMP

    71

 *  VAR_EXTERNAL

    72

 *  VAR_GLOBAL

    73

 *  VAR <var_name> AT <location>   -> Located variable!

    74

 * 

    75

 */

    76

    77

/* Note:

    78

 *  The current_type_decl that this class returns may reference the

    79

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

    80

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

    81

 * x : AAA;

    82

 * where the AAA type is previously declared as whatever.

    83

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

    84

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

    85

 *

    86

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

    87

 * we return a reference to the declaration!!

    88

 */

    89

    90

    91

class search_var_instance_decl_c: public search_visitor_c {

    92

    93

  public:

    94

    search_var_instance_decl_c(symbol_c *search_scope);

    95

    96

  public:

    97

    typedef enum {

    98

        input_vt   ,  // VAR_INPUT

    99

        output_vt  ,  // VAR_OUTPUT

   100

        inoutput_vt,  // VAR_IN_OUT

   101

        private_vt ,  // VAR

   102

        temp_vt    ,  // VAR_TEMP

   103

        external_vt,  // VAR_EXTERNAL

   104

        global_vt  ,  // VAR_GLOBAL

   105

        located_vt ,   // VAR <var_name> AT <location>

   106

        none_vt

   107

      } vt_t;

   108

   109

    typedef enum {

   110

        constant_opt  ,

   111

        retain_opt    ,

   112

        non_retain_opt,

   113

        none_opt

   114

      } opt_t;

   115

#if 0        

   116

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

   117

    static const unsigned int none_vt     = 0x0000;

   118

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

   119

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

   120

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

   121

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

   122

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

   123

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

   124

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

   125

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

   126

   127

    static const unsigned int none_opt        = 0x0000;

   128

    static const unsigned int constant_opt    = 0x0001;

   129

    static const unsigned int retain_opt      = 0x0002;

   130

    static const unsigned int non_retain_opt  = 0x0003;

   131

#endif    

   132

   133

    symbol_c *   get_decl   (symbol_c *variable_instance_name); 

   134

    vt_t         get_vartype(symbol_c *variable_instance_name);

   135

    opt_t        get_option (symbol_c *variable_instance_name);

   136

   137

    /* NOTE: The following function will be completely deleted in the (hopefully near) future. */

   138

    /* Returns true if the variable is an ARRAY or a STRUCT, otherwise returns false.

   139

     * Note that for FB, also returns false!

   140

     */

   141

    bool type_is_complex(symbol_c *variable_name);

   142

   143

   144

   145

  private:

   146

    symbol_c *search_scope;

   147

    symbol_c *search_name;

   148

    symbol_c *current_type_decl;

   149

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

   150

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

   151

    vt_t  current_vartype;

   152

    opt_t current_option;

   153

   154

   155

  private:

   156

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

   157

    /* B 0 - Programming Model */

   158

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

   159

    void *visit(library_c *symbol);

   160

   161

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

   162

    /* B 1.4.3 - Declaration & Initialisation */

   163

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

   164

   165

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

   166

    // SYM_REF2(edge_declaration_c, edge, var1_list)

   167

    // TODO

   168

    void *visit(constant_option_c *symbol);

   169

    void *visit(retain_option_c *symbol);

   170

    void *visit(non_retain_option_c *symbol);

   171

   172

   173

    void *visit(input_declarations_c *symbol);

   174

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

   175

    /* option -> may be NULL ! */

   176

    void *visit(output_declarations_c *symbol);

   177

    /*  VAR_IN_OUT var_declaration_list END_VAR */

   178

    void *visit(input_output_declarations_c *symbol);

   179

    /* ENO : BOOL */

   180

    void *visit(eno_param_declaration_c *symbol);

   181

    /* VAR [CONSTANT] var_init_decl_list END_VAR */

   182

    /* option -> may be NULL ! */

   183

    /* helper symbol for input_declarations */

   184

    void *visit(var_declarations_c *symbol);

   185

    /*  VAR RETAIN var_init_decl_list END_VAR */

   186

    void *visit(retentive_var_declarations_c *symbol);

   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

    void *visit(located_var_declarations_c *symbol);

   191

    /*| VAR_EXTERNAL [CONSTANT] external_declaration_list END_VAR */

   192

    /* option -> may be NULL ! */

   193

    //SYM_REF2(external_var_declarations_c, option, external_declaration_list)

   194

    void *visit(external_var_declarations_c *symbol);

   195

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

   196

    /* option -> may be NULL ! */

   197

    //SYM_REF2(global_var_declarations_c, option, global_var_decl_list)

   198

    void *visit(global_var_declarations_c *symbol);

   199

    /* var1_list is one of the following...

   200

     *    simple_spec_init_c *

   201

     *    subrange_spec_init_c *

   202

     *    enumerated_spec_init_c *

   203

     */

   204

    // SYM_REF2(var1_init_decl_c, var1_list, spec_init)

   205

    void *visit(var1_init_decl_c *symbol);

   206

    /* var1_list ',' variable_name */

   207

    // SYM_LIST(var1_list_c)

   208

    void *visit(var1_list_c *symbol);

   209

    /* name_list ':' function_block_type_name ASSIGN structure_initialization */

   210

    /* structure_initialization -> may be NULL ! */

   211

    void *visit(fb_name_decl_c *symbol);

   212

    /* name_list ',' fb_name */

   213

    void *visit(fb_name_list_c *symbol);

   214

    /* var1_list ':' array_spec_init */

   215

    // SYM_REF2(array_var_init_decl_c, var1_list, array_spec_init)

   216

    void *visit(array_var_init_decl_c *symbol);

   217

    /*  var1_list ':' initialized_structure */

   218

    // SYM_REF2(structured_var_init_decl_c, var1_list, initialized_structure)

   219

    void *visit(structured_var_init_decl_c *symbol);

   220

    /*  var1_list ':' array_specification */

   221

    // SYM_REF2(array_var_declaration_c, var1_list, array_specification)

   222

    void *visit(array_var_declaration_c *symbol);

   223

    /*  var1_list ':' structure_type_name */

   224

    // SYM_REF2(structured_var_declaration_c, var1_list, structure_type_name)

   225

    void *visit(structured_var_declaration_c *symbol);

   226

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

   227

    /* variable_name -> may be NULL ! */

   228

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

   229

    // TODO!!

   230

   231

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

   232

    // SYM_REF2(external_declaration_c, global_var_name, specification)

   233

    void *visit(external_declaration_c *symbol);

   234

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

   235

    /* type_specification ->may be NULL ! */

   236

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   237

    void *visit(global_var_decl_c *symbol);

   238

    /*| global_var_name location */

   239

    //SYM_REF2(global_var_spec_c, global_var_name, location)

   240

    void *visit(global_var_spec_c *symbol);

   241

    /*| global_var_list ',' global_var_name */

   242

    //SYM_LIST(global_var_list_c)

   243

    void *visit(global_var_list_c *symbol);

   244

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

   245

    /* variable_name -> may be NULL ! */

   246

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

   247

    void *visit(located_var_decl_c *symbol);

   248

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

   249

    /* type_specification ->may be NULL ! */

   250

    // SYM_REF2(global_var_decl_c, global_var_spec, type_specification)

   251

    // TODO!!

   252

    /*  AT direct_variable */

   253

    // SYM_REF2(location_c, direct_variable, unused)

   254

    void *visit(location_c *symbol);

   255

    /*| global_var_list ',' global_var_name */

   256

    // SYM_LIST(global_var_list_c)

   257

    // TODO!!

   258

    /*  var1_list ':' single_byte_string_spec */

   259

    // SYM_REF2(single_byte_string_var_declaration_c, var1_list, single_byte_string_spec)

   260

    void *visit(single_byte_string_var_declaration_c *symbol);

   261

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

   262

    /* integer ->may be NULL ! */

   263

    /* single_byte_character_string ->may be NULL ! */

   264

    // SYM_REF2(single_byte_string_spec_c, integer, single_byte_character_string)

   265

    // TODO!!

   266

   267

    /*  var1_list ':' double_byte_string_spec */

   268

    // SYM_REF2(double_byte_string_var_declaration_c, var1_list, double_byte_string_spec)

   269

    void *visit(double_byte_string_var_declaration_c *symbol);

   270

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

   271

    /* integer ->may be NULL ! */

   272

    /* double_byte_character_string ->may be NULL ! */

   273

    // SYM_REF2(double_byte_string_spec_c, integer, double_byte_character_string)

   274

    // TODO!!

   275

   276

    /*  variable_name incompl_location ':' var_spec */

   277

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

   278

    // TODO!!

   279

   280

    /*  AT incompl_location_token */

   281

    // SYM_TOKEN(incompl_location_c)

   282

    // TODO!!

   283

   284

   285

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

   286

    /* B.1.5 - Program organization units */

   287

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

   288

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

   289

    /* B 1.5.1 - Functions */

   290

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

   291

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

   292

    void *visit(function_declaration_c *symbol);

   293

   294

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

   295

    /* B 1.5.2 - Function Blocks */

   296

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

   297

    void *visit(function_block_declaration_c *symbol);

   298

   299

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

   300

    /* B 1.5.3 - Programs */

   301

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

   302

    void *visit(program_declaration_c *symbol);

   303

   304

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

   305

    /* B.1.6  Sequential function chart elements */

   306

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

   307

    /* | sequential_function_chart sfc_network */

   308

    // SYM_LIST(sequential_function_chart_c)

   309

    /* search_var_instance_decl_c inherits from serach_visitor_c, so no need to implement the following method. */

   310

    // void *visit(sequential_function_chart_c *symbol);

   311

   312

    /* initial_step {step | transition | action} */

   313

    // SYM_LIST(sfc_network_c)

   314

    /* search_var_instance_decl_c inherits from serach_visitor_c, so no need to implement the following method. */

   315

    // void *visit(sfc_network_c *symbol);

   316

   317

   318

    /* INITIAL_STEP step_name ':' action_association_list END_STEP */

   319

    // SYM_REF2(initial_step_c, step_name, action_association_list)

   320

    void *visit(initial_step_c *symbol);

   321

   322

    /* STEP step_name ':' action_association_list END_STEP */

   323

    // SYM_REF2(step_c, step_name, action_association_list)

   324

    void *visit(step_c *symbol);

   325

   326

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

   327

    /* B 1.7 Configuration elements */

   328

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

   329

   330

    /*

   331

    CONFIGURATION configuration_name

   332

       optional_global_var_declarations

   333

       (resource_declaration_list | single_resource_declaration)

   334

       optional_access_declarations

   335

       optional_instance_specific_initializations

   336

    END_CONFIGURATION

   337

    */

   338

    /*

   339

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

   340

    */                                                                                                            

   341

    void *visit(configuration_declaration_c *symbol);

   342

    /*

   343

    RESOURCE resource_name ON resource_type_name

   344

       optional_global_var_declarations

   345

       single_resource_declaration

   346

    END_RESOURCE

   347

    */

   348

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

   349

    void *visit(resource_declaration_c *symbol);

   350

   351

    /* task_configuration_list program_configuration_list */

   352

    // SYM_REF2(single_resource_declaration_c, task_configuration_list, program_configuration_list)

   353

    void *visit(single_resource_declaration_c *symbol);

   354

   355

   356

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

   357

    /* B.2 - Language IL (Instruction List) */

   358

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

   359

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

   360

    /* B 2.1 Instructions and Operands */

   361

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

   362

    /*| instruction_list il_instruction */

   363

    // SYM_LIST(instruction_list_c)

   364

    void *visit(instruction_list_c *symbol);

   365

   366

   367

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

   368

    /* B.3 - Language ST (Structured Text) */

   369

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

   370

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

   371

    /* B 3.2 Statements */

   372

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

   373

    // SYM_LIST(statement_list_c)

   374

    void *visit(statement_list_c *symbol);

   375

   376

}; // search_var_instance_decl_c

   377