Welcome to mirror list, hosted at ThFree Co, Russian Federation.

COM_Debug.h « intern « compositor « blender « source - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: e1aea69e4814d9f20c10b3a26c02ba933d2ffd91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Copyright 2013, Blender Foundation.
 */

#pragma once

#include <map>
#include <string>

#include "COM_ExecutionSystem.h"
#include "COM_NodeOperation.h"
#include "COM_defines.h"

namespace blender::compositor {

static constexpr bool COM_EXPORT_GRAPHVIZ = false;
class Node;
class ExecutionSystem;
class ExecutionGroup;

class DebugInfo {
 public:
  typedef enum { EG_WAIT, EG_RUNNING, EG_FINISHED } GroupState;

  typedef std::map<const Node *, std::string> NodeNameMap;
  typedef std::map<const NodeOperation *, std::string> OpNameMap;
  typedef std::map<const ExecutionGroup *, GroupState> GroupStateMap;

  static std::string node_name(const Node *node);
  static std::string operation_name(const NodeOperation *op);

 private:
  static int m_file_index;
  /** Map nodes to usable names for debug output. */
  static NodeNameMap m_node_names;
  /** Map operations to usable names for debug output. */
  static OpNameMap m_op_names;
  /** Base name for all operations added by a node. */
  static std::string m_current_node_name;
  /** Base name for automatic sub-operations. */
  static std::string m_current_op_name;
  /** For visualizing group states. */
  static GroupStateMap m_group_states;

 public:
  static void convert_started()
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_op_names.clear();
    }
  }

  static void execute_started(const ExecutionSystem *system)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_file_index = 1;
      m_group_states.clear();
      for (ExecutionGroup *execution_group : system->m_groups) {
        m_group_states[execution_group] = EG_WAIT;
      }
    }
  };

  static void node_added(const Node *node)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_node_names[node] = std::string(node->getbNode() ? node->getbNode()->name : "");
    }
  }

  static void node_to_operations(const Node *node)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_current_node_name = m_node_names[node];
    }
  }

  static void operation_added(const NodeOperation *operation)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_op_names[operation] = m_current_node_name;
    }
  };

  static void operation_read_write_buffer(const NodeOperation *operation)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_current_op_name = m_op_names[operation];
    }
  };

  static void execution_group_started(const ExecutionGroup *group)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_group_states[group] = EG_RUNNING;
    }
  };
  static void execution_group_finished(const ExecutionGroup *group)
  {
    if (COM_EXPORT_GRAPHVIZ) {
      m_group_states[group] = EG_FINISHED;
    }
  };

  static void graphviz(const ExecutionSystem *system);

 protected:
  static int graphviz_operation(const ExecutionSystem *system,
                                NodeOperation *operation,
                                const ExecutionGroup *group,
                                char *str,
                                int maxlen);
  static int graphviz_legend_color(const char *name, const char *color, char *str, int maxlen);
  static int graphviz_legend_line(
      const char *name, const char *color, const char *style, char *str, int maxlen);
  static int graphviz_legend_group(
      const char *name, const char *color, const char *style, char *str, int maxlen);
  static int graphviz_legend(char *str, int maxlen);
  static bool graphviz_system(const ExecutionSystem *system, char *str, int maxlen);
};

}  // namespace blender::compositor