├── _config.yml ├── .gitattributes ├── ShellcodeLoader ├── stdafx.h ├── stdafx.cpp ├── targetver.h ├── shellcode64.bin ├── shellcodex86.bin ├── ShellcodeLoader.cpp ├── ShellcodeLoader.vcxproj.filters ├── ShellcodeLoader.vcxproj └── argparse.hpp ├── ShellcodeLoader.sln ├── README.md └── .gitignore /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-slate -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /ShellcodeLoader/stdafx.h: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/stdafx.h -------------------------------------------------------------------------------- /ShellcodeLoader/stdafx.cpp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/stdafx.cpp -------------------------------------------------------------------------------- /ShellcodeLoader/targetver.h: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/targetver.h -------------------------------------------------------------------------------- /ShellcodeLoader/shellcode64.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/shellcode64.bin -------------------------------------------------------------------------------- /ShellcodeLoader/shellcodex86.bin: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/shellcodex86.bin -------------------------------------------------------------------------------- /ShellcodeLoader/ShellcodeLoader.cpp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sisoma2/ShellcodeLoader/HEAD/ShellcodeLoader/ShellcodeLoader.cpp -------------------------------------------------------------------------------- /ShellcodeLoader/ShellcodeLoader.vcxproj.filters: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | {4FC737F1-C7A5-4376-A066-2A32D752A2FF} 6 | cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx 7 | 8 | 9 | {93995380-89BD-4b04-88EB-625FBE52EBFB} 10 | h;hh;hpp;hxx;hm;inl;inc;xsd 11 | 12 | 13 | {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} 14 | rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms 15 | 16 | 17 | 18 | 19 | Archivos de encabezado 20 | 21 | 22 | Archivos de encabezado 23 | 24 | 25 | 26 | 27 | Archivos de origen 28 | 29 | 30 | Archivos de origen 31 | 32 | 33 | -------------------------------------------------------------------------------- /ShellcodeLoader.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio 15 4 | VisualStudioVersion = 15.0.27130.2020 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ShellcodeLoader", "ShellcodeLoader\ShellcodeLoader.vcxproj", "{8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|x64 = Debug|x64 11 | Debug|x86 = Debug|x86 12 | Release|x64 = Release|x64 13 | Release|x86 = Release|x86 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Debug|x64.ActiveCfg = Debug|x64 17 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Debug|x64.Build.0 = Debug|x64 18 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Debug|x86.ActiveCfg = Debug|Win32 19 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Debug|x86.Build.0 = Debug|Win32 20 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Release|x64.ActiveCfg = Release|x64 21 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Release|x64.Build.0 = Release|x64 22 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Release|x86.ActiveCfg = Release|Win32 23 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1}.Release|x86.Build.0 = Release|Win32 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {C4EC72CB-B9DF-4303-BCAE-16246B980B33} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ShellcodeLoader 2 | 3 | ShellcodeLoader has been built with the purpose to quickly debug a shellcode extracted in malware analysis in a context of an executable. 4 | What ShelcodeLoader does is read a bynary file from disk to memory and jump to the base or an especified entry point to execute the file. 5 | It autodetects if it's being debugged and asks the user if he/she wants to set a breakpoint before the execution of the shellcode. 6 | Works in x86 and x64 systems. 7 | 8 | ## Releases 9 | 10 | Go to the Releases tab and download the compiled executables. 11 | 12 | ## Usage 13 | 14 | The file is required. The other arguments are optional. 15 | ``` 16 | ShellcodeLoader.exe [-e --entrypoint ENTRYPOINT] [-a --address ADDRESS] [-r --run] [-b --break] FILE 17 | ``` 18 | 19 | Loads the file and executes the code at a specified offset 20 | ``` 21 | ShellcodeLoader.exe -e 1000 shellcodex86.bin 22 | ``` 23 | 24 | Reads the file and tries to allocate memory at the specified address and copy the shellcode to this region and execute it 25 | ``` 26 | ShellcodeLoader.exe -a 30000 shellcodex86.bin 27 | ``` 28 | 29 | Runs the shellcode without stopping or breaking. __Warning:__ The shellcode will be executed in your machine. 30 | ``` 31 | ShellcodeLoader.exe -r shellcodex86.bin 32 | ``` 33 | 34 | Tries to copy the shellcode at the specified region and sets a breakpoint before jumping to the specified entrypoint 35 | ``` 36 | ShellcodeLoader.exe -a 30000 -e 1000 -b shellcodex86.bin 37 | ``` 38 | 39 | ## Building 40 | __Requirements__ 41 | - Download and install Microsoft Visual C++ Build Tools or Visual Studio 42 | 43 | __Build Steps__ 44 | - Clone the repo and navigate to the directory 45 | - Open the SLN file to open the project to Visual Studio 46 | - Select the platform in which you will be compiling the binary (x32 or x64) 47 | - Go to Compile->Compile Solution to generate the EXE file 48 | 49 | ## Shellcode Samples 50 | 51 | The files shellcodex86.bin and shellcodex64.bin are shellcodes compiled with NASM that execute a calc.exe via WinExec Windows API for the purpose to test the software. 52 | 53 | ## Feedback 54 | 55 | Any questions, comments or requests you can find me on twitter: [@sisoma2](https://twitter.com/sisoma2) 56 | Pull requests welcome! 57 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | 4 | # User-specific files 5 | *.suo 6 | *.user 7 | *.userosscache 8 | *.sln.docstates 9 | 10 | # User-specific files (MonoDevelop/Xamarin Studio) 11 | *.userprefs 12 | 13 | # Build results 14 | [Dd]ebug/ 15 | [Dd]ebugPublic/ 16 | [Rr]elease/ 17 | [Rr]eleases/ 18 | x64/ 19 | x86/ 20 | bld/ 21 | [Bb]in/ 22 | [Oo]bj/ 23 | [Ll]og/ 24 | 25 | # Visual Studio 2015 cache/options directory 26 | .vs/ 27 | # Uncomment if you have tasks that create the project's static files in wwwroot 28 | #wwwroot/ 29 | 30 | # MSTest test Results 31 | [Tt]est[Rr]esult*/ 32 | [Bb]uild[Ll]og.* 33 | 34 | # NUNIT 35 | *.VisualState.xml 36 | TestResult.xml 37 | 38 | # Build Results of an ATL Project 39 | [Dd]ebugPS/ 40 | [Rr]eleasePS/ 41 | dlldata.c 42 | 43 | # DNX 44 | project.lock.json 45 | project.fragment.lock.json 46 | artifacts/ 47 | 48 | *_i.c 49 | *_p.c 50 | *_i.h 51 | *.ilk 52 | *.meta 53 | *.obj 54 | *.pch 55 | *.pdb 56 | *.pgc 57 | *.pgd 58 | *.rsp 59 | *.sbr 60 | *.tlb 61 | *.tli 62 | *.tlh 63 | *.tmp 64 | *.tmp_proj 65 | *.log 66 | *.vspscc 67 | *.vssscc 68 | .builds 69 | *.pidb 70 | *.svclog 71 | *.scc 72 | 73 | # Chutzpah Test files 74 | _Chutzpah* 75 | 76 | # Visual C++ cache files 77 | ipch/ 78 | *.aps 79 | *.ncb 80 | *.opendb 81 | *.opensdf 82 | *.sdf 83 | *.cachefile 84 | *.VC.db 85 | *.VC.VC.opendb 86 | 87 | # Visual Studio profiler 88 | *.psess 89 | *.vsp 90 | *.vspx 91 | *.sap 92 | 93 | # TFS 2012 Local Workspace 94 | $tf/ 95 | 96 | # Guidance Automation Toolkit 97 | *.gpState 98 | 99 | # ReSharper is a .NET coding add-in 100 | _ReSharper*/ 101 | *.[Rr]e[Ss]harper 102 | *.DotSettings.user 103 | 104 | # JustCode is a .NET coding add-in 105 | .JustCode 106 | 107 | # TeamCity is a build add-in 108 | _TeamCity* 109 | 110 | # DotCover is a Code Coverage Tool 111 | *.dotCover 112 | 113 | # NCrunch 114 | _NCrunch_* 115 | .*crunch*.local.xml 116 | nCrunchTemp_* 117 | 118 | # MightyMoose 119 | *.mm.* 120 | AutoTest.Net/ 121 | 122 | # Web workbench (sass) 123 | .sass-cache/ 124 | 125 | # Installshield output folder 126 | [Ee]xpress/ 127 | 128 | # DocProject is a documentation generator add-in 129 | DocProject/buildhelp/ 130 | DocProject/Help/*.HxT 131 | DocProject/Help/*.HxC 132 | DocProject/Help/*.hhc 133 | DocProject/Help/*.hhk 134 | DocProject/Help/*.hhp 135 | DocProject/Help/Html2 136 | DocProject/Help/html 137 | 138 | # Click-Once directory 139 | publish/ 140 | 141 | # Publish Web Output 142 | *.[Pp]ublish.xml 143 | *.azurePubxml 144 | # TODO: Comment the next line if you want to checkin your web deploy settings 145 | # but database connection strings (with potential passwords) will be unencrypted 146 | #*.pubxml 147 | *.publishproj 148 | 149 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 150 | # checkin your Azure Web App publish settings, but sensitive information contained 151 | # in these scripts will be unencrypted 152 | PublishScripts/ 153 | 154 | # NuGet Packages 155 | *.nupkg 156 | # The packages folder can be ignored because of Package Restore 157 | **/packages/* 158 | # except build/, which is used as an MSBuild target. 159 | !**/packages/build/ 160 | # Uncomment if necessary however generally it will be regenerated when needed 161 | #!**/packages/repositories.config 162 | # NuGet v3's project.json files produces more ignoreable files 163 | *.nuget.props 164 | *.nuget.targets 165 | 166 | # Microsoft Azure Build Output 167 | csx/ 168 | *.build.csdef 169 | 170 | # Microsoft Azure Emulator 171 | ecf/ 172 | rcf/ 173 | 174 | # Windows Store app package directories and files 175 | AppPackages/ 176 | BundleArtifacts/ 177 | Package.StoreAssociation.xml 178 | _pkginfo.txt 179 | 180 | # Visual Studio cache files 181 | # files ending in .cache can be ignored 182 | *.[Cc]ache 183 | # but keep track of directories ending in .cache 184 | !*.[Cc]ache/ 185 | 186 | # Others 187 | ClientBin/ 188 | ~$* 189 | *~ 190 | *.dbmdl 191 | *.dbproj.schemaview 192 | *.jfm 193 | *.pfx 194 | *.publishsettings 195 | node_modules/ 196 | orleans.codegen.cs 197 | 198 | # Since there are multiple workflows, uncomment next line to ignore bower_components 199 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 200 | #bower_components/ 201 | 202 | # RIA/Silverlight projects 203 | Generated_Code/ 204 | 205 | # Backup & report files from converting an old project file 206 | # to a newer Visual Studio version. Backup files are not needed, 207 | # because we have git ;-) 208 | _UpgradeReport_Files/ 209 | Backup*/ 210 | UpgradeLog*.XML 211 | UpgradeLog*.htm 212 | 213 | # SQL Server files 214 | *.mdf 215 | *.ldf 216 | 217 | # Business Intelligence projects 218 | *.rdl.data 219 | *.bim.layout 220 | *.bim_*.settings 221 | 222 | # Microsoft Fakes 223 | FakesAssemblies/ 224 | 225 | # GhostDoc plugin setting file 226 | *.GhostDoc.xml 227 | 228 | # Node.js Tools for Visual Studio 229 | .ntvs_analysis.dat 230 | 231 | # Visual Studio 6 build log 232 | *.plg 233 | 234 | # Visual Studio 6 workspace options file 235 | *.opt 236 | 237 | # Visual Studio LightSwitch build output 238 | **/*.HTMLClient/GeneratedArtifacts 239 | **/*.DesktopClient/GeneratedArtifacts 240 | **/*.DesktopClient/ModelManifest.xml 241 | **/*.Server/GeneratedArtifacts 242 | **/*.Server/ModelManifest.xml 243 | _Pvt_Extensions 244 | 245 | # Paket dependency manager 246 | .paket/paket.exe 247 | paket-files/ 248 | 249 | # FAKE - F# Make 250 | .fake/ 251 | 252 | # JetBrains Rider 253 | .idea/ 254 | *.sln.iml 255 | 256 | # CodeRush 257 | .cr/ 258 | 259 | # Python Tools for Visual Studio (PTVS) 260 | __pycache__/ 261 | *.pyc -------------------------------------------------------------------------------- /ShellcodeLoader/ShellcodeLoader.vcxproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Debug 6 | Win32 7 | 8 | 9 | Release 10 | Win32 11 | 12 | 13 | Debug 14 | x64 15 | 16 | 17 | Release 18 | x64 19 | 20 | 21 | 22 | 15.0 23 | {8FBFBBE9-601F-46D7-A045-7FD6E7E502C1} 24 | Win32Proj 25 | ShellcodeLoader 26 | 10.0.16299.0 27 | 28 | 29 | 30 | Application 31 | true 32 | v141 33 | Unicode 34 | 35 | 36 | Application 37 | false 38 | v141 39 | true 40 | Unicode 41 | 42 | 43 | Application 44 | true 45 | v141 46 | Unicode 47 | 48 | 49 | Application 50 | false 51 | v141 52 | true 53 | Unicode 54 | 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | true 75 | 76 | 77 | true 78 | 79 | 80 | false 81 | 82 | 83 | false 84 | 85 | 86 | 87 | Use 88 | Level3 89 | Disabled 90 | true 91 | WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions) 92 | true 93 | MultiThreadedDebug 94 | 95 | 96 | Console 97 | true 98 | false 99 | 100 | 101 | 102 | 103 | Use 104 | Level3 105 | Disabled 106 | true 107 | _DEBUG;_CONSOLE;%(PreprocessorDefinitions) 108 | true 109 | 110 | 111 | Console 112 | true 113 | 114 | 115 | 116 | 117 | Use 118 | Level3 119 | MaxSpeed 120 | true 121 | true 122 | true 123 | WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 124 | true 125 | MultiThreaded 126 | 127 | 128 | Console 129 | true 130 | true 131 | true 132 | 133 | 134 | 135 | 136 | Use 137 | Level3 138 | MaxSpeed 139 | true 140 | true 141 | true 142 | NDEBUG;_CONSOLE;%(PreprocessorDefinitions) 143 | true 144 | 145 | 146 | Console 147 | true 148 | true 149 | true 150 | 151 | 152 | 153 | 154 | 155 | 156 | 157 | 158 | 159 | Create 160 | Create 161 | Create 162 | Create 163 | 164 | 165 | 166 | 167 | 168 | -------------------------------------------------------------------------------- /ShellcodeLoader/argparse.hpp: -------------------------------------------------------------------------------- 1 | #ifndef ARGPARSE_HPP_ 2 | #define ARGPARSE_HPP_ 3 | 4 | #if __cplusplus >= 201103L 5 | #include 6 | typedef std::unordered_map IndexMap; 7 | #else 8 | #include 9 | typedef std::map IndexMap; 10 | #endif 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | 20 | /*! @class ArgumentParser 21 | * @brief A simple command-line argument parser based on the design of 22 | * python's parser of the same name. 23 | * 24 | * ArgumentParser is a simple C++ class that can parse arguments from 25 | * the command-line or any array of strings. The syntax is familiar to 26 | * anyone who has used python's ArgumentParser: 27 | * \code 28 | * // create a parser and add the options 29 | * ArgumentParser parser; 30 | * parser.addArgument("-n", "--name"); 31 | * parser.addArgument("--inputs", '+'); 32 | * 33 | * // parse the command-line arguments 34 | * parser.parse(argc, argv); 35 | * 36 | * // get the inputs and iterate over them 37 | * string name = parser.retrieve("name"); 38 | * vector inputs = parser.retrieve>("inputs"); 39 | * \endcode 40 | * 41 | */ 42 | class ArgumentParser { 43 | private: 44 | class Any; 45 | class Argument; 46 | class PlaceHolder; 47 | class Holder; 48 | typedef std::string String; 49 | typedef std::vector AnyVector; 50 | typedef std::vector StringVector; 51 | typedef std::vector ArgumentVector; 52 | 53 | // -------------------------------------------------------------------------- 54 | // Type-erasure internal storage 55 | // -------------------------------------------------------------------------- 56 | class Any { 57 | public: 58 | // constructor 59 | Any() : content(0) {} 60 | // destructor 61 | ~Any() { delete content; } 62 | // INWARD CONVERSIONS 63 | Any(const Any& other) : content(other.content ? other.content->clone() : 0) {} 64 | template 65 | Any(const ValueType& other) 66 | : content(new Holder(other)) {} 67 | Any& swap(Any& other) { 68 | std::swap(content, other.content); 69 | return *this; 70 | } 71 | Any& operator=(const Any& rhs) { 72 | Any tmp(rhs); 73 | return swap(tmp); 74 | } 75 | template 76 | Any& operator=(const ValueType& rhs) { 77 | Any tmp(rhs); 78 | return swap(tmp); 79 | } 80 | // OUTWARD CONVERSIONS 81 | template 82 | ValueType* toPtr() const { 83 | return content->type_info() == typeid(ValueType) 84 | ? &static_cast*>(content)->held_ 85 | : 0; 86 | } 87 | template 88 | ValueType& castTo() { 89 | if (!toPtr()) throw std::bad_cast(); 90 | return *toPtr(); 91 | } 92 | template 93 | const ValueType& castTo() const { 94 | if (!toPtr()) throw std::bad_cast(); 95 | return *toPtr(); 96 | } 97 | 98 | private: 99 | // Inner placeholder interface 100 | class PlaceHolder { 101 | public: 102 | virtual ~PlaceHolder() {} 103 | virtual const std::type_info& type_info() const = 0; 104 | virtual PlaceHolder* clone() const = 0; 105 | }; 106 | // Inner template concrete instantiation of PlaceHolder 107 | template 108 | class Holder : public PlaceHolder { 109 | public: 110 | ValueType held_; 111 | Holder(const ValueType& value) : held_(value) {} 112 | virtual const std::type_info& type_info() const { return typeid(ValueType); } 113 | virtual PlaceHolder* clone() const { return new Holder(held_); } 114 | }; 115 | PlaceHolder* content; 116 | }; 117 | 118 | // -------------------------------------------------------------------------- 119 | // Argument 120 | // -------------------------------------------------------------------------- 121 | static String delimit(const String& name) { 122 | return String(std::min(name.size(), (size_t)2), '-').append(name); 123 | } 124 | static String strip(const String& name) { 125 | size_t begin = 0; 126 | begin += name.size() > 0 ? name[0] == '-' : 0; 127 | begin += name.size() > 3 ? name[1] == '-' : 0; 128 | return name.substr(begin); 129 | } 130 | static String upper(const String& in) { 131 | String out(in); 132 | std::transform(out.begin(), out.end(), out.begin(), ::toupper); 133 | return out; 134 | } 135 | static String escape(const String& in) { 136 | String out(in); 137 | if (in.find(' ') != std::string::npos) out = String("\"").append(out).append("\""); 138 | return out; 139 | } 140 | 141 | struct Argument { 142 | Argument() : short_name(""), name(""), optional(true), fixed_nargs(0), fixed(true) {} 143 | Argument(const String& _short_name, const String& _name, bool _optional, char nargs) 144 | : short_name(_short_name), name(_name), optional(_optional) { 145 | if (nargs == '+' || nargs == '*') { 146 | variable_nargs = nargs; 147 | fixed = false; 148 | } else { 149 | fixed_nargs = nargs; 150 | fixed = true; 151 | } 152 | } 153 | String short_name; 154 | String name; 155 | bool optional; 156 | union { 157 | size_t fixed_nargs; 158 | char variable_nargs; 159 | }; 160 | bool fixed; 161 | String canonicalName() const { return (name.empty()) ? short_name : name; } 162 | String toString(bool named = true) const { 163 | std::ostringstream s; 164 | String uname = name.empty() ? upper(strip(short_name)) : upper(strip(name)); 165 | if (named && optional) s << "["; 166 | if (named) s << canonicalName(); 167 | if (fixed) { 168 | size_t N = std::min((size_t)3, fixed_nargs); 169 | for (size_t n = 0; n < N; ++n) s << " " << uname; 170 | if (N < fixed_nargs) s << " ..."; 171 | } 172 | if (!fixed) { 173 | s << " "; 174 | if (variable_nargs == '*') s << "["; 175 | s << uname << " "; 176 | if (variable_nargs == '+') s << "["; 177 | s << uname << "...]"; 178 | } 179 | if (named && optional) s << "]"; 180 | return s.str(); 181 | } 182 | }; 183 | 184 | void insertArgument(const Argument& arg) { 185 | size_t N = arguments_.size(); 186 | arguments_.push_back(arg); 187 | if (arg.fixed && arg.fixed_nargs <= 1) { 188 | variables_.push_back(String()); 189 | } else { 190 | variables_.push_back(StringVector()); 191 | } 192 | if (!arg.short_name.empty()) index_[arg.short_name] = N; 193 | if (!arg.name.empty()) index_[arg.name] = N; 194 | if (!arg.optional) required_++; 195 | } 196 | 197 | // -------------------------------------------------------------------------- 198 | // Error handling 199 | // -------------------------------------------------------------------------- 200 | void argumentError(const std::string& msg, bool show_usage = false) { 201 | if (use_exceptions_) throw std::invalid_argument(msg); 202 | std::cerr << "ArgumentParser error: " << msg << std::endl; 203 | if (show_usage) std::cerr << usage() << std::endl; 204 | exit(-5); 205 | } 206 | 207 | // -------------------------------------------------------------------------- 208 | // Member variables 209 | // -------------------------------------------------------------------------- 210 | IndexMap index_; 211 | bool ignore_first_; 212 | bool use_exceptions_; 213 | size_t required_; 214 | String app_name_; 215 | String final_name_; 216 | ArgumentVector arguments_; 217 | AnyVector variables_; 218 | std::vector all_args; 219 | 220 | public: 221 | ArgumentParser() : ignore_first_(true), use_exceptions_(false), required_(0) {} 222 | // -------------------------------------------------------------------------- 223 | // addArgument 224 | // -------------------------------------------------------------------------- 225 | void appName(const String& name) { app_name_ = name; } 226 | void addArgument(const String& name, char nargs = 0, bool optional = true) { 227 | if (name.size() > 2) { 228 | Argument arg("", verify(name), optional, nargs); 229 | insertArgument(arg); 230 | } else { 231 | Argument arg(verify(name), "", optional, nargs); 232 | insertArgument(arg); 233 | } 234 | } 235 | void addArgument(const String& short_name, const String& name, char nargs = 0, 236 | bool optional = true) { 237 | Argument arg(verify(short_name), verify(name), optional, nargs); 238 | insertArgument(arg); 239 | } 240 | void addFinalArgument(const String& name, char nargs = 1, bool optional = false) { 241 | final_name_ = delimit(name); 242 | Argument arg("", final_name_, optional, nargs); 243 | insertArgument(arg); 244 | } 245 | void ignoreFirstArgument(bool ignore_first) { ignore_first_ = ignore_first; } 246 | String verify(const String& name) { 247 | if (name.empty()) argumentError("argument names must be non-empty"); 248 | if ((name.size() == 2 && name[0] != '-') || name.size() == 3) 249 | argumentError(String("invalid argument '") 250 | .append(name) 251 | .append("'. Short names must begin with '-'")); 252 | if (name.size() > 3 && (name[0] != '-' || name[1] != '-')) 253 | argumentError(String("invalid argument '") 254 | .append(name) 255 | .append("'. Multi-character names must begin with '--'")); 256 | return name; 257 | } 258 | 259 | // -------------------------------------------------------------------------- 260 | // Parse 261 | // -------------------------------------------------------------------------- 262 | void parse(size_t argc, const char** argv) { parse(StringVector(argv, argv + argc)); } 263 | 264 | void parse(const StringVector& argv) { 265 | // check if the app is named 266 | if (app_name_.empty() && ignore_first_ && !argv.empty()) app_name_ = argv[0]; 267 | 268 | // set up the working set 269 | Argument active; 270 | Argument final = final_name_.empty() ? Argument() : arguments_[index_[final_name_]]; 271 | size_t consumed = 0; 272 | size_t nrequired = final.optional ? required_ : required_ - 1; 273 | size_t nfinal = final.optional ? 0 : (final.fixed ? final.fixed_nargs 274 | : (final.variable_nargs == '+' ? 1 : 0)); 275 | 276 | // iterate over each element of the array 277 | for (StringVector::const_iterator in = argv.begin() + ignore_first_; 278 | in < argv.end() - nfinal; ++in) { 279 | String active_name = active.canonicalName(); 280 | String el = *in; 281 | 282 | // add arguments to vector 283 | all_args.push_back(el); 284 | 285 | // check if the element is a key 286 | if (index_.count(el) == 0) { 287 | // input 288 | // is the current active argument expecting more inputs? 289 | if (active.fixed && active.fixed_nargs <= consumed) 290 | argumentError(String("attempt to pass too many inputs to ").append(active_name), 291 | true); 292 | if (active.fixed && active.fixed_nargs == 1) { 293 | variables_[index_[active_name]].castTo() = el; 294 | } else { 295 | variables_[index_[active_name]].castTo().push_back(el); 296 | } 297 | consumed++; 298 | } else { 299 | // new key! 300 | // has the active argument consumed enough elements? 301 | if ((active.fixed && active.fixed_nargs != consumed) || 302 | (!active.fixed && active.variable_nargs == '+' && consumed < 1)) 303 | argumentError(String("encountered argument ") 304 | .append(el) 305 | .append(" when expecting more inputs to ") 306 | .append(active_name), 307 | true); 308 | active = arguments_[index_[el]]; 309 | // check if we've satisfied the required arguments 310 | if (active.optional && nrequired > 0) 311 | argumentError(String("encountered optional argument ") 312 | .append(el) 313 | .append(" when expecting more required arguments"), 314 | true); 315 | // are there enough arguments for the new argument to consume? 316 | if ((active.fixed && active.fixed_nargs > (argv.end() - in - nfinal - 1)) || 317 | (!active.fixed && active.variable_nargs == '+' && 318 | !(argv.end() - in - nfinal - 1))) 319 | argumentError(String("too few inputs passed to argument ").append(el), true); 320 | if (!active.optional) nrequired--; 321 | consumed = 0; 322 | } 323 | } 324 | 325 | for (StringVector::const_iterator in = 326 | std::max(argv.begin() + ignore_first_, argv.end() - nfinal); 327 | in != argv.end(); ++in) { 328 | String el = *in; 329 | // check if we accidentally find an argument specifier 330 | if (index_.count(el)) 331 | argumentError(String("encountered argument specifier ") 332 | .append(el) 333 | .append(" while parsing final required inputs"), 334 | true); 335 | if (final.fixed && final.fixed_nargs == 1) { 336 | variables_[index_[final_name_]].castTo() = el; 337 | } else { 338 | variables_[index_[final_name_]].castTo().push_back(el); 339 | } 340 | nfinal--; 341 | } 342 | 343 | // check that all of the required arguments have been encountered 344 | if (nrequired > 0 || nfinal > 0) 345 | argumentError(String("too few required arguments passed to ").append(app_name_), true); 346 | 347 | //all_args.assign(argv, argv + argc); 348 | } 349 | 350 | // -------------------------------------------------------------------------- 351 | // Retrieve 352 | // -------------------------------------------------------------------------- 353 | template 354 | T& retrieve(const String& name) { 355 | if (index_.count(delimit(name)) == 0) throw std::out_of_range("Key not found"); 356 | size_t N = index_[delimit(name)]; 357 | return variables_[N].castTo(); 358 | } 359 | 360 | // -------------------------------------------------------------------------- 361 | // Properties 362 | // -------------------------------------------------------------------------- 363 | String usage() { 364 | // premable app name 365 | std::ostringstream help; 366 | help << "Usage: " << escape(app_name_); 367 | size_t indent = help.str().size(); 368 | size_t linelength = 0; 369 | 370 | // get the required arguments 371 | for (ArgumentVector::const_iterator it = arguments_.begin(); it != arguments_.end(); ++it) { 372 | Argument arg = *it; 373 | if (arg.optional) continue; 374 | if (arg.name.compare(final_name_) == 0) continue; 375 | help << " "; 376 | String argstr = arg.toString(); 377 | if (argstr.size() + linelength > 80) { 378 | help << "\n" << String(indent, ' '); 379 | linelength = 0; 380 | } else { 381 | linelength += argstr.size(); 382 | } 383 | help << argstr; 384 | } 385 | 386 | // get the optional arguments 387 | for (ArgumentVector::const_iterator it = arguments_.begin(); it != arguments_.end(); ++it) { 388 | Argument arg = *it; 389 | if (!arg.optional) continue; 390 | if (arg.name.compare(final_name_) == 0) continue; 391 | help << " "; 392 | String argstr = arg.toString(); 393 | if (argstr.size() + linelength > 80) { 394 | help << "\n" << String(indent, ' '); 395 | linelength = 0; 396 | } else { 397 | linelength += argstr.size(); 398 | } 399 | help << argstr; 400 | } 401 | 402 | // get the final argument 403 | if (!final_name_.empty()) { 404 | Argument arg = arguments_[index_[final_name_]]; 405 | String argstr = arg.toString(false); 406 | if (argstr.size() + linelength > 80) { 407 | help << "\n" << String(indent, ' '); 408 | linelength = 0; 409 | } else { 410 | linelength += argstr.size(); 411 | } 412 | help << argstr; 413 | } 414 | 415 | return help.str(); 416 | } 417 | void useExceptions(bool state) { use_exceptions_ = state; } 418 | bool empty() const { return index_.empty(); } 419 | void clear() { 420 | ignore_first_ = true; 421 | required_ = 0; 422 | index_.clear(); 423 | arguments_.clear(); 424 | variables_.clear(); 425 | } 426 | bool exists(const String& name) const { 427 | return find(all_args.begin(), all_args.end(), delimit(name)) != all_args.end(); 428 | } 429 | size_t count(const String& name) { 430 | // check if the name is an argument 431 | if (index_.count(delimit(name)) == 0) return 0; 432 | size_t N = index_[delimit(name)]; 433 | Argument arg = arguments_[N]; 434 | Any var = variables_[N]; 435 | // check if the argument is a vector 436 | if (arg.fixed) { 437 | return !var.castTo().empty(); 438 | } else { 439 | return var.castTo().size(); 440 | } 441 | } 442 | }; 443 | #endif 444 | --------------------------------------------------------------------------------