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

 *

     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 on which another data type is based on.

    35

 * If a new default initial value is given, we DO NOT consider it a

    36

 * new base class, and continue looking further!

    37

 *

    38

 * E.g. TYPE new_int_t : INT; END_TYPE;

    39

 *      TYPE new_int2_t : INT = 2; END_TYPE;

    40

 *      TYPE new_subr_t : INT (4..5); END_TYPE;

    41

 *

    42

 *    new_int_t is really an INT!!

    43

 *    new_int2_t is also really an INT!!

    44

 *    new_subr_t is also really an INT!!

    45

 *

    46

 * Note that a FB declaration is also considered a base type, as

    47

 * we may have FB instances declared of a specific FB type.

    48

 */

    49

    50

    51

class search_base_type_c: public null_visitor_c {

    52

    53

  private:

    54

    symbol_c *current_type_name;

    55

    symbol_c *current_basetype;

    56

    bool is_array;

    57

    bool is_subrange;

    58

    bool is_enumerated;

    59

    bool is_fb;

    60

    static search_base_type_c *search_base_type_singleton; // Make this a singleton class!

    61

    62

  private:  

    63

    static void create_singleton(void);

    64

    65

  public:

    66

    search_base_type_c(void);

    67

    static symbol_c *get_basetype_decl (symbol_c *symbol);

    68

    static symbol_c *get_basetype_id   (symbol_c *symbol);

    69

    static bool      type_is_subrange  (symbol_c *type_decl);

    70

    static bool      type_is_enumerated(symbol_c *type_decl);

    71

    static bool      type_is_fb        (symbol_c *type_decl);

    72

    73

  public:

    74

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

    75

  /* B.1 - Common elements */

    76

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

    77

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

    78

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

    79

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

    80

    void *visit(identifier_c *type_name);

    81

    82

    83

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

    84

  /* B 1.2 - Constants */

    85

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

    86

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

    87

  /* B 1.2.1 - Numeric Literals */

    88

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

    89

     /* Numeric literals without any explicit type cast have unknown data type, 

    90

      * so we continue considering them as their own basic data types until

    91

      * they can be resolved (for example, when using '30+x' where 'x' is a LINT variable, the

    92

      * numeric literal '30' must then be considered a LINT so the ADD function may be called

    93

      * with all inputs of the same data type.

    94

      * If 'x' were a SINT, then the '30' would have to be a SINT too!

    95

      */

    96

    void *visit(real_c *symbol);

    97

    void *visit(neg_real_c *symbol);

    98

    void *visit(integer_c *symbol);

    99

    void *visit(neg_integer_c *symbol);

   100

    void *visit(binary_integer_c *symbol);

   101

    void *visit(octal_integer_c *symbol);

   102

    void *visit(hex_integer_c *symbol);

   103

    void *visit(boolean_true_c *symbol);

   104

    void *visit(boolean_false_c *symbol);

   105

   106

   107

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

   108

  /* B 1.3.1 - Elementary Data Types */

   109

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

   110

    void *visit(time_type_name_c *symbol);

   111

    void *visit(bool_type_name_c *symbol);

   112

    void *visit(sint_type_name_c *symbol);

   113

    void *visit(int_type_name_c *symbol);

   114

    void *visit(dint_type_name_c *symbol);

   115

    void *visit(lint_type_name_c *symbol);

   116

    void *visit(usint_type_name_c *symbol);

   117

    void *visit(uint_type_name_c *symbol);

   118

    void *visit(udint_type_name_c *symbol);

   119

    void *visit(ulint_type_name_c *symbol);

   120

    void *visit(real_type_name_c *symbol);

   121

    void *visit(lreal_type_name_c *symbol);

   122

    void *visit(date_type_name_c *symbol);

   123

    void *visit(tod_type_name_c *symbol);

   124

    void *visit(dt_type_name_c *symbol);

   125

    void *visit(byte_type_name_c *symbol);

   126

    void *visit(word_type_name_c *symbol);

   127

    void *visit(dword_type_name_c *symbol);

   128

    void *visit(lword_type_name_c *symbol);

   129

    void *visit(string_type_name_c *symbol);

   130

    void *visit(wstring_type_name_c *symbol);

   131

   132

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

   133

    /* Extensions to the base standard as defined in      */

   134

    /* "Safety Software Technical Specification,          */

   135

    /*  Part 1: Concepts and Function Blocks,             */

   136

    /*  Version 1.0 – Official Release"                   */

   137

    /* by PLCopen - Technical Committee 5 - 2006-01-31    */

   138

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

   139

    void *visit(safetime_type_name_c *symbol);

   140

    void *visit(safebool_type_name_c *symbol);

   141

    void *visit(safesint_type_name_c *symbol);

   142

    void *visit(safeint_type_name_c *symbol);

   143

    void *visit(safedint_type_name_c *symbol);

   144

    void *visit(safelint_type_name_c *symbol);

   145

    void *visit(safeusint_type_name_c *symbol);

   146

    void *visit(safeuint_type_name_c *symbol);

   147

    void *visit(safeudint_type_name_c *symbol);

   148

    void *visit(safeulint_type_name_c *symbol);

   149

    void *visit(safereal_type_name_c *symbol);

   150

    void *visit(safelreal_type_name_c *symbol);

   151

    void *visit(safedate_type_name_c *symbol);

   152

    void *visit(safetod_type_name_c *symbol);

   153

    void *visit(safedt_type_name_c *symbol);

   154

    void *visit(safebyte_type_name_c *symbol);

   155

    void *visit(safeword_type_name_c *symbol);

   156

    void *visit(safedword_type_name_c *symbol);

   157

    void *visit(safelword_type_name_c *symbol);

   158

    void *visit(safestring_type_name_c *symbol);

   159

    void *visit(safewstring_type_name_c *symbol);

   160

   161

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

   162

  /* B 1.3.3 - Derived data types */

   163

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

   164

  /*  simple_type_name ':' simple_spec_init */

   165

    void *visit(simple_type_declaration_c *symbol);

   166

  /* simple_specification ASSIGN constant */

   167

    void *visit(simple_spec_init_c *symbol);

   168

  /*  subrange_type_name ':' subrange_spec_init */

   169

    void *visit(subrange_type_declaration_c *symbol);

   170

  /* subrange_specification ASSIGN signed_integer */

   171

    void *visit(subrange_spec_init_c *symbol);

   172

  /*  integer_type_name '(' subrange')' */

   173

    void *visit(subrange_specification_c *symbol);

   174

  /*  signed_integer DOTDOT signed_integer */

   175

    void *visit(subrange_c *symbol);

   176

   177

  /*  enumerated_type_name ':' enumerated_spec_init */

   178

    void *visit(enumerated_type_declaration_c *symbol);

   179

  /* enumerated_specification ASSIGN enumerated_value */

   180

    void *visit(enumerated_spec_init_c *symbol);

   181

  /* helper symbol for enumerated_specification->enumerated_spec_init */

   182

  /* enumerated_value_list ',' enumerated_value */

   183

    void *visit(enumerated_value_list_c *symbol);

   184

  /* enumerated_type_name '#' identifier */

   185

  // SYM_REF2(enumerated_value_c, type, value)

   186

    void *visit(enumerated_value_c *symbol);

   187

  /*  identifier ':' array_spec_init */

   188

    void *visit(array_type_declaration_c *symbol);

   189

  /* array_specification [ASSIGN array_initialization} */

   190

  /* array_initialization may be NULL ! */

   191

    void *visit(array_spec_init_c *symbol);

   192

  /* ARRAY '[' array_subrange_list ']' OF non_generic_type_name */

   193

    void *visit(array_specification_c *symbol);

   194

  /* helper symbol for array_specification */

   195

  /* array_subrange_list ',' subrange */

   196

    void *visit(array_subrange_list_c *symbol);

   197

  /* array_initialization:  '[' array_initial_elements_list ']' */

   198

  /* helper symbol for array_initialization */

   199

  /* array_initial_elements_list ',' array_initial_elements */

   200

    void *visit(array_initial_elements_list_c *symbol);

   201

  /* integer '(' [array_initial_element] ')' */

   202

  /* array_initial_element may be NULL ! */

   203

    void *visit(array_initial_elements_c *symbol);

   204

  /*  structure_type_name ':' structure_specification */

   205

      /* NOTE: structure_specification will point to either a

   206

       *       initialized_structure_c

   207

       *       OR A

   208

       *       structure_element_declaration_list_c

   209

       */

   210

    void *visit(structure_type_declaration_c *symbol);

   211

  /*  var1_list ':' structure_type_name */

   212

    void *visit(structured_var_declaration_c *symbol);

   213

  /* structure_type_name ASSIGN structure_initialization */

   214

  /* structure_initialization may be NULL ! */

   215

    void *visit(initialized_structure_c *symbol);

   216

  /* helper symbol for structure_declaration */

   217

  /* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   218

  /* structure_element_declaration_list structure_element_declaration ';' */

   219

    void *visit(structure_element_declaration_list_c *symbol);

   220

  /*  structure_element_name ':' *_spec_init */

   221

    void *visit(structure_element_declaration_c *symbol);

   222

  /* helper symbol for structure_initialization */

   223

  /* structure_initialization: '(' structure_element_initialization_list ')' */

   224

  /* structure_element_initialization_list ',' structure_element_initialization */

   225

    void *visit(structure_element_initialization_list_c *symbol);

   226

  /*  structure_element_name ASSIGN value */

   227

    void *visit(structure_element_initialization_c *symbol);

   228

  /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   229

  /*

   230

  SYM_REF4(string_type_declaration_c, string_type_name,

   231

  					elementary_string_type_name,

   232

  					string_type_declaration_size,

   233

  					string_type_declaration_init) // may be == NULL!

   234

  */

   235

    void *visit(string_type_declaration_c *symbol);

   236

   238

  /* structure_initialization -> may be NULL ! */

   240

   241

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

   242

  /* B 1.5.2 - Function Blocks */

   243

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

   244

  /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

   245

  // SYM_REF3(function_block_declaration_c, fblock_name, var_declarations, fblock_body)

   246

    void *visit(function_block_declaration_c *symbol);

   247

   248

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

   249

  /* B.1.6  Sequential function chart elements */

   250

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

   251

  /* INITIAL_STEP step_name ':' action_association_list END_STEP */

   252

  // SYM_REF2(initial_step_c, step_name, action_association_list)

   253

    void *visit(initial_step_c *symbol);

   254

   255

  /* STEP step_name ':' action_association_list END_STEP */

   256

  // SYM_REF2(step_c, step_name, action_association_list)

   257

    void *visit(step_c *symbol);

   258

   259

   260

}; // search_base_type_c

   261

   262

   263

   264