Merge pull request #20 from doronz88/refactor/global-unique-option

commands: refactor commands to not perform unique upon each

README.md

@@ -114,7 +114,7 @@ To view the list of available commands, [view the list below](#available-command
     name: g_awsome_global,
     instructions: [
             # find the byte sequence '11 22 33 44'
-            find-bytes --or '11 22 33 44'
+            find-bytes '11 22 33 44'
 
             # advance offset by 20
             offset 20
@@ -139,7 +139,7 @@ To view the list of available commands, [view the list below](#available-command
     name: free
     instructions: [
             # search the string "free"
-            find-str --or 'free' --null-terminated
+            find-str 'free' --null-terminated
 
             # goto xref
             xref
@@ -212,7 +212,7 @@ To view the list of available commands, [view the list below](#available-command
     name: cool_functions
     instructions: [
             # find string
-            find-str --or 'init_stuff' --null-terminated
+            find-str 'init_stuff' --null-terminated
 
             # goto to xref
             xref
@@ -259,7 +259,7 @@ To view the list of available commands, [view the list below](#available-command
 ```python
 from fa.commands.find_str import find_str 
 from fa.commands.set_name import set_name
-from fa.commands.unique import unique
+from fa.commands.verify_single import unique
 from fa import context
 
 def run(**kwargs):
@@ -283,7 +283,7 @@ def run(**kwargs):
 
 ```python
 TEMPLATE = '''
-find-str --or '{unique_string}'
+find-str '{unique_string}'
 xref
 function-start
 unique
@@ -310,7 +310,7 @@ from fa.commands.set_type import set_type
 from fa import fa_types
 
 TEMPLATE = '''
-find-str --or '{unique_string}'
+find-str '{unique_string}'
 xref
 '''
 

commands.md

@@ -41,6 +41,7 @@ Below is the list of available commands:
 - [verify-operand](#verify-operand)
 - [verify-ref](#verify-ref)
 - [verify-segment](#verify-segment)
+- [verify-single](#verify-single)
 - [verify-str](#verify-str)
 - [xref](#xref)
 - [xrefs-to](#xrefs-to)
@@ -168,7 +169,7 @@ optional arguments:
 ```
 ## find-bytes
 ```
-usage: find-bytes [-h] [--or] hex_str
+usage: find-bytes [-h] hex_str
 
 expands the result-set with the occurrences of the given bytes
 
@@ -177,22 +178,21 @@ EXAMPLE:
     0x00000004: 05 06 07 08
 
     results = []
-    -> find-bytes --or 01020304
+    -> find-bytes 01020304
     result = [0]
 
-    -> find-bytes --or 05060708
+    -> find-bytes 05060708
     results = [0, 4]
 
 positional arguments:
   hex_str
 
 optional arguments:
   -h, --help  show this help message and exit
-  --or
 ```
 ## find-bytes-ida
 ```
-usage: find-bytes-ida [-h] [--or] expression
+usage: find-bytes-ida [-h] expression
 
 expands the result-set with the occurrences of the given bytes
 expression in "ida bytes syntax"
@@ -202,22 +202,21 @@ EXAMPLE:
     0x00000004: 05 06 07 08
 
     results = []
-    -> find-bytes-ida --or '01 02 03 04'
+    -> find-bytes-ida '01 02 03 04'
     result = [0]
 
-    -> find-bytes-ida --or '05 06 ?? 08'
+    -> find-bytes-ida '05 06 ?? 08'
     results = [0, 4]
 
 positional arguments:
   expression
 
 optional arguments:
   -h, --help  show this help message and exit
-  --or
 ```
 ## find-immediate
 ```
-usage: find-immediate [-h] [--or] expression
+usage: find-immediate [-h] expression
 
 expands the result-set with the occurrences of the given
 immediate in "ida immediate syntax"
@@ -227,19 +226,18 @@ EXAMPLE:
     0x00000004: add r0, #2 ; 0x1236
 
     results = []
-    -> find-immediate --or 0x1236
+    -> find-immediate 0x1236
     result = [4]
 
 positional arguments:
   expression
 
 optional arguments:
   -h, --help  show this help message and exit
-  --or
 ```
 ## find-str
 ```
-usage: find-str [-h] [--or] [--null-terminated] hex_str
+usage: find-str [-h] [--null-terminated] hex_str
 
 expands the result-set with the occurrences of the given
 string
@@ -250,7 +248,7 @@ EXAMPLE:
     0x00000008: 30 31 32 33 -> ASCII '0123'
 
     results = []
-    -> find-str --or '0123'
+    -> find-str '0123'
 
     result = [8]
 
@@ -259,12 +257,11 @@ positional arguments:
 
 optional arguments:
   -h, --help         show this help message and exit
-  --or
   --null-terminated
 ```
 ## function-end
 ```
-usage: function-end [-h] [--not-unique]
+usage: function-end [-h]
 
 goto function's end
 
@@ -278,8 +275,7 @@ EXAMPLE:
     result = [0xf0]
 
 optional arguments:
-  -h, --help    show this help message and exit
-  --not-unique
+  -h, --help  show this help message and exit
 ```
 ## function-lines
 ```
@@ -305,7 +301,7 @@ optional arguments:
 ```
 ## function-start
 ```
-usage: function-start [-h] [--not-unique]
+usage: function-start [-h]
 
 goto function's start
 
@@ -319,8 +315,7 @@ EXAMPLE:
     result = [0]
 
 optional arguments:
-  -h, --help    show this help message and exit
-  --not-unique
+  -h, --help  show this help message and exit
 ```
 ## goto-ref
 ```
@@ -351,7 +346,7 @@ EXAMPLE:
     0x00000004: mov r0, r1
 
     results = []
-    -> keystone-find-opcodes --bele --or KS_ARCH_ARM KS_MODE_ARM 'mov r0, r1;'
+    -> keystone-find-opcodes --bele KS_ARCH_ARM KS_MODE_ARM 'mov r0, r1;'
     result = [4]
 
 positional arguments:
@@ -376,7 +371,7 @@ EXAMPLE:
     0x00000004: mov r0, r1
 
     results = [0, 4]
-    -> keystone-verify-opcodes --bele --or KS_ARCH_ARM KS_MODE_ARM 'mov r0, r1'
+    -> keystone-verify-opcodes --bele KS_ARCH_ARM KS_MODE_ARM 'mov r0, r1'
     result = [4]
 
 positional arguments:
@@ -608,17 +603,12 @@ optional arguments:
 ```
 usage: unique [-h]
 
-verifies the result-list contains a single value
-
-EXAMPLE #1:
-    results = [4, 12, 0, 8]
-    -> unique
-    result = []
+make the resultset unique
 
-EXAMPLE #2:
-    results = [4]
+EXAMPLE:
+    results = [0, 4, 8, 8, 12]
     -> unique
-    result = [4]
+    result = [0, 4, 8, 12]
 
 optional arguments:
   -h, --help  show this help message and exit
@@ -740,6 +730,25 @@ EXAMPLE:
 positional arguments:
   name        segment name
 
+optional arguments:
+  -h, --help  show this help message and exit
+```
+## verify-single
+```
+usage: verify-single [-h]
+
+verifies the result-list contains a single value
+
+EXAMPLE #1:
+    results = [4, 12, 0, 8]
+    -> unique
+    result = []
+
+EXAMPLE #2:
+    results = [4]
+    -> unique
+    result = [4]
+
 optional arguments:
   -h, --help  show this help message and exit
 ```

fa/commands/add_offset_range.py

@@ -21,7 +21,6 @@ def get_parser():
     return p
 
 
-@utils.yield_unique
 def add_offset_range(addresses, start, end, step):
     for ea in addresses:
         for i in range(start, end, step):

fa/commands/alias

@@ -1,8 +1,8 @@
-ppc32-big-find-all = keystone-find-opcodes --or KS_ARCH_PPC KS_MODE_BIG_ENDIAN|KS_MODE_PPC32
-ppc32-find-all = keystone-find-opcodes --bele --or KS_ARCH_PPC KS_MODE_PPC32
+ppc32-big-find-all = keystone-find-opcodes KS_ARCH_PPC KS_MODE_BIG_ENDIAN|KS_MODE_PPC32
+ppc32-find-all = keystone-find-opcodes --bele KS_ARCH_PPC KS_MODE_PPC32
 ppc32-big-verify = keystone-verify-opcodes KS_ARCH_PPC KS_MODE_BIG_ENDIAN|KS_MODE_PPC32
 ppc32-verify = keystone-verify-opcodes --bele KS_ARCH_PPC KS_MODE_PPC32
-arm-find-all = keystone-find-opcodes --bele --or KS_ARCH_ARM KS_MODE_ARM
-thumb-find-all = keystone-find-opcodes --bele --or KS_ARCH_ARM KS_MODE_THUMB
+arm-find-all = keystone-find-opcodes --bele KS_ARCH_ARM KS_MODE_ARM
+thumb-find-all = keystone-find-opcodes --bele KS_ARCH_ARM KS_MODE_THUMB
 arm-verify = keystone-verify-opcodes --bele KS_ARCH_ARM KS_MODE_ARM
 find-imm = find-immediate

fa/commands/find_bytes.py

@@ -1,5 +1,4 @@
 from argparse import RawTextHelpFormatter
-from collections import OrderedDict
 import binascii
 
 from fa import utils
@@ -11,10 +10,10 @@
     0x00000004: 05 06 07 08
 
     results = []
-    -> find-bytes --or 01020304
+    -> find-bytes 01020304
     result = [0]
 
-    -> find-bytes --or 05060708
+    -> find-bytes 05060708
     results = [0, 4]
 '''
 
@@ -23,24 +22,15 @@ def get_parser():
     p = utils.ArgumentParserNoExit('find-bytes',
                                    description=DESCRIPTION,
                                    formatter_class=RawTextHelpFormatter)
-    p.add_argument('--or', action='store_true')
     p.add_argument('hex_str')
     return p
 
 
-@utils.yield_unique
 def find_bytes(hex_str, segments=None):
     needle = binascii.unhexlify(''.join(hex_str.split(' ')))
     return utils.find_raw(needle, segments=segments)
 
 
 def run(segments, args, addresses, interpreter=None, **kwargs):
     results = list(find_bytes(args.hex_str, segments=segments))
-
-    retval = set(addresses)
-    if getattr(args, 'or'):
-        retval.update(results)
-    else:
-        raise ValueError("must specify --or option")
-
-    return list(OrderedDict.fromkeys(retval))
+    return addresses + results

fa/commands/find_bytes_ida.py

@@ -1,5 +1,4 @@
 from argparse import RawTextHelpFormatter
-from collections import OrderedDict
 
 from fa import utils, context
 
@@ -11,10 +10,10 @@
     0x00000004: 05 06 07 08
 
     results = []
-    -> find-bytes-ida --or '01 02 03 04'
+    -> find-bytes-ida '01 02 03 04'
     result = [0]
 
-    -> find-bytes-ida --or '05 06 ?? 08'
+    -> find-bytes-ida '05 06 ?? 08'
     results = [0, 4]
 '''
 
@@ -23,25 +22,16 @@ def get_parser():
     p = utils.ArgumentParserNoExit('find-bytes-ida',
                                    description=DESCRIPTION,
                                    formatter_class=RawTextHelpFormatter)
-    p.add_argument('--or', action='store_true')
     p.add_argument('expression')
     return p
 
 
 @context.ida_context
-@utils.yield_unique
 def find_bytes_ida(expression, segments=None):
     for address in utils.ida_find_all(expression):
         yield address
 
 
 def run(segments, args, addresses, interpreter=None, **kwargs):
     results = find_bytes_ida(args.expression)
-
-    retval = set(addresses)
-    if getattr(args, 'or'):
-        retval.update(results)
-    else:
-        raise ValueError("must specify --or option")
-
-    return list(OrderedDict.fromkeys(retval))
+    return addresses + results