stage4/generate_c/search_fb_instance_decl.cc
author lbessard
Tue, 26 Feb 2008 10:59:48 +0100
changeset 111 ee31ee39eaf6
parent 70 e1f0ebd2d9ec
permissions -rwxr-xr-x
Adding structure variable list generation module
70
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     1
/*
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     2
 * (c) 2003 Mario de Sousa
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     3
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     4
 * Offered to the public under the terms of the GNU General Public License
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     5
 * as published by the Free Software Foundation; either version 2 of the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     6
 * License, or (at your option) any later version.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     7
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     8
 * This program is distributed in the hope that it will be useful, but
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
     9
 * WITHOUT ANY WARRANTY; without even the implied warranty of
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    11
 * Public License for more details.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    12
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    13
 * This code is made available on the understanding that it will not be
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    14
 * used in safety-critical situations without a full and competent review.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    15
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    16
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    17
/*
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    18
 * An IEC 61131-3 IL and ST compiler.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    19
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    20
 * Based on the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    21
 * FINAL DRAFT - IEC 61131-3, 2nd Ed. (2001-12-10)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    22
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    23
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    24
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    25
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    26
/* Returns the function block type declaration
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    27
 * of a specific function block instance.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    28
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    29
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    30
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    31
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    32
/* Returns the type name of a specific function block
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    33
 * instance. This class will search the variable
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    34
 * declarations inside the scope given to it
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    35
 * searching for the declaration of the function
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    36
 * block instance.
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    37
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    38
 * The class constructor must be given the search scope
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    39
 * (function, function block or program within which
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    40
 * the function block instance was declared).
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    41
 *
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    42
 * This class will search the tree from the root given to the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    43
 * constructor. Another option would be to build a symbol table,
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    44
 * and search that instead. Building the symbol table would be done
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    45
 * while visiting the variable declaration objects in the parse
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    46
 * tree. Unfortuantely, generate_c_c does not visit these
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    47
 * objects, delegating it to another class. This means that
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    48
 * we would need another specialised class just to build the
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    49
 * symbol table. We might just as well have a specialised class
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    50
 * that searches the tree itself for the relevant info. This
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    51
 * class is exactly that...!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    52
 */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    53
class search_fb_instance_decl_c: public search_visitor_c {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    54
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    55
  private:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    56
    symbol_c *search_scope;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    57
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    58
    symbol_c *search_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    59
    symbol_c *current_fb_type_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    60
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    61
  public:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    62
    search_fb_instance_decl_c(symbol_c *search_scope) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    63
      this->search_scope = search_scope;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    64
      this->current_fb_type_name = NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    65
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    66
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    67
    symbol_c *get_type_name(symbol_c *fb_instance_name) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    68
      this->search_name = fb_instance_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    69
      return (symbol_c *)search_scope->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    70
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    71
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    72
  public:
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    73
/***************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    74
/* B 0 - Programming Model */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    75
/***************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    76
    void *visit(library_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    77
      /* we do not want to search multiple declaration scopes,
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    78
       * so we do not visit all the functions, fucntion blocks, etc...
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    79
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    80
      return NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    81
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    82
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    83
/******************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    84
/* B 1.4.3 - Declaration & Initialisation */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    85
/******************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    86
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    87
/* name_list ':' function_block_type_name ASSIGN structure_initialization */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    88
/* structure_initialization -> may be NULL ! */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    89
    void *visit(fb_name_decl_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    90
      current_fb_type_name = symbol->function_block_type_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    91
      return symbol->fb_name_list->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    92
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    93
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    94
/* name_list ',' fb_name */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    95
    void *visit(fb_name_list_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    96
      list_c *list = symbol;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    97
      for(int i = 0; i < list->n; i++) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    98
        if (compare_identifiers(list->elements[i], search_name) == 0)
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
    99
	  /* by now, current_fb_declaration should be != NULL */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   100
          return current_fb_type_name;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   101
      }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   102
      return NULL;
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   103
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   104
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   105
/**************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   106
/* B.1.5 - Program organization units */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   107
/**************************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   108
/***********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   109
/* B 1.5.1 - Functions */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   110
/***********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   111
    void *visit(function_declaration_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   112
      /* no need to search through all the body, so we only
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   113
       * visit the variable declarations...!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   114
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   115
      return symbol->var_declarations_list->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   116
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   117
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   118
/*****************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   119
/* B 1.5.2 - Function Blocks */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   120
/*****************************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   121
    void *visit(function_block_declaration_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   122
      /* no need to search through all the body, so we only
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   123
       * visit the variable declarations...!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   124
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   125
      return symbol->var_declarations->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   126
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   127
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   128
/**********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   129
/* B 1.5.3 - Programs */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   130
/**********************/
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   131
    void *visit(program_declaration_c *symbol) {
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   132
      /* no need to search through all the body, so we only
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   133
       * visit the variable declarations...!
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   134
       */
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   135
      return symbol->var_declarations->accept(*this);
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   136
    }
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   137
};
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   138
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   139
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   140
e1f0ebd2d9ec Change generate_cc to generate_c
lbessard
parents:
diff changeset
   141