config

Documentation

Index

• type Config
  • func Get() Config
  • func (c Config) DetermineCodeDir() (codeDir string)
  • func (c Config) GetArg(item string) string
  • func (c Config) GetCodebase() string
  • func (c Config) GetDBGpPort() int
  • func (c Config) GetFlag(item string) bool
  • func (c Config) GetHTTPPort() int
  • func (c Config) GetRemoteCodebase() string
  • func (c Config) GetUIPath() string
  • func (c Config) GoSilent()
  • func (c Config) GoVerbose()
  • func (c Config) HasCmdLine() bool
  • func (c Config) HasHTTP() bool
  • func (c Config) IsVerbose() bool
  • func (c Config) SetArg(item string, value string)
  • func (c Config) SetFlag(item string)
  • func (c Config) UnsetFlag(item string)

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

*

• The Config class stores command line arguments and flags.

func Get

func Get() Config

*

• Prepares and returns the configuration object. *
• Attempts to implement the Singleton pattern i.e. it always returns a single
• instance of the configuration object.

func (Config) DetermineCodeDir

func (c Config) DetermineCodeDir() (codeDir string)

*

• Determine the source code path returned by the DBGp engine. *
• When the DBGp engine and Footle are in different machines, source code paths
• returned by the DBGp engine will start with a path from that machine. This
• path is likely to be different from local paths seen by Footle.

func (Config) GetArg

func (c Config) GetArg(item string) string

*

• Get any command line argument.

func (Config) GetCodebase

func (c Config) GetCodebase() string

*

• Getter for path of source code to debug.

func (Config) GetDBGpPort

func (c Config) GetDBGpPort() int

*

• Getter for network port to listen for DBGp server.

func (Config) GetFlag

func (c Config) GetFlag(item string) bool

*

• Get any command line flag.

func (Config) GetHTTPPort

func (c Config) GetHTTPPort() int

*

• Getter for network port where Footle listens for HTTP requests.

func (Config) GetRemoteCodebase

func (c Config) GetRemoteCodebase() string

*

• Getter for remote path of source code to debug. *
• Only relevant when Footle and the DBGp engine are running in different
• machines. In this type of setups, the file paths returned by the DBGp engine
• will start with the remote path. *
• Example:
• Codebase in Footle's machine: /home/foo/bar/
• Codebase in DBGp engine's machine: /var/www/html/
• In this case /var/www/html/ is the remote codebase.

func (Config) GetUIPath

func (c Config) GetUIPath() string

*

• Getter for alternate HTTP UI path.

func (Config) GoSilent

func (c Config) GoSilent()

*

• Turn off verbose mode.

func (Config) GoVerbose

func (c Config) GoVerbose()

*

• Turn on verbose mode.

func (Config) HasCmdLine

func (c Config) HasCmdLine() bool

*

• Getter for the presence of the command line interface.

func (Config) HasHTTP

func (c Config) HasHTTP() bool

*

• Getter for the presence of the HTTP interface.

func (Config) IsVerbose

func (c Config) IsVerbose() bool

*

• Predicate for determine verbosity. *
• The "high" verbose mode displays all incoming and outgoing communication with
• DBGp server. The "low" and "medium" verbose modes are unused at the moment. *
• By default, there is no verbosity.

func (Config) SetArg

func (c Config) SetArg(item string, value string)

*

• Setter for argument.

func (Config) SetFlag

func (c Config) SetFlag(item string)

*

• Set flag to true.

func (Config) UnsetFlag

func (c Config) UnsetFlag(item string)

*

• Set flag to false.