add helper method to return a string representation of the encoding

Author: stefankueng

TextFile.cpp

@@ -1,6 +1,6 @@
 // sktoolslib - common files for SK tools
 
-// Copyright (C) 2012, 2014, 2017-2022 - Stefan Kueng
+// Copyright (C) 2012, 2014, 2017-2023 - Stefan Kueng
 
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License
@@ -56,7 +56,7 @@ bool CTextFile::Save(LPCWSTR path, bool keepFileDate) const
     FILETIME lastWriteTime{};
     if (keepFileDate)
     {
-        HANDLE hFile = CreateFile(path, GENERIC_READ, FILE_SHARE_READ|FILE_SHARE_WRITE|FILE_SHARE_DELETE,
+        HANDLE hFile = CreateFile(path, GENERIC_READ, FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
                                   nullptr, OPEN_EXISTING, FILE_FLAG_SEQUENTIAL_SCAN, nullptr);
         if (hFile != INVALID_HANDLE_VALUE)
         {
@@ -85,7 +85,7 @@ bool CTextFile::Save(LPCWSTR path, bool keepFileDate) const
     return true;
 }
 
-bool CTextFile::Load(LPCWSTR path, UnicodeType &type, bool bUTF8, std::atomic_bool& bCancelled)
+bool CTextFile::Load(LPCWSTR path, UnicodeType &type, bool bUTF8, std::atomic_bool &bCancelled)
 {
     encoding = AutoType;
     type     = AutoType;
@@ -283,7 +283,7 @@ bool CTextFile::Load(LPCWSTR path, UnicodeType &type, bool bUTF8, std::atomic_bo
             return false;
         }
     }
-    else //if (encoding == ANSI)
+    else // if (encoding == ANSI)
     {
         try
         {
@@ -435,12 +435,12 @@ CTextFile::UnicodeType CTextFile::CheckUnicodeType(BYTE *pBuffer, int cb) const
 {
     if (cb < 2)
         return Ansi;
-    UINT16 *pVal16 = reinterpret_cast<UINT16 *>(pBuffer);
-    UINT8 * pVal8  = reinterpret_cast<UINT8 *>(pVal16 + 1);
+    UINT16 *pVal16   = reinterpret_cast<UINT16 *>(pBuffer);
+    UINT8  *pVal8    = reinterpret_cast<UINT8 *>(pVal16 + 1);
     // scan the whole buffer for a 0x0000 sequence
     // if found, we assume a binary file
-    int nNull    = 0;
-    int nDblNull = 0;
+    int     nNull    = 0;
+    int     nDblNull = 0;
     for (int i = 0; i < (cb - 2); i = i + 2)
     {
         if (0x0000 == *pVal16++)
@@ -522,7 +522,7 @@ CTextFile::UnicodeType CTextFile::CheckUnicodeType(BYTE *pBuffer, int cb) const
     return Ansi;
 }
 
-bool CTextFile::CalculateLines(std::atomic_bool& bCancelled)
+bool CTextFile::CalculateLines(std::atomic_bool &bCancelled)
 {
     // fill an array with starting positions for every line in the loaded file
     if (pFileBuf == nullptr)
@@ -593,6 +593,26 @@ std::wstring CTextFile::GetLineString(long lineNumber) const
     return line;
 }
 
+std::wstring CTextFile::GetEncodingString(UnicodeType type)
+{
+    switch (type)
+    {
+        case CTextFile::Ansi:
+            return L"ANSI";
+        case CTextFile::Unicode_Le:
+            return L"UTF-16-LE";
+        case CTextFile::Unicode_Be:
+            return L"UTF-16-BE";
+        case CTextFile::UTF8:
+            return L"UTF8";
+        case CTextFile::Binary:
+            return L"BINARY";
+        default:
+            break;
+    }
+    return {};
+}
+
 std::wstring CTextFile::GetFileNameWithoutExtension() const
 {
     return CPathUtils::GetFileNameWithoutExtension(filename);

TextFile.h

@@ -1,6 +1,6 @@
 // sktoolslib - common files for SK tools
 
-// Copyright (C) 2012, 2017-2022 - Stefan Kueng
+// Copyright (C) 2012, 2017-2023 - Stefan Kueng
 
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License
@@ -50,7 +50,7 @@ class CTextFile
     /**
      * Saves the file contents to disk at \c path.
      */
-    bool Save(LPCWSTR path, bool keepFileDate) const;
+    bool                Save(LPCWSTR path, bool keepFileDate) const;
 
     /**
      * modifies the contents of a file.
@@ -59,17 +59,17 @@ class CTextFile
      * \param newLen length of the new file content in bytes
      * \note the old buffer is automatically freed.
      */
-    bool ContentsModified(std::unique_ptr<BYTE[]> pBuf, DWORD newLen);
+    bool                ContentsModified(std::unique_ptr<BYTE[]> pBuf, DWORD newLen);
 
     /**
      * Returns the line number from a given character position inside the file.
      */
-    long LineFromPosition(long pos) const;
+    long                LineFromPosition(long pos) const;
 
     /**
      * Returns the line from a given line number
      */
-    std::wstring GetLineString(long lineNumber) const;
+    std::wstring        GetLineString(long lineNumber) const;
 
     /**
      * Returns the file content as a text string.
@@ -81,17 +81,22 @@ class CTextFile
      * Returns a pointer to the file contents. Call GetFileLength() to get
      * the size in number of bytes of this buffer.
      */
-    LPVOID GetFileContent() const { return pFileBuf.get(); }
+    LPVOID              GetFileContent() const { return pFileBuf.get(); }
 
     /**
      * Returns the size of the file in bytes
      */
-    long GetFileLength() const { return fileLen; }
+    long                GetFileLength() const { return fileLen; }
 
     /**
      * Returns the encoding of the file
      */
-    UnicodeType GetEncoding() const { return encoding; }
+    UnicodeType         GetEncoding() const { return encoding; }
+
+    /**
+     * Returns a string representation of the encoding
+     */
+    static std::wstring        GetEncodingString(UnicodeType type);
 
     /**
      * Returns the filename
@@ -101,26 +106,26 @@ class CTextFile
     /**
      * Returns the filename without the extension (if any)
      */
-    std::wstring GetFileNameWithoutExtension() const;
+    std::wstring        GetFileNameWithoutExtension() const;
 
     /**
      * Returns the filename extension (if any)
      */
-    std::wstring GetFileNameExtension() const;
+    std::wstring        GetFileNameExtension() const;
 
     /**
      * Replaces the file content.
      */
-    void SetFileContent(const std::wstring& content);
+    void                SetFileContent(const std::wstring& content);
 
-    bool HasBOM() const { return hasBOM; }
+    bool                HasBOM() const { return hasBOM; }
 
     /**
      * Sets the number of null bytes that are allowed for
      * a file to still be considered text instead of binary
      * in the encoding detection. Default is 2.
      */
-    void SetNullbyteCountForBinary(int count) { nullByteCount = count; }
+    void                SetNullbyteCountForBinary(int count) { nullByteCount = count; }
 
 protected:
     /**