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

/*

    35

 * Determine the default initial value of a type declaration.

    36

 *

    37

 * This is part of the 4th stage that generates

    38

 * a c++ source program equivalent to the IL and ST

    39

 * code.

    40

 */

    41

    42

/* Given a type definition declration, determine its default

    43

 * initial value. Note that types based on other types

    44

 * may have to iterate through each type it is based on

    45

 * to determine the initial value.

    46

 * E.g.

    47

 *  TYPE

    48

 *    A_t : INT := 10;

    49

 *    B_t : A_t := 20;

    50

 *    C_t : B_t;

    51

 *    D_t : C_t := 40;

    52

 *  END_TYPE

    53

 * Where the default initial value for C_t is 20!

    54

 */

    55

/* NOTE: The main program only needs one instance of

    56

 *       this class of object. This class

    57

 *       is therefore a singleton.

    58

 */

    59

    60

class type_initial_value_c : public null_visitor_c {

    61

    62

  public:

    63

    static symbol_c *get(symbol_c *type);

    64

    65

  private:

    66

    /* constants for the default values of elementary data types... */

    67

    static ref_value_null_literal_c       *null_literal;

    68

    static real_c                         *real_0;

    69

    static integer_c                      *integer_0, *integer_1;

    70

    static boolean_literal_c              *bool_0;

    71

    static date_literal_c                 *date_literal_0;

    72

    static daytime_c                      *daytime_literal_0;

    73

    static duration_c                     *time_0;

    74

    static date_c                         *date_0;

    75

    static time_of_day_c                  *tod_0;

    76

    static date_and_time_c                *dt_0;

    77

    static single_byte_character_string_c *string_0;

    78

    static double_byte_character_string_c *wstring_0;

    79

    80

  protected:

    81

    type_initial_value_c(void);

    82

    83

  private:

    84

    static type_initial_value_c *_instance;

    85

    static type_initial_value_c *instance(void);

    86

    void *handle_type_spec(symbol_c *base_type_name, symbol_c *type_spec_init);

    87

    void *handle_type_name(symbol_c *type_name);

    88

    89

  private:

    90

    void *visit(                 identifier_c *symbol);

    91

    void *visit(derived_datatype_identifier_c *symbol);

    92

    void *visit(         poutype_identifier_c *symbol);

    93

    94

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

    95

    /* B 1.3.1 - Elementary Data Types */

    96

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

    97

    void *visit(time_type_name_c *symbol);

    98

    void *visit(bool_type_name_c *symbol);

    99

    void *visit(sint_type_name_c *symbol);

   100

    void *visit(int_type_name_c *symbol);

   101

    void *visit(dint_type_name_c *symbol);

   102

    void *visit(lint_type_name_c *symbol);

   103

    void *visit(usint_type_name_c *symbol);

   104

    void *visit(uint_type_name_c *symbol);

   105

    void *visit(udint_type_name_c *symbol);

   106

    void *visit(ulint_type_name_c *symbol);

   107

    void *visit(real_type_name_c *symbol);

   108

    void *visit(lreal_type_name_c *symbol);

   109

    void *visit(date_type_name_c *symbol);

   110

    void *visit(tod_type_name_c *symbol);

   111

    void *visit(dt_type_name_c *symbol);

   112

    void *visit(byte_type_name_c *symbol);

   113

    void *visit(word_type_name_c *symbol);

   114

    void *visit(dword_type_name_c *symbol);

   115

    void *visit(lword_type_name_c *symbol);

   116

    void *visit(string_type_name_c *symbol);

   117

    void *visit(wstring_type_name_c *symbol);

   118

   119

    void *visit(safetime_type_name_c *symbol);

   120

    void *visit(safebool_type_name_c *symbol);

   121

    void *visit(safesint_type_name_c *symbol);

   122

    void *visit(safeint_type_name_c *symbol);

   123

    void *visit(safedint_type_name_c *symbol);

   124

    void *visit(safelint_type_name_c *symbol);

   125

    void *visit(safeusint_type_name_c *symbol);

   126

    void *visit(safeuint_type_name_c *symbol);

   127

    void *visit(safeudint_type_name_c *symbol);

   128

    void *visit(safeulint_type_name_c *symbol);

   129

    void *visit(safereal_type_name_c *symbol);

   130

    void *visit(safelreal_type_name_c *symbol);

   131

    void *visit(safedate_type_name_c *symbol);

   132

    void *visit(safetod_type_name_c *symbol);

   133

    void *visit(safedt_type_name_c *symbol);

   134

    void *visit(safebyte_type_name_c *symbol);

   135

    void *visit(safeword_type_name_c *symbol);

   136

    void *visit(safedword_type_name_c *symbol);

   137

    void *visit(safelword_type_name_c *symbol);

   138

    void *visit(safestring_type_name_c *symbol);

   139

    void *visit(safewstring_type_name_c *symbol);

   140

   141

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

   142

    /* B 1.3.3 - Derived data types */

   143

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

   144

    /*  simple_type_name ':' simple_spec_init */

   145

    void *visit(simple_type_declaration_c *symbol);

   146

   147

    /* simple_specification ASSIGN constant */

   148

    void *visit(simple_spec_init_c *symbol);

   149

   150

    /*  subrange_type_name ':' subrange_spec_init */

   151

    void *visit(subrange_type_declaration_c *symbol);

   152

   153

    /* subrange_specification ASSIGN signed_integer */

   154

    void *visit(subrange_spec_init_c *symbol);

   155

   156

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

   157

    void *visit(subrange_specification_c *symbol);

   158

   159

    /*  signed_integer DOTDOT signed_integer */

   160

    void *visit(subrange_c *symbol);

   161

   162

    /*  enumerated_type_name ':' enumerated_spec_init */

   163

    void *visit(enumerated_type_declaration_c *symbol);

   164

   165

    /* enumerated_specification ASSIGN enumerated_value */

   166

    void *visit(enumerated_spec_init_c *symbol);

   167

   168

    /* helper symbol for enumerated_specification->enumerated_spec_init */

   169

    /* enumerated_value_list ',' enumerated_value */

   170

    void *visit(enumerated_value_list_c *symbol);

   171

   172

    /* enumerated_type_name '#' identifier */

   173

    // SYM_REF2(enumerated_value_c, type, value)

   174

    void *visit(enumerated_value_c *symbol);

   175

   176

    /*  identifier ':' array_spec_init */

   177

    void *visit(array_type_declaration_c *symbol);

   178

   179

    /* array_specification [ASSIGN array_initialization} */

   180

    /* array_initialization may be NULL ! */

   181

    void *visit(array_spec_init_c *symbol);

   182

   183

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

   184

    void *visit(array_specification_c *symbol);

   185

   186

    /* helper symbol for array_specification */

   187

    /* array_subrange_list ',' subrange */

   188

    void *visit(array_subrange_list_c *symbol);

   189

   190

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

   191

    /* helper symbol for array_initialization */

   192

    /* array_initial_elements_list ',' array_initial_elements */

   193

    void *visit(array_initial_elements_list_c *symbol);

   194

   195

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

   196

    /* array_initial_element may be NULL ! */

   197

    void *visit(array_initial_elements_c *symbol);

   198

   199

    /*  structure_type_name ':' structure_specification */

   200

    void *visit(structure_type_declaration_c *symbol);

   201

   202

    /* structure_type_name ASSIGN structure_initialization */

   203

    /* structure_initialization may be NULL ! */

   204

    void *visit(initialized_structure_c *symbol);

   205

   206

    /* helper symbol for structure_declaration */

   207

    /* structure_declaration:  STRUCT structure_element_declaration_list END_STRUCT */

   208

    /* structure_element_declaration_list structure_element_declaration ';' */

   209

    void *visit(structure_element_declaration_list_c *symbol);

   210

   211

    /*  structure_element_name ':' *_spec_init */

   212

    void *visit(structure_element_declaration_c *symbol);

   213

   214

    /* helper symbol for structure_initialization */

   215

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

   216

    /* structure_element_initialization_list ',' structure_element_initialization */

   217

    void *visit(structure_element_initialization_list_c *symbol);

   218

   219

    /*  structure_element_name ASSIGN value */

   220

    void *visit(structure_element_initialization_c *symbol);

   221

   222

    /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   223

    /*

   224

     * NOTE:

   225

     * (Summary: Contrary to what is expected, the

   226

     *           string_type_declaration_c is not used to store

   227

     *           simple string type declarations that do not include

   228

     *           size limits.

   229

     *           For e.g.:

   230

     *             str1_type: STRING := "hello!"

   231

     *           will be stored in a simple_type_declaration_c

   232

     *           instead of a string_type_declaration_c.

   233

     *           The following:

   234

     *             str2_type: STRING [64] := "hello!"

   235

     *           will be stored in a sring_type_declaration_c

   236

     *

   237

     *           Read on for why this is done...

   238

     * End Summary)

   239

     *

   240

     * According to the spec, the valid construct

   241

     * TYPE new_str_type : STRING := "hello!"; END_TYPE

   242

     * has two possible routes to type_declaration...

   243

     *

   244

     * Route 1:

   245

     * type_declaration: single_element_type_declaration

   246

     * single_element_type_declaration: simple_type_declaration

   247

     * simple_type_declaration: identifier ':' simple_spec_init

   248

     * simple_spec_init: simple_specification ASSIGN constant

   249

     * (shift:  identifier <- 'new_str_type')

   250

     * simple_specification: elementary_type_name

   251

     * elementary_type_name: STRING

   252

     * (shift: elementary_type_name <- STRING)

   253

     * (reduce: simple_specification <- elementary_type_name)

   254

     * (shift: constant <- "hello!")

   255

     * (reduce: simple_spec_init: simple_specification ASSIGN constant)

   256

     * (reduce: ...)

   257

     *

   258

     *

   259

     * Route 2:

   260

     * type_declaration: string_type_declaration

   261

     * string_type_declaration: identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init

   262

     * (shift:  identifier <- 'new_str_type')

   263

     * elementary_string_type_name: STRING

   264

     * (shift: elementary_string_type_name <- STRING)

   265

     * (shift: string_type_declaration_size <-  empty )

   266

     * string_type_declaration_init: ASSIGN character_string

   267

     * (shift: character_string <- "hello!")

   268

     * (reduce: string_type_declaration_init <- ASSIGN character_string)

   269

     * (reduce: string_type_declaration <- identifier ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init )

   270

     * (reduce: type_declaration <- string_type_declaration)

   271

     *

   272

     *

   273

     * At first glance it seems that removing route 1 would make

   274

     * the most sense. Unfortunately the construct 'simple_spec_init'

   275

     * shows up multiple times in other rules, so changing this construct

   276

     * would also mean changing all the rules in which it appears.

   277

     * I (Mario) therefore chose to remove route 2 instead. This means

   278

     * that the above declaration gets stored in a

   279

     * simple_type_declaration_c, and not in a string_type_declaration_c

   280

     * as would be expected!

   281

     */

   282

    /*  string_type_name ':' elementary_string_type_name string_type_declaration_size string_type_declaration_init */

   283

     // SYM_REF4(string_type_declaration_c,	string_type_name,

   284

     //					elementary_string_type_name,

   285

     //					string_type_declaration_size,

   286

     // 				string_type_declaration_init) /* may be == NULL! */

   287

    void *visit(string_type_declaration_c *symbol);

   288

   289

    /* REF_TO (non_generic_type_name | function_block_type_name) */

   290

    void *visit(ref_spec_c *symbol);

   291

    /* ref_spec [ ASSIGN ref_initialization ]; */

   292

    void *visit(ref_spec_init_c *symbol);

   293

    /* identifier ':' ref_spec_init */

   294

    void *visit(ref_type_decl_c *symbol);

   295

   296

}; // type_initial_value_c

   297

   298

   299