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

 *  This program is free software: you can redistribute it and/or modify

     8

 *  it under the terms of the GNU General Public License as published by

     9

 *  the Free Software Foundation, either version 3 of the License, or

    10

 *  (at your option) any later version.

    11

 *

    12

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

    13

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

    14

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    15

 *  GNU General Public License for more details.

    16

 *

    17

 *  You should have received a copy of the GNU General Public License

    18

 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.

    19

 *

    20

 *

    21

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

    22

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

    23

 */

    24

    25

#ifndef _HELPER_FUNCTIONS_HH_

    26

#define _HELPER_FUNCTIONS_HH_

    27

    28

#include "../absyntax/visitor.hh"

    29

#include <typeinfo>

    30

    31

    32

    33

#define is_type(type_name_symbol, type_name_class)  ((type_name_symbol == NULL) ? false : (typeid(*type_name_symbol) == typeid(type_name_class)))

    34

#define sizeoftype(symbol) get_sizeof_datatype_c::getsize(symbol)

    35

    36

    37

    38

    39

typedef struct {

    40

  symbol_c *function_name;

    41

  symbol_c *nonformal_operand_list;

    42

  symbol_c *   formal_operand_list;

    43

    44

  enum {POU_FB, POU_function} POU_type;

    45

//symbol_c &*datatype;

    46

//std::vector <symbol_c *> &candidate_datatypes;

    47

  std::vector <symbol_c *> &candidate_functions;

    48

  symbol_c *&called_function_declaration;

    49

  int      &extensible_param_count;

    50

} generic_function_call_t;

    51

    52

    53

    54

/* A small helper class, to transform elementary data type to string.

    55

 * this allows us to generate more relevant error messages...

    56

 */

    57

    58

class elementary_type_c: public null_visitor_c {

    59

  protected:

    60

    elementary_type_c(void)  {};

    61

    ~elementary_type_c(void) {};

    62

    63

  private:

    64

    /* singleton class! */

    65

    static elementary_type_c *singleton;

    66

    67

  public:

    68

    static const char * to_string(symbol_c *symbol);

    69

    70

    71

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

    72

    /* B 1.3.1 - Elementary Data Types */

    73

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

    74

    void *visit(time_type_name_c *symbol)        {return (void *)"TIME";        };

    75

    void *visit(bool_type_name_c *symbol)        {return (void *)"BOOL";        };

    76

    void *visit(sint_type_name_c *symbol)        {return (void *)"SINT";        };

    77

    void *visit(int_type_name_c *symbol)         {return (void *)"INT";         };

    78

    void *visit(dint_type_name_c *symbol)        {return (void *)"DINT";        };

    79

    void *visit(lint_type_name_c *symbol)        {return (void *)"LINT";        };

    80

    void *visit(usint_type_name_c *symbol)       {return (void *)"USINT";       };

    81

    void *visit(uint_type_name_c *symbol)        {return (void *)"UINT";        };

    82

    void *visit(udint_type_name_c *symbol)       {return (void *)"UDINT";       };

    83

    void *visit(ulint_type_name_c *symbol)       {return (void *)"ULINT";       };

    84

    void *visit(real_type_name_c *symbol)        {return (void *)"REAL";        };

    85

    void *visit(lreal_type_name_c *symbol)       {return (void *)"LREAL";       };

    86

    void *visit(date_type_name_c *symbol)        {return (void *)"DATE";        };

    87

    void *visit(tod_type_name_c *symbol)         {return (void *)"TOD";         };

    88

    void *visit(dt_type_name_c *symbol)          {return (void *)"DT";          };

    89

    void *visit(byte_type_name_c *symbol)        {return (void *)"BYTE";        };

    90

    void *visit(word_type_name_c *symbol)        {return (void *)"WORD";        };

    91

    void *visit(lword_type_name_c *symbol)       {return (void *)"LWORD";       };

    92

    void *visit(dword_type_name_c *symbol)       {return (void *)"DWORD";       };

    93

    void *visit(string_type_name_c *symbol)      {return (void *)"STRING";      };

    94

    void *visit(wstring_type_name_c *symbol)     {return (void *)"WSTRING";     };

    95

    96

    void *visit(safetime_type_name_c *symbol)    {return (void *)"SAFETIME";    };

    97

    void *visit(safebool_type_name_c *symbol)    {return (void *)"SAFEBOOL";    };

    98

    void *visit(safesint_type_name_c *symbol)    {return (void *)"SAFESINT";    };

    99

    void *visit(safeint_type_name_c *symbol)     {return (void *)"SAFEINT";     };

   100

    void *visit(safedint_type_name_c *symbol)    {return (void *)"SAFEDINT";    };

   101

    void *visit(safelint_type_name_c *symbol)    {return (void *)"SAFELINT";    };

   102

    void *visit(safeusint_type_name_c *symbol)   {return (void *)"SAFEUSINT";   };

   103

    void *visit(safeuint_type_name_c *symbol)    {return (void *)"SAFEUINT";    };

   104

    void *visit(safeudint_type_name_c *symbol)   {return (void *)"SAFEUDINT";   };

   105

    void *visit(safeulint_type_name_c *symbol)   {return (void *)"SAFEULINT";   };

   106

    void *visit(safereal_type_name_c *symbol)    {return (void *)"SAFEREAL";    };

   107

    void *visit(safelreal_type_name_c *symbol)   {return (void *)"SAFELREAL";   };

   108

    void *visit(safedate_type_name_c *symbol)    {return (void *)"SAFEDATE";    };

   109

    void *visit(safetod_type_name_c *symbol)     {return (void *)"SAFETOD";     };

   110

    void *visit(safedt_type_name_c *symbol)      {return (void *)"SAFEDT";      };

   111

    void *visit(safebyte_type_name_c *symbol)    {return (void *)"SAFEBYTE";    };

   112

    void *visit(safeword_type_name_c *symbol)    {return (void *)"SAFEWORD";    };

   113

    void *visit(safelword_type_name_c *symbol)   {return (void *)"SAFELWORD";   };

   114

    void *visit(safedword_type_name_c *symbol)   {return (void *)"SAFEDWORD";   };

   115

    void *visit(safestring_type_name_c *symbol)  {return (void *)"SAFESTRING";  };

   116

    void *visit(safewstring_type_name_c *symbol) {return (void *)"SAFEWSTRING"; };

   117

};

   118

   119

   120

   121

   122

   123

   124

/* Widening Primitive Conversion */

   125

struct widen_entry {

   126

	symbol_c *left;

   127

	symbol_c *right;

   128

	symbol_c *result;

   129

};

   130

/*

   131

 * 2.5.1.5.6 Functions of time data types

   132

 * Table 30 - page 64

   133

 */

   134

extern const struct widen_entry widen_ADD_table[];

   135

extern const struct widen_entry widen_SUB_table[];

   136

extern const struct widen_entry widen_MUL_table[];

   137

extern const struct widen_entry widen_DIV_table[];

   138

   139

/* Search for a datatype inside a candidate_datatypes list.

   140

 * Returns: position of datatype in the list, or -1 if not found.

   141

 */

   142

int search_in_candidate_datatype_list(symbol_c *datatype, std::vector <symbol_c *> candidate_datatypes);

   143

   144

/* Copy the elements in the candidate_datatype_list in one symbol (from)

   145

 * into the candidate_datatype_list of another symbol (to)

   146

 */

   147

void copy_candidate_datatype_list(symbol_c *from, symbol_c *to);

   148

   156

   157

/* A helper function... */

   158

bool is_ANY_ELEMENTARY_type         (symbol_c *type_symbol);

   159

bool is_ANY_SAFEELEMENTARY_type     (symbol_c *type_symbol);

   160

bool is_ANY_ELEMENTARY_compatible   (symbol_c *type_symbol);

   161

   162

bool is_ANY_MAGNITUDE_type          (symbol_c *type_symbol);

   163

bool is_ANY_SAFEMAGNITUDE_type      (symbol_c *type_symbol);

   164

bool is_ANY_MAGNITUDE_compatible    (symbol_c *type_symbol);

   165

   166

bool is_ANY_signed_MAGNITUDE_type          (symbol_c *type_symbol);

   167

bool is_ANY_signed_SAFEMAGNITUDE_type      (symbol_c *type_symbol);

   168

bool is_ANY_signed_MAGNITUDE_compatible    (symbol_c *type_symbol);

   169

   170

bool is_ANY_DATE_type               (symbol_c *type_symbol);

   171

bool is_ANY_SAFEDATE_type           (symbol_c *type_symbol);

   172

bool is_ANY_DATE_compatible         (symbol_c *type_symbol);

   173

   174

bool is_ANY_STRING_type             (symbol_c *type_symbol);

   175

bool is_ANY_SAFESTRING_type         (symbol_c *type_symbol);

   176

bool is_ANY_STRING_compatible       (symbol_c *type_symbol);

   177

   178

bool is_ANY_INT_type                (symbol_c *type_symbol);

   179

bool is_ANY_SAFEINT_type            (symbol_c *type_symbol);

   180

bool is_ANY_INT_compatible          (symbol_c *type_symbol);

   181

   182

bool is_ANY_signed_INT_type                (symbol_c *type_symbol);

   183

bool is_ANY_signed_SAFEINT_type            (symbol_c *type_symbol);

   184

bool is_ANY_signed_INT_compatible          (symbol_c *type_symbol);

   185

   186

bool is_ANY_REAL_type               (symbol_c *type_symbol);

   187

bool is_ANY_SAFEREAL_type           (symbol_c *type_symbol);

   188

bool is_ANY_REAL_compatible         (symbol_c *type_symbol);

   189

   190

bool is_ANY_NUM_type                (symbol_c *type_symbol);

   191

bool is_ANY_SAFENUM_type            (symbol_c *type_symbol);

   192

bool is_ANY_NUM_compatible          (symbol_c *type_symbol);

   193

   194

bool is_ANY_signed_NUM_type                (symbol_c *type_symbol);

   195

bool is_ANY_signed_SAFENUM_type            (symbol_c *type_symbol);

   196

bool is_ANY_signed_NUM_compatible          (symbol_c *type_symbol);

   197

   198

bool is_ANY_BIT_type                (symbol_c *type_symbol);

   199

bool is_ANY_SAFEBIT_type            (symbol_c *type_symbol);

   200

bool is_ANY_BIT_compatible          (symbol_c *type_symbol);

   201

   202

bool is_BOOL_type                   (symbol_c *type_symbol);

   203

bool is_SAFEBOOL_type               (symbol_c *type_symbol);

   204

bool is_ANY_BOOL_compatible         (symbol_c *type_symbol);

   205

   206

   207

bool is_type_equal(symbol_c *first_type, symbol_c *second_type);

   208

   209

// typedef bool (*helper_function_t) (symbol_c *type_symbol);  /* a pointer to a function! */

   210

   211

   212

#endif /* _HELPER_FUNCTIONS_HH_ */