Header menu logo B2R2

CmdOpts Module

Provides utility functions for parsing command line options.

Functions and values

Function or value Description

makeIntroString ()

Full Usage: makeIntroString ()

Parameters:
    () : unit

Returns: ColoredString

Creates a colored intro string for B2R2.

() : unit
Returns: ColoredString

parseAndRun mainFn tool usageTail spec opts args

Full Usage: parseAndRun mainFn tool usageTail spec opts args

Parameters:
    mainFn : string list -> 'a -> unit
    tool : 'b
    usageTail : string
    spec : CmdOpt<'a, 'c> list
    opts : 'a
    args : Args

Returns: int
Type parameters: 'a, 'b, 'c (requires :> B2R2.RearEnd.Utils.IVerboseOption)

Parses command line arguments and runs the mainFn

mainFn : string list -> 'a -> unit
tool : 'b
usageTail : string
spec : CmdOpt<'a, 'c> list
opts : 'a
args : Args
Returns: int

printUsage tool usageTail spec

Full Usage: printUsage tool usageTail spec

Parameters:
    tool : 'a
    usageTail : string
    spec : CmdOpt<'b, 'c> list

Returns: 'd
Type parameters: 'a, 'b, 'c, 'd

Prints out the usage message for the given tool.

tool : 'a
usageTail : string
spec : CmdOpt<'b, 'c> list
Returns: 'd

sanitizeRestArgs args

Full Usage: sanitizeRestArgs args

Parameters:
    args : string list

Checks if the rest args contain an option string. If so, exit the program. Otherwise, do nothing.

args : string list

writeIntro ()

Full Usage: writeIntro ()

Parameters:
    () : unit

Writes introduction message to console.

() : unit

Type something to start searching.