vim_client-ruby 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle/
+vendor/bundle/
+tmp/
+*.so

data/.yardopts

@@ -0,0 +1,3 @@
+--title "VimClient Documentation"
+--readme README.md
+--markup markdown

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    vim_client-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rake-compiler (0.8.1)
+      rake
+    redcarpet (2.1.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rake-compiler
+  redcarpet
+  rspec
+  vim_client-ruby!
+  yard

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Brian D. Burns
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+VimClient is a Ruby C extension providing a client for Vim's [clientserver][] feature.
+It allows communication with a Vim server through a persistent connection to the X11 server,
+much like using another instance of Vim.
+
+Prerequisites
+--------
+
+  - Ruby 1.9.2 or better
+  - X11 development headers
+  - For the Vim server, Vim must be compiled with the '+X11' and '+clientserver' features.
+
+Installation
+------------
+
+Install the gem using:
+
+```
+gem install vim_client-ruby
+```
+
+Or, add it to your project's Gemfile:
+
+```ruby
+gem 'vim_client-ruby'
+```
+
+Usage
+-----
+
+Require the library:
+
+```ruby
+require 'vim_client'
+```
+
+Before calling any methods, be sure to set the name of your Vim server:
+
+```ruby
+VimClient.server_name = 'vim_server1'
+VimClient.timeout_sec = 30 # and optionally update the timeout
+```
+
+For more usage information, see the documentation in `lib/vim_client.rb`.  
+Best viewed with [Yard][]
+
+Also, see the [wiki][] for examples, tips and sample projects.
+
+[clientserver]: http://vimdoc.sourceforge.net/htmldoc/remote.html#clientserver
+[Yard]: http://rubydoc.info/gems/vim_client-ruby
+[wiki]: http://github.com/burns/vim_client-ruby/wiki

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'rake/extensiontask'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+task :spec => [:compile]
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::ExtensionTask.new('vim_client') do |ext|
+  ext.lib_dir = 'lib/vim_client'
+end

data/ext/vim_client/extconf.rb

@@ -0,0 +1,20 @@
+require 'mkmf'
+
+unless have_header('sys/select.h')
+  unless have_header('sys/poll.h')
+    abort 'select or poll is required'
+  end
+end
+
+unless have_func('strcasecmp')
+  have_func('stricmp')
+end
+unless have_func('strncasecmp')
+  have_func('strnicmp')
+end
+
+unless have_library('X11')
+  abort 'X11 is required'
+end
+
+create_makefile('vim_client/vim_client')

data/ext/vim_client/misc.c

@@ -0,0 +1,267 @@
+/* vi:set ts=8 sts=4 sw=4:
+ *
+ * Misc functions
+ */
+
+#include "vim_client.h"
+
+/*
+ * Copy "string" into newly allocated memory.
+ */
+    char_u *
+vim_strsave(char_u *string) {
+    char_u	*p;
+    unsigned	len;
+
+    len = (unsigned)STRLEN(string) + 1;
+    p = alloc(len);
+    if (p != NULL)
+	memmove(p, string, (size_t)len);
+    return p;
+}
+
+    char_u *
+alloc(long_u size) {
+    char_u *p = NULL;  /* pointer to new storage space */
+
+    /* Safety check for allocating zero bytes */
+    if (size == 0)
+        return NULL;
+
+    if ((p = (char_u *)malloc((size_t)size)) != NULL)
+        return p;
+
+    rb_raise(ex_NoMemoryError, "out of memory");
+}
+
+/*
+ * Replacement for free() that ignores NULL pointers.
+ */
+    void
+vim_free(void *x) {
+    if (x != NULL)
+        free(x);
+}
+
+#if (!defined(HAVE_STRCASECMP) && !defined(HAVE_STRICMP))
+/*
+ * Compare two strings, ignoring case, using current locale.
+ * Doesn't work for multi-byte characters.
+ * return 0 for match, < 0 for smaller, > 0 for bigger
+ */
+    int
+vim_stricmp(char *s1, char *s2) {
+    int i;
+
+    for (;;)
+    {
+	i = (int)tolower(*s1) - (int)tolower(*s2);
+	if (i != 0)
+	    return i;			    /* this character different */
+	if (*s1 == NUL)
+	    break;			    /* strings match until NUL */
+	++s1;
+	++s2;
+    }
+    return 0;				    /* strings match */
+}
+#endif
+
+#if (!defined(HAVE_STRNCASECMP) && !defined(HAVE_STRNICMP))
+/*
+ * Compare two strings, for length "len", ignoring case, using current locale.
+ * Doesn't work for multi-byte characters.
+ * return 0 for match, < 0 for smaller, > 0 for bigger
+ */
+    int
+vim_strnicmp(char *s1, char *s2, size_t len) {
+    int i;
+
+    while (len > 0)
+    {
+	i = (int)tolower(*s1) - (int)tolower(*s2);
+	if (i != 0)
+	    return i;			    /* this character different */
+	if (*s1 == NUL)
+	    break;			    /* strings match until NUL */
+	++s1;
+	++s2;
+	--len;
+    }
+    return 0;				    /* strings match */
+}
+#endif
+
+/*
+ * These are Vim's canonical encoding names (src/mbyte.c)
+ * with the Ruby encoding names they resolve to.
+ * Those names which Ruby was not able to resolve are marked with (*).
+ *
+ * The Aliases listed will be used to fill in the gaps.
+ * 'dec-mcs' and 'hp-roman8' will be unsupported, since these
+ * can't be mapped from Ruby to Vim.
+ *
+ * Note that Vim's converter handles all Unicode as UTF-8.
+ * The encoding reported from the server does not reflect this, so these will
+ * be aliases as UTF-8. The corresponding Ruby encodings will be converted to
+ * UTF-8 before being sent to the server. These are marked with (**).
+ *
+ * Also, it appears that support for macRoman and the DOS/Windows codepages
+ * require that Vim is compiled on those systems.
+ *
+ *                                            Aliases
+ *  Vim            Ruby             Vim-to-Ruby     Ruby-to-Vim
+ ***********************************************************************
+    latin1       * ASCII-8BIT       ISO-8859-1
+    iso-8859-2     ISO-8859-2
+    iso-8859-3     ISO-8859-3
+    iso-8859-4     ISO-8859-4
+    iso-8859-5     ISO-8859-5
+    iso-8859-6     ISO-8859-6
+    iso-8859-7     ISO-8859-7
+    iso-8859-8     ISO-8859-8
+    iso-8859-9     ISO-8859-9
+    iso-8859-10    ISO-8859-10
+    iso-8859-11    ISO-8859-11
+    iso-8859-13    ISO-8859-13
+    iso-8859-14    ISO-8859-14
+    iso-8859-15    ISO-8859-15
+    koi8-r         KOI8-R
+    koi8-u         KOI8-U
+    utf-8          UTF-8
+    ucs-2        * ASCII-8BIT       UTF-16BE    **
+    ucs-2le      * ASCII-8BIT       UTF-16LE    **
+    utf-16       * ASCII-8BIT       UTF-16BE    **
+    utf-16le       UTF-16LE                     **
+    ucs-4        * ASCII-8BIT       UTF-32BE    **
+    ucs-4le        UTF-32LE                     **
+    euc-jp         EUC-JP
+    sjis           Shift_JIS
+    euc-kr         EUC-KR
+    euc-cn         GB2312
+    euc-tw         EUC-TW
+    big5           Big5
+    cp437          IBM437                           cp437
+    cp737          IBM737                           cp737
+    cp775          IBM775                           cp775
+    cp850          CP850
+    cp852          CP852
+    cp855          CP855
+    cp857          IBM857                           cp857
+    cp860          IBM860                           cp860
+    cp861          IBM861                           cp861
+    cp862          IBM862                           cp862
+    cp863          IBM863                           cp863
+    cp865          IBM865                           cp865
+    cp866          IBM866                           cp866
+    cp869          IBM869                           cp869
+    cp874          Windows-874                      cp874
+    cp932          Windows-31J                      cp932
+    cp936          GBK
+    cp949          CP949
+    cp950          Big5
+    cp1250         Windows-1250                     cp1250
+    cp1251         Windows-1251                     cp1251
+    cp1252         Windows-1252                     latin1
+    cp1253         Windows-1253                     cp1253
+    cp1254         Windows-1254                     cp1254
+    cp1255         Windows-1255                     cp1255
+    cp1256         Windows-1256                     cp1256
+    cp1257         Windows-1257                     cp1257
+    cp1258         Windows-1258                     cp1258
+    macroman       macRoman
+    dec-mcs      * ASCII-8BIT           -- Unsupported --
+    hp-roman8    * ASCII-8BIT           -- Unsupported --
+ */
+
+/* Vim-to-Ruby aliases from above */
+static struct {
+    const char_u *name;
+    const char_u *alias;
+} vim2rb_enc_aliases[] = {
+    { "latin1",     "ISO-8859-1" },
+    { "ucs-2",      "UTF-8" },
+    { "ucs-2le",    "UTF-8" },
+    { "utf-16",     "UTF-8" },
+    { "utf-16le",   "UTF-8" },
+    { "ucs-4",      "UTF-8" },
+    { "ucs-4le",    "UTF-8" },
+    { NULL, NULL }
+};
+
+/*
+ * Takes the response and encoding name returned from the Vim server
+ * and returns a Ruby string associated with the given encoding, or an
+ * alias from the Vim-to-Ruby alias table.
+ * This does not perform any transcoding.
+ */
+    VALUE
+vim2rb_enc_str(char_u **res, char_u *server_enc) {
+    int i;
+    for (i = 0; vim2rb_enc_aliases[i].name != NULL; ++i) {
+	if (STRCMP(server_enc, vim2rb_enc_aliases[i].name) == 0)
+	    server_enc = (char_u *)vim2rb_enc_aliases[i].alias;
+    }
+
+    return rb_enc_str_new(*res, STRLEN(*res), rb_enc_find(server_enc));
+}
+
+/* Ruby-to-Vim aliases from above */
+static struct {
+    const char_u *name;
+    const char_u *alias;
+    int convert;
+} rb2vim_enc_aliases[] = {
+    { "UTF-16BE",       "UTF-8",    1 },
+    { "UTF-16LE",       "UTF-8",    1 },
+    { "UTF-32BE",       "UTF-8",    1 },
+    { "UTF-32LE",       "UTF-8",    1 },
+    { "IBM437",         "cp437",    0 },
+    { "IBM737",         "cp737",    0 },
+    { "IBM775",         "cp775",    0 },
+    { "IBM857",         "cp857",    0 },
+    { "IBM860",         "cp860",    0 },
+    { "IBM861",         "cp861",    0 },
+    { "IBM862",         "cp862",    0 },
+    { "IBM863",         "cp863",    0 },
+    { "IBM865",         "cp865",    0 },
+    { "IBM866",         "cp866",    0 },
+    { "IBM869",         "cp869",    0 },
+    { "Windows-874",    "cp874",    0 },
+    { "Windows-31J",    "cp932",    0 },
+    { "Windows-1250",   "cp1250",   0 },
+    { "Windows-1251",   "cp1251",   0 },
+    { "Windows-1252",   "latin1",   0 },
+    { "Windows-1253",   "cp1253",   0 },
+    { "Windows-1254",   "cp1254",   0 },
+    { "Windows-1255",   "cp1255",   0 },
+    { "Windows-1256",   "cp1256",   0 },
+    { "Windows-1257",   "cp1257",   0 },
+    { "Windows-1258",   "cp1258",   0 },
+    { NULL, NULL }
+};
+
+/* This function uses the Ruby-to-Vim aliases table to set the encoding
+ * name to be sent to the server (returned in cmd_enc), and returns the
+ * command string in C string format. It will also transcode any 16/32 bit
+ * Unicode to UTF-8.
+ */
+    char_u *
+rb2vim_enc_str(VALUE str, char_u **cmd_enc) {
+    *cmd_enc = (char_u *)rb_enc_name(rb_enc_get(str));
+
+    int i;
+    for (i = 0; rb2vim_enc_aliases[i].name != NULL; ++i) {
+	if (STRCMP(*cmd_enc, rb2vim_enc_aliases[i].name) == 0) {
+	    *cmd_enc = (char_u *)rb2vim_enc_aliases[i].alias;
+
+            if (rb2vim_enc_aliases[i].convert)
+                /* returns a new string */
+                str = rb_str_export_to_enc(str, rb_enc_find(*cmd_enc));
+
+            break;
+        }
+    }
+
+    return StringValueCStr(str);
+}