[lmi-commits] [lmi] master df97bf0 4/4: Rename 'input_seq_*' files

[Greg Chicares]

branch: master
commit df97bf036c70c80888a3e84a4b8b61b0864573ab
Author: Gregory W. Chicares <address@hidden>
Commit: Gregory W. Chicares <address@hidden>

    Rename 'input_seq_*' files
    
    There is no longer any need to keep filenames short at the expense of
    comprehensibility and consistency.
    
    Incidentally documented why 'input_sequence_aux.hpp' is included, and
    added a comment explaining why it even exists.
---
 Makefile.am                                     |  8 ++++----
 gpt_input.cpp                                   |  2 +-
 input_realization.cpp                           |  2 +-
 input_seq_helpers.cpp => input_sequence_aux.cpp |  4 ++--
 input_seq_helpers.hpp => input_sequence_aux.hpp | 13 +++++++++----
 input_sequence_entry.cpp                        |  2 +-
 input_seq_test.cpp => input_sequence_test.cpp   |  0
 mec_input.cpp                                   |  2 +-
 objects.make                                    | 10 +++++-----
 yare_input.cpp                                  |  2 +-
 10 files changed, 25 insertions(+), 20 deletions(-)

diff --git a/Makefile.am b/Makefile.am
index d0e9df6..ccbfe59 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -321,8 +321,8 @@ liblmi_common_sources = \
     input.cpp \
     input_harmonization.cpp \
     input_realization.cpp \
-    input_seq_helpers.cpp \
     input_sequence.cpp \
+    input_sequence_aux.cpp \
     input_sequence_parser.cpp \
     input_xml_io.cpp \
     interest_rates.cpp \
@@ -718,9 +718,9 @@ test_ieee754_CXXFLAGS = $(AM_CXXFLAGS)
 
 test_input_seq_SOURCES = \
   $(common_test_objects) \
-  input_seq_test.cpp \
   input_sequence.cpp \
   input_sequence_parser.cpp \
+  input_sequence_test.cpp \
   miscellany.cpp
 test_input_seq_CXXFLAGS = $(AM_CXXFLAGS)
 
@@ -744,8 +744,8 @@ test_input_SOURCES = \
   input.cpp \
   input_harmonization.cpp \
   input_realization.cpp \
-  input_seq_helpers.cpp \
   input_sequence.cpp \
+  input_sequence_aux.cpp \
   input_sequence_parser.cpp \
   input_test.cpp \
   input_xml_io.cpp \
@@ -1163,8 +1163,8 @@ noinst_HEADERS = \
     illustration_view.hpp \
     illustrator.hpp \
     input.hpp \
-    input_seq_helpers.hpp \
     input_sequence.hpp \
+    input_sequence_aux.hpp \
     input_sequence_entry.hpp \
     input_sequence_interval.hpp \
     input_sequence_parser.hpp \
diff --git a/gpt_input.cpp b/gpt_input.cpp
index 600beb9..57cfcb8 100644
--- a/gpt_input.cpp
+++ b/gpt_input.cpp
@@ -31,7 +31,7 @@
 #include "database.hpp"
 #include "dbnames.hpp"
 #include "global_settings.hpp"
-#include "input_seq_helpers.hpp"        // convert_vector(), 
convert_vector_type()
+#include "input_sequence_aux.hpp"       // convert_vector(), 
convert_vector_type()
 #include "map_lookup.hpp"
 #include "miscellany.hpp"               // each_equal(), lmi_array_size()
 
diff --git a/input_realization.cpp b/input_realization.cpp
index 64adc1d..dbf3bd1 100644
--- a/input_realization.cpp
+++ b/input_realization.cpp
@@ -30,7 +30,7 @@
 #include "dbnames.hpp"
 #include "global_settings.hpp"
 #include "handle_exceptions.hpp"
-#include "input_seq_helpers.hpp"
+#include "input_sequence_aux.hpp"       // convert_vector()
 #include "miscellany.hpp"               // each_equal(), minmax
 #include "round_to.hpp"
 #include "value_cast.hpp"
diff --git a/input_seq_helpers.cpp b/input_sequence_aux.cpp
similarity index 92%
rename from input_seq_helpers.cpp
rename to input_sequence_aux.cpp
index c142060..7ed8aaf 100644
--- a/input_seq_helpers.cpp
+++ b/input_sequence_aux.cpp
@@ -1,4 +1,4 @@
-// Interpret sequence strings.
+// Interpret sequence strings containing mc_enum and tn_range types.
 //
 // Copyright (C) 2002, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 
2014, 2015, 2016, 2017 Gregory W. Chicares.
 //
@@ -21,7 +21,7 @@
 
 #include "pchfile.hpp"
 
-#include "input_seq_helpers.hpp"
+#include "input_sequence_aux.hpp"
 
 namespace detail
 {
diff --git a/input_seq_helpers.hpp b/input_sequence_aux.hpp
similarity index 89%
rename from input_seq_helpers.hpp
rename to input_sequence_aux.hpp
index c940545..b6ecd19 100644
--- a/input_seq_helpers.hpp
+++ b/input_sequence_aux.hpp
@@ -1,4 +1,4 @@
-// Interpret sequence strings.
+// Interpret sequence strings containing mc_enum and tn_range types.
 //
 // Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 
2012, 2013, 2014, 2015, 2016, 2017 Gregory W. Chicares.
 //
@@ -19,8 +19,13 @@
 // email: <address@hidden>
 // snail: Chicares, 186 Belle Woods Drive, Glastonbury CT 06033, USA
 
-#ifndef input_seq_helpers_hpp
-#define input_seq_helpers_hpp
+// Input sequences are often used with mc_enum and tn_range types.
+// This header contains some auxiliary functions that are useful for
+// those UDTs in combination with sequences, while keeping all those
+// entities physically separate otherwise.
+
+#ifndef input_sequence_aux_hpp
+#define input_sequence_aux_hpp
 
 #include "config.hpp"
 
@@ -126,5 +131,5 @@ std::vector<Number> convert_vector_type
     return z;
 }
 
-#endif // input_seq_helpers_hpp
+#endif // input_sequence_aux_hpp
 
diff --git a/input_sequence_entry.cpp b/input_sequence_entry.cpp
index bd12223..d8e2937 100644
--- a/input_sequence_entry.cpp
+++ b/input_sequence_entry.cpp
@@ -27,7 +27,7 @@
 #include "assert_lmi.hpp"
 #include "contains.hpp"
 #include "input.hpp"
-#include "input_seq_helpers.hpp"
+#include "input_sequence_aux.hpp"       // extract_keys_from_string_map()
 #include "input_sequence.hpp"
 #include "mvc_controller.hpp"
 #include "numeric_io_cast.hpp"
diff --git a/input_seq_test.cpp b/input_sequence_test.cpp
similarity index 100%
rename from input_seq_test.cpp
rename to input_sequence_test.cpp
diff --git a/mec_input.cpp b/mec_input.cpp
index 8b626ae..ad63ff3 100644
--- a/mec_input.cpp
+++ b/mec_input.cpp
@@ -31,7 +31,7 @@
 #include "database.hpp"
 #include "dbnames.hpp"
 #include "global_settings.hpp"
-#include "input_seq_helpers.hpp"        // convert_vector(), 
convert_vector_type()
+#include "input_sequence_aux.hpp"       // convert_vector(), 
convert_vector_type()
 #include "map_lookup.hpp"
 #include "miscellany.hpp"               // each_equal(), lmi_array_size()
 
diff --git a/objects.make b/objects.make
index c83585d..2010d2d 100644
--- a/objects.make
+++ b/objects.make
@@ -210,8 +210,8 @@ common_common_objects := \
   input.o \
   input_harmonization.o \
   input_realization.o \
-  input_seq_helpers.o \
   input_sequence.o \
+  input_sequence_aux.o \
   input_sequence_parser.o \
   input_xml_io.o \
   interest_rates.o \
@@ -418,7 +418,7 @@ unit_test_targets := \
   gpt_test \
   handle_exceptions_test \
   ieee754_test \
-  input_seq_test \
+  input_sequence_test \
   input_test \
   irc7702a_test \
   istream_to_string_test \
@@ -634,11 +634,11 @@ ieee754_test$(EXEEXT): \
   $(common_test_objects) \
   ieee754_test.o \
 
-input_seq_test$(EXEEXT): \
+input_sequence_test$(EXEEXT): \
   $(common_test_objects) \
-  input_seq_test.o \
   input_sequence.o \
   input_sequence_parser.o \
+  input_sequence_test.o \
   miscellany.o \
 
 input_test$(EXEEXT): \
@@ -662,8 +662,8 @@ input_test$(EXEEXT): \
   input.o \
   input_harmonization.o \
   input_realization.o \
-  input_seq_helpers.o \
   input_sequence.o \
+  input_sequence_aux.o \
   input_sequence_parser.o \
   input_test.o \
   input_xml_io.o \
diff --git a/yare_input.cpp b/yare_input.cpp
index f4a33d1..fa63f38 100644
--- a/yare_input.cpp
+++ b/yare_input.cpp
@@ -24,7 +24,7 @@
 #include "yare_input.hpp"
 
 #include "input.hpp"
-#include "input_seq_helpers.hpp"        // convert_vector_type()
+#include "input_sequence_aux.hpp"       // convert_vector_type()
 #include "miscellany.hpp"               // each_equal()
 
 #include <numeric>                      // std::accumulate()