3 * Helper templates to provide per-class information for class hierarchies. */
6 * GiNaC Copyright (C) 1999-2005 Johannes Gutenberg University Mainz, Germany
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #ifndef __GINAC_CLASS_INFO_H__
24 #define __GINAC_CLASS_INFO_H__
26 #include <cstddef> // for size_t
36 // OPT is the class that stores the actual per-class data. It must provide
37 // get_name(), get_parent_name() and get_id() members.
42 class_info(const OPT & o) : options(o), next(first), parent(NULL)
45 parents_identified = false;
48 /** Get pointer to class_info of parent class (or NULL). */
49 class_info *get_parent() const
55 /** Find class_info by name. */
56 static const class_info *find(const std::string &class_name);
58 /** Dump class hierarchy to std::cout. */
59 static void dump_hierarchy(bool verbose = false);
65 tree_node(class_info *i) : info(i) {}
66 void add_child(tree_node *n) { children.push_back(n); }
68 std::vector<tree_node *> children;
72 static void dump_tree(tree_node *n, const std::string & prefix, bool verbose);
73 static void identify_parents();
75 static class_info *first;
77 mutable class_info *parent;
79 static bool parents_identified;
83 const class_info<OPT> *class_info<OPT>::find(const std::string &class_name)
85 // Use a map for faster lookup. The registered_class_info list doesn't
86 // change at run-time, so it's sufficient to construct the map once
87 // on the first trip through this function.
88 typedef std::map<std::string, const class_info *> name_map_type;
89 static name_map_type name_map;
90 static bool name_map_initialized = false;
92 if (!name_map_initialized) {
94 const class_info *p = first;
96 name_map[p->options.get_name()] = p;
99 name_map_initialized = true;
102 typename name_map_type::const_iterator it = name_map.find(class_name);
103 if (it == name_map.end())
104 throw (std::runtime_error("class '" + class_name + "' not registered"));
110 void class_info<OPT>::dump_tree(tree_node *n, const std::string & prefix, bool verbose)
112 std::string name = n->info->options.get_name();
115 std::cout << " [ID 0x" << std::hex << std::setw(8) << std::setfill('0') << n->info->options.get_id() << std::dec << "]" << std::endl;
117 size_t num_children = n->children.size();
119 for (size_t i = 0; i < num_children; ++i) {
121 std::cout << prefix << " +- ";
122 if (i == num_children - 1)
123 dump_tree(n->children[i], prefix + " ", verbose);
125 dump_tree(n->children[i], prefix + " | ", verbose);
127 std::string spaces(name.size(), ' ');
129 std::cout << prefix << spaces;
130 if (num_children == 1)
131 std::cout << " --- ";
135 std::cout << " -+- ";
136 if (i == num_children - 1)
137 dump_tree(n->children[i], prefix + spaces + " ", verbose);
139 dump_tree(n->children[i], prefix + spaces + " | ", verbose);
143 std::cout << std::endl;
147 void class_info<OPT>::dump_hierarchy(bool verbose)
151 // Create tree nodes for all class_infos
152 std::vector<tree_node> tree;
153 for (class_info *p = first; p; p = p->next)
154 tree.push_back(tree_node(p));
156 // Identify children for all nodes and find the root
157 tree_node *root = NULL;
158 for (typename std::vector<tree_node>::iterator i = tree.begin(); i != tree.end(); ++i) {
159 class_info *p = i->info->get_parent();
161 for (typename std::vector<tree_node>::iterator j = tree.begin(); j != tree.end(); ++j) {
171 // Print hierarchy tree starting at the root
172 dump_tree(root, "", verbose);
176 void class_info<OPT>::identify_parents()
178 if (!parents_identified) {
179 for (class_info *p = first; p; p = p->next) {
180 const char *parent_name = p->options.get_parent_name();
181 for (class_info *q = first; q; q = q->next) {
182 if (strcmp(q->options.get_name(), parent_name) == 0) {
188 parents_identified = true;
192 template <class OPT> class_info<OPT> *class_info<OPT>::first = NULL;
193 template <class OPT> bool class_info<OPT>::parents_identified = false;
197 #endif // ndef __GINAC_CLASS_INFO_H__