use crate::error::OpossumError;
use crate::optic_ports::OpticPorts;
type Result<T> = std::result::Result<T, OpossumError>;
/// This trait deals with the translation of the OpticScenery-graph structure to the dot-file format which is needed to visualize the graphs
pub trait Dottable {
/// Return component type specific code in 'dot' format for `graphviz` visualization.
fn to_dot(
&self,
node_index: &str,
name: &str,
inverted: bool,
ports: &OpticPorts,
mut parent_identifier: String,
rankdir: &str
) -> Result<String> {
let inv_string = if inverted { " (inv)" } else { "" };
let node_name = format!("{}{}", name, inv_string);
parent_identifier = if parent_identifier.is_empty() {
format!("i{}", node_index)
} else {
format!("{}_i{}", &parent_identifier, node_index)
};
let mut dot_str = format!("\t{} [\n\t\tshape=plaintext\n", &parent_identifier);
let mut indent_level = 2;
dot_str.push_str(&self.add_html_like_labels(
&node_name,
&mut indent_level,
ports,
inverted,
rankdir
));
Ok(dot_str)
}
/// creates a table-cell wrapper around an "inner" string
fn add_table_cell_container(
&self,
inner_str: &str,
border_flag: bool,
indent_level: &mut i32,
) -> String {
if inner_str.is_empty() {
format!(
"{}<TD BORDER=\"{}\">{}</TD>\n",
"\t".repeat(*indent_level as usize),
border_flag,
inner_str
)
} else {
format!(
"{}<TD BORDER=\"{}\">{}{}{}</TD>\n",
"\t".repeat(*indent_level as usize),
border_flag,
inner_str,
"\t".repeat((*indent_level + 1) as usize),
"\t".repeat(*indent_level as usize)
)
}
}
/// create the dot-string of each port
fn create_port_cell_str(
&self,
port_name: &str,
input_flag: bool,
port_index: usize,
) -> String {
// inputs marked as green, outputs as blue
let color_str = if input_flag {
"\"lightgreen\""
} else {
"\"lightblue\""
};
// part of the tooltip that describes if the port is an input or output
let in_out_str = if input_flag {
"Input port"
} else {
"Output port"
};
format!(
"<TD HEIGHT=\"16\" WIDTH=\"16\" PORT=\"{}\" BORDER=\"1\" BGCOLOR={} HREF=\"\" TOOLTIP=\"{} {}: {}\">{}</TD>\n",
port_name,
color_str,
in_out_str,
port_index,
port_name,
port_index
)
}
/// create the dot-string that describes the ports, including their row/table/cell wrappers
fn create_port_cells_str(
&self,
input_flag: bool,
indent_level: &mut i32,
indent_incr: i32,
ports: &OpticPorts,
) -> String {
let mut ports = if input_flag {
ports.inputs()
} else {
ports.outputs()
};
ports.sort();
let mut dot_str = self.create_html_like_container("row", indent_level, true, 1);
dot_str.push_str(&self.create_html_like_container("cell", indent_level, true, 1));
dot_str.push_str(&self.create_html_like_container("table", indent_level, true, 1));
dot_str.push_str(&self.create_html_like_container("row", indent_level, true, 1));
dot_str.push_str(&self.add_table_cell_container("", false, indent_level));
let mut port_index = 1;
for port in ports {
dot_str.push_str(&self.create_port_cell_str(
&port,
input_flag,
port_index,
));
dot_str.push_str(&self.add_table_cell_container("", false, indent_level));
port_index += 1;
}
*indent_level -= 1;
dot_str.push_str(&self.create_html_like_container("row", indent_level, false, -1));
dot_str.push_str(&self.create_html_like_container("table", indent_level, false, -1));
dot_str.push_str(&self.create_html_like_container("cell", indent_level, false, -1));
dot_str.push_str(&self.create_html_like_container("row", indent_level, false, indent_incr));
dot_str
}
/// Returns the color of the node.
fn node_color(&self) -> &str {
"lightgray"
}
fn create_main_node_row_str(&self, node_name: &str, indent_level: &mut i32) -> String {
let mut dot_str = self.create_html_like_container("row", indent_level, true, 1);
dot_str.push_str(&format!("{}<TD BORDER=\"1\" BGCOLOR=\"{}\" ALIGN=\"CENTER\" WIDTH=\"80\" CELLPADDING=\"10\" HEIGHT=\"80\" STYLE=\"ROUNDED\">{}</TD>\n", "\t".repeat(*indent_level as usize), self.node_color(), node_name));
*indent_level -= 1;
dot_str.push_str(&self.create_html_like_container("row", indent_level, false, 0));
dot_str
}
/// starts or ends an html-like container
fn create_html_like_container(
&self,
container_str: &str,
indent_level: &mut i32,
start_flag: bool,
indent_incr: i32,
) -> String {
let container = match container_str {
"row" => {
if start_flag {
"<TR BORDER=\"0\">"
} else {
"</TR>"
}
}
"cell" => {
if start_flag {
"<TD BORDER=\"0\">"
} else {
"</TD>"
}
}
"table" => {
if start_flag {
"<TABLE BORDER=\"0\" CELLBORDER=\"0\" CELLSPACING=\"0\" CELLPADDING=\"0\" ALIGN=\"CENTER\">"
} else {
"</TABLE>"
}
}
_ => "Invalid container string!",
};
let new_str = "\t".repeat(*indent_level as usize) + container + "\n";
*indent_level += indent_incr;
new_str
}
fn create_node_table_cells(
&self,
ports: (&Vec<String>,&Vec<String>),
// outputs: &Vec<String>,
ports_count: (&mut usize, &mut usize),
ax_nums: (usize,usize),
node_name: &str
) -> String{
let mut dot_str = "".to_owned();
let max_port_num = if ports.0.len() <= ports.1.len(){
ports.1.len()
} else{
ports.0.len()
};
let port_0_count = ports_count.0;
let port_1_count = ports_count.1;
let (node_cell_size,
num_cells,
row_col_span,
port_0_start,
port_1_start
) = if max_port_num > 1{
(16*(max_port_num*2+1),
(max_port_num+1)*2+1,
max_port_num*2+1,
max_port_num - ports.0.len()+2,
max_port_num - ports.1.len()+2
)
}
else {
(80, 7, 5, 3,3)
};
if port_0_count < &mut ports.0.len() && ax_nums.0 >= port_0_start && (ax_nums.0-port_0_start) % 2 == 0 && ax_nums.1 == 0 {
dot_str.push_str(&self.create_port_cell_str(
&ports.0[*port_0_count],
true,
*port_0_count+1,
));
*port_0_count+=1;
}
else if port_1_count < &mut ports.1.len() && ax_nums.0 >= port_1_start && (ax_nums.0-port_1_start) % 2 == 0 && ax_nums.1 == num_cells-1{
dot_str.push_str(&self.create_port_cell_str(
&ports.1[*port_1_count],
false,
*port_1_count+1,
));
*port_1_count+=1;
}
else if ax_nums.0 == 1 && ax_nums.1 == 1{
dot_str.push_str(&format!( "<TD ROWSPAN=\"{}\" COLSPAN=\"{}\" BGCOLOR=\"{}\" WIDTH=\"{}\" HEIGHT=\"{}\" BORDER=\"1\" ALIGN=\"CENTER\" CELLPADDING=\"10\" STYLE=\"ROUNDED\">{}</TD>\n",
row_col_span,
row_col_span,
self.node_color(),
node_cell_size,
node_cell_size,
node_name));
}
else{
dot_str.push_str("<TD ALIGN=\"CENTER\" HEIGHT=\"16\" WIDTH=\"16\"> </TD>\n")
};
dot_str
}
/// creates the node label defined by html-like strings
fn add_html_like_labels(
&self,
node_name: &str,
indent_level: &mut i32,
ports: &OpticPorts,
inverted: bool,
rankdir:&str,
) -> String {
let mut dot_str = "\t\tlabel=<\n".to_owned();
let mut inputs = ports.inputs();
let mut outputs = ports.outputs();
let mut in_port_count = 0;
let mut out_port_count = 0;
inputs.sort();
outputs.sort();
let num_cells = if inputs.len() <=outputs.len() && outputs.len() > 1{
(outputs.len()+1)*2+1
} else if inputs.len() > outputs.len() && inputs.len() > 1{
(inputs.len()+1)*2+1
}
else{
7
};
let port_list = if inverted{(&outputs, &inputs)}else{(&inputs, &outputs)};
// Start Table environment
dot_str.push_str(&self.create_html_like_container("table", indent_level, true, 1));
//create each cell of the table
for row_num in 0..num_cells{
dot_str.push_str(&self.create_html_like_container("row", indent_level, true, 1));
for col_num in 0..num_cells{
if rankdir == "LR"
&& !(col_num > 1 && col_num <num_cells-1 && row_num>= 1 && row_num <num_cells-1)
&& !(col_num >= 1 && col_num <num_cells-1 && row_num> 1 && row_num <num_cells-1){
dot_str.push_str(&"\t".repeat(*indent_level as usize));
dot_str.push_str(
&self.create_node_table_cells(
port_list,
(&mut in_port_count, &mut out_port_count),
(row_num,col_num),
node_name
)
)
}
else if rankdir != "LR"
&& !(row_num > 1 && row_num <num_cells-1 && col_num>= 1 && col_num <num_cells-1)
&& !(row_num >= 1 && row_num <num_cells-1 && col_num> 1 && col_num <num_cells-1){
dot_str.push_str(&"\t".repeat(*indent_level as usize));
dot_str.push_str(
&self.create_node_table_cells(
port_list,
(&mut in_port_count, &mut out_port_count),
(col_num, row_num),
node_name)
)
};
}
*indent_level -= 1;
dot_str.push_str(&self.create_html_like_container("row", indent_level, false, 0));
}
//end table environment
dot_str.push_str(&self.create_html_like_container("table", indent_level, false, -1));
//end node-shape description
dot_str.push_str(&format!("{}>];\n", "\t".repeat(*indent_level as usize)));
dot_str
}
}