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

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

   142

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

   143

"""%{"input_name":Paramname}

   144

                res += """

   145

    symbol_c *%(input_name)s_type_symbol = param_data_type;

   146

    last_type_symbol = param_data_type;

   147

"""%{"input_name":Paramname}

   148

            else:

   149

                res += """

   150

{

   151

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

   152

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

   153

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

   154

    symbol_c *%(input_name)s_type_symbol = NULL;

   155

   156

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

   157

    if (%(input_name)s_param_value == NULL)

   158

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

   159

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

   160

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

   161

      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 ;

   162

    }

   163

"""%{"input_name":Paramname}

   164

   165

            for ParamType,NextParamDecl in ParamTypes.iteritems():

   166

   167

                res += """    

   168

    %(type_test)s

   169

    {

   170

%(if_good_type_code)s

   171

    }

   172

"""%{

   173

    "type_test":ANY_to_compiler_test_type_GEN(ParamType,Paramname), 

   174

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

   175

   176

            res += """    

   177

   178

    ERROR;

   179

}

   180

"""

   181

   182

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

   183

    else:

   184

        res = "\n"

   185

        fdecl=fdecls[0]

   186

   187

        if not do_type_search_only:

   188

            code_gen = eval(fdecl["python_eval_c_code_format"])

   189

   190

            if code_gen[1] is not None:

   191

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

   192

            if fdecl["extensible"]:

   193

                res += """

   194

if (nb_param < %(min_nb_param)d)

   195

  nb_param = %(min_nb_param)d;

   196

char* nb_param_str = new char[10];

   197

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

   198

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

   199

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

   200

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

   201

                res += """

   202

if (%(input_name)s_type_symbol == NULL)

   203

  %(input_name)s_type_symbol = last_type_symbol;

   204

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

   205

"""%{"input_name" : paramname}

   206

            if fdecl["extensible"]:

   207

                res += """

   208

int base_num = %d;

   209

symbol_c *param_value = NULL;

   210

do{

   211

    char my_name[10];

   212

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

   213

    identifier_c param_name(my_name);

   214

   215

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

   216

    param_value = function_call_param_iterator.search(&param_name);

   217

   218

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

   219

    if (param_value == NULL)

   220

      param_value = function_call_param_iterator.next();

   221

    if (param_value != NULL){

   222

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

   223

        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 ;

   224

   225

        /*Function specific CODE */

   226

        ADD_PARAM_LIST(param_value, current_type_symbol, function_param_iterator_c::direction_in)

   227

    }

   228

   229

}while(param_value != NULL);

   230

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

   231

   232

        result_type_rule = fdecl["return_type_rule"]

   233

        res += {

   234

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

   235

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

   236

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

   237

   238

        if not do_type_search_only:

   239

            if code_gen[0] is not None:

   240

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

   241

            if code_gen[2] is not None:

   242

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

   243

            res += "break;\n"

   244

        else:

   245

            res += "return return_type_symbol;\n"

   246

   247

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

   248

   249

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

   250

###                                                             ###

   251

###                           MAIN                              ###

   252

###                                                             ###

   253

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

   254

   255

"""

   256

Reorganize std_decl from structure.py

   257

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

   258

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

   259

Keep ptrack of original declaration order in a 

   260

separated list called official_order

   261

"""

   262

std_fdecls = {}

   263

official_order = []

   264

for section in std_decl:

   265

    for fdecl in section["list"]:

   266

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

   267

            official_order.append(fdecl["name"])

   268

        # store all func by name in a dict

   269

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

   270

        current = std_fdecls_fdecl_name

   271

        for i in fdecl["inputs"]:

   272

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

   273

            current = current[i[0]]

   274

            last = current

   275

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

   276

            current = current[i[1]]

   277

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

   278

        std_fdecls[fdecl["name"]] = std_fdecls_fdecl_name

   279

   280

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

   281

   282

"""

   283

Generate the long enumeration of std function types

   284

"""

   285

function_type_decl =  matiec_header + """

   286

typedef enum {

   287

"""

   288

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

   289

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

   290

   291

function_type_decl += """    function_none

   292

} function_type_t;

   293

"""

   294

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

   295

"""

   296

Generate the funct that return enumerated according function name

   297

"""

   298

get_function_type_decl = matiec_header + """

   299

function_type_t get_function_type(identifier_c *function_name) {

   300

"""

   301

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

   302

    get_function_type_decl += """

   303

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

   304

    return function_%s;

   305

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

   306

   307

get_function_type_decl += """

   308

    else return function_none;

   309

}

   310

   311

"""

   312

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

   313

"""

   314

Generate the part of generate_c_st_c::visit(function_invocation)

   315

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

   316

"""

   317

st_code_gen = matiec_header + """

   318

switch(current_function_type){

   319

"""

   320

   321

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

   322

    st_code_gen += """

   323

/****

   324

 *%s

   325

 */

   326

    case function_%s :

   327

    {

   328

        symbol_c *last_type_symbol = NULL;

   329

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

   330

    indent =  "    "

   331

   332

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

   333

   334

    st_code_gen += """

   335

    }/*function_%s*/

   336

    break;

   337

"""    %(fname.lower())

   338

st_code_gen +=  """

   339

    case function_none :

   340

    ERROR;

   341

}

   342

"""

   343

   344

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

   345

"""

   346

Generate the part of generate_c_il_c::visit(il_function_call)

   347

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

   348

"""

   349

il_code_gen = matiec_header + """

   350

switch(current_function_type){

   351

"""

   352

   353

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

   354

    il_code_gen += """

   355

/****

   356

 *%s

   357

 */

   358

    case function_%s :

   359

    {

   360

        symbol_c *last_type_symbol = NULL;

   361

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

   362

    indent =  "    "

   363

   364

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

   365

   366

    il_code_gen += """

   367

    }/*function_%s*/

   368

    break;

   369

"""    %(fname.lower())

   370

il_code_gen +=  """

   371

    case function_none :

   372

    ERROR;

   373

}

   374

"""

   375

   376

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

   377

"""

   378

Generate the part of search_expression_type_c::visit(function_invocation)

   379

that is responsible of returning type symbol for function invocation.

   380

"""

   381

search_type_code = matiec_header + """

   382

   383

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

   384

  function_type_t current_function_type;

   385

  function_call_param_iterator_c *tmp_function_call_param_iterator;

   386

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

   387

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

   388

    tmp_function_call_param_iterator = new function_call_param_iterator_c(st_symbol);

   389

  }

   390

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

   391

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

   392

    tmp_function_call_param_iterator = new function_call_param_iterator_c(il_symbol);

   393

  }

   394

  else

   395

    ERROR;

   396

  function_call_param_iterator_c function_call_param_iterator(*tmp_function_call_param_iterator);

   397

  search_expression_type_c* search_expression_type = this;

   398

   399

  switch(current_function_type){

   400

"""

   401

   402

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

   403

    search_type_code += """

   404

/****

   405

 *%s

   406

 */

   407

    case function_%s :

   408

    {

   409

        symbol_c *last_type_symbol = NULL;

   410

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

   411

    indent =  "    "

   412

   413

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

   414

   415

    search_type_code += """

   416

    }/*function_%s*/

   417

    break;

   418

"""    %(fname.lower())

   419

search_type_code += """

   420

    case function_none :

   421

    ERROR;

   422

  }

   423

  return NULL;

   424

}

   425

   426

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

   427

   428

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

   429

  function_call_param_iterator_c function_call_param_iterator(symbol);  

   430

  search_expression_type_c* search_expression_type = this;

   431

   432

  switch(current_function_type){

   433

"""

   434

   435

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

   436

    search_type_code += """

   437

/****

   438

 *%s

   439

 */

   440

    case function_%s :

   441

    {

   442

        symbol_c *last_type_symbol = NULL;

   443

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

   444

    indent =  "    "

   445

   446

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

   447

   448

    search_type_code += """

   449

    }/*function_%s*/

   450

    break;

   451

"""    %(fname.lower())

   452

search_type_code += """

   453

    case function_none :

   454

    ERROR;

   455

  }

   456

  return NULL;

   457

}

   458

"""

   459

   460

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

   461

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

   462

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

   463

"""

   464

Generate the standard_function_names[] for inclusion in bizon generated code

   465

"""

   466

standard_function_names = matiec_header + """

   467

const char *standard_function_names[] = {

   468

"""

   469

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

   470

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

   471

standard_function_names += """

   472

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

   473

NULL

   474

};

   475

   476

"""

   477

   478

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

   479

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

   480

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

   481

"""

   482

Generate the C implementation of the IEC standard function library.

   483

"""

   484

iec_std_lib_generated = matiec_lesser_header + """

   485

   486

/* Macro that expand to subtypes */

   487

"""

   488

for typename, parenttypename in TypeHierarchy_list:

   489

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

   490

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

   491

        for typename2, parenttypename2 in TypeHierarchy_list:

   492

            if(parenttypename2 == typename):

   493

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

   494

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

   495

                else:

   496

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

   497

        iec_std_lib_generated +=  "\n"

   498

    else:

   499

        break

   500

   501

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

   502

for path, name, ext in [

   503

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

   504

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

   505

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

   506

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

   507

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

   508

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

   509

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

   510

        ]: