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

#import pprint

    45

#pp = pprint.PrettyPrinter(indent=4)

    46

    47

matiec_header = """/*

    48

 * (c) 2008 Edouard TISSERANT

    49

 *

    50

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

    51

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

    52

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

    53

 *

    54

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

    55

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    56

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

    57

 * Public License for more details.

    58

 *

    59

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

    60

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

    61

 */

    62

    63

/*

    64

 * An IEC 61131-3 IL and ST compiler.

    65

 *

    66

 * Based on the

    67

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

    68

 *

    69

 */

    70

    71

/****

    72

 * IEC 61131-3 standard function library

    73

 * generated code, do not edit by hand

    74

 */

    75

    76

 """

    77

    78

matiec_lesser_header = """/*

    79

 * (c) 2008 Edouard TISSERANT

    80

 *

    81

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

    82

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

    83

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

    84

 *

    85

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

    86

 * WITHOUT ANY WARRANTY; without even the implied warranty of

    87

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

    88

 * General Public License for more details.

    89

 *

    90

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

    91

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

    92

 */

    93

    94

/****

    95

 * IEC 61131-3 standard function library

    96

 * generated code, do not edit by hand

    97

 */

    98

    99

 """

   100

   101

def ANY_to_compiler_test_type_GEN(typename, paramname):

   102

    """

   103

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

   104

    This tests are defined in search_expression_type.cc 

   105

    """

   106

    return {"ANY" : "",

   107

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

   108

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

   109

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

   110

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

   111

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

   112

    }.get(typename,

   113

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

   114

        "if(search_expression_type->is_same_type(&search_constant_type_c::%(typename)s_type_name, last_type_symbol))")%{

   115

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

   116

   117

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

   118

    """

   119

    This function generate visit(function_invocation) code for 

   120

        - ST code generator

   121

        - IL code generator

   122

        - search_expression_type class for ST

   123

        - search_expression_type class for IL

   124

   125

    Input data is a 

   126

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

   127

    nested dictionary structure.

   128

    """

   129

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

   130

        res = ""

   131

        for Paramname, ParamTypes in fdecls.iteritems():

   132

            if do_il:

   133

                res += """

   134

{"""

   135

                if not do_type_search_only:

   136

                    res += """

   137

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

   138

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

   139

"""%{"input_name":Paramname}

   140

                res += """

   141

    symbol_c *%(input_name)s_type_symbol = param_data_type;

   142

    last_type_symbol = param_data_type;

   143

"""%{"input_name":Paramname}

   144

            else:

   145

                res += """

   146

{

   147

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

   148

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

   149

    symbol_c *%(input_name)s_param_value = function_call_param_iterator.search(&param_name);

   150

   151

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

   152

    if (%(input_name)s_param_value == NULL)

   153

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

   154

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

   155

    last_type_symbol = last_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 ;

   156

"""%{"input_name":Paramname}

   157

   158

            for ParamType,NextParamDecl in ParamTypes.iteritems():

   159

   160

                res += """    

   161

    %(type_test)s

   162

    {

   163

%(if_good_type_code)s

   164

    }

   165

"""%{

   166

    "type_test":ANY_to_compiler_test_type_GEN(ParamType,Paramname), 

   167

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

   168

   169

            res += """    

   170

    ERROR;

   171

}

   172

"""

   173

   174

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

   175

    else:

   176

        res = "\n"

   177

        fdecl=fdecls[0]

   178

   179

        result_type_rule = fdecl["return_type_rule"]

   180

        res += {

   181

            "copy_input" : "symbol_c * return_type_symbol = last_type_symbol;\n",

   182

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

   183

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

   184

   185

        if not do_type_search_only:

   186

            code_gen = eval(fdecl["python_eval_c_code_format"])

   187

   188

            code_gen_dic_decl = {}

   189

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

   190

                code_gen_dic_decl[paramname+"_value"] = '");\n%s_param_value->accept(*this);\ns4o.print("'%(paramname)

   191

                code_gen_dic_decl[paramname+"_type"] = '");\n%s_type_symbol->accept(*this);\ns4o.print("'%(paramname)

   192

            code_gen_dic_decl["return_type"] = '");\nreturn_type_symbol->accept(*this);\ns4o.print("'

   193

            code_gen_dic_decl["param_count"] = '");\ns4o.print_integer(nb_param);\ns4o.print("'

   194

            code_gen_dic_decl["common_type"] = '");\nlast_type_symbol->accept(*this);\ns4o.print("'

   195

            code_gen_dic_decl["start_bool_filter"] = '");\nif (search_expression_type->is_bool_type(last_type_symbol))\n  s4o.print("('

   196

            code_gen_dic_decl["end_bool_filter"] = '");\nif (search_expression_type->is_bool_type(last_type_symbol)) {\n  s4o.print("&1");\n  s4o.print(")");\n}\ns4o.print("'

   197

   198

            if type(code_gen) == type(tuple()):

   199

                res += 's4o.indent_right();\n'

   200

                res += 's4o.print("%s\\n" + s4o.indent_spaces);\n'%(code_gen[0]%code_gen_dic_decl)

   201

                static_param_accept_list = []

   202

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

   203

                    static_param_accept_list.append("%s_param_value->accept(*this);\n"%(paramname))

   204

                res += ('s4o.print("%s\\n" + s4o.indent_spaces);\n'%(code_gen[1])).join(static_param_accept_list)

   205

                code = 's4o.print("%s\\n" + s4o.indent_spaces);\nparam_value->accept(*this);\n'%(code_gen[1])

   206

                end_code = 's4o.print("%s");\ns4o.indent_left();\nreturn NULL;\n'%(code_gen[2]%code_gen_dic_decl)

   207

            else:

   208

                code = ''

   209

                end_code = ('s4o.print("' + code_gen%code_gen_dic_decl + '");\nreturn NULL;\n').replace('s4o.print("");\n','')

   210

   211

            if fdecl["extensible"]:

   212

                res += ("""

   213

int base_num = %d;

   214

symbol_c *param_value = NULL;

   215

do{

   216

    char my_name[10];

   217

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

   218

    identifier_c param_name(my_name);

   219

   220

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

   221

    param_value = function_call_param_iterator.search(&param_name);

   222

   223

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

   224

    if (param_value == NULL)

   225

      param_value = function_call_param_iterator.next();

   226

    if (param_value != NULL){

   227

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

   228

        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 ;

   229

   230

        /*Function specific CODE */

   231

        %s

   232

    }

   233

   234

}while(param_value != NULL);

   235

%s

   236

"""%(fdecl["baseinputnumber"]+2, code.replace('\n','\n        '), end_code))

   237

            else:

   238

                #res += code + end_code

   239

                res += end_code

   240

        else:

   241

            res += "return return_type_symbol;\n"

   242

   243

   244

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

   245

   246

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

   247

###                                                             ###

   248

###                           MAIN                              ###

   249

###                                                             ###

   250

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

   251

   252

"""

   253

Reorganize std_decl from structure.py

   254

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

   255

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

   256

Keep ptrack of original declaration order in a 

   257

separated list called official_order

   258

"""

   259

std_fdecls = {}

   260

official_order = []

   261

for section in std_decl:

   262

    for fdecl in section["list"]:

   263

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

   264

            official_order.append(fdecl["name"])

   265

        # store all func by name in a dict

   266

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

   267

        current = std_fdecls_fdecl_name

   268

        for i in fdecl["inputs"]:

   269

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

   270

            current = current[i[0]]

   271

            last = current

   272

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

   273

            current = current[i[1]]

   274

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

   275

        std_fdecls[fdecl["name"]] = std_fdecls_fdecl_name

   276

   277

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

   278

   279

"""

   280

Generate the long enumeration of std function types

   281

"""

   282

function_type_decl =  matiec_header + """

   283

typedef enum {

   284

"""

   285

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

   286

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

   287

   288

function_type_decl += """    function_none

   289

} function_type_t;

   290

"""

   291

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

   292

"""

   293

Generate the funct that return enumerated according function name

   294

"""

   295

get_function_type_decl = matiec_header + """

   296

function_type_t get_function_type(identifier_c *function_name) {

   297

"""

   298

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

   299

    get_function_type_decl += """

   300

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

   301

    return function_%s;

   302

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

   303

   304

get_function_type_decl += """

   305

    else return function_none;

   306

}

   307

   308

"""

   309

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

   310

"""

   311

Generate the part of generate_c_st_c::visit(function_invocation)

   312

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

   313

"""

   314

st_code_gen = matiec_header + """

   315

switch(current_function_type){

   316

"""

   317

   318

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

   319

    st_code_gen += """

   320

/****

   321

 *%s

   322

 */

   323

    case function_%s :

   324

    {

   325

        symbol_c *last_type_symbol = NULL;

   326

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

   327

    indent =  "    "

   328

   329

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

   330

   331

    st_code_gen += """

   332

    }/*function_%s*/

   333

    break;

   334

"""    %(fname.lower())

   335

st_code_gen +=  """

   336

    case function_none :

   337

    ERROR;

   338

}

   339

return NULL;

   340

"""

   341

   342

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

   343

"""

   344

Generate the part of generate_c_il_c::visit(il_function_call)

   345

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

   346

"""

   347

il_code_gen = matiec_header + """

   348

switch(current_function_type){

   349

"""

   350

   351

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

   352

    il_code_gen += """

   353

/****

   354

 *%s

   355

 */

   356

    case function_%s :

   357

    {

   358

        symbol_c *last_type_symbol = NULL;

   359

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

   360

    indent =  "    "

   361

   362

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

   363

   364

    il_code_gen += """

   365

    }/*function_%s*/

   366

    break;

   367

"""    %(fname.lower())

   368

il_code_gen +=  """

   369

    case function_none :

   370

    ERROR;

   371

}

   372

return NULL;

   373

"""

   374

   375

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

   376

"""

   377

Generate the part of search_expression_type_c::visit(function_invocation)

   378

that is responsible of returning type symbol for function invocation.

   379

"""

   380

search_type_code = matiec_header + """

   381

   382

void *compute_standard_function_st(function_invocation_c *symbol) {

   383

   384

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

   385

  function_call_param_iterator_c function_call_param_iterator(symbol);

   386

  search_expression_type_c* search_expression_type = this;

   387

   388

  switch(current_function_type){

   389

"""

   390

   391

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

   392

    search_type_code += """

   393

/****

   394

 *%s

   395

 */

   396

    case function_%s :

   397

    {

   398

        symbol_c *last_type_symbol = NULL;

   399

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

   400

    indent =  "    "

   401

   402

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

   403

   404

    search_type_code += """

   405

    }/*function_%s*/

   406

    break;

   407

"""    %(fname.lower())

   408

search_type_code += """

   409

    case function_none :

   410

    ERROR;

   411

  }

   412

  return NULL;

   413

}

   414

   415

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

   416

   417

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

   418

  function_call_param_iterator_c function_call_param_iterator(symbol);  

   419

  search_expression_type_c* search_expression_type = this;

   420

   421

  switch(current_function_type){

   422

"""

   423

   424

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

   425

    search_type_code += """

   426

/****

   427

 *%s

   428

 */

   429

    case function_%s :

   430

    {

   431

        symbol_c *last_type_symbol = NULL;

   432

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

   433

    indent =  "    "

   434

   435

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

   436

   437

    search_type_code += """

   438

    }/*function_%s*/

   439

    break;

   440

"""    %(fname.lower())

   441

search_type_code += """

   442

    case function_none :

   443

    ERROR;

   444

  }

   445

  return NULL;

   446

}

   447

"""

   448

   449

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

   450

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

   451

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

   452

"""

   453

Generate the standard_function_names[] for inclusion in bizon generated code

   454

"""

   455

standard_function_names = matiec_header + """

   456

const char *standard_function_names[] = {

   457

"""

   458

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

   459

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

   460

standard_function_names += """

   461

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

   462

NULL

   463

};

   464

   465

"""

   466

   467

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

   468

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

   469

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

   470

"""

   471

Generate the C implementation of the IEC standard function library.

   472

"""

   473

iec_std_lib_generated = matiec_lesser_header + """

   474

   475

/* Macro that expand to subtypes */

   476

"""

   477

for typename, parenttypename in TypeHierarchy_list:

   478

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

   479

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

   480

        for typename2, parenttypename2 in TypeHierarchy_list:

   481

            if(parenttypename2 == typename):

   482

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

   483

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

   484

                else:

   485

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

   486

        iec_std_lib_generated +=  "\n"

   487

    else:

   488

        break

   489

   490

if len(sys.argv) != 2 :

   491

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

   492

    sys.exit(0)

   493

   494

# Now, print that out, or write to files from sys.argv

   495

for path, name, ext in [

   496

        ('stage4/generate_c','function_type_decl','h'),

   497

        ('stage4/generate_c','get_function_type_decl','c'),

   498

        ('stage4/generate_c','st_code_gen','c'),

   499

        ('stage4/generate_c','il_code_gen','c'),

   500

        ('stage4/generate_c','search_type_code','c'),

   501

        ('stage1_2','standard_function_names','c'),

   502

        ('lib', 'iec_std_lib_generated','h')

   503

        ]:

   504

    fd = open(os.path.join(sys.argv[1], path, name+'.'+ext),'w')

   505

    fd.write(eval(name))

   506

    fd.close()

   507

   508

#print "/* Code to eventually paste in iec_std_lib.h if type hierarchy changed */"

   509

#print "/* you also have to change iec_std_lib.h according to new types        */\n\n"

   510

#print iec_std_lib_generated