Cleanup: remove non-existing function declarations
[blender.git] / source / blender / compositor / intern / COM_Debug.h
1 /*
2  * Copyright 2013, Blender Foundation.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor:
19  *      Lukas Toenne
20  */
21
22 #ifndef __COM_DEBUG_H__
23 #define __COM_DEBUG_H__
24
25 #include <map>
26 #include <string>
27
28 #include "COM_defines.h"
29
30 class Node;
31 class NodeOperation;
32 class ExecutionSystem;
33 class ExecutionGroup;
34
35 class DebugInfo {
36 public:
37         typedef enum {
38                 EG_WAIT,
39                 EG_RUNNING,
40                 EG_FINISHED
41         } GroupState;
42
43         typedef std::map<const Node *, std::string> NodeNameMap;
44         typedef std::map<const NodeOperation *, std::string> OpNameMap;
45         typedef std::map<const ExecutionGroup *, GroupState> GroupStateMap;
46
47         static std::string node_name(const Node *node);
48         static std::string operation_name(const NodeOperation *op);
49
50         static void convert_started();
51         static void execute_started(const ExecutionSystem *system);
52
53         static void node_added(const Node *node);
54         static void node_to_operations(const Node *node);
55         static void operation_added(const NodeOperation *operation);
56         static void operation_read_write_buffer(const NodeOperation *operation);
57
58         static void execution_group_started(const ExecutionGroup *group);
59         static void execution_group_finished(const ExecutionGroup *group);
60
61         static void graphviz(const ExecutionSystem *system);
62
63 #ifdef COM_DEBUG
64 protected:
65         static int graphviz_operation(const ExecutionSystem *system, const NodeOperation *operation, const ExecutionGroup *group, char *str, int maxlen);
66         static int graphviz_legend_color(const char *name, const char *color, char *str, int maxlen);
67         static int graphviz_legend_line(const char *name, const char *color, const char *style, char *str, int maxlen);
68         static int graphviz_legend_group(const char *name, const char *color, const char *style, char *str, int maxlen);
69         static int graphviz_legend(char *str, int maxlen);
70         static bool graphviz_system(const ExecutionSystem *system, char *str, int maxlen);
71
72 private:
73         static int m_file_index;
74         static NodeNameMap m_node_names;                        /**< map nodes to usable names for debug output */
75         static OpNameMap m_op_names;                            /**< map operations to usable names for debug output */
76         static std::string m_current_node_name;         /**< base name for all operations added by a node */
77         static std::string m_current_op_name;           /**< base name for automatic sub-operations */
78         static GroupStateMap m_group_states;            /**< for visualizing group states */
79 #endif
80 };
81
82 #endif