Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc] Add doc for public classes and functions of Go packages. #7

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

[doc] Add doc for public classes and functions of Go packages. #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d0c92a2
add doc for package otns_main
simonlingoogle Apr 13, 2020
dbe0697
add doc for package otns_main
simonlingoogle Apr 13, 2020
54ba9f4
add doc for cmd/otns
simonlingoogle Apr 13, 2020
4c39591
add doc for package cli
simonlingoogle Apr 13, 2020
ef2b70a
add doc for package cli
simonlingoogle Apr 13, 2020
738c9bc
add doc for dissectpkt package
simonlingoogle Apr 13, 2020
b21a1cf
doc otoutfilter
simonlingoogle Apr 13, 2020
6130f6d
doc pcap
simonlingoogle Apr 13, 2020
2f9bf6e
doc web
simonlingoogle Apr 14, 2020
a9225c4
doc types
simonlingoogle Apr 14, 2020
32570d3
doc types
simonlingoogle Apr 14, 2020
d8cf517
doc threadconst
simonlingoogle Apr 14, 2020
66acb77
doc simulation
simonlingoogle Apr 14, 2020
e0f6fc2
doc simulation
simonlingoogle Apr 14, 2020
3facb66
doc visualize
simonlingoogle Apr 14, 2020
c8ee66b
doc dispatcher
simonlingoogle Apr 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 42 additions & 83 deletions cli/ast.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

// This file defines the format of all CLI commands and their flags.

package cli

import (
Expand All @@ -32,8 +34,7 @@ import (
"github.com/alecthomas/participle"
)

//noinspection GoStructTag
type Command struct {
type command struct {
Add *AddCmd ` @@` //nolint
CountDown *CountDownCmd `| @@` //nolint
Counters *CountersCmd `| @@` //nolint
Expand All @@ -43,7 +44,7 @@ type Command struct {
Exit *ExitCmd `| @@` //nolint
Go *GoCmd `| @@` //nolint
Joins *JoinsCmd `| @@` //nolint
Move *Move `| @@` //nolint
Move *MoveCmd `| @@` //nolint
Node *NodeCmd `| @@` //nolint
Nodes *NodesCmd `| @@` //nolint
Partitions *PartitionsCmd `| @@` //nolint
Expand All @@ -56,49 +57,22 @@ type Command struct {
Web *WebCmd `| @@` //nolint
}

//noinspection GoStructTag
type FullScreen struct {
FullScreen struct{} `"fs"` //nolint
}

//noinspection GoStructTag
type RadioRange struct {
Val int `"rr" @Int` //nolint
}

//noinspection GoStructTag
type FieldWidth struct {
Val int `"fw" @Int` //nolint
}

//noinspection GoStructTag
type FieldHeight struct {
Val int `"fh" @Int` //nolint
}

//noinspection GoStructTag
type VisualizeArg struct {
Flag struct{} `"v"` //nolint
None *NoneFlag `( @@` //nolint
Gui *GuiFlag `| @@ )` //nolint
}

//noinspection GoStructTag
// DebugCmd defines the `debug` command format.
type DebugCmd struct {
Cmd struct{} `"debug"` //nolint
Fail *string `[ @"fail" ]` //nolint
Echo *string `[ "echo" @String ]` //nolint
}

//noinspection GoStructTag
// GoCmd defines the `go` command format.
type GoCmd struct {
Cmd struct{} `"go"` //nolint
Seconds float64 `( (@Int|@Float)` //nolint
Ever *EverFlag `| @@ )` //nolint
Speed *float64 `[ "speed" (@Int|@Float) ]` //nolint
}

//noinspection GoStructTag
// NodeSelector defines the node selector format.
type NodeSelector struct {
Id int `@Int` //nolint
}
Expand All @@ -107,37 +81,37 @@ func (ns *NodeSelector) String() string {
return strconv.Itoa(ns.Id)
}

//noinspection GoStructTag
// Ipv6Address defines the IPv6 address format.
type Ipv6Address struct {
Addr string `@String` //nolint
}

//noinspection GoStructTag
// AddrType defines the `address type` flag format for specifying address type.
type AddrType struct {
Type string `@( "any" | "mleid" | "rloc" | "aloc" | "linklocal" )` //nolint
}

//noinspection GoStructTag
// DataSizeFlag defines the `datasize` flag format for specifying data size.
type DataSizeFlag struct {
Val int `("datasize"|"ds") @Int` //nolint
}

//noinspection GoStructTag
// IntervalFlag defines the `interval` flag format for specifying time interval.
type IntervalFlag struct {
Val int `("interval"|"itv") @Int` //nolint
}

//noinspection GoStructTag
// CountFlag defines the `count` flag format for specifying count.
type CountFlag struct {
Val int `("count" | "c") @Int` //nolint
}

//noinspection GoStructTag
// HopLimitFlag defines the `hop limit` flag format for specifying hop limit.
type HopLimitFlag struct {
Val int `("hoplimit" | "hl") @Int` //nolint
}

//noinspection GoStructTag
// PingCmd defines the `ping` command format.
type PingCmd struct {
Cmd struct{} `"ping"` //nolint
Src NodeSelector `@@` //nolint
Expand All @@ -150,42 +124,42 @@ type PingCmd struct {
HopLimit *HopLimitFlag `| @@ )*` //nolint
}

//noinspection GoStructTag
// NodeCmd defines `node` command format.
type NodeCmd struct {
Cmd struct{} `"node"` //nolint
Node NodeSelector `@@` //nolint
Command *string `[ @String ]` //nolint
}

//noinspection GoStructTag
// DemoLegendCmd defines the `demo_legend` command format.
type DemoLegendCmd struct {
Cmd struct{} `"demo_legend"` //nolint
Title string `@String` //nolint
X int `@Int` //nolint
Y int `@Int` //nolint
}

//noinspection GoStructTag
// CountDownCmd defines the `countdown` command format.
type CountDownCmd struct {
Cmd struct{} `"countdown"` //nolint
Seconds int `@Int` //nolint
Text *string `[ @String ]` //nolint
}

//noinspection GoStructTag
// ScanCmd defines the `scan` command format.
type ScanCmd struct {
Cmd struct{} `"scan"` //nolint
Node NodeSelector `@@` // nolint
}

//noinspection GoStructTag
// SpeedCmd defines the `speed` command format.
type SpeedCmd struct {
Cmd struct{} `"speed"` //nolint
Max *MaxSpeedFlag `( @@` //nolint
Speed *float64 `| [ (@Int|@Float) ] )` //nolint
}

//noinspection GoStructTag
// AddCmd defines the `add` command format.
type AddCmd struct {
Cmd struct{} `"add"` //nolint
Type NodeType `@@` //nolint
Expand All @@ -195,53 +169,48 @@ type AddCmd struct {
RadioRange *RadioRangeFlag `|@@ )*` //nolint
}

//noinspection GoStructTag
// RadioRangeFlag defines the `radio range` flag format.
type RadioRangeFlag struct {
Val int `"rr" @Int` //nolint
}

//noinspection MaxSpeedFlag
// MaxSpeedFlag defines the `max speed` flag format.
type MaxSpeedFlag struct {
Dummy struct{} `( "max" | "inf")` //nolint
}

//noinspection GoStructTag
// NodeType defines the `node type` flag for specifying node types.
type NodeType struct {
Val string `@("router"|"fed"|"med"|"sed")` //nolint
}

//noinspection GoStructTag
// AddNodeId defines the `id` flag format for specifying node ID.
type AddNodeId struct {
Val int `"id" @Int` //nolint
}

//noinspection GoStructTag
// DelCmd defines the `del` command format.
type DelCmd struct {
Cmd struct{} `"del"` //nolint
Nodes []NodeSelector `( @@ )+` //nolint
}

//noinspection GoStructTag
// EverFlag defines the `ever` flag format.
type EverFlag struct {
Dummy struct{} `"ever"` //nolint
}

//noinspection GoStructTag
type Empty struct {
Empty struct{} `""` //nolint
}

//noinspection GoStructTag
// ExitCmd defines the `exit` command format.
type ExitCmd struct {
Cmd struct{} `"exit"` //nolint
}

//noinspection GoStructTag
// WebCmd defines the `web` command format.
type WebCmd struct {
Cmd struct{} `"web"` //nolint
}

//noinspection GoStructTag
// RadioCmd defines the `radio` command format.
type RadioCmd struct {
Cmd struct{} `"radio"` //nolint
Nodes []NodeSelector `( @@ )+` //nolint
Expand All @@ -250,77 +219,67 @@ type RadioCmd struct {
FailTime *FailTimeParams `| @@ )` //nolint
}

//noinspection GoStructTag
// OnFlag defines the `on` flag format.
type OnFlag struct {
Dummy struct{} `"on"` //nolint
}

//noinspection GoStructTag
// OffFlag defines the `off` flag format.
type OffFlag struct {
Dummy struct{} `"off"` //nolint
}

//noinspection GoStructTag
type Move struct {
// MoveCmd defines the `move` command format.
type MoveCmd struct {
Cmd struct{} `"move"` //nolint
Target NodeSelector `@@` //nolint
X int `@Int` //nolint
Y int `@Int` //nolint
}

//noinspection GoStructTag
// NodesCmd defines the `nodes` command format.
type NodesCmd struct {
Cmd struct{} `"nodes"` //nolint
}

//noinspection GoStructTag
// PartitionsCmd defines the `partitions` command format.
type PartitionsCmd struct {
Cmd struct{} `( "partitions" | "pts")` //nolint
}

//noinspection GoStructTag
// PingsCmd defines the `pings` command format.
type PingsCmd struct {
Cmd struct{} `"pings"` //nolint
}

//noinspection GoStructTag
// JoinsCmd defines the `joins` command format.
type JoinsCmd struct {
Cmd struct{} `"joins"` //nolint
}

//noinspection GoStructTag
// CountersCmd defies the `counters` command format.
type CountersCmd struct {
Cmd struct{} `"counters"` //nolint
}

//noinspection GoStructTag
// PlrCmd defines the `plr` command format.
type PlrCmd struct {
Cmd struct{} `"plr"` //nolint
Val *float64 `[ (@Int|@Float) ]` //nolint
}

//noinspection GoStructTag
// FailTimeParams defines the fail time parameters format.
type FailTimeParams struct {
Dummy struct{} `"ft"` //nolint
FailDuration float64 `(@Int|@Float)` //nolint
FailInterval float64 `(@Int|@Float)` //nolint
}

//noinspection GoStructTag
type NoneFlag struct {
Dummy struct{} `"none"` //nolint
}

//noinspection GoStructTag
type GuiFlag struct {
Dummy struct{} `"gui"` //nolint
}

var (
commandParser = participle.MustBuild(&Command{})
commandParser = participle.MustBuild(&command{})
)

func ParseBytes(b []byte, cmd *Command) error {
func parseCmdBytes(b []byte, cmd *command) error {
err := commandParser.ParseBytes(b, cmd)
return err
}
Loading