1

/*

     2

 *  matiec - a compiler for the programming languages defined in IEC 61131-3

     3

 *

     4

 *  Copyright (C) 2009-2011  Mario de Sousa (msousa@fe.up.pt)

     5

 *  Copyright (C) 2007-2011  Laurent Bessard and Edouard Tisserant

     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

/*

    26

 * An IEC 61131-3 compiler.

    27

 *

    28

 * Based on the

    29

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

    30

 *

    31

 */

    32

    33

    34

/*

    35

 * Iterate through all declared functions and Function Blocks, 

    36

 * and, for each function/FB, add a declaration of the EN and ENO 

    37

 * parameters, if they have not already been explicitly declared.

    38

 *

    39

 * EN and ENO parameters declared explicitly (by the user in the source code)

    40

 * and implicitly (by the comnpiler, i.e. by this visitor class) may be

    41

 * distinguished later on by the 'method' flag in the en_param_declaration_c

    42

 * and eno_param_declaration_c objects.

    43

 */

    44

    45

#ifndef _ADD_EN_ENO_PARAM_DECL_HH

    46

#define _ADD_EN_ENO_PARAM_DECL_HH

    47

    48

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

    49

    50

    51

class add_en_eno_param_decl_c : public null_visitor_c {

    52

  public:

    53

    static symbol_c *add_to(symbol_c *tree_root);

    54

    ~add_en_eno_param_decl_c(void);

    55

    56

  private:

    57

    /* this class is a singleton. So we need a pointer to the single instance... */

    58

    static add_en_eno_param_decl_c *singleton;

    59

    60

    /* flags to remember whether the EN and/or ENO parameters have already

    61

     * been explicitly declared by the user in the IEC 61131-3 source code we are parsing...

    62

     */

    63

    bool en_declared;

    64

    bool eno_declared;

    65

    66

  private:

    67

    void* iterate_list(list_c *list);

    68

    input_declarations_c  *build_en_param (void);

    69

    output_declarations_c *build_eno_param(void);

    70

    71

  private:

    72

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

    73

    /* B 0 - Programming Model */

    74

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

    75

    void *visit(library_c *symbol);

    76

    77

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

    78

    /* B 1.5.1 - Functions */

    79

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

    80

    void *visit(function_declaration_c *symbol);

    81

    /* intermediate helper symbol for function_declaration */

    82

    void *visit(var_declarations_list_c *symbol);

    83

    84

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

    85

    /* B 1.4.3 - Declaration & Initialisation */

    86

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

    87

    void *visit(input_declarations_c *symbol);

    88

    void *visit(input_declaration_list_c *symbol);

    89

    void *visit(en_param_declaration_c *symbol);

    90

    void *visit(eno_param_declaration_c *symbol);

    91

    void *visit(output_declarations_c *symbol);

    92

    void *visit(var_init_decl_list_c *symbol);

    93

    94

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

    95

    /* B 1.5.2 - Function Blocks */

    96

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

    97

    /*  FUNCTION_BLOCK derived_function_block_name io_OR_other_var_declarations function_block_body END_FUNCTION_BLOCK */

    98

    void *visit(function_block_declaration_c *symbol);

    99

   100

}; // function_param_iterator_c

   101

   102

#endif /* _ADD_EN_ENO_PARAM_DECL_HH */

   103

   104

   105

   106

   107

   108

   109