1

/*

     2

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

     3

 *

     4

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

     5

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

     6

 *

     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

#include <sstream>

    35

#include "create_enumtype_conversion_functions.hh"

    36

    37

/* set to 1 to see debug info during execution */

    38

static const int debug = 0;

    39

    40

    41

/* 

    42

 * The create_enumtype_conversion_functions_c class generates ST source code!

    43

 * This code is in actual fact datatype conversion functions between user defined

    44

 * enumerated datatypes, and some basic datatypes.

    45

 *

    46

 * These conversion functions cannot be implemented the normal way (i.e. in the standard library)

    47

 * since they convert from/to a datatype that is defined by the user. So, we generate these conversions

    48

 * functions on the fly! 

    49

 * (to get an idea of what the generated code looks like, see the comments in create_enumtype_conversion_functions.cc)

    50

 *

    51

 * Currently, we support conversion between the user defined enumerated datatype and STRING,

    52

 * SINT, INT, DINT, LINT, USINT, UINT, UDINT, ULINT (basically the ANY_INT)

    53

 *

    54

 * ST source code is generated when the method get_declaration() is called. since the

    55

 * create_enumtype_conversion_functions_c inherits from the iterator visitor, this method may be 

    56

 * passed either the root of an abstract syntax tree, or sub-tree of the AST.

    57

 *

    58

 * This class will iterate through that AST, and for each enumerated type declaration, will 

    59

 * create the apropriate conversion functions.

    60

 */

    61

    62

create_enumtype_conversion_functions_c *create_enumtype_conversion_functions_c::singleton = NULL;

    63

    64

create_enumtype_conversion_functions_c:: create_enumtype_conversion_functions_c(symbol_c *ignore) {}

    65

create_enumtype_conversion_functions_c::~create_enumtype_conversion_functions_c(void)             {}

    66

    67

    68

std::string &create_enumtype_conversion_functions_c::get_declaration(symbol_c *symbol) {

    69

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

    70

    if (NULL == singleton)  ERROR_MSG("Out of memory. Bailing out!\n");

    71

    72

    singleton->text = "";

    73

    if (NULL != symbol) 

    74

      symbol->accept(*singleton);

    75

    76

    return singleton->text;

    77

}

    78

    79

    80

void *create_enumtype_conversion_functions_c::visit(identifier_c *symbol) {

    81

    currentToken = symbol->value;

    82

    return NULL;

    83

}

    84

    85

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

    86

/* B 1.3 - Data types */

    87

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

    88

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

    89

/* B 1.3.3 - Derived data types */

    90

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

    91

void *create_enumtype_conversion_functions_c::visit(enumerated_type_declaration_c *symbol) {

    92

    std::string enumerateName;

    93

    std::string functionName;

    94

    std::list <std::string> enumerateValues;

    95

    96

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

    97

    enumerateName = currentToken;

    98

    99

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

   100

    enumerateValues = currentTokenList;

   101

   102

    printStringToEnum  (enumerateName, enumerateValues);

   103

    printEnumToString  (enumerateName, enumerateValues);

   104

    for (size_t s = 8; s <= 64; s*= 2) {

   105

        printIntegerToEnum (enumerateName, enumerateValues, true , s);

   106

        printEnumToInteger (enumerateName, enumerateValues, true , s);

   107

        printIntegerToEnum (enumerateName, enumerateValues, false, s);

   108

        printEnumToInteger (enumerateName, enumerateValues, false, s);

   109

    }

   110

    if (debug) std::cout << text << std::endl;

   111

   112

    return NULL;

   113

}

   114

   115

void *create_enumtype_conversion_functions_c::visit(enumerated_value_list_c *symbol) {

   116

    list_c *list;

   117

   118

    currentTokenList.clear();

   119

    list = (list_c *)symbol;

   120

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

   121

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

   122

        currentTokenList.push_back(currentToken);

   123

    }

   124

   125

    return NULL;

   126

}

   127

   128

/*

   129

 * getIntegerName function generate a integer data name from signed and size.

   130

 */

   131

std::string create_enumtype_conversion_functions_c::getIntegerName(bool isSigned, size_t size) {

   132

    std::string integerType = "";

   133

    if (! isSigned) {

   134

        integerType = "U";

   135

    }

   136

    switch(size) {

   137

    case 8 : integerType += "S"; break;

   138

    case 16:                     break;

   139

    case 32: integerType += "D"; break;

   140

    case 64: integerType += "L"; break;

   141

    default:                     break;

   142

    }

   143

    integerType +="INT";

   144

   145

    return integerType;

   146

}

   147

   148

/*

   149

 * printStringToEnum function print conversion function from STRING to <ENUM>:

   150

 * ST Output:

   151

 *

   152

   153

 FUNCTION STRING_TO_<ENUM> : <ENUM>

   154

  VAR_INPUT

   155

  IN: STRING;

   156

  END_VAR

   157

  IF IN = '<ENUM.VALUE_1>' THEN

   158

   STRING_TO_<ENUM> := <ENUM>#<ENUM.VALUE_1>;

   159

   RETURN;

   160

  END_IF;

   161

  ...

   162

  IF IN = '<ENUM.VALU_N>' THEN

   163

   STRING_TO_<ENUM> := <ENUM>#<ENUM.VALUE_N>;

   164

   RETURN;

   165

  END_IF;

   166

  ENO := FALSE;

   167

  END_FUNCTION

   168

   169

  Note: if you change code below remember to update this comment.

   170

 */

   171

void create_enumtype_conversion_functions_c::printStringToEnum  (std::string &enumerateName, std::list<std::string> &enumerateValues) {

   172

    std::list <std::string>::const_iterator itr;

   173

    std::string functionName;

   174

   175

    functionName = "STRING_TO_" + enumerateName;

   176

    text += "FUNCTION " + functionName + " : " + enumerateName;

   177

    text += "\nVAR_INPUT\nIN : STRING;\nEND_VAR\n";

   178

    for (itr = enumerateValues.begin(); itr != enumerateValues.end(); ++itr) {

   179

       std::string value = *itr;

   180

       text += "IF IN = '" + value + "' THEN\n";

   181

       text += " " + functionName + " := " + enumerateName + "#" + value + ";\n";

   182

       text += " RETURN;\n"; 

   183

       text += "END_IF;\n";

   184

    }

   185

    text += "ENO := FALSE;\n";

   186

    text += "END_FUNCTION\n\n";

   187

}

   188

   189

/*

   190

 * printEnumToString function print conversion function from <ENUM> to STRING:

   191

 * ST Output:

   192

 *

   193

   194

 FUNCTION <ENUM>_TO_STRING : STRING

   195

  VAR_INPUT

   196

  IN: <ENUM>;

   197

  END_VAR

   198

  IF IN = <ENUM>#<ENUM.VALUE_1> THEN

   199

   <ENUM>_TO_STRING := '<ENUM>#<ENUM.VALUE_1>';

   200

   RETURN;

   201

  END_IF;

   202

  ...

   203

  IF IN = <ENUM>#<ENUM.VALUE_N> THEN

   204

   <ENUM>_TO_STRING := '<ENUM>#<ENUM.VALUE_N>';

   205

   RETURN;

   206

  END_IF;

   207

  ENO := FALSE;

   208

  END_FUNCTION

   209

   210

  Note: if you change code below remember to update this comment.

   211

 */

   212

void create_enumtype_conversion_functions_c::printEnumToString  (std::string &enumerateName, std::list<std::string> &enumerateValues) {

   213

    std::list <std::string>::const_iterator itr;

   214

    std::string functionName;

   215

   216

    functionName = enumerateName + "_TO_STRING";

   217

    text += "FUNCTION " + functionName + " : STRING";

   218

    text += "\nVAR_INPUT\nIN : " + enumerateName + ";\nEND_VAR\n";

   219

    for (itr = enumerateValues.begin(); itr != enumerateValues.end(); ++itr) {

   220

        std::string value = *itr;

   221

        text += "IF IN = " + enumerateName + "#" + value + " THEN\n";

   222

        text += " " + functionName + " := '" + enumerateName + "#" + value + "';\n";

   223

        text += " RETURN;\n";

   224

        text += "END_IF;\n";

   225

    }

   226

    text += "ENO := FALSE;\n";

   227

    text += "END_FUNCTION\n\n";

   228

}

   229

   230

/*

   231

 * printIntegerToEnum function print conversion function from <INTEGER> to <ENUM>:

   232

 * ST Output:

   233

 *

   234

   235

 FUNCTION <INTEGER>_TO_<ENUM> : <ENUM>

   236

  VAR_INPUT

   237

  IN: <INTEGER>;

   238

  END_VAR

   239

  IF IN = 1 THEN

   240

   <INTEGER>_TO_<ENUM> := <ENUM>#<ENUM.VALUE_1>;

   241

   RETURN;

   242

  END_IF;

   243

  ...

   244

  IF IN = N THEN

   245

   <INTEGER>_TO_<ENUM> := <ENUM>#<ENUM.VALUE_N>;

   246

   RETURN;

   247

  END_IF;

   248

  ENO := FALSE;

   249

  END_FUNCTION

   250

   251

  Note: if you change code below remember to update this comment.

   252

 */

   253

void create_enumtype_conversion_functions_c::printIntegerToEnum (std::string &enumerateName, std::list<std::string> &enumerateValues, bool isSigned, size_t size) {

   254

    std::list <std::string>::const_iterator itr;

   255

    std::string functionName;

   256

    std::string integerType;

   257

    int count;

   258

   259

    integerType  = getIntegerName(isSigned, size);

   260

    functionName = integerType + "_TO_" + enumerateName;

   261

    text += "FUNCTION " + functionName + " : " + enumerateName;

   262

    text += "\nVAR_INPUT\nIN : " + integerType + ";\nEND_VAR\n";

   263

    count = 0;

   264

    for (itr = enumerateValues.begin(); itr != enumerateValues.end(); ++itr) {

   265

        std::string value = *itr;

   266

        std::stringstream out;

   267

        out << count;

   268

        text += "IF IN = " + out.str() + " THEN\n";

   269

        text += " " + functionName + " := " + enumerateName + "#" + value + ";\n";

   270

        text += " RETURN;\n";

   271

        text += "END_IF;\n";

   272

        count++;

   273

    }

   274

    text += "ENO := FALSE;\n";

   275

    text += "END_FUNCTION\n\n";

   276

}

   277

   278

/*

   279

 * printEnumToInteger function print conversion function from <ENUM> to <INTEGER>:

   280

 * ST Output:

   281

 *

   282

   283

 FUNCTION <ENUM>_TO_<INTEGER> : <INTEGER>

   284

  VAR_INPUT

   285

  IN: <INTEGER>;

   286

  END_VAR

   287

  IF IN = <ENUM>#<ENUM.VALUE_1> THEN

   288

   <ENUM>_TO_<INTEGER> := 1;

   289

   RETURN;

   290

  END_IF;

   291

  ...

   292

  IF IN = <ENUM>#<ENUM.VALUE_N> THEN

   293

   <ENUM>_TO_<INTEGER> := N;

   294

   RETURN;

   295

  END_IF;

   296

  ENO := FALSE;

   297

  END_FUNCTION

   298

   299

  Note: if you change code below remember to update this comment.

   300

 */

   301

void create_enumtype_conversion_functions_c::printEnumToInteger (std::string &enumerateName, std::list<std::string> &enumerateValues, bool isSigned, size_t size) {

   302

    std::list <std::string>::const_iterator itr;

   303

    std::string functionName;

   304

    std::string integerType;

   305

    int count;

   306

   307

    integerType  = getIntegerName(isSigned, size);

   308

    functionName = enumerateName + "_TO_" + integerType;

   309

    text += "FUNCTION " + functionName + " : " + integerType;

   310

    text += "\nVAR_INPUT\nIN : " + enumerateName + ";\nEND_VAR\n";

   311

    count = 0;

   312

    for (itr = enumerateValues.begin(); itr != enumerateValues.end(); ++itr) {

   313

        std::string value = *itr;

   314

        std::stringstream out;

   315

        out << count;

   316

        text += "IF IN = " + enumerateName + "#" + value + " THEN\n";

   317

        text += " " + functionName + " := " + out.str() + ";\n";

   318

        text += " RETURN;\n";

   319

        text += "END_IF;\n";

   320

        count++;

   321

    }

   322

    text += "ENO := FALSE;\n";

   323

    text += "END_FUNCTION\n\n";

   324

}

   325

   326

   327