Skip to content

Latest commit

 

History

History
238 lines (166 loc) · 9.22 KB

guide.md

File metadata and controls

238 lines (166 loc) · 9.22 KB
Raw

LiteIDE Feature Guide

How to use the low version Go1.1 and Go1.2

LiteIDE build config default use -i flag, if use Go1.1 or Go1.2 not support. View -> Options -> LiteBuild double click gosrc.xml to edit, modify BUILDARGS value:

<custom id="BuildArgsi" name="BUILDARGS" value="-i"/>

set value to empty and restart LiteIDE to support Go1.1 and Go1.2.

Window Style Setup

LiteIDE now support splitter style and side style.

Options->View->LiteApp-> Style

Environments

The LiteIDE environment setup plugin allows you to quickly switch between multiple system environments for your build. Each environment has its own set of environment variables that can be used to control the build process.

Selecting an Environment

The dropdown in the toolbar can be used to select the environment currently being used for builds. By default, the system environment, representing the platform and architecture of the host machine, is used.

envselect.png

The following environments are provided as part of the supported platforms:

  • Windows - system win64 win32
  • Linux - system linux64 linux32
  • MacOSX - system darwin64 darwin32

See the section below on cross-compiling before switching to a non-native environment.

Configuring an Environment

The variables defined as part of the environments can be modified by hand. To edit an environment, simply click the Edit Environment button next to the environment dropdown when the desired environment has been selected.

Alternatively, environments can be viewed and edited in the View > Options > LiteEnv panel.

Example win32.env:

#win32 environment

GOROOT=c:\go
#GOBIN=
GOARCH=386
GOOS=windows

PATH=c:\mingw32\bin;%GOROOT%\bin;%PATH%

LITEIDE_GDB=gdb
LITEIDE_MAKE=mingw32-make
LITEIDE_TERM=%COMSPEC%
LITEIDE_TERMARGS=
LITEIDE_EXEC=%COMSPEC%
LITEIDE_EXECOPT=/C

Example linux32.env:

#linux32 environment

GOROOT=$HOME/go
#GOBIN=
GOARCH=386
GOOS=linux

PATH=$GOROOT/bin:$PATH

LITEIDE_GDB=gdb
LITEIDE_MAKE=make
LITEIDE_TERM=/usr/bin/gnome-terminal
LITEIDE_TERMARGS=
LITEIDE_EXEC=/usr/bin/xterm
LITEIDE_EXECOPT=-e

Quick Open

  • QuickOpen Ctrl+P
  • QuickOpenEditor Ctrl+Alt+P or QuickOpen window input ~
  • QuickOpenSymbol Ctrl+Shift+O or QuickOpen window input @
  • QuickOpenLines Ctrl+L or QuickOpen window input :
  • Help QuickOpen window input ?

Cross-compilation (Go1.5 or high)

Change LiteIDE environment , set GOROOT GOARCH GOOS, build project.

Cross-compilation (before Go1.5)

You will need to build or install Go compilers for other platforms and architectures before cross-compiling. If you do not do this, you may receive errors about missing executables or even the following error:

%GOROOT%/src/pkg/runtime/extern.go:137: undefined: theGoos

See the "Building compilers" subsection for examples.

Environment variables

To cross-compile your project for another operating system or architecture, you will need to define the following variables in your environment:

  • $GOOS - the name of the target operating system (default: $GOHOSTOS). Possible values are:
    • darwin (Mac OS X 10.6 and above)
    • freebsd
    • linux
    • netbsd
    • openbsd
    • plan9
    • windows
  • $GOARCH - the name of the target architecture (default: $GOHOSTARCH). Possible values are:
    • amd64 (64-bit x86, the most mature port)
    • 386 (32-bit x86)
    • arm (32-bit ARM)
  • $GOARM - ARM architecture version the run-time libraries should target (default: 6).
    • Setting $GOARM to 5 causes the linker to emit calls to a software floating point implementation instead of using hardware floating point support.
  • $CGO_ENABLED
    • This should be set to 0 when cross-compiling.

Building Compilers

To build the compilers for cross-compilation, run the appropriate script from the Go sources directory. The examples below demonstrate how to build some common compilers; you must modify the environment variables appropriately.

go1.5 or high (go1.8 cross-compile CGO_ENABLED auto set 0)

Building cross-compiler for 64-bit Linux on Windows (in MinGW with GCC):

> set GOARCH=amd64
> set GOOS=linux
> set CGO_ENABLED=0
> go build std

Building cross-compiler for 32-bit Windows on macOS:

> GOARCH=386 GOOS=window CGO_ENABLED=0 go build std

Building cross-compiler for Linux ARM on macOS:

> GOARCH=arm GOOS=linux CGO_ENABLED=0 go build std

go 1.0 go1.1 go1.2 go1.3 go1.4

Building cross-compiler for 64-bit Linux on Windows (in MinGW with GCC):

> set GOARCH=amd64
> set GOOS=linux
> set CGO_ENABLED=0
> cd %GOROOT%\src
> all.bat

Building cross-compiler for 32-bit Windows on macOS:

> export GOARCH=386
> export GOOS=windows
> export CGO_ENABLED=0
> cd $GOROOT/src
> ./all.bash

Building cross-compiler for Linux ARM on macOS:

> export GOARCH=arm
> export GOOS=linux
> export CGO_ENABLED=0
> cd $GOROOT/src
> ./all.bash

Building

To actually perform a cross-compilation in LiteIDE, begin by selecting the appropriate environment as described above. Ensure that the environment has the correct variables set. GOARCH, GOOS, GOARM, and CGO_ENABLED must be set as outlined previously. Ensure that GOROOT and GOBIN are also properly defined for your host platform, and that your PATH includes the Go binary and Go's bin directory.

Once the target environment has been selected, simply rebuild your project in the editor.

Example configuration for cross-compiling 64-bit Linux binaries on Windows:

GOROOT=c:\go
GOBIN=
GOARCH=amd64
GOOS=linux
CGO_ENABLED=0

PATH=%GOBIN%;%GOROOT%\bin;%PATH%
...

Golang Code Format

Automatic formatting when saving.

Goimports

LiteIDE View->Options->GolangFmt-> Use goimports instead of gofmt, for code format

This tool updates your Go import lines, adding missing ones and removing unreferenced ones.

Gocode

Code completion use gocode https://github.com/nsf/gocode. gocode works by inspecting the .a files from the project dependencies, so if the code completion is not working properly, please update project dependant packages/libraries.

update dependant packages

update dependant packages for gocode, click build menu or toolbar Get(go get)

auto update dependant packages

LiteIDE View->Options->Gocode-> auto update depends packages

Build System

LiteIDE's build system is highly configurable, allowing you to define your own custom build actions using XML files.

Configuring Build Actions

To modify the available build options, open View > Options > LiteBuild. You can add your own images in this directory to define new icons. Any XML files in this directory are read to load action buttons. Double click on an XML file to edit it. Each XML file defines all of the build actions for one particular type of file.

Example XML for Lua (lua.xml):

<?xml version="1.0" encoding="UTF-8"?>
<mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'>
	<mime-type type="text/x-lua" id="lua" work="$(EDITOR_DIR_PATH)" lock="file" ver="2">
		<config id="GoTools" name="GOTOOLS" value="$(LITEIDE_TOOL_PATH)/gotools"/>
		<action id="Run" key="Ctrl+R" img="run.png" cmd="lua" args="-e io.stdout:setvbuf('no') $(EDITOR_FILE_NAME)" save="editor" output="true" codec="utf-8" regex="([\w\d:_\-\\/\.]+):(\d+)" readline="true" />
		<action id="RunTerm" key="Ctrl+Shift+F5" img="runterm.png" cmd="$(LITEIDE_EXEC)" args="$(LITEIDE_EXECOPT) $(GOTOOLS) runcmd lua -e io.stdout:setvbuf(&quot;no&quot;) $(EDITOR_FILE_NAME)" save="editor" output="false" readline="true"/>
	</mime-type>
</mime-info>

Godoc Viewer

LiteIDE includes an integrated viewer for godoc output. Documentation can be viewed for the Go language itself or for your own packages. Open the viewer using View > Godoc Viewer for more details.

Search and replace

The editor provides search and replace functionality in the Find menu. Regular expressions are supported. For example:

Find: (Colo)(u)(r)
Replace: \1\3

The above example will replace all instances of Colour with Color.

Search functionality is also provided for the filesystem through Find > File Search.

Debugging

To debug your code with LiteIDE, you must have GDB installed (part of MinGW for Windows users). See INSTALL for installation details.

The environment variable LITEIDE_GDB can be used to control which binary is executed for debugging. 32-bit Windows will use gdb.exe, while 64-bit Windows will use gdb64.exe. Configure this environment variable in your environment file.

Keybord Mapping Scheme

You can modify the shortcut keys used for all of LiteIDE's features. Open View > Options > LiteApp > Keyboard to modify the hotkeys. Double click on the shortcut in the list to edit it, and press Apply to apply the changes.

Shortcut keys must follow a specific format. You can separate items using a comma (,) to form an AND relationship (i.e. both shortcuts must be pressed to activate the item). Separate items with a semicolon (;) to form an OR relationship (i.e. any of the shortcuts will activate the item). This is normally what you want.

Examples:

  • Ctrl+B
  • Ctrl+Shift+B
  • Ctrl+K,Ctrl+U
  • Ctrl+Y;Ctrl+Shift+Z