Package information  edit

Original tclreadline

What	tclreadline
Where	http://tclreadline.sourceforge.net/
Description	Tcl bindings for GNU readline, by Johannes Zellner, used to enhance an interactive Tcl.
Latest version	2.1.0
Updated	07/2001

More recently updated forks

• https://chiselapp.com/user/aspect/repository/tclreadline/timeline — don't expect this to be maintained, but it has some long-awaited patches discussed below and on SourceForge.
• Flightaware maintains a fork. "An up-to-date version of tclreadline that works with the latest GNU readline and has had tender loving care from dbohdan can be found at https://github.com/flightaware/tclreadline."

Use example  edit

package require tclreadline

proc ::tclreadline::prompt1 {} {
    return "[lindex [split [info hostname] "."] 0] [lindex [split [pwd] "/"] end] % "
}

::tclreadline::Loop

Implementing completion yourself with an old version of tclreadline  edit

package require tclreadline


# This proc returns the larges common startstring in a list, e.g.:
# for {list link} it will return li
 
namespace eval readline {
    namespace export readline history
    proc largest_common_substring { word matches } {
        # returns a list with the largest common substring
        if {[llength $matches]==1} {
            return [list [lindex $matches 0] $matches]
        }
        set subword $word
        while {[llength [lsearch -inline -all $matches $subword*]]==[llength $matches]} {
            if {$subword eq [lindex $matches 0]} break;
            set word $subword
            set subword [string range [lindex $matches 0] 0 [string length $word]]
        }
        return [list $word $matches]

    }
}

readline::history read ~/.sh_history ; # read saved history

# unknown should behave as in an interactive tclsh
set tcl_interactive 1 ; info script ""

# save history before exit use hide instead if rename so no _exit is show in [info commands]
interp hide {} exit
 
proc exit {args} {
     readline::history write ~/.sh_history
     interp invokehidden {} exit
}

# Define completion proc
# The completion proc is called from readline with the arguments:
# line:  The complete line in the readline buffer
# word:  The word that is being completed
# start: The start index of the word in line
# end:   The end index of the word in line
#
# A completion proc returns a list with two elements 
# 0: The text that will replace the word that is being completed
# 1: A list of all possible matches for the word that is currently being completed

proc complete {line word start end} {
    set matches {}
    if {[string index $word 0] eq {$}} {
        # variable completion
        set var_name [string range $word 1 end]
        foreach var [uplevel #0 [list info vars ${var_name}*]] {
            lappend matches \$[set var]
        }
    } elseif {$word eq $line} {
        # command completion
        set matches [uplevel #0 [list info commands $word*]]
        foreach ns [namespace children ::] {
            if {[string match $word* $ns]!=0} {
                lappend matches $ns
            }
        }
    } else {
        foreach file [glob -nocomplain $word*] {
            string map [list [file normalize ~] ~] $file
            lappend matches [string map  {{ } {\ }} $file]
        }
        foreach file [glob -nocomplain -type hidden $word*] {
            string map [list [file normalize ~] ~] $file
            lappend matches [string map  {{ } {\ }} $file]
        }
    }
    # suppress space
    if {[llength $matches] == 1} {
        return [list [lindex $matches 0] [list {}]]
    }
    return [::readline::largest_common_substring $word $matches]
} 

 
# register compeletion proc, completion can be disabled by readline::completion {}

readline::completion complete
    
# command loop
while {1} {
    set command [readline::readline "([file tail [pwd]]) % "]
    while {![info complete $command]} {
     set command $command\n[readline::readline "> "]
    }
    readline::history add $command
    catch [eval $command] result
    if {($result ne "") && ([string range $command end-1 end] ne ";;")} { 
        puts $result
    }
}

Notes  edit

See also  edit

• eltclsh
• liboop
• Miscellaneous Tcl procs (Dillinger)
• Objective C / Tcl library
• Pure-tcl readline
• Pure-tcl readline2
• rdl
• readline extension TclRl
• readline extension tclsh-readline
• readline-like function support for Tk (Miguel)
• rlwrap
• [libtecla]
• ReloadableWidgets:
• linenoise

Discussion  edit

• After you have made sure you have a recent version of the readline library (I use 5.2), you will need to make sure that the symbolic link under /usr/lib/libreadline.dylib is pointing to the right location (originally it was pointing to /usr/lib/libedit.dylib).

• Edit tclreadline.c file and rename all MALLOC to malloc and FREE to free (and remove the macros MALLOC and FREE)

• Apparently /usr/lib/libedit.dylib is or contains libreadline as a 'nm -o /usr/lib/libedit.dylib' will show you...
• I still cannot build tclreadline on Mac OSX. Could someone provide a link to some nice build so that I could RTFM ???
• Build on GNU/linux was a breeze...

• set the environment variable MACOSX_DEPLOYMENT_TARGET to 10.4 (I used "setenv MACOSX_DEPLOYMENT_TARGET 10.4" but I use tcsh - always forget the bash syntax).
• link glibtool into the build directory with "ln -s /usr/bin/glibtool libtool" as the configure scripts weren't able to create their own.

• built a libreadline.dylib by downloading readline-6.1.tar.gz from http://tiswww.case.edu/php/chet/readline/rltop.html, and following the README. (It's standard procedure: from Terminal, navigate into the readline-6.1 directory, enter './configure', and 'make'.) DON'T 'make install', however.
• /usr/lib/libreadline.dylib is a symlink to /usr/lib/libedit.dylib. On the recommendation of someone at the Apple Discussions Unix forum, I renamed the symlink to /usr/lib/libreadline_OLD.dylib and moved my newly-built libreadline.dylib (from previous step) into /usr/lib/. Needed sudo, of course.
• built a libtclreadline.dylib by downloading it from http://tclreadline.sourceforge.net/. (Migraine sufferers are cautioned about the page's color scheme.) Unfortunately, this package is so old it needs some tweaks to get it to build a dylib:

if {$tcl_interactive} {
    package require tclreadline 
    ::tclreadline::Loop
}

• ftp://ftp.gnu.org/pub/gnu/readline/readline-6.1.tar.gz
• http://downloads.sourceforge.net/project/tclreadline/tclreadline/tclreadline-2.1.0/tclreadline-2.1.0.tar.gz

cd ~/

tar xvzf ~/Downloads/readline-6.1.tar.gz

tar xvzf ~/Downloads/tclreadline-2.1.0.tar.gz

cd ~/readline-6.1/

./configure --disable-shared --prefix=/tmp/readline-install/

make

make install

cd ~/tclreadline-2.1.0/

autoreconf -fvi

./configure --with-readline-includes=/tmp/readline-install/include/readline --with-readline-library=/tmp/readline-install/lib/libreadline.a

egrep -v '#define (FREE|MALLOC)' tclreadline.c | sed 's/MALLOC/malloc/; s/FREE/free/' > tclreadline.c.new

mv -f tclreadline.c.new tclreadline.c

make

sudo make install

rm -rf /tmp/readline-install

if {$tcl_interactive} {
    package require tclreadline
    ::tclreadline::Loop
}

pull request for tclreadline

• Home
• Recent changes
• Help
• WhoAmI/Logout
• Create new page
• Random page
• Previous page
• Next page
• 
  
• Add comments
• Edit
• History
• Edit summary
• References