quick name change for the utils function

Author: LinuxDevon

src/util/utils.cpp

@@ -2,7 +2,7 @@
 
 namespace Utils {
 
-	std::istream & SafeString::getline( std::istream & stream, std::string & line ) {
+	std::istream & SafeString::get_line( std::istream & stream, std::string & line ) {
 		std::string newline;
 
 		std::getline( stream, newline );

src/util/utils.hpp

@@ -6,7 +6,16 @@ namespace Utils {
 
 	class SafeString {
 	public:
-		static std::istream & getline( std::istream & stream, std::string & line );
+		/**
+		 * This is a safe non line ending specific get_ine function. This is to help with files
+		 * carried over from different systems. i.e Unix file comes to Windows with LF endings
+		 * instead of CRLF.
+		 *
+		 * @param  stream [description]
+		 * @param  line   [description]
+		 * @return        [description]
+		 */
+		static std::istream & get_line( std::istream & stream, std::string & line );
 
 	};
 

test/test_utils.cpp

@@ -4,22 +4,22 @@
 
 using namespace Utils;
 
-TEST_CASE("Basic file input with safe getline", "") {
-	SECTION("Verify line inputs") {
+TEST_CASE("Basic file input with safe get_line that is non line ending specific", "") {
+	SECTION("Verify various line ending input files") {
 		std::ifstream TextFile;
 		std::string test;
 
 		TextFile.open(TEXT_FILE, std::ios::in);
 		CHECK(TextFile.is_open());
 
 		if(TextFile.is_open()) {
-			SafeString::getline(TextFile, test);
+			SafeString::get_line(TextFile, test);
 			REQUIRE(test == "This is a non dbc formatted file.");
-			SafeString::getline(TextFile, test);
+			SafeString::get_line(TextFile, test);
 			REQUIRE(test == "");
-			SafeString::getline(TextFile, test);
+			SafeString::get_line(TextFile, test);
 			REQUIRE(test == "Make sure things pass with this");
-			SafeString::getline(TextFile, test);
+			SafeString::get_line(TextFile, test);
 			REQUIRE(test == "Who knows 	what might happen.");
 
 			TextFile.close();