command

Documentation

Overview

Package command provides methods to execute commands from strings

Copyright 2013 Matthew Collins (purggames@gmail.com)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Index

• func Complete(caller Caller, command string) []string
• func Exec(caller Caller, command string) (ret interface{}, err string)
• func Register(def string, callback interface{})
• type Caller

Functions

func Complete

func Complete(caller Caller, command string) []string

func Exec

func Exec(caller Caller, command string) (ret interface{}, err string)

The format of the command is as follows:

command arg1 2 `arg 3` $(echo arg4)

'command' is the first part identifies the command tree to check this must be a constant value.

'arg1' is a string type

'2' is a number type (maybe float or int depending on the command)

'$(echo arg4)' This will execute the command contained in the brackets up to one deep

func Register

func Register(def string, callback interface{})

The format is a follows:

command #argType1 const2

Must not be called after init

Types

type Caller

type Caller interface {
	CanCall(string) bool
	SendMessage(*message.Message)
}