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

#include <stdlib.h>

    25

    26

class generate_c_typedecl_c: public generate_c_base_c {

    27

    28

  protected:

    29

    stage4out_c &s4o_incl;

    30

    31

  private:

    32

    symbol_c* current_type_name;

    33

    bool array_is_derived;

    34

    search_base_type_c search_base_type;

    35

    search_constant_type_c search_constant_type;

    36

    37

    generate_c_base_c *basedecl;

    38

    39

  public:

    40

    generate_c_typedecl_c(stage4out_c *s4o_ptr, stage4out_c *s4o_incl_ptr): generate_c_base_c(s4o_ptr), s4o_incl(*s4o_incl_ptr) {

    41

      current_typedefinition = none_td;

    42

      current_basetypedeclaration = none_bd;

    43

      current_type_name = NULL;

    44

      basedecl = new generate_c_base_c(&s4o_incl);

    45

    }

    46

    generate_c_typedecl_c(stage4out_c *s4o_ptr): generate_c_base_c(s4o_ptr), s4o_incl(*s4o_ptr) {

    47

      current_typedefinition = none_td;

    48

      current_basetypedeclaration = none_bd;

    49

      current_type_name = NULL;

    50

      basedecl = new generate_c_base_c(&s4o_incl);

    51

    }

    52

    ~generate_c_typedecl_c(void) {

    53

      delete basedecl;

    54

    }

    55

    56

    typedef enum {

    57

      none_td,

    58

      enumerated_td,

    59

      subrange_td,

    60

      array_td,

    61

      struct_td,

    62

    } typedefinition_t;

    63

    64

    typedefinition_t current_typedefinition;

    65

    66

    typedef enum {

    67

      none_bd,

    68

      subrangebasetype_bd,

    69

      subrangetest_bd,

    70

      arrayderiveddeclaration_bd,

    71

      arraybasetype_bd,

    72

      arraybasetypeincl_bd,

    73

      arraysubrange_bd,

    74

      arraytranslateindex_bd

    75

    } basetypedeclaration_t;

    76

    77

    basetypedeclaration_t current_basetypedeclaration;

    78

    79

    int extract_integer(symbol_c *integer) {

    80

      return atoi(((integer_c *)integer)->value);

    81

    }

    82

    83

    void print_integer(unsigned int integer) {

    84

      char str[10];

    85

      sprintf(str, "%d", integer);

    86

      s4o.print(str);

    87

    }

    88

    89

    void print_integer_incl(unsigned int integer) {

    90

      char str[10];

    91

      sprintf(str, "%d", integer);

    92

      s4o_incl.print(str);

    93

    }

    94

    95

    void *print_list_incl(list_c *list,

    96

         std::string pre_elem_str = "",

    97

         std::string inter_elem_str = "",

    98

         std::string post_elem_str = "",

    99

         visitor_c *visitor = NULL) {

   100

      if (visitor == NULL) visitor = this;

   101

   102

      if (list->n > 0) {

   103

//std::cout << "generate_c_base_c::print_list(n = " << list->n << ")   000\n";

   104

        s4o_incl.print(pre_elem_str);

   105

        list->elements[0]->accept(*visitor);

   106

      }

   107

   108

      for(int i = 1; i < list->n; i++) {

   109

//std::cout << "generate_c_base_c::print_list   " << i << "\n";

   110

        s4o_incl.print(inter_elem_str);

   111

        list->elements[i]->accept(*visitor);

   112

      }

   113

   114

      if (list->n > 0)

   115

        s4o_incl.print(post_elem_str);

   116

   117

      return NULL;

   118

    }

   119

   120

   121

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

   122

/* B 0 - Programming Model */

   123

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

   124

  /* leave for derived classes... */

   125

   126

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

   127

/* B.1 - Common elements */

   128

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

   129

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

   130

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

   131

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

   132

  /* done in base class(es) */

   133

   134

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

   135

/* B 1.2 - Constants */

   136

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

   137

  /* originally empty... */

   138

   139

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

   140

/* B 1.2.1 - Numeric Literals */

   141

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

   142

  /* done in base class(es) */

   143

   144

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

   145

/* B.1.2.2   Character Strings */

   146

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

   147

  /* done in base class(es) */

   148

   149

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

   150

/* B 1.2.3 - Time Literals */

   151

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

   152

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

   153

/* B 1.2.3.1 - Duration */

   154

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

   155

  /* done in base class(es) */

   156

   157

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

   158

/* B 1.2.3.2 - Time of day and Date */

   159

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

   160

  /* done in base class(es) */

   161

   162

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

   163

/* B.1.3 - Data types */

   164

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

   165

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

   166

/* B 1.3.1 - Elementary Data Types */

   167

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

   168

  /* done in base class(es) */

   169

   170

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

   171

/* B.1.3.2 - Generic data types */

   172

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

   173

  /* originally empty... */

   174

   175

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

   176

/* B 1.3.3 - Derived data types */

   177

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

   178

/*  subrange_type_name ':' subrange_spec_init */

   179

void *visit(subrange_type_declaration_c *symbol) {

   180

  TRACE("subrange_type_declaration_c");  

   181

   182

  current_typedefinition = subrange_td;

   183

  current_type_name = symbol->subrange_type_name;

   184

   185

  s4o_incl.print("__DECLARE_DERIVED_TYPE(");

   186

  current_type_name->accept(*basedecl);

   187

  s4o_incl.print(",");

   188

  current_basetypedeclaration = subrangebasetype_bd;

   189

  symbol->subrange_spec_init->accept(*this);

   190

  current_basetypedeclaration = none_bd;

   191

  s4o_incl.print(")\n");

   192

   193

  current_basetypedeclaration = subrangetest_bd;

   194

  symbol->subrange_spec_init->accept(*this);

   195

  current_basetypedeclaration = none_bd;

   196

   197

  current_type_name = NULL;

   198

  current_typedefinition = none_td;

   199

   200

  return NULL;

   201

}

   202

   203

/* subrange_specification ASSIGN signed_integer */

   204

void *visit(subrange_spec_init_c *symbol) {

   205

  TRACE("subrange_spec_init_c");

   206

  symbol->subrange_specification->accept(*this);

   207

  return NULL;

   208

}

   209

   210

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

   211

void *visit(subrange_specification_c *symbol) {

   212

  if (current_typedefinition == subrange_td) {

   213

    switch (current_basetypedeclaration) {

   214

      case subrangebasetype_bd:

   215

        symbol->integer_type_name->accept(*basedecl);

   216

        break;

   217

      case subrangetest_bd:

   218

        if (symbol->subrange != NULL) {

   219

          current_type_name->accept(*this);

   220

          s4o.print(" __CHECK_");

   221

          current_type_name->accept(*this);

   222

          s4o.print("(");

   223

          current_type_name->accept(*this);

   224

          s4o.print(" value) {\n");

   225

          s4o.indent_right();

   226

   227

          if (search_base_type.type_is_subrange(symbol->integer_type_name)) {

   228

            s4o.print(s4o.indent_spaces + "value = __CHECK_");

   229

            symbol->integer_type_name->accept(*this);

   230

            s4o.print("(value);\n");

   231

          }

   232

   233

          symbol->subrange->accept(*this);

   234

   235

          s4o.indent_left();

   236

          s4o.print("}\n");

   237

        }

   238

        else {

   239

          s4o.print("#define __CHECK_");

   240

          current_type_name->accept(*this);

   241

          s4o.print(" __CHECK_");

   242

          symbol->integer_type_name->accept(*this);

   243

          s4o.print("\n");

   244

        }

   245

        break;

   246

      default:

   247

        break;

   248

    }

   249

  }

   250

  else {

   251

    symbol->integer_type_name->accept(*basedecl);

   252

  }

   253

  return NULL;

   254

}

   255

   256

/*  signed_integer DOTDOT signed_integer */

   257

void *visit(subrange_c *symbol) {

   258

  int dimension;

   259

  switch (current_typedefinition) {

   260

    case array_td:

   261

      if (current_basetypedeclaration == arraysubrange_bd) {

   262

        s4o_incl.print("[");

   263

        dimension = extract_integer(symbol->upper_limit) - extract_integer(symbol->lower_limit) + 1;

   264

        print_integer_incl(dimension);

   265

        s4o_incl.print("]");

   266

      }

   267

      else

   268

        symbol->lower_limit->accept(*this);

   269

      break;

   270

    case subrange_td:

   271

      s4o.print(s4o.indent_spaces + "if (value < ");

   272

      symbol->lower_limit->accept(*this);

   273

      s4o.print(")\n");

   274

      s4o.indent_right();

   275

      s4o.print(s4o.indent_spaces + "return ");

   276

      symbol->lower_limit->accept(*this);

   277

      s4o.print(";\n");

   278

      s4o.indent_left();

   279

      s4o.print(s4o.indent_spaces + "else if (value > ");

   280

      symbol->upper_limit->accept(*this);

   281

      s4o.print(")\n");

   282

      s4o.indent_right();

   283

      s4o.print(s4o.indent_spaces + "return ");

   284

      symbol->upper_limit->accept(*this);

   285

      s4o.print(";\n");

   286

      s4o.indent_left();

   287

      s4o.print(s4o.indent_spaces + "else\n");

   288

      s4o.indent_right();

   289

      s4o.print(s4o.indent_spaces + "return value;\n");

   290

      s4o.indent_left();

   291

    default:

   292

      break;

   293

  }

   294

  return NULL;

   295

}

   296

   297

/*  enumerated_type_name ':' enumerated_spec_init */

   298

void *visit(enumerated_type_declaration_c *symbol) {

   299

  TRACE("enumerated_type_declaration_c");

   300

   301

  current_typedefinition = enumerated_td;

   302

  current_type_name = symbol->enumerated_type_name;

   303

   304

  s4o_incl.print("__DECLARE_ENUMERATED_TYPE(");

   305

  current_type_name->accept(*basedecl);

   306

  s4o_incl.print(",\n");

   307

  s4o_incl.indent_right();

   308

  symbol->enumerated_spec_init->accept(*this);

   309

  s4o_incl.indent_left();

   310

  s4o_incl.print(")\n");

   311

   312

  current_type_name = NULL;

   313

  current_typedefinition = none_td;

   314

   315

  return NULL;

   316

}

   317

   318

/* enumerated_specification ASSIGN enumerated_value */

   319

void *visit(enumerated_spec_init_c *symbol) {

   320

  TRACE("enumerated_spec_init_c");

   321

  if (current_typedefinition == enumerated_td)

   322

    symbol->enumerated_specification->accept(*this);

   323

  else

   324

    symbol->enumerated_specification->accept(*basedecl);

   325

  return NULL;

   326

}

   327

   328

/* helper symbol for enumerated_specification->enumerated_spec_init */

   329

/* enumerated_value_list ',' enumerated_value */

   330

void *visit(enumerated_value_list_c *symbol) {

   331

  print_list_incl(symbol, s4o_incl.indent_spaces, ",\n"+s4o_incl.indent_spaces, "\n");

   332

  return NULL;

   333

}

   334

   335

/* enumerated_type_name '#' identifier */

   336

void *visit(enumerated_value_c *symbol) {

   337

  symbol_c *value_type;

   338

  if (current_typedefinition == enumerated_td)

   339

    current_type_name->accept(*basedecl);

   340

  else {

   341

    value_type = (symbol_c *)symbol->accept(search_constant_type);

   342

    if (value_type == NULL) ERROR;

   343

   344

    value_type->accept(*basedecl);

   345

  }

   347

  symbol->value->accept(*basedecl);

   348

  return NULL;

   349

}

   350

   351

/*  identifier ':' array_spec_init */

   352

void *visit(array_type_declaration_c *symbol) {

   353

  TRACE("array_type_declaration_c");

   354

   355

  current_typedefinition = array_td;

   356

  current_type_name = symbol->identifier;

   357

   358

  array_is_derived = false;

   359

  current_basetypedeclaration = arrayderiveddeclaration_bd;

   360

  symbol->array_spec_init->accept(*this);

   361

  current_basetypedeclaration = none_bd;

   362

   363

  if (array_is_derived)

   364

	s4o_incl.print("__DECLARE_DERIVED_TYPE(");

   365

  else

   366

	s4o_incl.print("__DECLARE_ARRAY_TYPE(");

   367

  current_type_name->accept(*basedecl);

   368

  s4o_incl.print(",");

   369

  current_basetypedeclaration = arraybasetypeincl_bd;

   370

  symbol->array_spec_init->accept(*this);

   371

  current_basetypedeclaration = none_bd;

   372

  if (!array_is_derived) {

   373

	s4o_incl.print(",");

   374

	current_basetypedeclaration = arraysubrange_bd;

   375

	symbol->array_spec_init->accept(*this);

   376

	current_basetypedeclaration = none_bd;

   377

  }

   378

  s4o_incl.print(")\n");

   379

   380

  if (search_base_type.type_is_subrange(symbol->identifier)) {

   381

	s4o.print("#define __CHECK_");

   382

	current_type_name->accept(*this);

   383

	s4o.print(" __CHECK_");

   384

	current_basetypedeclaration = arraybasetype_bd;

   385

	symbol->array_spec_init->accept(*this);

   386

	current_basetypedeclaration = none_bd;

   387

	s4o.print("\n");

   388

  }

   389

   390

  current_basetypedeclaration = arraytranslateindex_bd;

   391

  symbol->array_spec_init->accept(*this);

   392

  current_basetypedeclaration = none_bd;

   393

  s4o.print("\n");

   394

   395

  current_type_name = NULL;

   396

  current_typedefinition = none_td;

   397

   398

  return NULL;

   399

}

   400

   401

/* array_specification [ASSIGN array_initialization] */

   402

/* array_initialization may be NULL ! */

   403

void *visit(array_spec_init_c *symbol) {

   404

  TRACE("array_spec_init_c");

   405

   406

  if (current_typedefinition == array_td) {

   407

    switch (current_basetypedeclaration) {

   408

	  case arrayderiveddeclaration_bd:

   409

	    array_is_derived = dynamic_cast<identifier_c *>(symbol->array_specification) != NULL;

   410

	    break;

   411

	  case arraytranslateindex_bd:

   412

	    if (!array_is_derived)

   413

		  symbol->array_specification->accept(*this);

   414

	    s4o.print("#define __");

   415

	    current_type_name->accept(*this);

   416

	    s4o.print("_TRANSIDX(row, index) __");

   417

	    if (array_is_derived)

   418

		   symbol->array_specification->accept(*this);

   419

	    else

   420

		   current_type_name->accept(*this);

   421

	    s4o.print("_TRANSIDX##row(index)");

   422

	    break;

   423

	  default:

   424

	    if (array_is_derived)

   425

		  symbol->array_specification->accept(*basedecl);

   426

	    else

   427

		  symbol->array_specification->accept(*this);

   428

	    break;

   429

    }

   430

  }

   431

  else {

   432

	symbol->array_specification->accept(*basedecl);

   433

  }

   434

  return NULL;

   435

}

   436

   437

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

   438

void *visit(array_specification_c *symbol) {

   439

  switch (current_basetypedeclaration) {

   440

    case arraybasetype_bd:

   441

      symbol->non_generic_type_name->accept(*this);

   442

      break;

   443

    case arraybasetypeincl_bd:

   444

      symbol->non_generic_type_name->accept(*basedecl);

   445

      break;

   446

    case arraysubrange_bd:

   447

    case arraytranslateindex_bd:

   448

      symbol->array_subrange_list->accept(*this);

   449

      break;

   450

    default:

   451

      break;

   452

  }

   453

  return NULL;

   454

}

   455

   456

/* helper symbol for array_specification */

   457

/* array_subrange_list ',' subrange */

   458

void *visit(array_subrange_list_c *symbol) {

   459

  if (current_basetypedeclaration == arraytranslateindex_bd) {

   460

    for (int i = 0; i < symbol->n; i++) {

   461

      s4o.print("#define __");

   462

      current_type_name->accept(*this);

   463

      s4o.print("_TRANSIDX");

   464

      print_integer(i);

   465

      s4o.print("(index) (index) - ");

   466

      symbol->elements[i]->accept(*this);

   467

      s4o.print("\n");

   468

    }

   469

  }

   470

  else

   471

    print_list(symbol);

   472

  return NULL;

   473

}

   474

   475

/*  TYPE type_declaration_list END_TYPE */

   476

void *visit(data_type_declaration_c *symbol) {

   477

  TRACE("data_type_declaration_c");

   478

  symbol->type_declaration_list->accept(*this);

   479

  s4o.print("\n\n");

   480

  return NULL;

   481

}

   482

   483

/* helper symbol for data_type_declaration */

   484

void *visit(type_declaration_list_c *symbol) {

   485

  TRACE("type_declaration_list_c");

   486

  return print_list_incl(symbol, "", "\n", "\n");

   487

}

   488

   489

/*  simple_type_name ':' simple_spec_init */

   490

void *visit(simple_type_declaration_c *symbol) {

   491

  TRACE("simple_type_declaration_c");

   492

   493

  s4o_incl.print("__DECLARE_DERIVED_TYPE(");

   494

  symbol->simple_type_name->accept(*basedecl);

   495

  s4o_incl.print(",");