What is Lime?

I love the Sublime Text editor. I have created several plugins to make it even better. One thing that scares me though is that it is not open sourced and the pace of nightly releases have recently been anything but nightly, even now that version 3 is out in Beta.

There was a period of about 6 months after the Sublime Text 2 "stable" version was released where pretty much nothing at all was communicated to the users about what to expect in the future, nor was there much support offered in the forums. People including myself were wondering if the product was dead and I personally wondered what would happen to all the bugs, crashes and annoyances that still existed in ST2. This lack of communication is a dealbreaker to me and I decided that I will not spend any more money on that product because of it.

As none of the other text editors I've tried come close to the love I had for Sublime Text, I decided I had to create my own.

The frontend(s) are not ready to replace your favourite editor, but the backend itself I believe isn't too far away.

Why create a clone?

Because I like the architecture of the extensibilities in the original editor.

Goals

☑ 100% Open source
☑ Compatible with Textmate color schemes (which is what ST is using)
☑ Compatible with Textmate syntax definitions (which again is what ST is using)
☐ Compatible with Textmate snippets
☑ Compatible with Sublime Text’s python plugin API. I’ll probably never implement this 100%, only the api bits I need for the plugins I use.
☑ Compatible with Sublime Text’s keybindings and settings (think most of it is working)
☐ Compatible with Sublime Text snippets
☐ Sublime Text’s Goto anything panel
☑ Multiple cursors
☑ Regression tests (Programming in Go makes it trivial and even fun to write them ;))
☐ Support for plugging in a custom parser for more advanced syntax highlighting.
☐ Terminal UI (Maybe I’ll work on a simple non-terminal UI at some point)
☐ Cross platform (It appears to be compiling and running on OSX and Linux last I tried, but needs further validation.)

Build instructions

Install required components

Go 1.1
- Download a binary package from http://golang.org/doc/install
- Or if you prefer building from source, follow the instructions at tip.golang.org
- Go 1.2 is required on OS X Mavericks (see issue here); use brew install --devel go
Python3
- Python 3 must be compiled without sigaltstack enabled.
Oniguruma
- sudo apt-get install libonig-dev # On Linux
- brew install oniguruma # On Mac
qt5 (Optional) (this is way, way broken at the moment, don't even try it unless you want to fix it)
- Follow the instructions at go-qt5

Compiling Python3 without sigaltstack enabled

cd Python-3.3.2
./configure --enable-shared
cat pyconfig.h | sed s/#define\ HAVE_SIGALTSTACK\ 1// > pyconfig.new && mv pyconfig.new pyconfig.h
make -j8
make install

Download the needed repositories

go get -d code.google.com/p/log4go github.com/quarnster/parser github.com/quarnster/util github.com/howeyc/fsnotify
git clone --recursive https://github.com/limetext/lime.git $GOPATH/src/lime

Modify gopy's cgo.go settings

open $GOPATH/src/lime/3rdparty/libs/gopy/lib/cgo.go

You should be able to update with the output of python3.3-config --cflags and python3.3-config --libs. Here's a shell one liner that might help:

cat lib/cgo.go | python -c "import re,sys; print re.sub(r'(CFLAGS:[^\n]+)(\n+.*?)(LDFLAGS:[^\n]+)', 'CFLAGS: `python3.3-config --cflags`\g<2>LDFLAGS: -L/usr/local/lib `python3.3-config --ldflags`', sys.stdin.read())" > lib/cgo2.go && rm -f lib/cgo.go

Example of cgo.go settings on my Mac:

package py

// #cgo CFLAGS: -I/usr/local/include/python3.3m
// #cgo LDFLAGS: -L/usr/local/lib/python3.3/config-3.3m -ldl -framework CoreFoundation -lpython3.3 -lintl
// #cgo pkg-config: /usr/local/Cellar/libffi/3.0.13/lib/pkgconfig/libffi.pc
import "C"

Make sure gopy works

cd $GOPATH/src/lime/3rdparty/lib/gopy
go install
go test

A successful run of go test will output something similar to:

tick
tick
PASS
ok    lime/3rdparty/libs/gopy 5.299s

Compile lime

cd $GOPATH/src/lime/build
go run build.go

Done!

To use termbox frontend

cd ../frontend/termbox
go run main.go

Press Ctrl+Q to exit.

To use qt5 frontend

cd ../frontend/qt5
go run main.go

License

The license of the project is the 2-clause BSD license:

Copyright (c) 2013 Fredrik Ehnbom
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

mfpbbr / lime