Godit - A very religious text editor written in Go(github.com)
github.com
Godit - A very religious text editor written in Go
https://github.com/nsf/godit
78 comments
"the tab size is always an equivalent to 8 spaces/characters" - our faiths are incompatible
https://github.com/nsf/godit/blob/master/godit.go#L14
> - tabstop_length = 8
> + tabstop_length = 4
> - tabstop_length = 8
> + tabstop_length = 4
The so-called Plan9 way of providing customizable features.
Sorry for spoiling your fun, but Plan 9 has a $tabstop environment variable: http://plan9.bell-labs.com/magic/man2html/1/0intro
I'm surprised that they didn't find some scientific/artistic optimum for that, like they did with the Acme colors (which are picked by someone vastly superior to normal users who would just screw things up, if I remember correctly).
I read that too, it is supposedly invented by some great designer, which is, well, controversial, when you actually look at it ;)
After careful mathematical analysis, which this comment box is too small to contain, I've determined that the optimal number of spaces for a tab is precisely 2e. Unfortunately, this turns out to pose certain practical problems. I imagine Plan9 came to the same conclusion and realized there wasn't a usable mathematical justification.
That still doesn't rule out evaluation by a proper artist. We just have to wait until s/he gets out of the Tufte Ashram(tm), bearing the answer on two golden ratio tablets, lettered in Helvetica.
Never used plan9 in my life. The reason why I wrote this editor is because I don't like bloated emacs and I use this many of its features. Go produces nice 100% statically linked binaries, so eventually I can just wget the godit to any of my linux machines and just use it.
The editor is never meant to be used by anyone except me. But if someone finds it nice, I don't mind sharing it. Plus it's the only serious example of termbox library usage (I wrote it too).
The editor is never meant to be used by anyone except me. But if someone finds it nice, I don't mind sharing it. Plus it's the only serious example of termbox library usage (I wrote it too).
I was semi-joking in reference to the comment, the Plan9 and suckless communities are famous for being very hard-headed about programming being the only way to customize their software. For example, I use dwm - http://dwm.suckless.org/ and like it a lot, though I wish they would change this aspect. I am not criticizing what you did in any way, in fact it looks very nice in comparison to great many similar projects, nice code and interesting design.
I know, I know. I don't take it that personally, just was clarifying why I wrote it and that it's not necessary how I write software.
>the Plan9 and suckless communities
Are two totally separate things and you are painting them both with the suckless brush. The plan9 community is nothing like that at all.
Are two totally separate things and you are painting them both with the suckless brush. The plan9 community is nothing like that at all.
I remember some poor guy asking about syntax highlighting in Acme and the reaction was pretty similar...
Syntax highlighting is not a simple configuration option, it is a whole huge subsystem that has to be written.
Did you read that? It does not support your notion that the plan9 community thinks programming is the way to customize software. It shows that the plan9 community thinks you shouldn't do those things, at all. They are not missing because you should edit the code to change them, they are missing because they should never exist.
Hi! I think I got (I'm not a Go programmer, reading Go is slow and not very reliable for me) that buffers are represented as linked lists of lines.
If this is true, do you still find the performance satisfactory when editing large-ish files (tens of thousands of lines)?
It used to be that buffer representation for general-purpose editing was kind of a Real Problem, so it's interesting if a basic linked list of strings representing lines cuts it, these days.
If this is true, do you still find the performance satisfactory when editing large-ish files (tens of thousands of lines)?
It used to be that buffer representation for general-purpose editing was kind of a Real Problem, so it's interesting if a basic linked list of strings representing lines cuts it, these days.
Godit is quite fast. I tested the godit on intel atom netbook, it keeps CPU usage fairly low.
In my opinion linked list of lines is perfect here. Because the only time you need to go through it in a linear fashion is the actual "goto line" operation. The rest is mostly O(1). Of course line insertion is much more common than "goto line" in editors.
The only problem in godit is that it still doesn't handle long lines very well, here most of the operations are O(N). In fact in godit every time you move a cursor or basically do anything it will do O(N) operation on a current line. I checked this kind of stuff on long enough line (10k), no problems here. I don't think there are that many docs with lines longer than 10k.
So, yes, it will work on very large files without any problems. I've just tested it by creating a 56M file with ~660k lines. Can't see any performance issues on my i5-3470, except for loading and saving, it feels like 0.5s for both or so.
Of course contiguous buffer is not an efficient way to do an editor, I guess "advanced" editors use rope data structure or something. Although most of the editors load large files slower than godit. In a perfect world on files bigger than say 50M you should do memory mapping or something. But most editors like to know the amount of lines in a file they're showing to you, so, no mmap here.
Anyways.. It works very well in practice.
In my opinion linked list of lines is perfect here. Because the only time you need to go through it in a linear fashion is the actual "goto line" operation. The rest is mostly O(1). Of course line insertion is much more common than "goto line" in editors.
The only problem in godit is that it still doesn't handle long lines very well, here most of the operations are O(N). In fact in godit every time you move a cursor or basically do anything it will do O(N) operation on a current line. I checked this kind of stuff on long enough line (10k), no problems here. I don't think there are that many docs with lines longer than 10k.
So, yes, it will work on very large files without any problems. I've just tested it by creating a 56M file with ~660k lines. Can't see any performance issues on my i5-3470, except for loading and saving, it feels like 0.5s for both or so.
Of course contiguous buffer is not an efficient way to do an editor, I guess "advanced" editors use rope data structure or something. Although most of the editors load large files slower than godit. In a perfect world on files bigger than say 50M you should do memory mapping or something. But most editors like to know the amount of lines in a file they're showing to you, so, no mmap here.
Anyways.. It works very well in practice.
Writing software is always a good idea, at least for the experience, so don't be offended by the following comment.
In the case of this particular itch, there are many small statically linked editors, some of them quite powerful. I don't think a small emacs was ever spotted, but the original vi (not vim) is often statically linked and present in /bin in Linux installs (it's a rescue thing).
In the case of this particular itch, there are many small statically linked editors, some of them quite powerful. I don't think a small emacs was ever spotted, but the original vi (not vim) is often statically linked and present in /bin in Linux installs (it's a rescue thing).
Micromacs was favorite in the late 80s. JOVE early 90s. And the commercial unipress emacs. GNU emacs outlived them, probably because situations where a light spot editor was desired are now fast enough that there is very little additional cost to a full featured editor.
That being said, I still have EDITOR set to /usr/bin/emacsclient.
That being said, I still have EDITOR set to /usr/bin/emacsclient.
I totally agree with that, but you know how it goes with sensitive tools like editors. "Nya nya nya, but where is my feature X?"
Writing the right combination of what I want is a perfect way to solve this problem.
Writing the right combination of what I want is a perfect way to solve this problem.
there is also zile[1]
[1]: https://www.gnu.org/software/zile/
[1]: https://www.gnu.org/software/zile/
[deleted]
Obviously the tab character should move forward to the next column divisible by the tab size -- it's not just a replacement for a fixed number of spaces!
That's just my english. Of course I meant that the tab size is the same as the size of 8 space characters. And it sounds like the tab _character_ is an equivalent to 8 spaces, which is not true. Sorry for confusing description.
so, you can indent 9 times in an 80 column display, and less then that usefully?
I'd much rather have tab size be set to get smaller based on the number of indentations/longest line.
I'd much rather have tab size be set to get smaller based on the number of indentations/longest line.
Prophet says:
Now, some people will claim that having 8-character indentations makes the code move too far to the right, and makes it hard to read on a 80-character terminal screen. The answer to that is that if you need more than 3 levels of indentation, you're screwed anyway, and should fix your program.
And I think I kinda agree with this.
Now, some people will claim that having 8-character indentations makes the code move too far to the right, and makes it hard to read on a 80-character terminal screen. The answer to that is that if you need more than 3 levels of indentation, you're screwed anyway, and should fix your program.
And I think I kinda agree with this.
I do agree that there comes a point where you can get over zealous with indentation, but 3 levels deep is pretty common. In fact you idle at one level of indentation just with having your code inside a function. So basically all you need is one conditional inside a loop and you're already maxed out.
Probably not good for ruby when combinations of the following things can result in deeply nested code:
module
class
def
if
class << self
defWell, the Prophet is a C programmer so his numbers may need adjustment by some constant for languages with objects, namespaces, modules, etc.
But still excessive indentation is a hint that the code may benefit from some refactoring.
But still excessive indentation is a hint that the code may benefit from some refactoring.
It is clearly time for a religious war.
It's more like this if you ask me:
https://www.youtube.com/watch?v=gb_qHP7VaZE
(I bet half of you knows what movie clip that is before clicking)
https://www.youtube.com/watch?v=gb_qHP7VaZE
(I bet half of you knows what movie clip that is before clicking)
I'm also guessing syntax highlighting isn't a planned feature.
Correct, I think it's useless. :D
And no wonder, for Satan himself masquerades as an angel of light.
~ 2 Corinthians 11:15
8 characters tab width is insane. :(
Roundness of the Earth is equally insane. But both are facts.
m@sauron:~ $ echo -e '\tx'
xFrom PEP-8, "Use 4 spaces per indentation level. For really old code that you don't want to mess up, you can continue to use 8-space tabs." [1].
While I agree on ending the '\r\n' mania(which itself is a very hard task), pushing tab stops down my throat is not cool.
[1]: http://www.python.org/dev/peps/pep-0008/
While I agree on ending the '\r\n' mania(which itself is a very hard task), pushing tab stops down my throat is not cool.
[1]: http://www.python.org/dev/peps/pep-0008/
I have no problem with people using 4 spaces for indentation.
However, damned shall be those who think that tabs are anything but 8 spaces wide and actually use them this way in their code. Tabs really are 8 spaces wide and every terminal will tell you so.
Real world example: just yesterday I've been bitten by Eclipse defaulting to use "4 space wide tabs" for indentation in otherwise space-indented codebase. Everything looked nice and cool until I ran git diff. How could Eclipse developers think that it was a good idea?
However, damned shall be those who think that tabs are anything but 8 spaces wide and actually use them this way in their code. Tabs really are 8 spaces wide and every terminal will tell you so.
Real world example: just yesterday I've been bitten by Eclipse defaulting to use "4 space wide tabs" for indentation in otherwise space-indented codebase. Everything looked nice and cool until I ran git diff. How could Eclipse developers think that it was a good idea?
Eclipse is very goofy about this, and it's something I loathed about using it (having recently switched to IntelliJ, which is better but not by an order of magnitude). In my experience, it will sometimes indent according to your settings, spaces or tabs, but at other times, based on some other setting that is in a different place than the first, it will indent based on the line previous to the one you are indenting. This results in a kind of slow creep of badly formatted code entering the codebase, if you have a lot of developers who don't care or don't know to check whitespace upon commit, and don't explicitly share a well-customized settings file.
At least IntelliJ has Emacs-style DWIM tab, but still has a whole host of problems with its better than Eclipse but still subpar editor.
At least IntelliJ has Emacs-style DWIM tab, but still has a whole host of problems with its better than Eclipse but still subpar editor.
Exactly. The insane thing is to use tab characters to indent code.
This is why I love this particular religious war so much. No matter how absurd it gets, someone can always come along and post something even dumber and more deliberately inflammatory, and without any self awareness at all.
Strange that you can see it is deliberately inflammatory but not self-aware/tongue-in-cheek.
[deleted]
tab width can be any size you want, it's just many text rendering systems default to 8.
Personally I prefer 4 chars. In my opinion it looks tidier when reading back source code.
Personally I prefer 4 chars. In my opinion it looks tidier when reading back source code.
I don't habe my copy of "Code Complete" here, but AFAICR it cites a study that says code comprehension is best at 3-4 charakter indent.
So, yes, a tab size of 8 is insane...
So, yes, a tab size of 8 is insane...
It's the only correct one. But it should have nothing to do with indent size.
Performance is truly impressive. And I really love how small the codebase actually is. I've been dreaming about writing my own text editor for quite some time. This will really help me to get started, thanks a lot nsf!
p.s. panic on opening a directory isn't really a best way to say that you don't support viewing directories...
p.s. panic on opening a directory isn't really a best way to say that you don't support viewing directories...
I agree this panic is quite annoying sometimes. Will make a proper error message when I have time. A very minor issue at the moment. You see I'm not really actively working on it anymore, I use the godit for all of my text editing tasks and if some feature/bug annoys me a lot in godit - I fix it. Directory opening by accident happens sometimes, lol, and when you see a panic message, you panic as well, but then phew.. :)
Is it a Go thing to have no file organisation? (Is this tooling sufficiently nice that this is manageable?)
Do you want me to write code like that?
https://github.com/Mikkeren/FizzBuzzEnterpriseEdition
Sure, but honestly the original complaint was implying that godit is badly structured. Yes, I don't use Go packages for it, because it's just a small 5k lines of code project and I don't need to use 100 packages to avoid namespace clashes. I use a separate file for most of editor modes and concepts, what else the author wants me to do? Hence, the irony in the answer.
Sorry, my original comment was way harsher than necessary. I wasn't meaning to imply you had structured it badly, the use of files is certainly clear.
I was just wondering if the lack of folders was a typical Go thing. For example, I probably would have something like modes/{all _mode.go files}, and maybe view/{view files}, but I've never touched Go, so I was wondering whether this was unidiomatic.
I was just wondering if the lack of folders was a typical Go thing. For example, I probably would have something like modes/{all _mode.go files}, and maybe view/{view files}, but I've never touched Go, so I was wondering whether this was unidiomatic.
Well in Go there are no makefiles, but there is a tool called "go". It can build stuff for you. It maintains an assumption that all *.go files within the same directory belong to the same package. So you can't actually store multiple packages in the same dir or span files of one package across multiple dirs and use the go tool at the same time. Since the go tool makes like really easier, I choose to obey its conventions. That's why all files are in the same dir.
And I can't just add "modes" and "view" packages, because there are parts in them which depend on core concepts, which leads me to another "core" package or something. And that's 3 packages already. When there's 3, there's 4. It's easier the way it is.
And I can't just add "modes" and "view" packages, because there are parts in them which depend on core concepts, which leads me to another "core" package or something. And that's 3 packages already. When there's 3, there's 4. It's easier the way it is.
Ah, ok, that does sound much easier.
(Thanks for the explanation! :) )
(Thanks for the explanation! :) )
You can do either. Folders are packages, so if you had /modes, that would be a modes sub-package which could be included in the top level code with import.
A couple of weeks ago I was searching for go programs in order to see examples of how I could organize a toy project I was starting. I found godit and after reading the source I think it is a good way to organize a small project. Eventually you can start moving functionality to packages once they grow big enough.
And the tooling helps. There is no Makefile and no instructions, so I tried `go build` and it just works.
And the tooling helps. There is no Makefile and no instructions, so I tried `go build` and it just works.
go does have file organisation. You can create packages in directories and nest them and the tooling will handle it easily.
I think Gomacs or Gemacs would've been better name. It looks so similar to emacs.
Perhaps, but it's too late to change the name.
[deleted]
if only it had Vim bindings instead of Emacs bindings :/
I've been searching for something less bloated than Vim for a while (straight vi doesn't cut it).
I've been searching for something less bloated than Vim for a while (straight vi doesn't cut it).
why not just emacs?
Emacs is big, startup is slow and you have to carry a pile of elisp scripts which fulfil your feature needs. All features has to be written in elisp of course that could be an issue too. Just a matter of taste.
"Emacs is big, startup is slow..."
Please. I don't even bother compiling my .el to .elc and I've got a shitload of modes and a gigantic .emacs file (which I should split btw).
Emacs, from the scratch, takes two seconds to fully load, including all the modes and my solarized color theme etc. I'm not talking about always running an Emacs server to which you can connect in a split second: no, I'm talking about a cold start.
It's 2013 and that's on a Core i5 3450s with 4 GB of RAM. Hardly a speed/memory demon.
If I was motivated I'd compile all my .el to .elc and always run emacs in server/daemon mode to connect lightweight windows to it but why bother!? The friggin' entire thing launches in two seconds!
Regarding the "Emacs is big", I know the joke was funny when people, 20 years ago, were writing that Emacs meant "Eight Megabytes And Constantly Swapping" but in this day and age where most devs are using IntelliJ IDEA, Eclipse or other super-fat IDEs, you have to admit that Emacs is really in the "very very very lightweight camp".
Yes, you need lot of elisp scripts: and preferrably as much as possible written by yourself, because this means you're tailoring your editor to your needs, not the other way around.
Please. I don't even bother compiling my .el to .elc and I've got a shitload of modes and a gigantic .emacs file (which I should split btw).
Emacs, from the scratch, takes two seconds to fully load, including all the modes and my solarized color theme etc. I'm not talking about always running an Emacs server to which you can connect in a split second: no, I'm talking about a cold start.
It's 2013 and that's on a Core i5 3450s with 4 GB of RAM. Hardly a speed/memory demon.
If I was motivated I'd compile all my .el to .elc and always run emacs in server/daemon mode to connect lightweight windows to it but why bother!? The friggin' entire thing launches in two seconds!
Regarding the "Emacs is big", I know the joke was funny when people, 20 years ago, were writing that Emacs meant "Eight Megabytes And Constantly Swapping" but in this day and age where most devs are using IntelliJ IDEA, Eclipse or other super-fat IDEs, you have to admit that Emacs is really in the "very very very lightweight camp".
Yes, you need lot of elisp scripts: and preferrably as much as possible written by yourself, because this means you're tailoring your editor to your needs, not the other way around.
Two seconds? Is this a joke? My browser starts faster than that. Often it takes me less than two seconds to open a file, make a minor edit, save it, exit, and recompile.
Maybe someone would rather rewrite their editor in Go than elisp.
But why oh why immitate the Emacs shortcuts?
I love Emacs. I use it all the time. But the default shortcuts are the most stupid thing ever. That Control-x (C-x in Emacs lingua) is insanity at its best: due to the stupid non-symmetric layout of typical staggered keyboards 'x' in itself is one the hardest key to type (the equivalent with the right hand is way easier : '>' on a QWERTY keyboard). I'm a touch-typist and to hit 'x' I need to move my whole hand a bit. To hit '>' I just need to move on finger. I blame this on the fact that keyboard are using a staggered layout instead of a matrix or symmetric layout but whatever.
Then Control. Zomg. Control has to be accessed with the left pinky if you're a touch-typist: some very touch-typist friendly keyboards like the HHKB Pro 2 don't even botter with a right control key.
So to hit "C-x" you're supposed to use the two leftmost fingers of your left hand: this alone has to be one of the most RSI inducing keyboard shortcut ever.
But in Emacs everything is configurable. So I'm using "C-," to replace "C-x" and "M-," to replace "M-x".
It shall never cease to amaze me (in a very sad way) that when people "copy Emacs", the first thing they copy are the Emacs shortcuts. The Emacs shortcuts are the lamest thing ever in Emacs.
I love Emacs but I hate its default shortcuts. Emacs is not about its shortcuts: Emacs is about tailoring it to your needs by using Lisp.
I'm also wondering why that constant loss of energy in editors which shall never produce anything close to what one million lines of elisp code are providing. I'd much rather see that energy spend on creating a bridge for the Go-completion facility in Emacs, the real thing.
I love Emacs. I use it all the time. But the default shortcuts are the most stupid thing ever. That Control-x (C-x in Emacs lingua) is insanity at its best: due to the stupid non-symmetric layout of typical staggered keyboards 'x' in itself is one the hardest key to type (the equivalent with the right hand is way easier : '>' on a QWERTY keyboard). I'm a touch-typist and to hit 'x' I need to move my whole hand a bit. To hit '>' I just need to move on finger. I blame this on the fact that keyboard are using a staggered layout instead of a matrix or symmetric layout but whatever.
Then Control. Zomg. Control has to be accessed with the left pinky if you're a touch-typist: some very touch-typist friendly keyboards like the HHKB Pro 2 don't even botter with a right control key.
So to hit "C-x" you're supposed to use the two leftmost fingers of your left hand: this alone has to be one of the most RSI inducing keyboard shortcut ever.
But in Emacs everything is configurable. So I'm using "C-," to replace "C-x" and "M-," to replace "M-x".
It shall never cease to amaze me (in a very sad way) that when people "copy Emacs", the first thing they copy are the Emacs shortcuts. The Emacs shortcuts are the lamest thing ever in Emacs.
I love Emacs but I hate its default shortcuts. Emacs is not about its shortcuts: Emacs is about tailoring it to your needs by using Lisp.
I'm also wondering why that constant loss of energy in editors which shall never produce anything close to what one million lines of elisp code are providing. I'd much rather see that energy spend on creating a bridge for the Go-completion facility in Emacs, the real thing.
I hope no emacs users use control, there is a caps lock for that.
It's ok to disagree with godit, it's not meant for everybody. Frankly, just for me. And if someone else likes it, I don't mind sharing it.
Go-completion facility in Emacs is available. `github.com/nsf/gocode` has two plugins for emacs (auto-complete-mode and company-mode).
It's ok to disagree with godit, it's not meant for everybody. Frankly, just for me. And if someone else likes it, I don't mind sharing it.
Go-completion facility in Emacs is available. `github.com/nsf/gocode` has two plugins for emacs (auto-complete-mode and company-mode).