ordered_list.h

// -*-c++-*-
#ifndef STORMM_ORDERED_LIST_H
#define STORMM_ORDERED_LIST_H
 
#include <string>
#include <vector>
#include "copyright.h"
#include "FileManagement/file_enumerators.h"
#include "Parsing/textfile.h"
#include "reporting_enumerators.h"
#include "summary_file.h"
 
namespace stormm {
namespace review {
 
using diskutil::PrintSituation;
using parse::TextFile;

class OrderedList {
public:

  OrderedList(ListEnumeration style_in, int reserved_length = 0, int indentation_in = 2,
              char bullet_in = '*', ListEnumeration nested_style_in = ListEnumeration::BULLET,
              int nested_reserved_length = 0, int nested_indentation_in = 4,
              char nested_bullet_in = '-', int format_width_in = default_output_file_width);
 
  OrderedList(ListEnumeration style_in, ListEnumeration nested_style_in);  

  OrderedList(const OrderedList &original) = default;
  OrderedList(OrderedList &&original) = default;
  OrderedList& operator=(const OrderedList &original) = default;
  OrderedList& operator=(OrderedList &&original) = default;

  int getItemCount() const;

  int getNestedItemCount() const;
  int getNestedItemCount(int item_index) const;

  std::string getItem(int item_index, int width = -1, int alt_indent = -1,
                      ListEnumeration alt_style = ListEnumeration::NONE) const;

  std::string getNestedItem(int item_index, int nested_item_index, int width = -1,
                            int alt_indent = -1,
                            ListEnumeration alt_style = ListEnumeration::NONE) const;

  std::string printList(int width = default_output_file_width, int alt_indent = -1,
                        int alt_nested_indent = -1,
                        ListEnumeration alt_style = ListEnumeration::NONE,
                        ListEnumeration alt_nested_style = ListEnumeration::NONE) const;
 
  TextFile printList(OutputSyntax style, int width, int alt_indent = -1,
                     int alt_nested_indent = -1,
                     ListEnumeration alt_marking = ListEnumeration::NONE,
                     ListEnumeration alt_nested_marking = ListEnumeration::NONE) const;
  
  void printList(std::ofstream *foutp, OutputSyntax style, int width = default_output_file_width,
                 int alt_indent = -1, int alt_nested_indent = -1,
                 ListEnumeration alt_marking = ListEnumeration::NONE,
                 ListEnumeration alt_nested_marking = ListEnumeration::NONE) const;
 
  void printList(const std::string &file_name, PrintSituation expectation, OutputSyntax style,
                 int width = default_output_file_width, int alt_indent = -1,
                 int alt_nested_indent = -1, ListEnumeration alt_marking = ListEnumeration::NONE,
                 ListEnumeration alt_nested_marking = ListEnumeration::NONE) const;

  void setStyle(ListEnumeration style_in);

  void setNestedStyle(ListEnumeration nested_style_in);

  void setBullet(char bullet_in);

  void setNestedBullet(char nested_bullet_in);

  void setFormatWidth(int format_width_in);
  
  void addItem(const std::string &item_in, int item_index = -1);

  void addItemBefore(const std::string &item_in, int item_index);
  void addItemBefore(const std::string &item_in, const std::string &current_item);

  void addItemAfter(const std::string &item_in, int item_index);
  void addItemAfter(const std::string &item_in, const std::string &current_item);

  void addNestedItem(const std::string &nested_item_in, int current_item = -1);
  void addNestedItem(const std::string &nested_item_in, const std::string &current_item);
 
private:
  int item_count;                         
  ListEnumeration style;                  
  int indentation;                        
  ListEnumeration nested_style;           
  int nested_indentation;                 
  char bullet;                            
  char nested_bullet;                     
  int max_marker_length;                  
  int max_nested_marker_length;           
  int format_width;                       
  std::vector<std::string> items;         
  std::vector<int> nested_item_limits;    
  std::vector<int> nested_item_contents;  
  std::vector<std::string> nested_items;  
  std::vector<int> item_homes;            

  void validateItemIndex(int item_index, const char* caller = nullptr) const;  

  void validateNestedItemIndex(int item_index, int nested_item_index,
                               const char* caller = nullptr) const;
  
  int locateItem(const std::string &current_item) const;

  void calculateMarkerLengths();
};
  
} // namespace review
} // namespace stormm
 
#endif