1

/*

     2

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

     3

 *

     4

 *  Copyright (C) 2003-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

/*

    27

 * A generic symbol table that allows duplicate values.

    28

 *

    29

 * This is used to create a symbol table of previously defined

    30

 * functions. Duplicate are allowed since the standard permits function\

    31

 * overloading in the standard library.

    32

 */

    33

    34

    35

    36

#ifndef _DSYMTABLE_HH

    37

#define _DSYMTABLE_HH

    38

    39

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

    40

    41

#include <map>

    42

#include <string>

    43

    44

    45

    46

    47

template<typename value_type, value_type null_value> class dsymtable_c {

    48

  /* Case insensitive string compare copied from

    49

   * "The C++ Programming Language" - 3rd Edition

    50

   * by Bjarne Stroustrup, ISBN 0201889544.

    51

   */

    52

  class nocase_c {

    53

    public:

    54

      bool operator() (const std::string& x, const std::string& y) const {

    55

        std::string::const_iterator ix = x.begin();

    56

        std::string::const_iterator iy = y.begin();

    57

    58

        for(; (ix != x.end()) && (iy != y.end()) && (toupper(*ix) == toupper(*iy)); ++ix, ++iy);

    59

        if (ix == x.end()) return (iy != y.end());

    60

        if (iy == y.end()) return false;

    61

        return (toupper(*ix) < toupper(*iy));

    62

      };

    63

  };

    64

    65

  public:

    66

    typedef value_type value_t;

    67

    68

  private:

    69

    /* Comparison between identifiers must ignore case, therefore the use of nocase_c */

    70

    typedef std::multimap<std::string, value_t, nocase_c> base_t;

    71

    base_t _base;

    72

    73

  public:

    74

  typedef typename base_t::iterator iterator;

    75

  typedef typename base_t::const_iterator const_iterator;

    76

  typedef typename base_t::reverse_iterator reverse_iterator;

    77

  typedef typename base_t::const_reverse_iterator const_reverse_iterator;

    78

    79

  private:

    80

    void reset(void); /* clear all entries... */

    81

    const char *symbol_to_string(const symbol_c *symbol);

    82

    83

  public:

    84

    dsymtable_c(void) {};

    85

    86

    void insert(const char *identifier_str, value_t value);

    87

    void insert(const symbol_c *symbol, value_t value);

    88

    89

    /* Determine how many entries are associated to key identifier_str */ 

    90

    /* returns:

    91

     *         0: if no entry is found

    92

     *         1: if 1 entry is found

    93

     *         2: if more than 1 entry is found 

    94

     */

    95

    int multiplicity(const char *identifier_str);

    96

    int multiplicity(const symbol_c *symbol)        {return multiplicity(symbol_to_string(symbol));}

    97

    98

    /* Search for an entry. Will return end_value() if not found */

    99

    value_t end_value(void) {return null_value;}

   100

    value_t find_value(const char *identifier_str);

   101

    value_t find_value(const symbol_c *symbol)       {return find_value(symbol_to_string(symbol));}

   102

   103

    /* Search for an entry associated with identifier_str. Will return end() if not found */

   104

    iterator find(const char *identifier_str)        {return _base.find(identifier_str);}

   105

    iterator find(const symbol_c *symbol)            {return find(symbol_to_string(symbol));}

   106

   107

    /* Search for the first entry associated with (i.e. with key ==) identifier_str. Will return end() if not found */

   108

    /* Basically, the same as find() */

   109

    iterator lower_bound(const char *identifier_str) {return _base.lower_bound(identifier_str);}

   110

    iterator lower_bound(const symbol_c *symbol)     {return lower_bound(symbol_to_string(symbol));}

   111

   112

    /* Search for the first entry with key greater than identifier_str. Will return end() if not found */

   113

    iterator upper_bound(const char *identifier_str) {return _base.upper_bound(identifier_str);}

   114

    iterator upper_bound(const symbol_c *symbol)     {return upper_bound(symbol_to_string(symbol));}

   115

   116

    /* get the value to which an iterator is pointing to... */

   117

    value_t get_value(const iterator i) {return i->second;}

   118

   119

  /* iterators pointing to beg/end of map... */

   120

    iterator begin() 			{return _base.begin();}

   121

    const_iterator begin() const	{return _base.begin();}

   122

    iterator end()			{return _base.end();}

   123

    const_iterator end() const 		{return _base.end();}

   124

    reverse_iterator rbegin()		{return _base.rbegin();}

   125

    const_reverse_iterator rbegin() const {return _base.rbegin();}

   126

    reverse_iterator rend() 		{return _base.rend();}

   127

    const_reverse_iterator rend() const	{return _base.rend();}

   128

   129

    /* debuging function... */

   130

    void print(void);

   131

};

   132

   133

   134

   135

/* Templates must include the source into the code! */

   136

#include "dsymtable.cc"

   137

   138

#endif /*  _DSYMTABLE_HH */