github.com/ebceco/ebc@v1.8.19-0.20190309150932-8cb0b9e06484/cmd/ebc/usage.go (about) 1 // Copyright 2015 The go-ethereum Authors 2 // This file is part of go-ethereum. 3 // 4 // go-ethereum is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // go-ethereum is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>. 16 17 // Contains the geth command usage template and generator. 18 19 package main 20 21 import ( 22 "io" 23 "sort" 24 25 "strings" 26 27 "github.com/ebceco/ebc/cmd/utils" 28 "github.com/ebceco/ebc/internal/debug" 29 "gopkg.in/urfave/cli.v1" 30 ) 31 32 // AppHelpTemplate is the test template for the default, global app help topic. 33 var AppHelpTemplate = `NAME: 34 {{.App.Name}} - {{.App.Usage}} 35 36 Copyright 2013-2018 The go-ethereum Authors 37 38 USAGE: 39 {{.App.HelpName}} [options]{{if .App.Commands}} command [command options]{{end}} {{if .App.ArgsUsage}}{{.App.ArgsUsage}}{{else}}[arguments...]{{end}} 40 {{if .App.Version}} 41 VERSION: 42 {{.App.Version}} 43 {{end}}{{if len .App.Authors}} 44 AUTHOR(S): 45 {{range .App.Authors}}{{ . }}{{end}} 46 {{end}}{{if .App.Commands}} 47 COMMANDS: 48 {{range .App.Commands}}{{join .Names ", "}}{{ "\t" }}{{.Usage}} 49 {{end}}{{end}}{{if .FlagGroups}} 50 {{range .FlagGroups}}{{.Name}} OPTIONS: 51 {{range .Flags}}{{.}} 52 {{end}} 53 {{end}}{{end}}{{if .App.Copyright }} 54 COPYRIGHT: 55 {{.App.Copyright}} 56 {{end}} 57 ` 58 59 // flagGroup is a collection of flags belonging to a single topic. 60 type flagGroup struct { 61 Name string 62 Flags []cli.Flag 63 } 64 65 // AppHelpFlagGroups is the application flags, grouped by functionality. 66 var AppHelpFlagGroups = []flagGroup{ 67 { 68 Name: "ETHEREUM", 69 Flags: []cli.Flag{ 70 configFileFlag, 71 utils.DataDirFlag, 72 utils.KeyStoreDirFlag, 73 utils.NoUSBFlag, 74 utils.NetworkIdFlag, 75 utils.TestnetFlag, 76 utils.RinkebyFlag, 77 utils.SyncModeFlag, 78 utils.GCModeFlag, 79 utils.EthStatsURLFlag, 80 utils.IdentityFlag, 81 utils.LightServFlag, 82 utils.LightPeersFlag, 83 utils.LightKDFFlag, 84 utils.WhitelistFlag, 85 }, 86 }, 87 { 88 Name: "DEVELOPER CHAIN", 89 Flags: []cli.Flag{ 90 utils.DeveloperFlag, 91 utils.DeveloperPeriodFlag, 92 }, 93 }, 94 { 95 Name: "ETHASH", 96 Flags: []cli.Flag{ 97 utils.EthashCacheDirFlag, 98 utils.EthashCachesInMemoryFlag, 99 utils.EthashCachesOnDiskFlag, 100 utils.EthashDatasetDirFlag, 101 utils.EthashDatasetsInMemoryFlag, 102 utils.EthashDatasetsOnDiskFlag, 103 }, 104 }, 105 //{ 106 // Name: "DASHBOARD", 107 // Flags: []cli.Flag{ 108 // utils.DashboardEnabledFlag, 109 // utils.DashboardAddrFlag, 110 // utils.DashboardPortFlag, 111 // utils.DashboardRefreshFlag, 112 // utils.DashboardAssetsFlag, 113 // }, 114 //}, 115 { 116 Name: "TRANSACTION POOL", 117 Flags: []cli.Flag{ 118 utils.TxPoolLocalsFlag, 119 utils.TxPoolNoLocalsFlag, 120 utils.TxPoolJournalFlag, 121 utils.TxPoolRejournalFlag, 122 utils.TxPoolPriceLimitFlag, 123 utils.TxPoolPriceBumpFlag, 124 utils.TxPoolAccountSlotsFlag, 125 utils.TxPoolGlobalSlotsFlag, 126 utils.TxPoolAccountQueueFlag, 127 utils.TxPoolGlobalQueueFlag, 128 utils.TxPoolLifetimeFlag, 129 }, 130 }, 131 { 132 Name: "PERFORMANCE TUNING", 133 Flags: []cli.Flag{ 134 utils.CacheFlag, 135 utils.CacheDatabaseFlag, 136 utils.CacheTrieFlag, 137 utils.CacheGCFlag, 138 utils.TrieCacheGenFlag, 139 }, 140 }, 141 { 142 Name: "ACCOUNT", 143 Flags: []cli.Flag{ 144 utils.UnlockedAccountFlag, 145 utils.PasswordFileFlag, 146 }, 147 }, 148 { 149 Name: "API AND CONSOLE", 150 Flags: []cli.Flag{ 151 utils.RPCEnabledFlag, 152 utils.RPCListenAddrFlag, 153 utils.RPCPortFlag, 154 utils.RPCApiFlag, 155 utils.WSEnabledFlag, 156 utils.WSListenAddrFlag, 157 utils.WSPortFlag, 158 utils.WSApiFlag, 159 utils.WSAllowedOriginsFlag, 160 utils.IPCDisabledFlag, 161 utils.IPCPathFlag, 162 utils.RPCCORSDomainFlag, 163 utils.RPCVirtualHostsFlag, 164 utils.JSpathFlag, 165 utils.ExecFlag, 166 utils.PreloadJSFlag, 167 }, 168 }, 169 { 170 Name: "NETWORKING", 171 Flags: []cli.Flag{ 172 utils.BootnodesFlag, 173 utils.BootnodesV4Flag, 174 utils.BootnodesV5Flag, 175 utils.ListenPortFlag, 176 utils.MaxPeersFlag, 177 utils.MaxPendingPeersFlag, 178 utils.NATFlag, 179 utils.NoDiscoverFlag, 180 utils.DiscoveryV5Flag, 181 utils.NetrestrictFlag, 182 utils.NodeKeyFileFlag, 183 utils.NodeKeyHexFlag, 184 }, 185 }, 186 { 187 Name: "MINER", 188 Flags: []cli.Flag{ 189 utils.MiningEnabledFlag, 190 utils.MinerThreadsFlag, 191 utils.MinerNotifyFlag, 192 utils.MinerGasPriceFlag, 193 utils.MinerGasTargetFlag, 194 utils.MinerGasLimitFlag, 195 utils.MinerEtherbaseFlag, 196 utils.MinerExtraDataFlag, 197 utils.MinerRecommitIntervalFlag, 198 utils.MinerNoVerfiyFlag, 199 }, 200 }, 201 { 202 Name: "GAS PRICE ORACLE", 203 Flags: []cli.Flag{ 204 utils.GpoBlocksFlag, 205 utils.GpoPercentileFlag, 206 }, 207 }, 208 { 209 Name: "VIRTUAL MACHINE", 210 Flags: []cli.Flag{ 211 utils.VMEnableDebugFlag, 212 utils.EVMInterpreterFlag, 213 utils.EWASMInterpreterFlag, 214 }, 215 }, 216 { 217 Name: "LOGGING AND DEBUGGING", 218 Flags: append([]cli.Flag{ 219 utils.FakePoWFlag, 220 utils.NoCompactionFlag, 221 }, debug.Flags...), 222 }, 223 { 224 Name: "METRICS AND STATS", 225 Flags: []cli.Flag{ 226 utils.MetricsEnabledFlag, 227 utils.MetricsEnableInfluxDBFlag, 228 utils.MetricsInfluxDBEndpointFlag, 229 utils.MetricsInfluxDBDatabaseFlag, 230 utils.MetricsInfluxDBUsernameFlag, 231 utils.MetricsInfluxDBPasswordFlag, 232 utils.MetricsInfluxDBHostTagFlag, 233 }, 234 }, 235 { 236 Name: "WHISPER (EXPERIMENTAL)", 237 Flags: whisperFlags, 238 }, 239 { 240 Name: "DEPRECATED", 241 Flags: []cli.Flag{ 242 utils.MinerLegacyThreadsFlag, 243 utils.MinerLegacyGasTargetFlag, 244 utils.MinerLegacyGasPriceFlag, 245 utils.MinerLegacyEtherbaseFlag, 246 utils.MinerLegacyExtraDataFlag, 247 }, 248 }, 249 { 250 Name: "MISC", 251 }, 252 } 253 254 // byCategory sorts an array of flagGroup by Name in the order 255 // defined in AppHelpFlagGroups. 256 type byCategory []flagGroup 257 258 func (a byCategory) Len() int { return len(a) } 259 func (a byCategory) Swap(i, j int) { a[i], a[j] = a[j], a[i] } 260 func (a byCategory) Less(i, j int) bool { 261 iCat, jCat := a[i].Name, a[j].Name 262 iIdx, jIdx := len(AppHelpFlagGroups), len(AppHelpFlagGroups) // ensure non categorized flags come last 263 264 for i, group := range AppHelpFlagGroups { 265 if iCat == group.Name { 266 iIdx = i 267 } 268 if jCat == group.Name { 269 jIdx = i 270 } 271 } 272 273 return iIdx < jIdx 274 } 275 276 func flagCategory(flag cli.Flag) string { 277 for _, category := range AppHelpFlagGroups { 278 for _, flg := range category.Flags { 279 if flg.GetName() == flag.GetName() { 280 return category.Name 281 } 282 } 283 } 284 return "MISC" 285 } 286 287 func init() { 288 // Override the default app help template 289 cli.AppHelpTemplate = AppHelpTemplate 290 291 // Define a one shot struct to pass to the usage template 292 type helpData struct { 293 App interface{} 294 FlagGroups []flagGroup 295 } 296 297 // Override the default app help printer, but only for the global app help 298 originalHelpPrinter := cli.HelpPrinter 299 cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) { 300 if tmpl == AppHelpTemplate { 301 // Iterate over all the flags and add any uncategorized ones 302 categorized := make(map[string]struct{}) 303 for _, group := range AppHelpFlagGroups { 304 for _, flag := range group.Flags { 305 categorized[flag.String()] = struct{}{} 306 } 307 } 308 uncategorized := []cli.Flag{} 309 for _, flag := range data.(*cli.App).Flags { 310 if _, ok := categorized[flag.String()]; !ok { 311 if strings.HasPrefix(flag.GetName(), "dashboard") { 312 continue 313 } 314 uncategorized = append(uncategorized, flag) 315 } 316 } 317 if len(uncategorized) > 0 { 318 // Append all ungategorized options to the misc group 319 miscs := len(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags) 320 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = append(AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags, uncategorized...) 321 322 // Make sure they are removed afterwards 323 defer func() { 324 AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags = AppHelpFlagGroups[len(AppHelpFlagGroups)-1].Flags[:miscs] 325 }() 326 } 327 // Render out custom usage screen 328 originalHelpPrinter(w, tmpl, helpData{data, AppHelpFlagGroups}) 329 } else if tmpl == utils.CommandHelpTemplate { 330 // Iterate over all command specific flags and categorize them 331 categorized := make(map[string][]cli.Flag) 332 for _, flag := range data.(cli.Command).Flags { 333 if _, ok := categorized[flag.String()]; !ok { 334 categorized[flagCategory(flag)] = append(categorized[flagCategory(flag)], flag) 335 } 336 } 337 338 // sort to get a stable ordering 339 sorted := make([]flagGroup, 0, len(categorized)) 340 for cat, flgs := range categorized { 341 sorted = append(sorted, flagGroup{cat, flgs}) 342 } 343 sort.Sort(byCategory(sorted)) 344 345 // add sorted array to data and render with default printer 346 originalHelpPrinter(w, tmpl, map[string]interface{}{ 347 "cmd": data, 348 "categorizedFlags": sorted, 349 }) 350 } else { 351 originalHelpPrinter(w, tmpl, data) 352 } 353 } 354 }