1

#!/usr/bin/env python

     2

# -*- coding: utf-8 -*-

     3

     4

#This file is part of PLCOpenEditor, a library implementing an IEC 61131-3 editor

     5

#based on the plcopen standard. 

     6

#

     7

#Copyright (C) 2007: Edouard TISSERANT and Laurent BESSARD

     8

#

     9

#See COPYING file for copyrights details.

    10

#

    11

#This library is free software; you can redistribute it and/or

    12

#modify it under the terms of the GNU General Public

    13

#License as published by the Free Software Foundation; either

    14

#version 2.1 of the License, or (at your option) any later version.

    15

#

    16

#This library is distributed in the hope that it will be useful,

    17

#but WITHOUT ANY WARRANTY; without even the implied warranty of

    18

#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

    19

#General Public License for more details.

    20

#

    21

#You should have received a copy of the GNU General Public

    22

#License along with this library; if not, write to the Free Software

    23

#Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    24

    25

"""

    26

    27

 THIS CODE GENARATES C++ CODE FOR IEC2C COMPILER

    28

 GENERATED CODE IS :

    29

    30

function_type_decl.h - the long enumeration of std function types

    31

get_function_type_decl.c - the funct that return enumerated according function name

    32

st_code_gen.c - part of generate_c_st_c::visit(function_invocation)

    33

                responsible to generate C code for std lib calls

    34

il_code_gen.c - part of generate_c_il_c::visit(il_function_call)

    35

                responsible to generate C code for std lib calls

    36

search_type_code.c - called by search_expression_type_c::visit(function_invocation) 

    37

                     return type symbol for std function invocation

    38

    39

"""

    40

    41

# Get definitions

    42

from plcopen.structures import *

    43

    44

if len(sys.argv) != 2 :

    45

    print "Usage: " + sys.argv[0] + " path_name\n -> create files in path_name"

    46

    sys.exit(0)

    47

    48

#import pprint

    49

#pp = pprint.PrettyPrinter(indent=4)

    50

    51

matiec_header = """/*

    52

 * (c) 2008 Edouard TISSERANT

    53

 *

    54

 * Offered to the public under the terms of the GNU General Public License

    55

 * as published by the Free Software Foundation; either version 2 of the

    56

 * License, or (at your option) any later version.

    57

 *

    58

 * This program is distributed in the hope that it will be useful, but

    59

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    60

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General

    61

 * Public License for more details.

    62

 *

    63

 * This code is made available on the understanding that it will not be

    64

 * used in safety-critical situations without a full and competent review.

    65

 */

    66

    67

/*

    68

 * An IEC 61131-3 IL and ST compiler.

    69

 *

    70

 * Based on the

    71

 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)

    72

 *

    73

 */

    74

    75

/****

    76

 * IEC 61131-3 standard function library

    77

 * generated code, do not edit by hand

    78

 */

    79

    80

 """

    81

    82

matiec_lesser_header = """/*

    83

 * (c) 2008 Edouard TISSERANT

    84

 *

    85

 * Offered to the public under the terms of the GNU Lesser General Public

    86

 * License as published by the Free Software Foundation; either version 2

    87

 * of the License, or (at your option) any later version.

    88

 *

    89

 * This program is distributed in the hope that it will be useful, but

    90

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    91

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser

    92

 * General Public License for more details.

    93

 *

    94

 * This code is made available on the understanding that it will not be

    95

 * used in safety-critical situations without a full and competent review.

    96

 */

    97

    98

/****

    99

 * IEC 61131-3 standard function library

   100

 * generated code, do not edit by hand

   101

 */

   102

   103

 """

   104

   105

def ANY_to_compiler_test_type_GEN(typename, paramname):

   106

    """

   107

    Convert ANY_XXX IEC type declaration into IEC2C's generated type test.

   108

    This tests are defined in search_expression_type.cc 

   109

    """

   110

    return {"ANY" : "",

   111

    "ANY_BIT" : "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_binary_type(%(paramname)s_type_symbol))",

   112

    "ANY_NBIT" : "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_nbinary_type(%(paramname)s_type_symbol))",

   113

    "ANY_NUM" : "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_num_type(%(paramname)s_type_symbol))",

   114

    "ANY_REAL" : "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_real_type(%(paramname)s_type_symbol))",

   115

    "ANY_INT" : "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_integer_type(%(paramname)s_type_symbol))"

   116

    }.get(typename,

   117

        #"if (typeid(*last_type_symbol) == typeid(%(typename)s_type_name_c))")%{

   118

        "if(%(paramname)s_type_symbol == NULL || search_expression_type->is_same_type(&search_constant_type_c::%(typename)s_type_name, last_type_symbol))")%{

   119

                "paramname" : paramname, "typename": typename.lower()}

   120

   121

def recurse_and_indent(fdecls, indent, do_type_search_only = False, do_il = False):

   122

    """

   123

    This function generate visit(function_invocation) code for 

   124

        - ST code generator

   125

        - IL code generator

   126

        - search_expression_type class for ST

   127

        - search_expression_type class for IL

   128

   129

    Input data is a 

   130

    "{fname : {IN[0]paramname : {IN[0]paramtype : {IN[1]paraname : {IN[1]paramtype : {... : {IN[N]paraname : {IN[N]paramtype : (fdecl,)}}}}}}"

   131

    nested dictionary structure.

   132

    """

   133

    if type(fdecls) != type(tuple()):

   134

        res = ""

   135

        for Paramname, ParamTypes in fdecls.iteritems():

   136

            if do_il:

   137

                res += """

   138

{"""

   139

                if not do_type_search_only:

   140

                    res += """

   141

    identifier_c %(input_name)s_param_name("%(input_name)s");

   142

    /* Get the value from a foo(<param_name> = <param_value>) style call */

   143

    symbol_c *%(input_name)s_param_value = &this->default_variable_name;

   144

"""%{"input_name":Paramname}

   145

                res += """

   146

    symbol_c *%(input_name)s_type_symbol = param_data_type;

   147

    last_type_symbol = param_data_type;

   148

"""%{"input_name":Paramname}

   149

            else:

   150

                res += """

   151

{

   152

    identifier_c %(input_name)s_param_name("%(input_name)s");

   153

    /* Get the value from a foo(<param_name> = <param_value>) style call */

   154

    symbol_c *%(input_name)s_param_value = function_call_param_iterator.search_f(&%(input_name)s_param_name);

   155

    symbol_c *%(input_name)s_type_symbol = NULL;

   156

   157

    /* Get the value from a foo(<param_value>) style call */

   158

    if (%(input_name)s_param_value == NULL)

   159

      %(input_name)s_param_value = function_call_param_iterator.next_nf();

   160

    if (%(input_name)s_param_value != NULL) {

   161

      %(input_name)s_type_symbol = search_expression_type->get_type(%(input_name)s_param_value);

   162

      last_type_symbol = last_type_symbol && %(input_name)s_type_symbol && search_expression_type->is_same_type(%(input_name)s_type_symbol, last_type_symbol) ? search_expression_type->common_type(%(input_name)s_type_symbol, last_type_symbol) : %(input_name)s_type_symbol ;

   163

    }

   164

"""%{"input_name":Paramname}

   165

   166

            for ParamType,NextParamDecl in ParamTypes.iteritems():

   167

   168

                res += """    

   169

    %(type_test)s

   170

    {

   171

%(if_good_type_code)s

   172

    }

   173

"""%{

   174

    "type_test":ANY_to_compiler_test_type_GEN(ParamType,Paramname), 

   175

    "if_good_type_code":recurse_and_indent(NextParamDecl,indent,do_type_search_only).replace('\n','\n    ')}

   176

   177

            res += """    

   178

   179

    ERROR;

   180

}

   181

"""

   182

   183

        return res.replace('\n','\n'+indent)

   184

    else:

   185

        res = "\n"

   186

        fdecl=fdecls[0]

   187

   188

        if not do_type_search_only:

   189

            code_gen = eval(fdecl["python_eval_c_code_format"])

   190

   191

            if code_gen[1] is not None:

   192

                res += "function_name = (symbol_c*)(new pragma_c(\"%s\"));\n"%code_gen[1]

   193

            if fdecl["extensible"]:

   194

                res += """

   195

if (nb_param < %(min_nb_param)d)

   196

  nb_param = %(min_nb_param)d;

   197

char* nb_param_str = new char[10];

   198

sprintf(nb_param_str, "%%d", nb_param);

   199

identifier_c nb_param_name("nb_param");

   200

ADD_PARAM_LIST(&nb_param_name, (symbol_c*)(new integer_c((const char *)nb_param_str)), (symbol_c*)(new int_type_name_c()), function_param_iterator_c::direction_in)

   201

"""%{"min_nb_param" : len(fdecl["inputs"])}

   202

            for paramname,paramtype,unused in fdecl["inputs"]:

   203

                res += """

   204

if (%(input_name)s_type_symbol == NULL)

   205

  %(input_name)s_type_symbol = last_type_symbol;

   206

ADD_PARAM_LIST(&%(input_name)s_param_name, %(input_name)s_param_value, %(input_name)s_type_symbol, function_param_iterator_c::direction_in)

   207

"""%{"input_name" : paramname}

   208

            if fdecl["extensible"]:

   209

                res += """

   210

int base_num = %d;

   211

symbol_c *param_value = NULL;

   212

do{

   213

    char my_name[10];

   214

    sprintf(my_name, "IN%%d", base_num++);

   215

    identifier_c param_name(my_name);

   216

   217

    /* Get the value from a foo(<param_name> = <param_value>) style call */

   218

    param_value = function_call_param_iterator.search_f(&param_name);

   219

   220

    /* Get the value from a foo(<param_value>) style call */

   221

    if (param_value == NULL)

   222

      param_value = function_call_param_iterator.next_nf();

   223

    if (param_value != NULL){

   224

        symbol_c *current_type_symbol = search_expression_type->get_type(param_value);

   225

        last_type_symbol = last_type_symbol && search_expression_type->is_same_type(current_type_symbol, last_type_symbol) ? search_expression_type->common_type(current_type_symbol, last_type_symbol) : current_type_symbol ;

   226

   227

        /*Function specific CODE */

   228

        ADD_PARAM_LIST(&param_name, param_value, current_type_symbol, function_param_iterator_c::direction_in)

   229

    }

   230

   231

}while(param_value != NULL);

   232

"""%(fdecl["baseinputnumber"] + 2)

   233

   234

        result_type_rule = fdecl["return_type_rule"]

   235

        res += {

   236

            "copy_input" : """symbol_c * return_type_symbol;

   237

if (search_expression_type->is_literal_integer_type(last_type_symbol))

   238

    return_type_symbol = &search_constant_type_c::%s_type_name;

   239

else

   240

    return_type_symbol = last_type_symbol;

   241

"""%({True: "lword", False: """lint_type_name;

   242

else if (search_expression_type->is_literal_real_type(last_type_symbol))

   243

    return_type_symbol = &search_constant_type_c::lreal"""}[reduce(lambda x, y: x or y, [paramtype == "ANY_BIT" for paramname,paramtype,unused in fdecl["inputs"]], False)]),

   244

            "defined" : "symbol_c * return_type_symbol = &search_constant_type_c::%s_type_name;\n"%fdecl["outputs"][0][1].lower(),

   245

            }.get(result_type_rule, "symbol_c * return_type_symbol = %s;\n"%result_type_rule)

   246

   247

        if not do_type_search_only:

   248

            if code_gen[0] is not None:

   249

                res += "function_type_prefix = %s;\n"%{"return_type" : "return_type_symbol"}.get(code_gen[0], "(symbol_c*)(new pragma_c(\"%s\"))"%code_gen[0])

   250

            if code_gen[2] is not None:

   251

                res += "function_type_suffix = %s_symbol;\n"%{"common_type" : "last_type"}.get(code_gen[2], code_gen[2])

   252

            res += "break;\n"

   253

        else:

   254

            res += "return return_type_symbol;\n"

   255

   256

        return res.replace('\n','\n'+indent)

   257

   258

###################################################################

   259

###                                                             ###

   260

###                           MAIN                              ###

   261

###                                                             ###

   262

###################################################################

   263

   264

"""

   265

Reorganize std_decl from structure.py

   266

into a nested dictionnary structure (i.e. a tree):

   267

"{fname : {IN[0]paramname : {IN[0]paramtype : {IN[1]paraname : {IN[1]paramtype : {... : {IN[N]paraname : {IN[N]paramtype : (fdecl,)}}}}}}"

   268

Keep ptrack of original declaration order in a 

   269

separated list called official_order

   270

"""

   271

std_fdecls = {}

   272

official_order = []

   273

for section in std_decl:

   274

    for fdecl in section["list"]:

   275

        if len(official_order)==0 or official_order[-1] != fdecl["name"]:

   276

            official_order.append(fdecl["name"])

   277

        # store all func by name in a dict

   278

        std_fdecls_fdecl_name = std_fdecls.get(fdecl["name"], {})

   279

        current = std_fdecls_fdecl_name

   280

        for i in fdecl["inputs"]:

   281

            current[i[0]] = current.get(i[0], {})

   282

            current = current[i[0]]

   283

            last = current

   284

            current[i[1]] = current.get(i[1], {})

   285

            current = current[i[1]]

   286

        last[i[1]]=(fdecl,)

   287

        std_fdecls[fdecl["name"]] = std_fdecls_fdecl_name

   288

   289

###################################################################

   290

   291

"""

   292

Generate the long enumeration of std function types

   293

"""

   294

function_type_decl =  matiec_header + """

   295

typedef enum {

   296

"""

   297

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   298

    function_type_decl += "    function_"+fname.lower()+",\n"

   299

   300

function_type_decl += """    function_none

   301

} function_type_t;

   302

"""

   303

###################################################################

   304

"""

   305

Generate the funct that return enumerated according function name

   306

"""

   307

get_function_type_decl = matiec_header + """

   308

function_type_t get_function_type(identifier_c *function_name) {

   309

"""

   310

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   311

    get_function_type_decl += """

   312

if (!strcasecmp(function_name->value, "%s"))

   313

    return function_%s;

   314

"""%(fname,fname.lower())

   315

   316

get_function_type_decl += """

   317

    else return function_none;

   318

}

   319

   320

"""

   321

###################################################################

   322

"""

   323

Generate the part of generate_c_st_c::visit(function_invocation)

   324

that is responsible to generate C code for std lib calls.

   325

"""

   326

st_code_gen = matiec_header + """

   327

switch(current_function_type){

   328

"""

   329

   330

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   331

    st_code_gen += """

   332

/****

   333

 *%s

   334

 */

   335

    case function_%s :

   336

    {

   337

        symbol_c *last_type_symbol = NULL;

   338

"""    %(fname, fname.lower())

   339

    indent =  "    "

   340

   341

    st_code_gen += recurse_and_indent(fdecls, indent).replace('\n','\n    ')

   342

   343

    st_code_gen += """

   344

    }/*function_%s*/

   345

    break;

   346

"""    %(fname.lower())

   347

st_code_gen +=  """

   348

    case function_none :

   349

    ERROR;

   350

}

   351

"""

   352

   353

###################################################################

   354

"""

   355

Generate the part of generate_c_il_c::visit(il_function_call)

   356

that is responsible to generate C code for std lib calls.

   357

"""

   358

il_code_gen = matiec_header + """

   359

switch(current_function_type){

   360

"""

   361

   362

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   363

    il_code_gen += """

   364

/****

   365

 *%s

   366

 */

   367

    case function_%s :

   368

    {

   369

        symbol_c *last_type_symbol = NULL;

   370

"""    %(fname, fname.lower())

   371

    indent =  "    "

   372

   373

    il_code_gen += recurse_and_indent(fdecls, indent, do_il=True).replace('\n','\n    ')

   374

   375

    il_code_gen += """

   376

    }/*function_%s*/

   377

    break;

   378

"""    %(fname.lower())

   379

il_code_gen +=  """

   380

    case function_none :

   381

    ERROR;

   382

}

   383

"""

   384

   385

###################################################################

   386

"""

   387

Generate the part of search_expression_type_c::visit(function_invocation)

   388

that is responsible of returning type symbol for function invocation.

   389

"""

   390

search_type_code = matiec_header + """

   391

   392

void *search_expression_type_c::compute_standard_function_default(function_invocation_c *st_symbol = NULL, il_formal_funct_call_c *il_symbol = NULL) {

   393

  function_type_t current_function_type;

   394

  function_call_param_iterator_c *tmp_function_call_param_iterator;

   395

  if (st_symbol != NULL && il_symbol == NULL) {

   396

    current_function_type = get_function_type((identifier_c *)st_symbol->function_name);

   397

    tmp_function_call_param_iterator = new function_call_param_iterator_c(st_symbol);

   398

  }

   399

  else if (st_symbol == NULL && il_symbol != NULL) {

   400

    current_function_type = get_function_type((identifier_c *)il_symbol->function_name);

   401

    tmp_function_call_param_iterator = new function_call_param_iterator_c(il_symbol);

   402

  }

   403

  else

   404

    ERROR;

   405

  function_call_param_iterator_c function_call_param_iterator(*tmp_function_call_param_iterator);

   406

  search_expression_type_c* search_expression_type = this;

   407

   408

  switch(current_function_type){

   409

"""

   410

   411

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   412

    search_type_code += """

   413

/****

   414

 *%s

   415

 */

   416

    case function_%s :

   417

    {

   418

        symbol_c *last_type_symbol = NULL;

   419

"""    %(fname, fname.lower())

   420

    indent =  "    "

   421

   422

    search_type_code += recurse_and_indent(fdecls, indent, True).replace('\n','\n    ')

   423

   424

    search_type_code += """

   425

    }/*function_%s*/

   426

    break;

   427

"""    %(fname.lower())

   428

search_type_code += """

   429

    case function_none :

   430

    ERROR;

   431

  }

   432

  return NULL;

   433

}

   434

   435

void *search_expression_type_c::compute_standard_function_il(il_function_call_c *symbol, symbol_c *param_data_type) {

   436

   437

  function_type_t current_function_type = get_function_type((identifier_c *)symbol->function_name);

   438

  function_call_param_iterator_c function_call_param_iterator(symbol);  

   439

  search_expression_type_c* search_expression_type = this;

   440

   441

  switch(current_function_type){

   442

"""

   443

   444

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   445

    search_type_code += """

   446

/****

   447

 *%s

   448

 */

   449

    case function_%s :

   450

    {

   451

        symbol_c *last_type_symbol = NULL;

   452

"""    %(fname, fname.lower())

   453

    indent =  "    "

   454

   455

    search_type_code += recurse_and_indent(fdecls, indent, True, True).replace('\n','\n    ')

   456

   457

    search_type_code += """

   458

    }/*function_%s*/

   459

    break;

   460

"""    %(fname.lower())

   461

search_type_code += """

   462

    case function_none :

   463

    ERROR;

   464

  }

   465

  return NULL;

   466

}

   467

"""

   468

   469

###################################################################

   470

###################################################################

   471

###################################################################

   472

"""

   473

Generate the standard_function_names[] for inclusion in bizon generated code

   474

"""

   475

standard_function_names = matiec_header + """

   476

const char *standard_function_names[] = {

   477

"""

   478

for fname, fdecls in [ (fname,std_fdecls[fname]) for fname in official_order ]:

   479

    standard_function_names += "\""+fname+"\",\n"

   480

standard_function_names += """

   481

/* end of array marker! Do not remove! */

   482

NULL

   483

};

   484

   485

"""

   486

   487

###################################################################

   488

###################################################################

   489

###################################################################

   490

"""

   491

Generate the C implementation of the IEC standard function library.

   492

"""

   493

iec_std_lib_generated = matiec_lesser_header + """

   494

   495

/* Macro that expand to subtypes */

   496

"""

   497

for typename, parenttypename in TypeHierarchy_list:

   498

    if (typename.startswith("ANY")):

   499

        iec_std_lib_generated += "#define " + typename + "(DO)"

   500

        for typename2, parenttypename2 in TypeHierarchy_list:

   501

            if(parenttypename2 == typename):

   502

                if(typename2.startswith("ANY")):

   503

                    iec_std_lib_generated +=  " " + typename2 + "(DO)"

   504

                else:

   505

                    iec_std_lib_generated +=  " DO(" + typename2 + ")"

   506

        iec_std_lib_generated +=  "\n"

   507

    else:

   508

        break

   509