What are Tcl lists?
Archive - Originally posted on "The Horse's Mouth" - 2009-10-22 09:11:37 - Graham EllisIn Tcl, all variables (except 'arrays') are held as strings of text - and that includes lists. A list is a string which is treated as a collection of individual words, space separated, and you can then select individual words by their word number.
And this means that if you have a simple, space separated file of data you can read in the data line by line and use commands like lindex to refer, item by item, to the components of that line without needing to recourse to splits or joins. There's an example that shows that truly simple (almost naive) approach here which I wrote on the public Tcl programming course I presented earlier this week. There's a further example of analyzing the log file and building up a list of the hosts served here - again a naive example (as adding arrays to the mix is helpful in this case).
Actually, lists are rather more sophisticated than the example shown above will lead you to believe - they're interpreted within Tcl by the same syntax analyzer that analyses your code (why not - it keeps the footprint down!) so that you can include spaces and other special characters in your list elements - using {} and \ protection just as you would on your data. Tools such as the list and split and join commands let you manipulate lists easily, even if the list members include 'specials'.
Here is a summary of the main list commands:
Creating and modifying lists
As well as creating lists from first principles, you can construct and modify lists using:
list - provides automatic quoting
lappend - adds second and subsequent arguments to list named as first argument
linsert - inserts elements into a list at a given index position, returns a new list
lreplace - replaces elements in a list (first argument) with index numbers in a range (second and third arguments) with subsequent arguments
split - splits a string into list elements and returns the list. If called with two arguments, the second argument is the separator character
Extracting information from a list
Information can be returned from lists using:
lindex - first parameter, the list; second parameter, the index number of the element to be returned
llength - returns the length of a list
join - merges the elements of a list, separating each with the second parameter
lsearch - search a list for a value
Manipulating lists to create other lists
concat - takes multiple lists as parameters and returns a single joined list
lrange - returns part of the incoming list, from start index number to end index number
lsort - sort an incoming list and return a new sorted list
(This table is from our course notes - all delegates get a copy of our course notes to take away with them - approx 60 pages per day of training. The source code of all the examples is available on our web site too.)