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

/* As the name of derived datatypes and POUs are still stored as identifiers in the respective datatype and POU declaration,  */

    80

/* only the indintifier_c visitor should be necessary!                                                                        */

    81

void *create_enumtype_conversion_functions_c::visit(                 identifier_c *symbol) {currentToken = symbol->value; return NULL;}

    82

void *create_enumtype_conversion_functions_c::visit(         poutype_identifier_c *symbol) {ERROR; return NULL;}

    83

void *create_enumtype_conversion_functions_c::visit(derived_datatype_identifier_c *symbol) {ERROR; return NULL;}

    84

    85

    86

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

    87

/* B 1.3 - Data types */

    88

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

    89

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

    90

/* B 1.3.3 - Derived data types */

    91

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

    92

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

    93

    std::string enumerateName;

    94

    std::string functionName;

    95

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

    96

    97

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

    98

    enumerateName = currentToken;

    99

   100

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

   101

    enumerateValues = currentTokenList;

   102

   103

    printStringToEnum  (enumerateName, enumerateValues);

   104

    printEnumToString  (enumerateName, enumerateValues);

   105

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

   106

        printIntegerToEnum (enumerateName, enumerateValues, true , s);

   107

        printEnumToInteger (enumerateName, enumerateValues, true , s);

   108

        printIntegerToEnum (enumerateName, enumerateValues, false, s);

   109

        printEnumToInteger (enumerateName, enumerateValues, false, s);

   110

    }

   111

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

   112

   113

    return NULL;

   114

}

   115

   116

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

   117

    list_c *list;

   118

   119

    currentTokenList.clear();

   120

    list = (list_c *)symbol;

   121

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

   122

        list->get_element(i)->accept(*this);

   123

        currentTokenList.push_back(currentToken);

   124

    }

   125

   126

    return NULL;

   127

}

   128

   129

/*

   130

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

   131

 */

   132

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

   133

    std::string integerType = "";

   134

    if (! isSigned) {

   135

        integerType = "U";

   136

    }

   137

    switch(size) {

   138

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

   139

    case 16:                     break;

   140

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

   141

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

   142

    default:                     break;

   143

    }

   144

    integerType +="INT";

   145

   146

    return integerType;

   147

}

   148

   149

/*

   150

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

   151

 * ST Output:

   152

 *

   153

   154

 FUNCTION STRING_TO_<ENUM> : <ENUM>

   155

  VAR_INPUT

   156

  IN: STRING;

   157

  END_VAR

   158

  IF IN = '<ENUM.VALUE_1>' THEN

   159

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

   160

   RETURN;

   161

  END_IF;

   162

  ...

   163

  IF IN = '<ENUM.VALU_N>' THEN

   164

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

   165

   RETURN;

   166

  END_IF;

   167

  ENO := FALSE;

   168

  END_FUNCTION

   169

   170

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

   171

 */

   172

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

   173

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

   174

    std::string functionName;

   175

   176

    functionName = "STRING_TO_" + enumerateName;

   177

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

   178

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

   179

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

   180

       std::string value = *itr;

   181

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

   182

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

   183

       text += " RETURN;\n"; 

   184

       text += "END_IF;\n";

   185

    }

   186

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

   187

    text += "END_FUNCTION\n\n";

   188

}

   189

   190

/*

   191

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

   192

 * ST Output:

   193

 *

   194

   195

 FUNCTION <ENUM>_TO_STRING : STRING

   196

  VAR_INPUT

   197

  IN: <ENUM>;

   198

  END_VAR

   199

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

   200

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

   201

   RETURN;

   202

  END_IF;

   203

  ...

   204

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

   205

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

   206

   RETURN;

   207

  END_IF;

   208

  ENO := FALSE;

   209

  END_FUNCTION

   210

   211

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

   212

 */

   213

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

   214

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

   215

    std::string functionName;

   216

   217

    functionName = enumerateName + "_TO_STRING";

   218

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

   219

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

   220

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

   221

        std::string value = *itr;

   222

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

   223

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

   224

        text += " RETURN;\n";

   225

        text += "END_IF;\n";

   226

    }

   227

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

   228

    text += "END_FUNCTION\n\n";

   229

}

   230

   231

/*

   232

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

   233

 * ST Output:

   234

 *

   235

   236

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

   237

  VAR_INPUT

   238

  IN: <INTEGER>;

   239

  END_VAR

   240

  IF IN = 1 THEN

   241

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

   242

   RETURN;

   243

  END_IF;

   244

  ...

   245

  IF IN = N THEN

   246

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

   247

   RETURN;

   248

  END_IF;

   249

  ENO := FALSE;

   250

  END_FUNCTION

   251

   252

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

   253

 */

   254

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

   255

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

   256

    std::string functionName;

   257

    std::string integerType;

   258

    int count;

   259

   260

    integerType  = getIntegerName(isSigned, size);

   261

    functionName = integerType + "_TO_" + enumerateName;

   262

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

   263

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

   264

    count = 0;

   265

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

   266

        std::string value = *itr;

   267

        std::stringstream out;

   268

        out << count;

   269

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

   270

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

   271

        text += " RETURN;\n";

   272

        text += "END_IF;\n";

   273

        count++;

   274

    }

   275

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

   276

    text += "END_FUNCTION\n\n";

   277

}

   278

   279

/*

   280

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

   281

 * ST Output:

   282

 *

   283

   284

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

   285

  VAR_INPUT

   286

  IN: <INTEGER>;

   287

  END_VAR

   288

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

   289

   <ENUM>_TO_<INTEGER> := 1;

   290

   RETURN;

   291

  END_IF;

   292

  ...

   293

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

   294

   <ENUM>_TO_<INTEGER> := N;

   295

   RETURN;

   296

  END_IF;

   297

  ENO := FALSE;

   298

  END_FUNCTION

   299

   300

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

   301

 */

   302

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

   303

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

   304

    std::string functionName;

   305

    std::string integerType;

   306

    int count;

   307

   308

    integerType  = getIntegerName(isSigned, size);

   309

    functionName = enumerateName + "_TO_" + integerType;

   310

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

   311

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

   312

    count = 0;

   313

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

   314

        std::string value = *itr;

   315

        std::stringstream out;

   316

        out << count;

   317

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

   318

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

   319

        text += " RETURN;\n";

   320

        text += "END_IF;\n";

   321

        count++;

   322

    }

   323

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

   324

    text += "END_FUNCTION\n\n";

   325

}

   326

   327

   328