OSDN Git Service

Reduce compiler warnings
[winmerge-jp/winmerge-jp.git] / Src / FileFilterMgr.cpp
index c9e24e6..c8b0576 100644 (file)
@@ -1,43 +1,29 @@
-/////////////////////////////////////////////////////////////////////////////
-//    License (GPLv2+):
-//    This program is free software; you can redistribute it and/or modify it
-//    under the terms of the GNU General Public License as published by the
-//    Free Software Foundation; either version 2 of the License, or (at your
-//    option) any later version.
-//    This program is distributed in the hope that it will be useful, but
-//    WITHOUT ANY WARRANTY; without even the implied warranty of
-//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-//    General Public License for more details.
-//    You should have received a copy of the GNU General Public License
-//    along with this program; if not, write to the Free Software
-//    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-/////////////////////////////////////////////////////////////////////////////
+// SPDX-License-Identifier: GPL-2.0-or-later
 /**
  *  @file FileFilterMgr.cpp
  *
  *  @brief Implementation of FileFilterMgr and supporting routines
  */ 
-// ID line follows -- this is updated by SVN
-// $Id$
 
-#include "StdAfx.h"
-#include <string.h>
+#include "pch.h"
+#include "FileFilterMgr.h"
 #include <vector>
+#include <Poco/String.h>
+#include <Poco/Glob.h>
+#include <Poco/RegularExpression.h>
+#include "DirTravel.h"
+#include "DirItem.h"
 #include "UnicodeString.h"
 #include "FileFilter.h"
-#include "pcre.h"
-#include "FileFilterMgr.h"
 #include "UniFile.h"
-#include "coretools.h"
-#include "Ucs2Utf8.h"
-
-#ifdef _DEBUG
-#define new DEBUG_NEW
-#undef THIS_FILE
-static char THIS_FILE[] = __FILE__;
-#endif
+#include "paths.h"
 
 using std::vector;
+using Poco::Glob;
+using Poco::icompare;
+using Poco::RegularExpression;
+
+static void AddFilterPattern(vector<FileFilterElementPtr> *filterList, String & str, bool fileFilter);
 
 /**
  * @brief Destructor, frees all filters.
@@ -52,41 +38,50 @@ FileFilterMgr::~FileFilterMgr()
  * @param [in] szFilterFile Filter file to load.
  * @return FILTER_OK if succeeded or one of FILTER_RETVALUE values on error.
  */
-int FileFilterMgr::AddFilter(LPCTSTR szFilterFile)
+int FileFilterMgr::AddFilter(const String& szFilterFile)
 {
        int errorcode = FILTER_OK;
        FileFilter * pFilter = LoadFilterFile(szFilterFile, errorcode);
-       if (pFilter)
-               m_filters.push_back(pFilter);
+       if (pFilter != nullptr)
+               m_filters.push_back(FileFilterPtr(pFilter));
        return errorcode;
 }
 
 /**
  * @brief Load all filter files matching pattern from disk into internal filter set.
- *
- * @param [in] szPattern Pattern from where to load filters, for example "\\Filters\\*.flt"
- * @param [in] szExt File-extension of filter files
+ * @param [in] dir Directory from where filters are loaded.
+ * @param [in] szPattern Pattern for filters to load filters, for example "*.flt".
+ * @param [in] szExt File-extension of filter files.
  */
-void FileFilterMgr::LoadFromDirectory(LPCTSTR szPattern, LPCTSTR szExt)
+void FileFilterMgr::LoadFromDirectory(const String& dir, const String& szPattern, const String& szExt)
 {
-       CFileFind finder;
-       BOOL bWorking = finder.FindFile(szPattern);
-       int extlen = szExt ? _tcslen(szExt) : 0;
-       while (bWorking)
+       try
        {
-               bWorking = finder.FindNextFile();
-               if (finder.IsDots() || finder.IsDirectory())
-                       continue;
-               CString sFilename = finder.GetFileName();
-               if (szExt)
+               DirItemArray dirs, files;
+               LoadAndSortFiles(dir, &dirs, &files, false);
+               Glob glb(ucr::toUTF8(szPattern));
+       
+               for (DirItem& item: files)
                {
-                       // caller specified a specific extension
-                       // (This is really a workaround for brokenness in windows, which
-                       //  doesn't screen correctly on extension in pattern)
-                       if (sFilename.Right(extlen).CompareNoCase(szExt))
-                               return;
+                       String filename = item.filename;
+                       if (!glb.match(ucr::toUTF8(filename)))
+                               continue;
+                       if (!szExt.empty())
+                       {
+                               // caller specified a specific extension
+                               // (This is really a workaround for brokenness in windows, which
+                               //  doesn't screen correctly on extension in pattern)
+                               const String ext = filename.substr(filename.length() - szExt.length());
+                               if (strutils::compare_nocase(szExt, ext) != 0)
+                                       return;
+                       }
+
+                       String filterpath = paths::ConcatPath(dir, filename);
+                       AddFilter(filterpath);
                }
-               AddFilter(finder.GetFilePath());
+       }
+       catch (...)
+       {
        }
 }
 
@@ -95,15 +90,14 @@ void FileFilterMgr::LoadFromDirectory(LPCTSTR szPattern, LPCTSTR szExt)
  *
  * @param [in] szFilterFile Filename of filter to remove.
  */
-void FileFilterMgr::RemoveFilter(LPCTSTR szFilterFile)
+void FileFilterMgr::RemoveFilter(const String& szFilterFile)
 {
        // Note that m_filters.GetSize can change during loop
-       vector<FileFilter*>::iterator iter = m_filters.begin();
+       vector<FileFilterPtr>::iterator iter = m_filters.begin();
        while (iter != m_filters.end())
        {
-               if (string_compare_nocase((*iter)->fullpath, szFilterFile) == 0)
+               if (strutils::compare_nocase((*iter)->fullpath, szFilterFile) == 0)
                {
-                       delete (*iter);
                        m_filters.erase(iter);
                        break;
                }
@@ -116,12 +110,7 @@ void FileFilterMgr::RemoveFilter(LPCTSTR szFilterFile)
  */
 void FileFilterMgr::DeleteAllFilters()
 {
-       while (!m_filters.empty())
-       {
-               FileFilter* filter = m_filters.back();
-               delete filter;
-               m_filters.pop_back();
-       }
+       m_filters.clear();
 }
 
 /**
@@ -130,59 +119,37 @@ void FileFilterMgr::DeleteAllFilters()
  * @param [in] filterList List where pattern is added.
  * @param [in] str Temporary variable (ie, it may be altered)
  */
-static void AddFilterPattern(vector<FileFilterElement*> *filterList, CString & str)
+static void AddFilterPattern(vector<FileFilterElementPtr> *filterList, String & str, bool fileFilter)
 {
-       LPCTSTR commentLeader = _T("##"); // Starts comment
-       str.TrimLeft();
+       const String& commentLeader = _T("##"); // Starts comment
+       str = strutils::trim_ws_begin(str);
 
        // Ignore lines beginning with '##'
-       int pos = str.Find(commentLeader);
+       size_t pos = str.find(commentLeader);
        if (pos == 0)
                return;
 
        // Find possible comment-separator '<whitespace>##'
-       while (pos > 0 && !_istspace(str[pos - 1]))
-               pos = str.Find(commentLeader, pos + 1);
+       while (pos != std::string::npos && !(str[pos - 1] == ' ' || str[pos - 1] == '\t'))
+               pos = str.find(commentLeader, pos + 1);
 
        // Remove comment and whitespaces before it
-       if (pos > 0)
-               str = str.Left(pos);
-       str.TrimRight();
-       if (str.IsEmpty())
+       if (pos != std::string::npos)
+               str = str.substr(0, pos);
+       str = strutils::trim_ws_end(str);
+       if (str.empty())
                return;
 
-       const char * errormsg = NULL;
-       int erroroffset = 0;
-       char regexString[200] = {0};
-       int regexLen = 0;
-       int pcre_opts = 0;
-
-#ifdef UNICODE
-       // For unicode builds, use UTF-8.
-       // Convert pattern to UTF-8 and set option for PCRE to specify UTF-8.
-       regexLen = TransformUcs2ToUtf8((LPCTSTR)str, _tcslen(str),
-               regexString, sizeof(regexString));
-       pcre_opts |= PCRE_UTF8;
-#else
-       strcpy(regexString, (LPCTSTR)str);
-       regexLen = strlen(regexString);
-#endif
-       pcre_opts |= PCRE_CASELESS;
-       
-       pcre *regexp = pcre_compile(regexString, pcre_opts, &errormsg,
-               &erroroffset, NULL);
-       if (regexp)
+       int re_opts = RegularExpression::RE_CASELESS;
+       std::string regexString = ucr::toUTF8(str);
+       re_opts |= RegularExpression::RE_UTF8;
+       try
        {
-               FileFilterElement *elem = new FileFilterElement();
-               errormsg = NULL;
-
-               pcre_extra *pe = pcre_study(regexp, 0, &errormsg);
-               elem->pRegExp = regexp;
-               
-               if (pe != NULL && errormsg != NULL)
-                       elem->pRegExpExtra = pe;
-               
-               filterList->push_back(elem);
+               filterList->push_back(FileFilterElementPtr(new FileFilterElement(regexString, re_opts, fileFilter)));
+       }
+       catch (...)
+       {
+               // TODO:
        }
 }
 
@@ -190,27 +157,30 @@ static void AddFilterPattern(vector<FileFilterElement*> *filterList, CString & s
  * @brief Parse a filter file, and add it to array if valid.
  *
  * @param [in] szFilePath Path (w/ filename) to file to load.
- * @param [out] error Error-code if loading failed (returned NULL).
- * @return Pointer to new filter, or NULL if error (check error code too).
+ * @param [out] error Error-code if loading failed (returned `nullptr`).
+ * @return Pointer to new filter, or `nullptr` if error (check error code too).
  */
-FileFilter * FileFilterMgr::LoadFilterFile(LPCTSTR szFilepath, int & error)
+FileFilter * FileFilterMgr::LoadFilterFile(const String& szFilepath, int & error)
 {
        UniMemFile file;
        if (!file.OpenReadOnly(szFilepath))
        {
                error = FILTER_ERROR_FILEACCESS;
-               return NULL;
+               return nullptr;
        }
 
        file.ReadBom(); // in case it is a Unicode file, let UniMemFile handle BOM
+       if (!file.IsUnicode() && !ucr::CheckForInvalidUtf8(
+               reinterpret_cast<const char*>(file.GetBase()), static_cast<size_t>(file.GetFileSize())))
+               file.SetUnicoding(ucr::UTF8);
 
        String fileName;
-       SplitFilename(szFilepath, NULL, &fileName, NULL);
+       paths::SplitFilename(szFilepath, nullptr, &fileName, nullptr);
        FileFilter *pfilter = new FileFilter;
        pfilter->fullpath = szFilepath;
-       pfilter->name = fileName.c_str(); // Filename is the default name
+       pfilter->name = std::move(fileName); // Filename is the default name
 
-       CString sLine;
+       String sLine;
        bool lossy = false;
        bool bLinesLeft = true;
        do
@@ -218,47 +188,58 @@ FileFilter * FileFilterMgr::LoadFilterFile(LPCTSTR szFilepath, int & error)
                // Returns false when last line is read
                String tmpLine;
                bLinesLeft = file.ReadString(tmpLine, &lossy);
-               sLine = tmpLine.c_str();
-               sLine.TrimLeft();
-               sLine.TrimRight();
+               sLine = std::move(tmpLine);
+               sLine = strutils::trim_ws(sLine);
 
-               if (0 == _tcsncmp(sLine, _T("name:"), 5))
+               if (0 == sLine.compare(0, 5, _T("name:"), 5))
                {
                        // specifies display name
-                       CString str = sLine.Mid(5);
-                       str.TrimLeft();
-                       if (!str.IsEmpty())
-                               pfilter->name = str;
+                       String str = sLine.substr(5);
+                       str = strutils::trim_ws_begin(str);
+                       if (!str.empty())
+                               pfilter->name = std::move(str);
                }
-               else if (0 == _tcsncmp(sLine, _T("desc:"), 5))
+               else if (0 == sLine.compare(0, 5, _T("desc:"), 5))
                {
                        // specifies display name
-                       CString str = sLine.Mid(5);
-                       str.TrimLeft();
-                       if (!str.IsEmpty())
-                               pfilter->description = str;
+                       String str = sLine.substr(5);
+                       str = strutils::trim_ws_begin(str);
+                       if (!str.empty())
+                               pfilter->description = std::move(str);
                }
-               else if (0 == _tcsncmp(sLine, _T("def:"), 4))
+               else if (0 == sLine.compare(0, 4, _T("def:"), 4))
                {
                        // specifies default
-                       CString str = sLine.Mid(4);
-                       str.TrimLeft();
+                       String str = sLine.substr(4);
+                       str = strutils::trim_ws_begin(str);
                        if (str == _T("0") || str == _T("no") || str == _T("exclude"))
                                pfilter->default_include = false;
                        else if (str == _T("1") || str == _T("yes") || str == _T("include"))
                                pfilter->default_include = true;
                }
-               else if (0 == _tcsncmp(sLine, _T("f:"), 2))
+               else if (0 == sLine.compare(0, 2, _T("f:"), 2))
                {
                        // file filter
-                       CString str = sLine.Mid(2);
-                       AddFilterPattern(&pfilter->filefilters, str);
+                       String str = sLine.substr(2);
+                       AddFilterPattern(&pfilter->filefilters, str, true);
                }
-               else if (0 == _tcsncmp(sLine, _T("d:"), 2))
+               else if (0 == sLine.compare(0, 2, _T("d:"), 2))
                {
                        // directory filter
-                       CString str = sLine.Mid(2);
-                       AddFilterPattern(&pfilter->dirfilters, str);
+                       String str = sLine.substr(2);
+                       AddFilterPattern(&pfilter->dirfilters, str, false);
+               }
+               else if (0 == sLine.compare(0, 3, _T("f!:"), 3))
+               {
+                       // file filter
+                       String str = sLine.substr(3);
+                       AddFilterPattern(&pfilter->filefiltersExclude, str, true);
+               }
+               else if (0 == sLine.compare(0, 3, _T("d!:"), 3))
+               {
+                       // directory filter
+                       String str = sLine.substr(3);
+                       AddFilterPattern(&pfilter->dirfiltersExclude, str, false);
                }
        } while (bLinesLeft);
 
@@ -269,82 +250,92 @@ FileFilter * FileFilterMgr::LoadFilterFile(LPCTSTR szFilepath, int & error)
  * @brief Give client back a pointer to the actual filter.
  *
  * @param [in] szFilterPath Full path to filterfile.
- * @return Pointer to found filefilter or NULL;
+ * @return Pointer to found filefilter or `nullptr`;
  * @note We just do a linear search, because this is seldom called
  */
-FileFilter * FileFilterMgr::GetFilterByPath(LPCTSTR szFilterPath)
+FileFilter * FileFilterMgr::GetFilterByPath(const String& szFilterPath)
 {
-       vector<FileFilter*>::const_iterator iter = m_filters.begin();
+       vector<FileFilterPtr>::const_iterator iter = m_filters.begin();
        while (iter != m_filters.end())
        {
-               if (string_compare_nocase((*iter)->fullpath, szFilterPath) == 0)
-                       return (*iter);
+               if (strutils::compare_nocase((*iter)->fullpath, szFilterPath) == 0)
+                       return (*iter).get();
                ++iter;
        }
        return 0;
 }
 
 /**
+ * @brief Give client back a pointer to the actual filter.
+ *
+ * @param [in] i Index of filter.
+ * @return Pointer to filefilter in given index or `nullptr`.
+ */
+FileFilter * FileFilterMgr::GetFilterByIndex(int i)
+{
+       if (i < 0 || i >= m_filters.size())
+               return nullptr;
+
+       return m_filters[i].get();
+}
+
+/**
  * @brief Test given string against given regexp list.
  *
  * @param [in] filterList List of regexps to test against.
  * @param [in] szTest String to test against regexps.
- * @return TRUE if string passes
+ * @return true if string passes
  * @note Matching stops when first match is found.
  */
-BOOL TestAgainstRegList(const vector<FileFilterElement*> *filterList, LPCTSTR szTest)
+bool TestAgainstRegList(const vector<FileFilterElementPtr> *filterList, const String& szTest)
 {
-       vector<FileFilterElement*>::const_iterator iter = filterList->begin();
+       if (filterList->size() == 0)
+               return false;
+
+       std::string compString, compStringFileName;
+       ucr::toUTF8(szTest, compString);
+       vector<FileFilterElementPtr>::const_iterator iter = filterList->begin();
        while (iter != filterList->end())
        {
-               //const FileFilterElement & elem = filterList.GetNext(pos);
-               int ovector[30];
-               char compString[200] = {0};
-               int stringLen = 0;
-               TCHAR * tempName = _tcsdup(szTest); // Create temp copy for conversions
-               TCHAR * cmpStr = _tcsupr(tempName);
-
-#ifdef UNICODE
-               stringLen = TransformUcs2ToUtf8(cmpStr, _tcslen(cmpStr),
-                       compString, sizeof(compString));
-#else
-               strcpy(compString, cmpStr);
-               stringLen = strlen(compString);
-#endif
-
-               pcre * regexp = (*iter)->pRegExp;
-               pcre_extra * extra = (*iter)->pRegExpExtra;
-               int result = pcre_exec(regexp, extra, compString, stringLen,
-                       0, 0, ovector, 30);
-
-               free(tempName);
-
-               if (result >= 0)
-                       return TRUE;
-
+               RegularExpression::Match match;
+               try
+               {
+                       if ((*iter)->_fileNameOnly && compStringFileName.empty())
+                               ucr::toUTF8(paths::FindFileName(szTest), compStringFileName);
+                       if ((*iter)->regexp.match((*iter)->_fileNameOnly ? compStringFileName : compString, 0, match) > 0)
+                               return true;
+               }
+               catch (...)
+               {
+                       // TODO:
+               }
+               
                ++iter;
        }
-       return FALSE;
+       return false;
 }
 
 /**
  * @brief Test given filename against filefilter.
  *
  * Test filename against active filefilter. If matching rule is found
- * we must first determine type of rule that matched. If we return FALSE
+ * we must first determine type of rule that matched. If we return false
  * from this function directory scan marks file as skipped.
  *
  * @param [in] pFilter Pointer to filefilter
  * @param [in] szFileName Filename to test
- * @return TRUE if file passes the filter
+ * @return true if file passes the filter
  */
-BOOL FileFilterMgr::TestFileNameAgainstFilter(const FileFilter * pFilter,
-       LPCTSTR szFileName) const
+bool FileFilterMgr::TestFileNameAgainstFilter(const FileFilter * pFilter,
+       const String& szFileName) const
 {
-       if (!pFilter)
-               return TRUE;
+       if (pFilter == nullptr)
+               return true;
        if (TestAgainstRegList(&pFilter->filefilters, szFileName))
-               return !pFilter->default_include;
+       {
+               if (pFilter->filefiltersExclude.empty() || !TestAgainstRegList(&pFilter->filefiltersExclude, szFileName))
+                       return !pFilter->default_include;
+       }
        return pFilter->default_include;
 }
 
@@ -352,88 +343,27 @@ BOOL FileFilterMgr::TestFileNameAgainstFilter(const FileFilter * pFilter,
  * @brief Test given directory name against filefilter.
  *
  * Test directory name against active filefilter. If matching rule is found
- * we must first determine type of rule that matched. If we return FALSE
+ * we must first determine type of rule that matched. If we return false
  * from this function directory scan marks file as skipped.
  *
  * @param [in] pFilter Pointer to filefilter
  * @param [in] szDirName Directory name to test
- * @return TRUE if directory name passes the filter
+ * @return true if directory name passes the filter
  */
-BOOL FileFilterMgr::TestDirNameAgainstFilter(const FileFilter * pFilter,
-       LPCTSTR szDirName) const
+bool FileFilterMgr::TestDirNameAgainstFilter(const FileFilter * pFilter,
+       const String& szDirName) const
 {
-       if (!pFilter)
-               return TRUE;
+       if (pFilter == nullptr)
+               return true;
        if (TestAgainstRegList(&pFilter->dirfilters, szDirName))
-               return !pFilter->default_include;
+       {
+               if (pFilter->dirfiltersExclude.empty() || !TestAgainstRegList(&pFilter->dirfiltersExclude, szDirName))
+                       return !pFilter->default_include;
+       }
        return pFilter->default_include;
 }
 
 /**
- * @brief Return name of filter.
- *
- * @param [in] i Index of filter.
- * @return Name of filter in given index.
- */
-String FileFilterMgr::GetFilterName(int i) const
-{
-       return m_filters[i]->name; 
-}
-
-/**
- * @brief Return name of filter.
- * @param [in] pFilter Filter to get name for.
- * @return Given filter's name.
- */
-String FileFilterMgr::GetFilterName(const FileFilter *pFilter) const
-{
-       return pFilter->name; 
-}
-
-/**
- * @brief Return description of filter.
- *
- * @param [in] i Index of filter.
- * @return Description of filter in given index.
- */
-String FileFilterMgr::GetFilterDesc(int i) const
-{
-       return m_filters[i]->description; 
-}
-
-/**
- * @brief Return description of filter.
- * @param [in] pFilter Filter to get description for.
- * @return Given filter's description.
- */
-String FileFilterMgr::GetFilterDesc(const FileFilter *pFilter) const
-{
-       return pFilter->description;
-}
-
-/**
- * @brief Return full path to filter.
- *
- * @param [in] i Index of filter.
- * @return Full path of filter in given index.
- */
-String FileFilterMgr::GetFilterPath(int i) const
-{
-       return m_filters[i]->fullpath;
-}
-
-/**
- * @brief Return full path to filter.
- *
- * @param [in] pFilter Pointer to filter.
- * @return Full path of filter.
- */
-String FileFilterMgr::GetFullpath(FileFilter * pfilter) const
-{
-       return pfilter->fullpath;
-}
-
-/**
  * @brief Reload filter from disk
  *
  * Reloads filter from disk. This is done by creating a new one
@@ -446,24 +376,23 @@ String FileFilterMgr::GetFullpath(FileFilter * pfilter) const
 int FileFilterMgr::ReloadFilterFromDisk(FileFilter * pfilter)
 {
        int errorcode = FILTER_OK;
-       FileFilter * newfilter = LoadFilterFile(pfilter->fullpath.c_str(), errorcode);
+       FileFilter * newfilter = LoadFilterFile(pfilter->fullpath, errorcode);
 
-       if (newfilter == NULL)
+       if (newfilter == nullptr)
        {
                return errorcode;
        }
 
-       vector<FileFilter*>::iterator iter = m_filters.begin();
+       vector<FileFilterPtr>::iterator iter = m_filters.begin();
        while (iter != m_filters.end())
        {
-               if (pfilter == (*iter))
+               if (pfilter == (*iter).get())
                {
-                       delete (*iter);
                        m_filters.erase(iter);
                        break;
                }
        }
-       m_filters.push_back(newfilter);
+       m_filters.push_back(FileFilterPtr(newfilter));
        return errorcode;
 }
 
@@ -475,7 +404,7 @@ int FileFilterMgr::ReloadFilterFromDisk(FileFilter * pfilter)
  * @param [in] szFullPath Full path to filter file to reload.
  * @return FILTER_OK when succeeds or one of FILTER_RETVALUE values when fails.
  */
-int FileFilterMgr::ReloadFilterFromDisk(LPCTSTR szFullPath)
+int FileFilterMgr::ReloadFilterFromDisk(const String& szFullPath)
 {
        int errorcode = FILTER_OK;
        FileFilter * filter = GetFilterByPath(szFullPath);
@@ -485,3 +414,25 @@ int FileFilterMgr::ReloadFilterFromDisk(LPCTSTR szFullPath)
                errorcode = FILTER_NOTFOUND;
        return errorcode;
 }
+
+/**
+ * @brief Clone file filter manager from another file filter Manager.
+ * This function clones file filter manager from another file filter manager.
+ * Current contents in the file filter manager are removed and new contents added from the given file filter manager.
+ * @param [in] fileFilterManager File filter manager to clone.
+ */
+void FileFilterMgr::CloneFrom(const FileFilterMgr* fileFilterMgr)
+{
+       if (!fileFilterMgr)
+               return;
+
+       m_filters.clear();
+
+       size_t count = fileFilterMgr->m_filters.size();
+       for (size_t i = 0; i < count; i++)
+       {
+               auto ptr = std::make_shared<FileFilter>(FileFilter());
+               ptr->CloneFrom(fileFilterMgr->m_filters[i].get());
+               m_filters.push_back(ptr);
+       }
+}