1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2003-2012  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     6

 *  Copyright (C) 2012       Manuele Conti  (conti.ma@alice.it)

     7

 *

     8

 *  This program is free software: you can redistribute it and/or modify

     9

 *  it under the terms of the GNU General Public License as published by

    10

 *  the Free Software Foundation, either version 3 of the License, or

    11

 *  (at your option) any later version.

    12

 *

    13

 *  This program is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    20

 *

    21

 *

    22

 * This code is made available on the understanding that it will not be

    23

 * used in safety-critical situations without a full and competent review.

    24

 */

    25

    26

/*

    27

 * An IEC 61131-3 compiler.

    28

 *

    29

 * Based on the

    30

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    31

 *

    32

 */

    33

    34

/* Determine the characteristics of a specific data type

    35

 *  e.g., is it an enumeration, is it an array, is it ANY_INT, etc...

    36

 *

    37

 * The methods of this class may be passed either:

    38

 *  - a data type declaration symbol_c, 

    39

 *   OR

    40

 *  - the name of a data type (identifier_c)

    41

 *    In this case, we shall first serach for the basetype declaration using search_base_type_c, and then 

    42

 *    run the normal process.

    43

 */

    44

#include "absyntax_utils.hh"

    45

    46

#include "../main.hh" // required for ERROR() and ERROR_MSG() macros.

    47

    48

    49

    50

#include <typeinfo>  // required for typeid

    51

    52

    53

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

    54

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

    55

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

    56

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

    57

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

    58

/*****           Some helper classes                  *****/

    59

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

    60

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

    61

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

    62

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

    63

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

    64

    68

/* Return the identifier (name) of a datatype, typically declared in a TYPE .. END_TYPE declaration */

    71

class get_datatype_id_c: null_visitor_c {

    72

  private:

    73

    static get_datatype_id_c *singleton;

    74

    75

  public:

    76

    static symbol_c *get_id(symbol_c *symbol) {

    77

      if (NULL == singleton) singleton = new  get_datatype_id_c();

    78

      if (NULL == singleton) ERROR;

    79

      return (symbol_c *)symbol->accept(*singleton);

    80

    }

    81

    82

  protected:

    83

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

    84

    /* B 1.3.1 - Elementary Data Types */

    85

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

    86

    void *visit(time_type_name_c        *symbol) {return (void *)symbol;};

    87

    void *visit(bool_type_name_c        *symbol) {return (void *)symbol;};

    88

    void *visit(sint_type_name_c        *symbol) {return (void *)symbol;};

    89

    void *visit(int_type_name_c         *symbol) {return (void *)symbol;};

    90

    void *visit(dint_type_name_c        *symbol) {return (void *)symbol;};

    91

    void *visit(lint_type_name_c        *symbol) {return (void *)symbol;};

    92

    void *visit(usint_type_name_c       *symbol) {return (void *)symbol;};

    93

    void *visit(uint_type_name_c        *symbol) {return (void *)symbol;};

    94

    void *visit(udint_type_name_c       *symbol) {return (void *)symbol;};

    95

    void *visit(ulint_type_name_c       *symbol) {return (void *)symbol;};

    96

    void *visit(real_type_name_c        *symbol) {return (void *)symbol;};

    97

    void *visit(lreal_type_name_c       *symbol) {return (void *)symbol;};

    98

    void *visit(date_type_name_c        *symbol) {return (void *)symbol;};

    99

    void *visit(tod_type_name_c         *symbol) {return (void *)symbol;};

   100

    void *visit(dt_type_name_c          *symbol) {return (void *)symbol;};

   101

    void *visit(byte_type_name_c        *symbol) {return (void *)symbol;};

   102

    void *visit(word_type_name_c        *symbol) {return (void *)symbol;};

   103

    void *visit(lword_type_name_c       *symbol) {return (void *)symbol;};

   104

    void *visit(dword_type_name_c       *symbol) {return (void *)symbol;};

   105

    void *visit(string_type_name_c      *symbol) {return (void *)symbol;};

   106

    void *visit(wstring_type_name_c     *symbol) {return (void *)symbol;};

   107

   108

    void *visit(safetime_type_name_c    *symbol) {return (void *)symbol;};

   109

    void *visit(safebool_type_name_c    *symbol) {return (void *)symbol;};

   110

    void *visit(safesint_type_name_c    *symbol) {return (void *)symbol;};

   111

    void *visit(safeint_type_name_c     *symbol) {return (void *)symbol;};

   112

    void *visit(safedint_type_name_c    *symbol) {return (void *)symbol;};

   113

    void *visit(safelint_type_name_c    *symbol) {return (void *)symbol;};

   114

    void *visit(safeusint_type_name_c   *symbol) {return (void *)symbol;};

   115

    void *visit(safeuint_type_name_c    *symbol) {return (void *)symbol;};

   116

    void *visit(safeudint_type_name_c   *symbol) {return (void *)symbol;};

   117

    void *visit(safeulint_type_name_c   *symbol) {return (void *)symbol;};

   118

    void *visit(safereal_type_name_c    *symbol) {return (void *)symbol;};

   119

    void *visit(safelreal_type_name_c   *symbol) {return (void *)symbol;};

   120

    void *visit(safedate_type_name_c    *symbol) {return (void *)symbol;};

   121

    void *visit(safetod_type_name_c     *symbol) {return (void *)symbol;};

   122

    void *visit(safedt_type_name_c      *symbol) {return (void *)symbol;};

   123

    void *visit(safebyte_type_name_c    *symbol) {return (void *)symbol;};

   124

    void *visit(safeword_type_name_c    *symbol) {return (void *)symbol;};

   125

    void *visit(safelword_type_name_c   *symbol) {return (void *)symbol;};

   126

    void *visit(safedword_type_name_c   *symbol) {return (void *)symbol;};

   127

    void *visit(safestring_type_name_c  *symbol) {return (void *)symbol;};

   128

    void *visit(safewstring_type_name_c *symbol) {return (void *)symbol;};

   129

   130

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

   131

    /* B 1.3.3 - Derived data types */

   132

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

   133

    /*  simple_type_name ':' simple_spec_init */

   134

    void *visit(simple_type_declaration_c     *symbol)  {return symbol->simple_type_name;}

   135

    /*  subrange_type_name ':' subrange_spec_init */

   136

    void *visit(subrange_type_declaration_c   *symbol)  {return symbol->subrange_type_name;}

   137

    /*  enumerated_type_name ':' enumerated_spec_init */

   138

    void *visit(enumerated_type_declaration_c *symbol)  {return symbol->enumerated_type_name;}

   139

    /*  identifier ':' array_spec_init */

   140

    void *visit(array_type_declaration_c      *symbol)  {return symbol->identifier;}

   141

    /*  structure_type_name ':' structure_specification */

   142

    void *visit(structure_type_declaration_c  *symbol)  {return symbol->structure_type_name;}

   143

    /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   144

    void *visit(string_type_declaration_c     *symbol)  {return symbol->string_type_name;}

   145

    /* ref_type_decl: identifier ':' ref_spec_init */

   146

    void *visit(ref_type_decl_c               *symbol)  {return symbol->ref_type_name;}

   147

    /* NOTE: DO NOT place any code here that references symbol->anotations_map["generate_c_annotaton__implicit_type_id"] !!

   148

     *       All anotations in the symbol->anotations_map[] are considered a stage4 construct. In the above example,

   149

     *       That anotation is specific to the generate_c stage4 code, and must therefore NOT be referenced

   150

     *       in the absyntax_utils code, as this last code should be independent of the stage4 version!

   151

     */ 

   152

   153

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

   154

    /* B 1.5.2 - Function Blocks */

   155

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

   156

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   157

    void *visit(function_block_declaration_c  *symbol)  {return symbol->fblock_name;}

   158

}; // get_datatype_id_c 

   159

   160

get_datatype_id_c *get_datatype_id_c::singleton = NULL;

   161

   162

   163

   164

   172

   173

/* A small helper class, to transform elementary data type to string.

   174

 * this allows us to generate more relevant error messages...

   175

 */

   176

   177

class get_datatype_id_str_c: public null_visitor_c {

   178

  protected:

   179

     get_datatype_id_str_c(void)  {};

   180

    ~get_datatype_id_str_c(void) {};

   181

   182

  private:

   183

    /* singleton class! */

   184

    static get_datatype_id_str_c *singleton;

   185

   186

  public:

   187

    static const char *get_id_str(symbol_c *symbol) {

   188

      if (NULL == singleton)    singleton = new get_datatype_id_str_c;

   189

      if (NULL == singleton)    ERROR;

   190

      const char *res           = (const char *)symbol->accept(*singleton);

   191

      if (NULL == res)          ERROR;

   192

      return res;

   193

    }

   194

   195

   196

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

   197

    /* B.1 - Common elements */

   198

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

   199

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

   200

    /* B 1.1 - Letters, digits and identifiers */

   201

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

   202

    void *visit(identifier_c *symbol) {return (void *)symbol->value;};

   203

   204

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

   205

    /* B 1.3.1 - Elementary Data Types */

   206

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

   207

    void *visit(time_type_name_c        *symbol) {return (void *)"TIME";        };

   208

    void *visit(bool_type_name_c        *symbol) {return (void *)"BOOL";        };

   209

    void *visit(sint_type_name_c        *symbol) {return (void *)"SINT";        };

   210

    void *visit(int_type_name_c         *symbol) {return (void *)"INT";         };

   211

    void *visit(dint_type_name_c        *symbol) {return (void *)"DINT";        };

   212

    void *visit(lint_type_name_c        *symbol) {return (void *)"LINT";        };

   213

    void *visit(usint_type_name_c       *symbol) {return (void *)"USINT";       };

   214

    void *visit(uint_type_name_c        *symbol) {return (void *)"UINT";        };

   215

    void *visit(udint_type_name_c       *symbol) {return (void *)"UDINT";       };

   216

    void *visit(ulint_type_name_c       *symbol) {return (void *)"ULINT";       };

   217

    void *visit(real_type_name_c        *symbol) {return (void *)"REAL";        };

   218

    void *visit(lreal_type_name_c       *symbol) {return (void *)"LREAL";       };

   219

    void *visit(date_type_name_c        *symbol) {return (void *)"DATE";        };

   220

    void *visit(tod_type_name_c         *symbol) {return (void *)"TOD";         };

   221

    void *visit(dt_type_name_c          *symbol) {return (void *)"DT";          };

   222

    void *visit(byte_type_name_c        *symbol) {return (void *)"BYTE";        };

   223

    void *visit(word_type_name_c        *symbol) {return (void *)"WORD";        };

   224

    void *visit(lword_type_name_c       *symbol) {return (void *)"LWORD";       };

   225

    void *visit(dword_type_name_c       *symbol) {return (void *)"DWORD";       };

   226

    void *visit(string_type_name_c      *symbol) {return (void *)"STRING";      };

   227

    void *visit(wstring_type_name_c     *symbol) {return (void *)"WSTRING";     };

   228

   229

    void *visit(safetime_type_name_c    *symbol) {return (void *)"SAFETIME";    };

   230

    void *visit(safebool_type_name_c    *symbol) {return (void *)"SAFEBOOL";    };

   231

    void *visit(safesint_type_name_c    *symbol) {return (void *)"SAFESINT";    };

   232

    void *visit(safeint_type_name_c     *symbol) {return (void *)"SAFEINT";     };

   233

    void *visit(safedint_type_name_c    *symbol) {return (void *)"SAFEDINT";    };

   234

    void *visit(safelint_type_name_c    *symbol) {return (void *)"SAFELINT";    };

   235

    void *visit(safeusint_type_name_c   *symbol) {return (void *)"SAFEUSINT";   };

   236

    void *visit(safeuint_type_name_c    *symbol) {return (void *)"SAFEUINT";    };

   237

    void *visit(safeudint_type_name_c   *symbol) {return (void *)"SAFEUDINT";   };

   238

    void *visit(safeulint_type_name_c   *symbol) {return (void *)"SAFEULINT";   };

   239

    void *visit(safereal_type_name_c    *symbol) {return (void *)"SAFEREAL";    };

   240

    void *visit(safelreal_type_name_c   *symbol) {return (void *)"SAFELREAL";   };

   241

    void *visit(safedate_type_name_c    *symbol) {return (void *)"SAFEDATE";    };

   242

    void *visit(safetod_type_name_c     *symbol) {return (void *)"SAFETOD";     };

   243

    void *visit(safedt_type_name_c      *symbol) {return (void *)"SAFEDT";      };

   244

    void *visit(safebyte_type_name_c    *symbol) {return (void *)"SAFEBYTE";    };

   245

    void *visit(safeword_type_name_c    *symbol) {return (void *)"SAFEWORD";    };

   246

    void *visit(safelword_type_name_c   *symbol) {return (void *)"SAFELWORD";   };

   247

    void *visit(safedword_type_name_c   *symbol) {return (void *)"SAFEDWORD";   };

   248

    void *visit(safestring_type_name_c  *symbol) {return (void *)"SAFESTRING";  };

   249

    void *visit(safewstring_type_name_c *symbol) {return (void *)"SAFEWSTRING"; };

   250

   251

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

   252

    /* B 1.3.3 - Derived data types */

   253

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

   254

    /*  simple_type_name ':' simple_spec_init */

   255

    void *visit(simple_type_declaration_c     *symbol)  {return symbol->simple_type_name->accept(*this);}

   256

    /*  subrange_type_name ':' subrange_spec_init */

   257

    void *visit(subrange_type_declaration_c   *symbol)  {return symbol->subrange_type_name->accept(*this);}

   258

    /*  enumerated_type_name ':' enumerated_spec_init */

   259

    void *visit(enumerated_type_declaration_c *symbol)  {return symbol->enumerated_type_name->accept(*this);}

   260

    /*  identifier ':' array_spec_init */

   261

    void *visit(array_type_declaration_c      *symbol)  {return symbol->identifier->accept(*this);}

   262

    /*  structure_type_name ':' structure_specification */

   263

    void *visit(structure_type_declaration_c  *symbol)  {return symbol->structure_type_name->accept(*this);}

   264

    /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   265

    void *visit(string_type_declaration_c     *symbol)  {return symbol->string_type_name->accept(*this);}

   266

    /* ref_type_decl: identifier ':' ref_spec_init */

   267

    void *visit(ref_type_decl_c               *symbol)  {return symbol->ref_type_name->accept(*this);}

   268

    /* NOTE: DO NOT place any code here that references symbol->anotations_map["generate_c_annotaton__implicit_type_id"] !!

   269

     *       All anotations in the symbol->anotations_map[] are considered a stage4 construct. In the above example,

   270

     *       That anotation is specific to the generate_c stage4 code, and must therefore NOT be referenced

   271

     *       in the absyntax_utils code, as this last code should be independent of the stage4 version!

   272

     */ 

   273

   274

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

   275

    /* B 1.5.2 - Function Blocks */

   276

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

   277

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   278

    void *visit(function_block_declaration_c  *symbol)  {return symbol->fblock_name->accept(*this);}    

   279

};

   280

   281

get_datatype_id_str_c *get_datatype_id_str_c::singleton = NULL;

   282

   283

   284

   394

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

   395

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

   396

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

   397

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

   398

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

   399

/*****        GET_DATATYPE_INFO_C                     *****/

   400

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

   401

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

   402

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

   403

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

   404

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

   405

   406

const char *get_datatype_info_c::get_id_str(symbol_c *datatype) {

   407

  return get_datatype_id_str_c::get_id_str(datatype);

   408

}

   409

   410

   411

symbol_c *get_datatype_info_c::get_id(symbol_c *datatype) {

   412

  return get_datatype_id_c::get_id(datatype);

   413

}

   414

   415

   420

/* Returns true if both datatypes are equivalent (not necessarily equal!).

   421

 * WARNING: May return true even though the datatypes are not the same/identicial!!!

   422

 *          This occurs when at least one of the datatypes is of a generic

   423

 *          datatype (or a REF_TO a generic datatype). 

   424

 *          (Generic dataypes: ANY, ANY_INT, ANY_NUM, ...)

   425

 * NOTE: Currently only the ANY generic datatype is implemented!

   426

 * NOTE: Currently stage1_2 only allows the use of the ANY keyword when in conjuntion with

   427

 *       the REF_TO keyword (i.e. REF_TO ANY), so when handling non REF_TO datatypes,

   428

 *       this function will currently only return true if the dataypes are identicial.

   429

 */

   430

   431

/* NOTE: Currently the datatype model used by matiec considers any implicitly defined datatype

   432

 *       (e.g. an array datatype defined in the variable declaration itself, instead of inside a TYPE ... END_TYPE

   433

 *       construct) to be different (i.e. not the same datatype, and therefore not compatible) to any other

   434

 *       datatype, including with datatypes declared identically to the implicit datatype.

   435

 *       e.g.

   436

 *         TYPE my_array_t: ARRAY [1..3] OF INT; END_TYPE;

   437

 *         FUNCTION_BLOCK FOO

   438

 *          VAR my_array:  ARRAY [1..3] OF INT; END_VAR

   439

 *         ...

   440

 *         END_FUNCTION_BLOCK

   441

 * 

   442

 *         In the abive code, my_array is NOT considered to te compatible with my_Array_t !!!

   443

 * 

   444

 *       In essence, the currently supported datatype model considers all datatypes to be different to each other,

   445

 *       even though the stored data is the same (Let us call this rule (0))!

   446

 *       There are 2 exceptions to the above rule:

   447

 *        (1) Datatypes that are directly derived from other datatypes.

   448

 *              (this rule is specified in the standard, so we follow it!)

   449

 *        (2) REF_TO datatypes that reference the same datatype

   450

 *              (I dont think the standard says anything about this!)

   451

 *

   452

 *         TYPE 

   453

 *          my_array_1_t: ARRAY [1..3] OF INT; 

   454

 *          my_array_2_t: ARRAY [1..3] OF INT; 

   455

 *          my_array_3_t: my_array_1_t; 

   456

 *          A_ref_t: REF_TO my_array_1_t;

   457

 *          B_ref_t: REF_TO my_array_1_t;

   458

 *          C_ref_t: A_ref_t;

   459

 *         END_TYPE;

   460

 *                 

   461

 *         In the above code, my_array_1_t is a distinct datatype to my_array_2_t

   462

 *           (this is different to C and C++, where they would be considered the same datatype!)

   463

 *           (following rule (0))

   464

 *         In the above code, my_array_3_t is the same datatype as my_array_1_t

   465

 *           (following rule (1))

   466

 *         In the above code, A_ref_t is the same datatype as B_ref_t

   467

 *           (following rule (2))

   468

 *         In the above code, A_ref_t is the same datatype as C_ref_t

   469

 *           (following rule (1))

   470

 *

   471

 *       Note that rule (0) means that a function/FB with a parameter whose datatype is implicitly defined

   472

 *       can never be passed a value!

   473

 *         FUNCTION_BLOCK FOO

   474

 *          VAR_INPUT my_array:  ARRAY [1..3] OF INT; END_VAR

   475

 *         ...

   476

 *         END_FUNCTION_BLOCK

   477

 *

   478

 *       Any call to FB foo can never pass a value to parameter my_array, as its datatype is distinct

   479

 *       to all other datatypes, and therefore passing any other variable to my_array will result in an

   480

 *       'incompatible datatypes' error!

   481

 *       The above seems natural o me (Mario) in a programming language that is very strongly typed.

   482

 * 

   483

 *       However, if we did not have exception (2), the following would also be invalid:

   484

 *         TYPE my_array_t: ARRAY [1..3] OF INT; END_TYPE;

   485

 *         FUNCTION_BLOCK FOO_t

   486

 *          VAR_INPUT my_array: REF_TO my_array_t; END_VAR

   487

 *         ...

   488

 *         END_FUNCTION_BLOCK

   489

 * 

   490

 *         FUNCTION_BLOCK BAR

   491

 *          VAR

   492

 *            my_array: my_array_t; 

   493

 *            foo: FOO_t;

   494

 *          END_VAR

   495

 *          foo(REF(my_array));  <----- invalid, without rule 2!!

   496

 *         ...

   497