msousa@417: /* msousa@417: * matiec - a compiler for the programming languages defined in IEC 61131-3 msousa@417: * msousa@417: * Copyright (C) 2009-2012 Mario de Sousa (msousa@fe.up.pt) msousa@417: * Copyright (C) 2012 Manuele Conti (conti.ma@alice.it) msousa@417: * msousa@417: * This program is free software: you can redistribute it and/or modify msousa@417: * it under the terms of the GNU General Public License as published by msousa@417: * the Free Software Foundation, either version 3 of the License, or msousa@417: * (at your option) any later version. msousa@417: * msousa@417: * This program is distributed in the hope that it will be useful, msousa@417: * but WITHOUT ANY WARRANTY; without even the implied warranty of msousa@417: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the msousa@417: * GNU General Public License for more details. msousa@417: * msousa@417: * You should have received a copy of the GNU General Public License msousa@417: * along with this program. If not, see . msousa@417: * msousa@417: * msousa@417: * This code is made available on the understanding that it will not be msousa@417: * used in safety-critical situations without a full and competent review. msousa@417: */ msousa@417: msousa@417: #ifndef _HELPER_FUNCTIONS_HH_ msousa@417: #define _HELPER_FUNCTIONS_HH_ msousa@417: msousa@417: #include "../absyntax/visitor.hh" msousa@417: #include msousa@417: msousa@434: msousa@434: msousa@436: #define is_type(type_name_symbol, type_name_class) ((type_name_symbol == NULL) ? false : (typeid(*type_name_symbol) == typeid(type_name_class))) msousa@436: #define sizeoftype(symbol) get_sizeof_datatype_c::getsize(symbol) msousa@436: msousa@436: msousa@434: msousa@438: msousa@438: typedef struct { msousa@438: symbol_c *function_name; msousa@438: symbol_c *nonformal_operand_list; msousa@438: symbol_c * formal_operand_list; msousa@438: msousa@441: enum {POU_FB, POU_function} POU_type; msousa@438: //symbol_c &*datatype; msousa@438: //std::vector &candidate_datatypes; msousa@438: std::vector &candidate_functions; msousa@438: symbol_c *&called_function_declaration; msousa@438: int &extensible_param_count; msousa@438: } generic_function_call_t; msousa@438: msousa@438: msousa@438: msousa@434: /* A small helper class, to transform elementary data type to string. msousa@434: * this allows us to generate more relevant error messages... msousa@434: */ msousa@434: msousa@434: class elementary_type_c: public null_visitor_c { msousa@434: protected: msousa@434: elementary_type_c(void) {}; msousa@434: ~elementary_type_c(void) {}; msousa@434: msousa@434: private: msousa@434: /* singleton class! */ msousa@434: static elementary_type_c *singleton; msousa@434: msousa@434: public: msousa@434: static const char * to_string(symbol_c *symbol); msousa@434: msousa@434: msousa@434: /***********************************/ msousa@434: /* B 1.3.1 - Elementary Data Types */ msousa@434: /***********************************/ msousa@434: void *visit(time_type_name_c *symbol) {return (void *)"TIME"; }; msousa@434: void *visit(bool_type_name_c *symbol) {return (void *)"BOOL"; }; msousa@434: void *visit(sint_type_name_c *symbol) {return (void *)"SINT"; }; msousa@434: void *visit(int_type_name_c *symbol) {return (void *)"INT"; }; msousa@434: void *visit(dint_type_name_c *symbol) {return (void *)"DINT"; }; msousa@434: void *visit(lint_type_name_c *symbol) {return (void *)"LINT"; }; msousa@434: void *visit(usint_type_name_c *symbol) {return (void *)"USINT"; }; msousa@434: void *visit(uint_type_name_c *symbol) {return (void *)"UINT"; }; msousa@434: void *visit(udint_type_name_c *symbol) {return (void *)"UDINT"; }; msousa@434: void *visit(ulint_type_name_c *symbol) {return (void *)"ULINT"; }; msousa@434: void *visit(real_type_name_c *symbol) {return (void *)"REAL"; }; msousa@434: void *visit(lreal_type_name_c *symbol) {return (void *)"LREAL"; }; msousa@434: void *visit(date_type_name_c *symbol) {return (void *)"DATE"; }; msousa@434: void *visit(tod_type_name_c *symbol) {return (void *)"TOD"; }; msousa@434: void *visit(dt_type_name_c *symbol) {return (void *)"DT"; }; msousa@434: void *visit(byte_type_name_c *symbol) {return (void *)"BYTE"; }; msousa@434: void *visit(word_type_name_c *symbol) {return (void *)"WORD"; }; msousa@434: void *visit(lword_type_name_c *symbol) {return (void *)"LWORD"; }; msousa@434: void *visit(dword_type_name_c *symbol) {return (void *)"DWORD"; }; msousa@434: void *visit(string_type_name_c *symbol) {return (void *)"STRING"; }; msousa@434: void *visit(wstring_type_name_c *symbol) {return (void *)"WSTRING"; }; msousa@434: msousa@434: void *visit(safetime_type_name_c *symbol) {return (void *)"SAFETIME"; }; msousa@434: void *visit(safebool_type_name_c *symbol) {return (void *)"SAFEBOOL"; }; msousa@434: void *visit(safesint_type_name_c *symbol) {return (void *)"SAFESINT"; }; msousa@434: void *visit(safeint_type_name_c *symbol) {return (void *)"SAFEINT"; }; msousa@434: void *visit(safedint_type_name_c *symbol) {return (void *)"SAFEDINT"; }; msousa@434: void *visit(safelint_type_name_c *symbol) {return (void *)"SAFELINT"; }; msousa@434: void *visit(safeusint_type_name_c *symbol) {return (void *)"SAFEUSINT"; }; msousa@434: void *visit(safeuint_type_name_c *symbol) {return (void *)"SAFEUINT"; }; msousa@434: void *visit(safeudint_type_name_c *symbol) {return (void *)"SAFEUDINT"; }; msousa@434: void *visit(safeulint_type_name_c *symbol) {return (void *)"SAFEULINT"; }; msousa@434: void *visit(safereal_type_name_c *symbol) {return (void *)"SAFEREAL"; }; msousa@434: void *visit(safelreal_type_name_c *symbol) {return (void *)"SAFELREAL"; }; msousa@434: void *visit(safedate_type_name_c *symbol) {return (void *)"SAFEDATE"; }; msousa@434: void *visit(safetod_type_name_c *symbol) {return (void *)"SAFETOD"; }; msousa@434: void *visit(safedt_type_name_c *symbol) {return (void *)"SAFEDT"; }; msousa@434: void *visit(safebyte_type_name_c *symbol) {return (void *)"SAFEBYTE"; }; msousa@434: void *visit(safeword_type_name_c *symbol) {return (void *)"SAFEWORD"; }; msousa@434: void *visit(safelword_type_name_c *symbol) {return (void *)"SAFELWORD"; }; msousa@434: void *visit(safedword_type_name_c *symbol) {return (void *)"SAFEDWORD"; }; msousa@434: void *visit(safestring_type_name_c *symbol) {return (void *)"SAFESTRING"; }; msousa@434: void *visit(safewstring_type_name_c *symbol) {return (void *)"SAFEWSTRING"; }; msousa@434: }; msousa@434: msousa@434: msousa@434: msousa@434: msousa@434: msousa@417: msousa@417: /* Widening Primitive Conversion */ msousa@417: struct widen_entry { msousa@417: symbol_c *left; msousa@417: symbol_c *right; msousa@417: symbol_c *result; msousa@417: }; msousa@417: /* msousa@417: * 2.5.1.5.6 Functions of time data types msousa@417: * Table 30 - page 64 msousa@417: */ msousa@417: extern const struct widen_entry widen_ADD_table[]; msousa@417: extern const struct widen_entry widen_SUB_table[]; msousa@417: extern const struct widen_entry widen_MUL_table[]; msousa@417: extern const struct widen_entry widen_DIV_table[]; msousa@417: msousa@425: /* Search for a datatype inside a candidate_datatypes list. msousa@425: * Returns: position of datatype in the list, or -1 if not found. msousa@425: */ conti@445: int search_in_candidate_datatype_list(symbol_c *datatype, std::vector candidate_datatypes); msousa@425: msousa@443: /* Copy the elements in the candidate_datatype_list in one symbol (from) msousa@443: * into the candidate_datatype_list of another symbol (to) msousa@443: */ msousa@443: void copy_candidate_datatype_list(symbol_c *from, symbol_c *to); msousa@443: msousa@457: /* Intersect two candidate_datatype_lists. msousa@457: * Remove from list1 (origin, dest.) all elements that are not found in list2 (with). msousa@457: * In essence, list1 will contain the result of the intersection of list1 with list2. msousa@457: * In other words, modify list1 so it only contains the elelements that are simultaneously in list1 and list2! msousa@457: */ msousa@457: void intersect_candidate_datatype_list(symbol_c *list1 /*origin, dest.*/, symbol_c *list2 /*with*/); msousa@457: msousa@443: msousa@417: /* A helper function... */ msousa@417: bool is_ANY_ELEMENTARY_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEELEMENTARY_type (symbol_c *type_symbol); msousa@417: bool is_ANY_ELEMENTARY_compatible (symbol_c *type_symbol); msousa@417: msousa@417: bool is_ANY_MAGNITUDE_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEMAGNITUDE_type (symbol_c *type_symbol); msousa@417: bool is_ANY_MAGNITUDE_compatible (symbol_c *type_symbol); msousa@417: msousa@435: bool is_ANY_signed_MAGNITUDE_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_SAFEMAGNITUDE_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_MAGNITUDE_compatible (symbol_c *type_symbol); msousa@435: msousa@417: bool is_ANY_DATE_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEDATE_type (symbol_c *type_symbol); msousa@417: bool is_ANY_DATE_compatible (symbol_c *type_symbol); msousa@417: msousa@417: bool is_ANY_STRING_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFESTRING_type (symbol_c *type_symbol); msousa@417: bool is_ANY_STRING_compatible (symbol_c *type_symbol); msousa@417: msousa@417: bool is_ANY_INT_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEINT_type (symbol_c *type_symbol); msousa@417: bool is_ANY_INT_compatible (symbol_c *type_symbol); msousa@417: msousa@435: bool is_ANY_signed_INT_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_SAFEINT_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_INT_compatible (symbol_c *type_symbol); msousa@435: msousa@417: bool is_ANY_REAL_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEREAL_type (symbol_c *type_symbol); msousa@417: bool is_ANY_REAL_compatible (symbol_c *type_symbol); msousa@417: msousa@417: bool is_ANY_NUM_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFENUM_type (symbol_c *type_symbol); msousa@417: bool is_ANY_NUM_compatible (symbol_c *type_symbol); msousa@417: msousa@435: bool is_ANY_signed_NUM_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_SAFENUM_type (symbol_c *type_symbol); msousa@435: bool is_ANY_signed_NUM_compatible (symbol_c *type_symbol); msousa@435: msousa@417: bool is_ANY_BIT_type (symbol_c *type_symbol); msousa@417: bool is_ANY_SAFEBIT_type (symbol_c *type_symbol); msousa@417: bool is_ANY_BIT_compatible (symbol_c *type_symbol); msousa@417: msousa@417: bool is_BOOL_type (symbol_c *type_symbol); msousa@417: bool is_SAFEBOOL_type (symbol_c *type_symbol); msousa@417: bool is_ANY_BOOL_compatible (symbol_c *type_symbol); msousa@417: msousa@425: msousa@417: bool is_type_equal(symbol_c *first_type, symbol_c *second_type); msousa@417: msousa@425: // typedef bool (*helper_function_t) (symbol_c *type_symbol); /* a pointer to a function! */ msousa@417: msousa@417: msousa@417: #endif /* _HELPER_FUNCTIONS_HH_ */