Merge pull request #42 from mlange-42/feature/branches-and-tags

Give access to actual branches and tags
* Renamed branches to all_branches (breaking change)
* Store actual branches and tags as indices into all_branches

Author: mlange-42

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "git-graph"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Martin Lange <martin_lange_@gmx.net>"]
 description = "Command line tool to show clear git graphs arranged for your branching model"
 repository = "https://github.com/mlange-42/git-graph.git"

Cargo.toml

@@ -13,8 +13,15 @@ const ORIGIN: &str = "origin/";
 pub struct GitGraph {
     pub repository: Repository,
     pub commits: Vec<CommitInfo>,
+    /// Mapping from commit id to index in `commits`
     pub indices: HashMap<Oid, usize>,
-    pub branches: Vec<BranchInfo>,
+    /// All detected branches and tags, including merged and deleted
+    pub all_branches: Vec<BranchInfo>,
+    /// Indices of all real (still existing) branches in `all_branches`
+    pub branches: Vec<usize>,
+    /// Indices of all tags in `all_branches`
+    pub tags: Vec<usize>,
+    /// The current HEAD
     pub head: HeadInfo,
 }
 
@@ -66,8 +73,8 @@ impl GitGraph {
 
         assign_children(&mut commits, &indices);
 
-        let mut branches = assign_branches(&repository, &mut commits, &indices, &settings)?;
-        assign_sources_targets(&commits, &indices, &mut branches);
+        let mut all_branches = assign_branches(&repository, &mut commits, &indices, &settings)?;
+        assign_sources_targets(&commits, &indices, &mut all_branches);
 
         let (shortest_first, forward) = match settings.branch_order {
             BranchOrder::ShortestFirst(fwd) => (true, fwd),
@@ -77,7 +84,7 @@ impl GitGraph {
         assign_branch_columns(
             &commits,
             &indices,
-            &mut branches,
+            &mut all_branches,
             &settings.branches,
             shortest_first,
             forward,
@@ -99,7 +106,7 @@ impl GitGraph {
             .map(|(oid, index)| (*index, filtered_indices.get(oid)))
             .collect();
 
-        for branch in branches.iter_mut() {
+        for branch in all_branches.iter_mut() {
             if let Some(mut start_idx) = branch.range.0 {
                 let mut idx0 = index_map[&start_idx];
                 while idx0.is_none() {
@@ -118,11 +125,36 @@ impl GitGraph {
             }
         }
 
+        let branches = all_branches
+            .iter()
+            .enumerate()
+            .filter_map(|(idx, br)| {
+                if !br.is_merged && !br.is_tag {
+                    Some(idx)
+                } else {
+                    None
+                }
+            })
+            .collect();
+        let tags = all_branches
+            .iter()
+            .enumerate()
+            .filter_map(|(idx, br)| {
+                if !br.is_merged && br.is_tag {
+                    Some(idx)
+                } else {
+                    None
+                }
+            })
+            .collect();
+
         Ok(GitGraph {
             repository,
             commits: filtered_commits,
             indices: filtered_indices,
+            all_branches,
             branches,
+            tags,
             head,
         })
     }

src/graph.rs

@@ -392,7 +392,7 @@ fn run(
     let duration_graph = now.elapsed().as_micros();
 
     if settings.debug {
-        for branch in &graph.branches {
+        for branch in &graph.all_branches {
             eprintln!(
                 "{} (col {}) ({:?}) {} s: {:?}, t: {:?}",
                 branch.name,

src/main.rs

@@ -16,14 +16,14 @@ fn get_deviate_index(graph: &GitGraph, index: usize, par_index: usize) -> usize
     let info = &graph.commits[index];
 
     let par_info = &graph.commits[par_index];
-    let par_branch = &graph.branches[par_info.branch_trace.unwrap()];
+    let par_branch = &graph.all_branches[par_info.branch_trace.unwrap()];
 
     let mut min_split_idx = index;
     for sibling_oid in &par_info.children {
         if let Some(&sibling_index) = graph.indices.get(sibling_oid) {
             if let Some(sibling) = graph.commits.get(sibling_index) {
                 if let Some(sibling_trace) = sibling.branch_trace {
-                    let sibling_branch = &graph.branches[sibling_trace];
+                    let sibling_branch = &graph.all_branches[sibling_trace];
                     if sibling_oid != &info.oid
                         && sibling_branch.visual.column == par_branch.visual.column
                         && sibling_index > min_split_idx

src/print/mod.rs

@@ -14,7 +14,7 @@ pub fn print_svg(graph: &GitGraph, settings: &Settings) -> Result<String, String
     let mut max_column = 0;
 
     if settings.debug {
-        for branch in &graph.branches {
+        for branch in &graph.all_branches {
             if let (Some(start), Some(end)) = branch.range {
                 document = document.add(bold_line(
                     start,
@@ -29,7 +29,7 @@ pub fn print_svg(graph: &GitGraph, settings: &Settings) -> Result<String, String
 
     for (idx, info) in graph.commits.iter().enumerate() {
         if let Some(trace) = info.branch_trace {
-            let branch = &graph.branches[trace];
+            let branch = &graph.all_branches[trace];
             let branch_color = &branch.visual.svg_color;
 
             if branch.visual.column.unwrap() > max_column {
@@ -40,7 +40,7 @@ pub fn print_svg(graph: &GitGraph, settings: &Settings) -> Result<String, String
                 if let Some(par_oid) = info.parents[p] {
                     if let Some(par_idx) = graph.indices.get(&par_oid) {
                         let par_info = &graph.commits[*par_idx];
-                        let par_branch = &graph.branches[par_info.branch_trace.unwrap()];
+                        let par_branch = &graph.all_branches[par_info.branch_trace.unwrap()];
 
                         let color = if info.is_merge {
                             &par_branch.visual.svg_color

src/print/svg.rs

@@ -39,7 +39,7 @@ pub fn print_unicode(
     settings: &Settings,
 ) -> Result<(Vec<String>, Vec<usize>), String> {
     let num_cols = 2 * graph
-        .branches
+        .all_branches
         .iter()
         .map(|b| b.visual.column.unwrap_or(0))
         .max()
@@ -114,7 +114,7 @@ pub fn print_unicode(
 
     for (idx, info) in graph.commits.iter().enumerate() {
         if let Some(trace) = info.branch_trace {
-            let branch = &graph.branches[trace];
+            let branch = &graph.all_branches[trace];
             let column = branch.visual.column.unwrap();
             let idx_map = index_map[idx];
 
@@ -133,7 +133,7 @@ pub fn print_unicode(
                     if let Some(par_idx) = graph.indices.get(&par_oid) {
                         let par_idx_map = index_map[*par_idx];
                         let par_info = &graph.commits[*par_idx];
-                        let par_branch = &graph.branches[par_info.branch_trace.unwrap()];
+                        let par_branch = &graph.all_branches[par_info.branch_trace.unwrap()];
                         let par_column = par_branch.visual.column.unwrap();
 
                         let (color, pers) = if info.is_merge {
@@ -397,7 +397,7 @@ fn get_inserts(graph: &GitGraph, compact: bool) -> HashMap<usize, Vec<Vec<Occ>>>
     let mut inserts: HashMap<usize, Vec<Vec<Occ>>> = HashMap::new();
 
     for (idx, info) in graph.commits.iter().enumerate() {
-        let column = graph.branches[info.branch_trace.unwrap()]
+        let column = graph.all_branches[info.branch_trace.unwrap()]
             .visual
             .column
             .unwrap();
@@ -407,14 +407,14 @@ fn get_inserts(graph: &GitGraph, compact: bool) -> HashMap<usize, Vec<Vec<Occ>>>
 
     for (idx, info) in graph.commits.iter().enumerate() {
         if let Some(trace) = info.branch_trace {
-            let branch = &graph.branches[trace];
+            let branch = &graph.all_branches[trace];
             let column = branch.visual.column.unwrap();
 
             for p in 0..2 {
                 if let Some(par_oid) = info.parents[p] {
                     if let Some(par_idx) = graph.indices.get(&par_oid) {
                         let par_info = &graph.commits[*par_idx];
-                        let par_branch = &graph.branches[par_info.branch_trace.unwrap()];
+                        let par_branch = &graph.all_branches[par_info.branch_trace.unwrap()];
                         let par_column = par_branch.visual.column.unwrap();
                         let column_range = sorted(column, par_column);
 
@@ -563,7 +563,7 @@ pub fn format_branches(
 ) -> Result<String, String> {
     let curr_color = info
         .branch_trace
-        .map(|branch_idx| &graph.branches[branch_idx].visual.term_color);
+        .map(|branch_idx| &graph.all_branches[branch_idx].visual.term_color);
 
     let mut branch_str = String::new();
 
@@ -584,14 +584,14 @@ pub fn format_branches(
 
         let branches = info.branches.iter().sorted_by_key(|br| {
             if let Some(head) = head {
-                head.name != graph.branches[**br].name
+                head.name != graph.all_branches[**br].name
             } else {
                 false
             }
         });
 
         for (idx, branch_index) in branches.enumerate() {
-            let branch = &graph.branches[*branch_index];
+            let branch = &graph.all_branches[*branch_index];
             let branch_color = branch.visual.term_color;
 
             if let Some(head) = head {
@@ -622,7 +622,7 @@ pub fn format_branches(
     if !info.tags.is_empty() {
         write!(branch_str, " [").map_err(|err| err.to_string())?;
         for (idx, tag_index) in info.tags.iter().enumerate() {
-            let tag = &graph.branches[*tag_index];
+            let tag = &graph.all_branches[*tag_index];
             let tag_color = curr_color.unwrap_or(&tag.visual.term_color);
 
             if color {