55 |
56 |
--------------------------------------------------------------------------------
/extconf.rb:
--------------------------------------------------------------------------------
1 | # extconf.rb - a part of a Ruby binding for terminfo library.
2 | #
3 | # Copyright (C) 2007 Tanaka Akira. All rights reserved.
4 | #
5 | # Redistribution and use in source and binary forms, with or without
6 | # modification, are permitted provided that the following conditions
7 | # are met:
8 | #
9 | # 1. Redistributions of source code must retain the above copyright
10 | # notice, this list of conditions and the following disclaimer.
11 | # 2. Redistributions in binary form must reproduce the above
12 | # copyright notice, this list of conditions and the following
13 | # disclaimer in the documentation and/or other materials provided
14 | # with the distribution.
15 | # 3. The name of the author may not be used to endorse or promote
16 | # products derived from this software without specific prior
17 | # written permission.
18 | #
19 | # THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 | # IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 | # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 | # ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
23 | # DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 | # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
25 | # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 | # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27 | # WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28 | # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29 | # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 |
31 | require 'mkmf'
32 |
33 | # Debian GNU/Linux 4.0 (etch) curses.h, term.h, -lncurses (ncurses.h is linked to curses.h)
34 | # FreeBSD 6.2 curses.h, term.h, -lncurses (ncurses.h is linked to curses.h)
35 | # OpenBSD 4.0 curses.h, term.h, -lncurses (curses.h includes ncurses.h by default)
36 | # HP-UX 11i v3 term.h, -lcurses
37 | # SunOS 5.10 curses.h, term.h, -lcurses
38 |
39 | # NetBSD 3.1 with ncurses ncurses.h, -lncurses (curses.h is incompatible for ncurses)
40 |
41 | have_header("curses.h")
42 | have_header("term.h")
43 |
44 | have_func("ctermid", "stdio.h")
45 |
46 | has_setupterm = true
47 | if have_library("ncurses", "setupterm")
48 | have_header("ncurses.h")
49 | elsif have_library("curses", "setupterm")
50 | else
51 | has_setupterm = false
52 | end
53 |
54 | have_header("wchar.h")
55 |
56 | rubyio_h = nil
57 | rubyio_h = "ruby/io.h" if have_header("ruby/io.h")
58 | rubyio_h = "rubyio.h" unless rubyio_h
59 |
60 | if have_type("rb_io_t", ["ruby.h", rubyio_h])
61 | have_struct_member("rb_io_t", "fd", ["ruby.h", rubyio_h])
62 | else
63 | have_struct_member("OpenFile", "fd", ["ruby.h", rubyio_h])
64 | end
65 |
66 | have_header("ruby/encoding.h")
67 |
68 | if has_setupterm
69 | create_header
70 | create_makefile('terminfo')
71 |
72 | open("Makefile", "a") {|mfile|
73 | mfile.puts <<'End'
74 | rdoc:
75 | rdoc --op rdoc terminfo.c lib/terminfo.rb
76 | End
77 | }
78 | else
79 | puts "terminfo library not found"
80 | end
81 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ruby-terminfo - terminfo bindings for Ruby
2 |
3 | ruby-terminfo provides terminfo bindings for Ruby
4 |
5 | [](https://badge.fury.io/rb/ruby-terminfo)
6 |
7 | ## Author
8 |
9 | Tanaka Akira
10 |
11 | ## Home Page
12 |
13 | http://www.a-k-r.org/ruby-terminfo/
14 |
15 | ## Features
16 |
17 | * Easy to use methods
18 | * `control` (combination of `tigetstr`/`tparm`/`tputs`)
19 | * Low-level terminfo bindings
20 | * `setupterm`
21 | * `tigetflag`
22 | * `tigetnum`
23 | * `tigetstr`
24 | * `tparm`
25 | * `tputs`
26 | * TIOCGWINSZ/TIOCSWINSZ ioctl for screen size
27 | * `ctermid` to avoid hardcoding /dev/tty
28 | * `wcswidth` to measure a string width in number of columns
29 |
30 | ## Usage
31 |
32 | ### Easy to use methods
33 | ```ruby
34 | require 'terminfo'
35 |
36 | TermInfo.control("cuf", 7) # cursor forward 7 columns
37 | p TermInfo.screen_size # use TIOCGWINSZ, LINES/COLUMNS env. or terminfo lines#/cols#
38 | ```
39 |
40 | ### Low level methods
41 | ```ruby
42 | require 'terminfo'
43 |
44 | t = TermInfo.new(ENV["TERM"], File.open(TermInfo.ctermid, "r+"))
45 | print t.tputs(t.tparm(t.tigetstr("cuf"), 7), 1) # cursor forward 7 columns
46 | p TermInfo.tiocgwinsz(STDOUT) # use TIOCGWINSZ
47 | ```
48 |
49 | ## Requirements
50 |
51 | * Ruby : http://www.ruby-lang.org/
52 |
53 | ## Download
54 |
55 | * Latest release: http://www.a-k-r.org/ruby-terminfo/ruby-terminfo-0.2.tar.gz
56 |
57 | * Development version: http://github.com/akr/ruby-terminfo
58 |
59 | ## Install
60 |
61 | ```shell
62 | ruby extconf.rb
63 | make
64 | make install
65 | ```
66 |
67 | ## Reference Manual
68 |
69 | See rdoc/TermInfo.html or
70 | http://www.a-k-r.org/ruby-terminfo/rdoc/TermInfo.html
71 |
72 | ## License
73 |
74 |
75 | Redistribution and use in source and binary forms, with or without
76 | modification, are permitted provided that the following conditions are met:
77 |
78 | (1) Redistributions of source code must retain the above copyright notice, this
79 | list of conditions and the following disclaimer.
80 | (2) Redistributions in binary form must reproduce the above copyright notice,
81 | this list of conditions and the following disclaimer in the documentation
82 | and/or other materials provided with the distribution.
83 | (3) The name of the author may not be used to endorse or promote products
84 | derived from this software without specific prior written permission.
85 |
86 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
87 | WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
88 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
89 | EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
90 | EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
91 | OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
92 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
93 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
94 | IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
95 | OF SUCH DAMAGE.
96 |
97 | (The modified BSD licence)
98 |
--------------------------------------------------------------------------------
/Rakefile:
--------------------------------------------------------------------------------
1 | require 'rubygems'
2 | require 'rake'
3 | require 'rake/clean'
4 | require 'rake/testtask'
5 | require 'rake/packagetask'
6 | require 'rubygems/package_task'
7 | require 'rdoc/task'
8 | #require 'rake/contrib/rubyforgepublisher'
9 | #require 'rake/contrib/sshpublisher'
10 | require 'fileutils'
11 | include FileUtils
12 |
13 | NAME = "ruby-terminfo"
14 | AUTHOR = "Tanaka Akira"
15 | EMAIL = "akr@fsij.org"
16 | DESCRIPTION = "terminfo binding for Ruby"
17 | RUBYFORGE_PROJECT = "ruby-terminfo"
18 | HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
19 | BIN_FILES = %w( )
20 |
21 | VERS = "0.1.1"
22 | REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
23 | CLEAN.include ['**/.*.sw?', '*.gem', '.config']
24 | RDOC_OPTS = [
25 | '--title', "#{NAME} documentation",
26 | "--charset", "utf-8",
27 | "--opname", "index.html",
28 | "--line-numbers",
29 | "--main", "README",
30 | "--inline-source",
31 | ]
32 |
33 | task :default => [:test]
34 | task :package => [:clean]
35 |
36 | Rake::TestTask.new("test") do |t|
37 | t.libs << "test"
38 | t.pattern = "test/**/*_test.rb"
39 | t.verbose = true
40 | end
41 |
42 | spec = Gem::Specification.new do |s|
43 | s.name = NAME
44 | s.version = VERS
45 | s.platform = Gem::Platform::RUBY
46 | #s.has_rdoc = true
47 | s.extra_rdoc_files = ["README", "ChangeLog"]
48 | s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
49 | s.summary = DESCRIPTION
50 | s.description = DESCRIPTION
51 | s.author = AUTHOR
52 | s.email = EMAIL
53 | s.homepage = HOMEPATH
54 | s.executables = BIN_FILES
55 | s.rubyforge_project = RUBYFORGE_PROJECT
56 | s.bindir = "bin"
57 | s.require_path = "lib"
58 | #s.autorequire = ""
59 | s.test_files = Dir["test/*_test.rb"]
60 |
61 | #s.add_dependency('activesupport', '>=1.3.1')
62 | #s.required_ruby_version = '>= 1.8.2'
63 | s.add_development_dependency('rake', '~> 13.0')
64 |
65 | s.files = %w(README ChangeLog Rakefile) +
66 | Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") +
67 | Dir.glob("*.{c,rb}") +
68 | Dir.glob("examples/**/*.rb") +
69 | Dir.glob("tools/*.rb") +
70 | Dir.glob("rails/*.rb")
71 |
72 | s.extensions = ["extconf.rb"]
73 | end
74 |
75 | Rake::PackageTask.new(spec.name, VERS) do |pkg|
76 | pkg.need_tar = true
77 | end
78 |
79 |
80 | task :install do
81 | name = "#{NAME}-#{VERS}.gem"
82 | sh %{rake package}
83 | sh %{sudo gem install pkg/#{name}}
84 | end
85 |
86 | task :uninstall => [:clean] do
87 | sh %{sudo gem uninstall #{NAME}}
88 | end
89 |
90 |
91 | Rake::RDocTask.new do |rdoc|
92 | rdoc.rdoc_dir = 'html'
93 | rdoc.options += RDOC_OPTS
94 | rdoc.template = "resh"
95 | #rdoc.template = "#{ENV['template']}.rb" if ENV['template']
96 | if ENV['DOC_FILES']
97 | rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
98 | else
99 | rdoc.rdoc_files.include('README', 'ChangeLog')
100 | rdoc.rdoc_files.include('lib/**/*.rb')
101 | rdoc.rdoc_files.include('**/*.c')
102 | end
103 | end
104 |
105 | desc "Publish to RubyForge"
106 | task :rubyforge => [:rdoc, :package] do
107 | require 'rubyforge'
108 | Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'takiuchi').upload
109 | end
110 |
111 | desc 'Package and upload the release to rubyforge.'
112 | task :release => [:clean, :package] do |t|
113 | v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
114 | abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
115 | pkg = "pkg/#{NAME}-#{VERS}"
116 |
117 | require 'rubyforge'
118 | rf = RubyForge.new.configure
119 | puts "Logging in"
120 | rf.login
121 |
122 | c = rf.userconfig
123 | # c["release_notes"] = description if description
124 | # c["release_changes"] = changes if changes
125 | c["preformatted"] = true
126 |
127 | files = [
128 | "#{pkg}.tgz",
129 | "#{pkg}.gem"
130 | ].compact
131 |
132 | puts "Releasing #{NAME} v. #{VERS}"
133 | rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
134 | end
135 |
136 | desc 'Show information about the gem.'
137 | task :debug_gem do
138 | puts spec.to_ruby
139 | end
140 |
141 | desc 'Update gem spec'
142 | task :gemspec do
143 | open("#{NAME}.gemspec", 'w').write spec.to_ruby
144 | end
145 |
--------------------------------------------------------------------------------
/rdoc/files/extconf_rb.html:
--------------------------------------------------------------------------------
1 |
2 |
5 |
6 |
7 |
8 | File: extconf.rb
9 |
10 |
11 |
12 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
extconf.rb
51 |
52 |
53 |
Path:
54 |
extconf.rb
55 |
56 |
57 |
58 |
Last Update:
59 |
2007-04-10 18:07:11 +0900
60 |
61 |
62 |
63 |
64 |
65 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 | extconf.rb - a part of a Ruby binding for terminfo library.
74 |
75 |
76 | Copyright (C) 2007 Tanaka Akira. All rights reserved.
77 |
78 |
79 | Redistribution and use in source and binary forms, with or without
80 | modification, are permitted provided that the following conditions are met:
81 |
82 |
83 | 1. Redistributions of source code must retain the above copyright
84 | notice, this list of conditions and the following disclaimer.
85 | 2. Redistributions in binary form must reproduce the above
86 | copyright notice, this list of conditions and the following
87 | disclaimer in the documentation and/or other materials provided
88 | with the distribution.
89 | 3. The name of the author may not be used to endorse or promote
90 | products derived from this software without specific prior
91 | written permission.
92 |
93 |
94 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS’’ AND ANY
95 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
96 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
97 | DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
98 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
99 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
100 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
101 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
104 | DAMAGE.
105 |
73 | terminfo.rb - a part of a Ruby binding for terminfo library.
74 |
75 |
76 | Copyright (C) 2007 Tanaka Akira. All rights reserved.
77 |
78 |
79 | Redistribution and use in source and binary forms, with or without
80 | modification, are permitted provided that the following conditions are met:
81 |
82 |
83 | 1. Redistributions of source code must retain the above copyright
84 | notice, this list of conditions and the following disclaimer.
85 | 2. Redistributions in binary form must reproduce the above
86 | copyright notice, this list of conditions and the following
87 | disclaimer in the documentation and/or other materials provided
88 | with the distribution.
89 | 3. The name of the author may not be used to endorse or promote
90 | products derived from this software without specific prior
91 | written permission.
92 |
93 |
94 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS’’ AND ANY
95 | EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
96 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
97 | DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
98 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
99 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
100 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
101 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102 | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103 | OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
104 | DAMAGE.
105 |