facelessuser
diff --git a/‎.codecov.yml
+5 b/‎.codecov.yml
+5
diff --git a/‎.dictionary
+5 b/‎.dictionary
+5
diff --git a/‎.gitignore
+2 b/‎.gitignore
+2
diff --git a/‎README.md
+3-3 b/‎README.md
+3-3
diff --git a/‎docs/src/markdown/changelog.md
+22 b/‎docs/src/markdown/changelog.md
+22
diff --git a/‎docs/src/markdown/images/chain_button.png
12.3 KB b/‎docs/src/markdown/images/chain_button.png
12.3 KB
diff --git a/‎docs/src/markdown/images/chain_mode.png
65.1 KB b/‎docs/src/markdown/images/chain_mode.png
65.1 KB
diff --git a/‎docs/src/markdown/images/chains.png
47.7 KB b/‎docs/src/markdown/images/chains.png
47.7 KB
diff --git a/‎docs/src/markdown/images/content_tab.png
-868 Bytes b/‎docs/src/markdown/images/content_tab.png
-868 Bytes
diff --git a/‎docs/src/markdown/images/files_tab.png
18.3 KB b/‎docs/src/markdown/images/files_tab.png
18.3 KB
diff --git a/‎docs/src/markdown/images/limit_search_panel.png
-51 Bytes b/‎docs/src/markdown/images/limit_search_panel.png
-51 Bytes
diff --git a/‎docs/src/markdown/images/load_search.png
14.6 KB b/‎docs/src/markdown/images/load_search.png
14.6 KB
diff --git a/‎docs/src/markdown/images/plugin_input.png
27.1 KB b/‎docs/src/markdown/images/plugin_input.png
27.1 KB
diff --git a/‎docs/src/markdown/images/plugin_toggle.png
16.4 KB b/‎docs/src/markdown/images/plugin_toggle.png
16.4 KB
diff --git a/‎docs/src/markdown/images/regex_tester.png
7.1 KB b/‎docs/src/markdown/images/regex_tester.png
7.1 KB
diff --git a/‎docs/src/markdown/images/save_search.png
13.8 KB b/‎docs/src/markdown/images/save_search.png
13.8 KB
diff --git a/‎docs/src/markdown/images/search_replace_panel.png
-11.7 KB b/‎docs/src/markdown/images/search_replace_panel.png
-11.7 KB
diff --git a/‎docs/src/markdown/images/search_tab.png
12.6 KB b/‎docs/src/markdown/images/search_tab.png
12.6 KB
diff --git a/‎docs/src/markdown/installation.md
+7-7 b/‎docs/src/markdown/installation.md
+7-7
diff --git a/‎docs/src/markdown/usage.md
+139-2 b/‎docs/src/markdown/usage.md
+139-2
diff --git a/‎docs/theme/extra-6068b97e47.css
-1 b/‎docs/theme/extra-6068b97e47.css
-1
diff --git a/‎docs/theme/extra-9b4c72abee.css
+1 b/‎docs/theme/extra-9b4c72abee.css
+1
@@ -0,0 +1,5 @@
+comment: false
+
+coverage:
+  status:
+    patch: false
@@ -1,3 +1,4 @@
+API
 Automator
 Backrefs
 Changelog
@@ -22,7 +23,10 @@ multi
 NONINFRINGEMENT
 OS's
 OSD
+Plugin
 plugin
+plugins
+POSIX
 PyMdown
 Regex
 regex
@@ -35,5 +39,6 @@ symlink
 taskbar
 timestamp
 Tox
+tuple
 UI
 wxPython
@@ -48,3 +48,5 @@ pyinstaller
 site/*
 
 .cache
+
+*.patch
@@ -10,11 +10,11 @@ Rummage
 
 Rummage is a cross platform search and replace tool written in Python. Rummage crawls directories and searches for specified patterns (either regular expression or literal) and can optionally replace those targets with desired text.
 
-Rummage was inspired by the Windows tool [grepWin][grepwin]. At the time, it was difficult to find a decent GUI search and replace tool macOS and Linux. Rummage was created to fill that void and is available on Linux, macOS, and Windows.
+Rummage was inspired by the Windows tool [grepWin](http://stefanstools.sourceforge.net/grepWin.html). At the time, it was difficult to find a decent GUI search and replace tool macOS and Linux. Rummage was created to fill that void and is available on Linux, macOS, and Windows.
 
-Rummage is written in Python and is currently available on Python 2.7 and Python 3.4+. Rummage by default uses the Python's Re regular expression engine, but you can also use the fantastic, feature rich [Regex][regex] search engine and do interesting things like fuzzy searching and more.
+Rummage is written in Python and is currently available on Python 2.7 and Python 3.4+. Rummage by default uses the Python's Re regular expression engine, but you can also use the fantastic, feature rich [Regex](https://pypi.python.org/pypi/regex) search engine and do interesting things like fuzzy searching and more.
 
-When specifying a specific file encoding, Rummage is quick enough to search large projects easily. Optionally you can let Rummage detect encoding, but because the encoding detection is done by the pure Python package [Chardet][chardet], it will run significantly slower. Encoding detection is the biggest bottleneck. This shouldn't be a problem in small projects, but it will become quite noticeable in large projects.
+When specifying a specific file encoding, Rummage is quick enough to search large projects easily. Optionally you can let Rummage detect encoding, but because the encoding detection is done by the pure Python package [Chardet](https://pypi.python.org/pypi/chardet, it will run significantly slower. Encoding detection is the biggest bottleneck. This shouldn't be a problem in small projects, but it will become quite noticeable in large projects.
 
 ## Screenshots
 
 
@@ -1,5 +1,27 @@
 # Changelog
 
+## 2.1.0
+
+> Jul X, 2017
+
+- **NEW**: Add new chained search feature.
+- **NEW**: Add new replace plugin support.
+- **NEW**: Restructure internal API to support chained search.
+- **NEW**: Saved searches will now require a unique name and an optional comment. Old legacy saves will be converted on first access. The old legacy name will be the comment, and a unique name will be generated from the comment.
+- **NEW**: Saved search names and comments can be edited from the "Load Search" panel.
+- **NEW**: Internal API no longer will guess and decode strings, only files.  It is expected that the caller handles encoding of string buffers.  A Unicode buffer will be searched as usual, and a binary string buffer will be treated as binary.
+- **NEW**: Tester dialog will now process literal searches as well.
+- **NEW**: Literal searches will now utilize the Unicode related flags. This is particularly notable if using the Regex module and wanting to have full case-folding applied in case-insensitive matches.
+- **FIX**: Visual inconsistencies in regard to text box size relative to siblings, alignment of labels, etc.
+- **FIX**: Content text box in tester dialog will now allow entering tab characters on all platforms instead of navigating to next control.
+- **FIX**: Fix wxPython deprecation noise in the console.
+- **FIX**: Fix some binary related replace issues.
+- **FIX**: Fix search not aborting.
+- **FIX**: Fix issue where selecting file from drop down list didn't hide limit panel.
+- **FIX**: Don't display replace message when aborting replace.
+- **FIX**: Fix limit panel hide logic so it doesn't show a the hidden panel on search.
+- **FIX**: POSIX flag not generating refresh in tester dialog.
+
 ## 2.0.5
 
 > Jul 2, 2017
 
@@ -4,13 +4,13 @@
 
 Rummage has a few requirements when installing.  These will all be taken care of when installing via `pip`.
 
-Name                           | Required | Details
------------------------------- | -------- | -------
-[`backrefs` 1.0.1+][backrefs]    | Yes      | Used to extend the `re` or `regex` regular expression engine with additional back references.
-[`gntp`][gntp]                   | Yes      | Used to send notifications to Growl via the the Growl Notification Transport Protocol for all platforms (macOS, Windows, and Linux).
-[`chardet`\ 3.0.4+][chardet]             | Yes      | Used for file encoding guessing when an encoding is not specified.
-[`wxPython`\ 4.0.0a3+][wxpython] | Yes      | The new wxPython 4.0.0 is required for for Rummage to run in Python 2 and Python 3. Classic wxPython support has unfortunately be dropped.
-[`regex`\ 2015.07.19+][regex]    | No       | **regex** is completely optional, but it will be installed automatically if using `pip`. It is a great regular expression engine that adds some nice features such as fuzzy searching, nested char sets, better Unicode support, and more.
+Name                             | Details
+-------------------------------- | -------
+[`backrefs` 1.0.1+][backrefs]    | Used to extend the `re` or `regex` regular expression engine with additional back references.
+[`gntp`][gntp]                   | Used to send notifications to Growl via the the Growl Notification Transport Protocol for all platforms (macOS, Windows, and Linux).
+[`chardet`\ 3.0.4+][chardet]     | Used for file encoding guessing when an encoding is not specified.
+[`wxPython`\ 4.0.0a3+][wxpython] | The new wxPython 4.0.0 is required for for Rummage to run in Python 2 and Python 3. Classic wxPython support has unfortunately be dropped.
+[`regex`\ 2015.07.19+][regex]    | **regex** is usage is completely optional, but it is included for those who wish to use it. Regex is a great regular expression engine that adds some nice features such as fuzzy searching, nested char sets, better Unicode support, and more.
 
 !!! warning "Linux Prerequisites"
     In traditional Linux fashion, there is a little extra work that needs to be done prior to installing.  Linux requires some prerequisites so that it can build wxPython during installation.
 
@@ -88,7 +88,8 @@ Toggle                      | Description
 --------------------------- | -----------
 Best\ fuzzy\ match          | If performing a fuzzy match, the *best* fuzzy match will be used.
 Improve\ fuzzy\ fit         | Makes fuzzy matching attempt to improve the fit of the next match that it finds.
-Unicode\ word\ breaks       | Will use proper Unicode word breaks when Unicode is enabled.  This differs from Re's default.
+Unicode\ word\ breaks       | Will use proper Unicode word breaks and line separators when Unicode is enabled. See Regex documentation for more info.
+Use\ POSIX\ matching        | Use the POSIX standard for regular expression, which is to return the leftmost longest match.
 Search\ backwards           | Search backwards. The result of a reverse search is not necessarily the reverse of a forward search.
 Format\ style\ replacements | Replace pattern will use [Python's string replace format][format-string] for replace. `#!python "{1[-1]} {1[-2]} {1[-3]}"` etc.
 Full\ case-folding          | Use full case folding. For Regex `V0` only as it is enabled by default for `V1`.
@@ -103,12 +104,14 @@ Boolean\ match          | Will check each file up until the first match and will
 Count\ only             | Will just count the number of matches in the file and will not display line context information. This has no effect when applying replaces.
 Create\ backups         | On replace, files with matches will be backed up before applying the replacements; backup files will have the `.rum-bak` extension.
 Force\ &lt;encoding&gt; | Forces all files to be opened with the specified encoding opposed to trying to detect the encoding.  Encoding is hard and slow, so this is the preferred method for fast searches.  On failure, binary will be used instead.
+Use\ chain\ search      | Puts Rummage into ["search chain" mode](#search-chains). When in "search chain" mode, rummage will only use saved search chains for search and replace.
+Use\ replace\ plugin    | When enabled, Rummage will use a [replace plugin](#replace-plugins) instead of a replace pattern in order to do more advanced replaces.
 
 ### Regular Expression Tester
 
 ![Regex Tester](/images/regex_tester.png)
 
-Rummage comes with a simple regular expression tester.  It has a simple multi-line text box for content to search, and another multi-line box that will show the final results after the find and replace.  Below that you will find two text input boxes for the find pattern and the replace pattern.  Lastly, all related regular expression flag toggles will be found under the patterns.
+Rummage comes with a simple regular expression tester (but you can also test literal patterns if desired). It has a simple multi-line text box to place content to search, and another multi-line box that will show the final results after the find and replace are applied.  Below that you will find two text input boxes for the find pattern and the replace pattern.  Lastly, all search and replace flag toggles are found under the patterns.
 
 To use the tester, simply enter the content to search, set your desired toggles, and input your find and replace pattern.  As you change your pattern or change your toggles, matches will be updated and highlighted, and the result box will be updated.
 
@@ -120,12 +123,146 @@ Regular expressions can be very complex, and sometimes you might want to save th
 
 When you have a pattern configured that you want to save, simply click the `Save Search` button, and a dialog will pop up asking you to name the search.  When done, click the `Save` button on the dialog and your search patterns and toggles will be saved.
 
+You'll notice that there are two input boxes. The first requires a unique name (only word characters, underscores, and hyphens are allowed). The second is an optional comment in case you wish to elaborate on what the pattern is for.
+
+Underneath the inputs will be the actual search settings being saved.  All of the search settings will be in read only controls.
+
 ![Save Search](/images/save_search.png)
 
 To load a pattern that was saved previously, click the `Load Search` button.  You will be presented with a dialog showing all your saved searches.  Highlight the pattern you want to load and click the `Load` button.  Your pattern and toggles will be populated in the main dialog.
 
+If you wish to edit the name or comment of a search, you can double click the entry or click the "Edit" button.
+
 ![Load Search](/images/load_search.png)
 
+### Search Chains
+
+There are times you may have a task that requires you to do multiple find and replaces that are all related, but are too difficult to represent as a single find and replace. This is where search chains can be helpful.
+
+Search chains are essentially a sequence of multiple [saved search and replace patterns](#saving-and-loading-regular-expressions). You can create a search chain by clicking the `Search Chains` button which will bring up the search change manager.
+
+![Chain Button](/images/chain_button.png)
+
+Here you can create or delete search chains.
+
+![Search Chains](/images/chains.png)
+
+To use search chains you must put Rummage in "search chain" mode by selecting the check box named `Use search chains` in the main window. When "search chain" mode is enabled, all controls that don't apply to search chains will be disabled, and the search box will be replaced with a drop down for selecting created chains. When a search is performed, Rummage will iterate over each file with all the saved searches in the chain.
+
+![Chain Select](/images/chain_mode.png)
+
+### Replace plugins
+
+Regular expressions are great, but some times regular expressions aren't enough.  If you are dealing with a replace task that requires logic that cannot be represented in a simple replace pattern, you can create a "replace plugin".
+
+Simply create a Python script with a Replace class derived from the `ReplacePlugin` class found in `rumcore` at: `#!py from rummage.rummage import rumcore`.  The plugin file must include a function called `get_replace` that returns the needed class.
+
+```py
+class ReplacePlugin(object):
+    """Rummage replace plugin."""
+
+    def __init__(self, file_info, flags):
+        """Initialize."""
+
+        self.file_info = file_info
+        self.flags = flags
+        self.on_init()
+
+    def on_init(self):
+        """Override this function to add initialization setup."""
+
+    def get_flags(self):
+        """Get flags."""
+
+        return self.flags
+
+    def get_file_name(self):
+        """Get file name."""
+
+        return self.file_info.name
+
+    def is_binary(self):
+        """Is a binary search."""
+
+        return self.file_info.encoding.encode == 'bin'
+
+    def is_literal(self):
+        """Is a literal search."""
+
+        return self.flags & LITERAL
+
+    def replace(self, m):
+        """Make replacement."""
+
+        return m.group(0)
+```
+
+The `file_info` property is a named tuple providing information about the current file such as name, size, creation date, etc.
+
+```py
+class FileInfoRecord(namedtuple('FileInfoRecord', ['id', 'name', 'size', 'modified', 'created', 'encoding'])):
+    """A record for tracking file info."""
+```
+
+The `flags` property seen above contains only Rummage search related flags (the flags are abstracted at this level and are converted to the appropriate regular expression flags later).
+
+```py
+# Common regular expression flags (re|regex)
+IGNORECASE = 0x1  # (?i)
+DOTALL = 0x2      # (?s)
+MULTILINE = 0x4   # (?m)
+UNICODE = 0x8     # (?u)
+
+# Regex module flags
+ASCII = 0x10            # (?a)
+FULLCASE = 0x20         # (?f)
+WORD = 0x40             # (?w)
+BESTMATCH = 0x80        # (?b)
+ENHANCEMATCH = 0x100    # (?e)
+REVERSE = 0x200         # (?r)
+VERSION0 = 0x400        # (?V0)
+VERSION1 = 0x800        # (?V1)
+FORMATREPLACE = 0x1000  # Use {1} for groups in replace
+POSIX = 0x2000          # (?p)
+
+# Rumcore search related flags
+LITERAL = 0x10000           # Literal search
+```
+
+To use replace plugins, simply check the `Use plugin replace` check box in the main dialog.
+
+![Enable Replace Plugin](/images/plugin_toggle.png)
+
+The main dialog's `Replace with` text box will become the `Replace plugin` text box with an associated file picker.  Here you can point to your replace plugin file.
+
+![Enable Replace Plugin](/images/plugin_input.png)
+
+
+??? settings "Example Plugin"
+    In the example below, we have a replace plugin that replaces the search result with the name of the file.  It is assumed this is not a binary replace.
+
+    ```py
+    from __future__ import unicode_literals
+    from rummage.rummage import rumcore
+    import os
+
+
+    class TestReplace(rumcore.ReplacePlugin):
+        """Replace object."""
+
+        def replace(self, m):
+            """Replace method."""
+
+            name = os.path.basename(self.get_file_name())
+            return name
+
+
+    def get_replace():
+        """Get the replace object."""
+
+        return TestReplace
+    ```
+
 ## Limit Search Panel
 
 ![Limit Search Panel](/images/limit_search_panel.png)
-Original file line number
+Diff line change
 site/*
 .cache
++
 +*.patch