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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
//! Block borders.
pub mod block_border;
pub mod block_connect;
pub mod block_grid;
pub mod border_symbols;
use dyn_clone::DynClone;
use ratatui::widgets::BorderType;
use std::fmt::Debug;
/// Names for the sides of an area.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Side {
/// Border along the top side.
Top,
/// Border along bottom side.
Bottom,
/// Border along the right side.
Right,
/// Border along the left side.
Left,
}
/// Symbol set trait
pub trait BorderSymbolSet: DynClone {
///
/// Equivalent BorderType.
///
fn border_type(&self) -> BorderType;
///
/// Get the actual symbol occurring along one side of the area.
///
/// side: Which side of the area.
/// symbol: Symbol definition.
///
fn symbol(&self, side: Side, symbol: BorderSymbol) -> &'static str;
///
/// Get the symbol for a 4-way crossing of lines.
///
/// The number of parameters comes from handling Quadrant crossings.
/// 
///
/// __Remark__
/// Not needed for drawing Rects or grids, but a bit of a missing link otherwise.
///
#[allow(clippy::too_many_arguments)]
fn crossing(
&self,
top_side: Side,
top: BorderType,
right_side: Side,
right: BorderType,
bottom_side: Side,
bottom: BorderType,
left_side: Side,
left: BorderType,
) -> &'static str;
}
/// Symbol descriptor.
///
/// Describes the symbols geometrically as they occur along one
/// side of the area.
///
/// Schematics for the connection.
///
/// 
///
/// Which side of the other area is connected may also influence
/// the actual glyph.
///
/// 
///
/// Construction for PlainBorderSet. Note that some of the glyphs do not
/// exist in unicode and are replaced with single line versions.
///
/// 
///
/// Construction for QuadrantInsideBorderSet
///
/// 
/// 
/// 
/// 
///
///
///
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BorderSymbol {
/// Regular start corner.
StartCornerRegular,
/// Start corner with an extension perpendicular to the line.
StartCornerAngled(Side, BorderType),
/// Start corner that goes on in the direction of the line.
StartCornerProlonged(Side, BorderType),
/// Crossing at the start.
/// The first value is the border perpendicular to the line,
/// the second goes in the direction of the line.
StartCornerCrossed(Side, BorderType, Side, BorderType),
/// Regular side.
SideRegular,
/// Regular side, but overlapping with some other border.
SideOverlap(Side, BorderType),
/// Side with a connection point outwards.
SideOutward(Side, BorderType),
/// Side with a connection point inwards.
SideInward(Side, BorderType),
/// Side with a crossing.
/// The first value is the border outwards, the second
/// goes inwards.
SideCrossed(Side, BorderType, Side, BorderType),
/// Regular end corner.
EndCornerRegular,
/// End corner with an extension perpendicular to the line.
EndCornerAngled(Side, BorderType),
/// End corner that goes on in the direction of the line.
EndCornerProlonged(Side, BorderType),
/// Crossing at the end.
/// The first value is the border perpendicular to the line,
/// the second goes in the direction of the line.
EndCornerCrossed(Side, BorderType, Side, BorderType),
}
impl Side {
/// Give the opposite side.
pub fn opposite(&self) -> Self {
match self {
Side::Top => Side::Bottom,
Side::Right => Side::Left,
Side::Bottom => Side::Top,
Side::Left => Side::Right,
}
}
}
impl BorderSymbol {
/// Adds an outward connection to the given border.
///
/// Replaces any existing outward connection.
/// Changes the BorderSymbol to add an outward connection if possible.
pub fn join_outward(&mut self, side: Side, border: BorderType) {
use BorderSymbol::*;
*self = match *self {
StartCornerRegular => StartCornerAngled(side, border),
StartCornerAngled(_, _) => StartCornerAngled(side, border),
StartCornerProlonged(prolong_side, prolong_border) => {
StartCornerCrossed(side, border, prolong_side, prolong_border)
}
StartCornerCrossed(_, _, prolong_side, prolong_border) => {
StartCornerCrossed(side, border, prolong_side, prolong_border)
}
SideRegular => SideOutward(side, border),
SideOverlap(_, _) => SideOutward(side, border),
SideOutward(_, _) => SideOutward(side, border),
SideInward(inward_side, inward_border) => {
SideCrossed(side, border, inward_side, inward_border)
}
SideCrossed(_, _, inward_side, inward_border) => {
SideCrossed(side, border, inward_side, inward_border)
}
EndCornerRegular => EndCornerAngled(side, border),
EndCornerAngled(_, _) => EndCornerAngled(side, border),
EndCornerProlonged(prolong_side, prolong_border) => {
EndCornerCrossed(side, border, prolong_side, prolong_border)
}
EndCornerCrossed(_, _, prolong_side, prolong_border) => {
EndCornerCrossed(side, border, prolong_side, prolong_border)
}
}
}
/// Adds an inward connection to the given border.
///
/// Replaces any existing inward connection.
/// Changes the BorderSymbol to add an inward connection if possible.
pub fn join_inward(&mut self, side: Side, border: BorderType) {
use BorderSymbol::*;
*self = match *self {
StartCornerRegular => *self,
StartCornerAngled(_, _) => *self,
StartCornerProlonged(_, _) => *self,
StartCornerCrossed(_, _, _, _) => *self,
SideRegular => SideInward(side, border),
SideOverlap(_, _) => SideInward(side, border),
SideOutward(outward_side, outward_border) => {
SideCrossed(outward_side, outward_border, side, border)
}
SideInward(_, _) => SideInward(side, border),
SideCrossed(outward_side, outward_border, _, _) => {
SideCrossed(outward_side, outward_border, side, border)
}
EndCornerRegular => *self,
EndCornerAngled(_, _) => *self,
EndCornerProlonged(_, _) => *self,
EndCornerCrossed(_, _, _, _) => *self,
}
}
/// Changes the BorderSymbol to add an overlapping area if possible.
///
/// Does nothing if this is not possible for the current symbol.
pub fn overlap(&mut self, side: Side, border: BorderType) {
use BorderSymbol::*;
*self = match *self {
StartCornerRegular => *self,
StartCornerAngled(_, _) => *self,
StartCornerProlonged(_, _) => *self,
StartCornerCrossed(_, _, _, _) => *self,
SideRegular => SideOverlap(side, border),
SideOverlap(_, _) => SideOverlap(side, border),
SideOutward(_, _) => *self,
SideInward(_, _) => *self,
SideCrossed(_, _, _, _) => *self,
EndCornerRegular => *self,
EndCornerAngled(_, _) => *self,
EndCornerProlonged(_, _) => *self,
EndCornerCrossed(_, _, _, _) => *self,
}
}
/// Changes the BorderSymbol to prolong the border along the side.
///
/// Does nothing if this is not possible for the current symbol.
pub fn prolong(&mut self, side: Side, border: BorderType) {
use BorderSymbol::*;
*self = match *self {
StartCornerRegular => StartCornerProlonged(side, border),
StartCornerAngled(angle_side, angle_border) => {
StartCornerCrossed(angle_side, angle_border, side, border)
}
StartCornerProlonged(_, _) => StartCornerProlonged(side, border),
StartCornerCrossed(angle_side, angle_border, _, _) => {
StartCornerCrossed(angle_side, angle_border, side, border)
}
SideRegular => *self,
SideOverlap(_, _) => *self,
SideOutward(_, _) => *self,
SideInward(_, _) => *self,
SideCrossed(_, _, _, _) => *self,
EndCornerRegular => EndCornerProlonged(side, border),
EndCornerAngled(angle_side, angle_border) => {
EndCornerCrossed(angle_side, angle_border, side, border)
}
EndCornerProlonged(_, _) => EndCornerProlonged(side, border),
EndCornerCrossed(angle_side, angle_border, _, _) => {
EndCornerCrossed(angle_side, angle_border, side, border)
}
}
}
}