1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# docidx.tcl --
#
# The docidx import plugin. Bridge between import management and
# the parsing of docidx markup.
#
# Copyright (c) 2009 Andreas Kupries <andreas_kupries@sourceforge.net>
#
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
# RCS: @(#) $Id: import_docidx.tcl,v 1.3 2009/08/07 18:53:11 andreas_kupries Exp $
# This package is a plugin for the the doctools::idx v2 system. It
# takes text in docidx format and produces the list serialization of a
# keyword index.
# ### ### ### ######### ######### #########
## Requisites
# @mdgen NODEP: doctools::idx::import::plugin
package require Tcl 8.4
package require doctools::idx::import::plugin ; # The presence of this
# pseudo package
# indicates execution
# of this code inside
# of an interpreter
# which was properly
# initialized for use
# by import plugins.
package require doctools::idx::parse ; # The actual docidx
# parser used by the
# plugin.
# ### ### ### ######### ######### #########
## We redefine the command 'doctools::idx::parse::GetFile' to use the
## 'include' alias provided by the plugin manager, as reguar file
## commands are not allowed in this 'safe' environment. However this
## is done if and only if we truly are in the plugin environment. The
## testsuite, for example, will leave out the definition of 'include',
## signaling in this way that the regular file operations can still be
## used.
if {[llength [info commands include]]} {
# Note: We are poking directly into the implementation of the
# class. Any changes to the interface here have to reviewed
# for their impact on doctools::idx::parse, and possibly
# ported over.
proc ::doctools::idx::parse::GetFile {currentfile path dv pv ev mv} {
upvar 1 $dv data $pv fullpath $ev error $mv emessage
foreach {ok data fullpath error emessage} [include $currentfile $path] break
return $ok
}
}
# ### ### ### ######### ######### #########
## API :: Convert text to canonical index serialization.
proc import {text configuration} {
global errorInfo errorCode
doctools::idx::parse var load $configuration
# Could be done better using a try/finally
set code [catch {
doctools::idx::parse text $text
} serial]
# Save error state if there was any.
set ei $errorInfo
set ec $errorCode
# Cleanup parser configuration, regardless of errors or not.
doctools::idx::parse var unset *
# Rethrow any error, using the captured state.
if {$code} {
return -code $code -errorinfo $ei -errorcode $ec $serial
}
return $serial
}
# ### ### ### ######### ######### #########
## Ready
package provide doctools::idx::import::docidx 0.1
return
|
