1page_util_quote(n)          Parser generator tools          page_util_quote(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       page_util_quote - page character quoting utilities
9

SYNOPSIS

11       package require page::util::quote  ?0.1?
12
13       package require snit
14
15       ::page::util::quote::unquote char
16
17       ::page::util::quote::quote'tcl char
18
19       ::page::util::quote::quote'tclstr char
20
21       ::page::util::quote::quote'tclcom char
22
23______________________________________________________________________________
24

DESCRIPTION

26       This package provides a few utility commands to convert characters into
27       various forms.
28

API

30       ::page::util::quote::unquote char
31              A character, as stored in an abstract syntax tree by a PEG  pro‐
32              cessor (See the packages grammar::peg::interpreter, grammar::me,
33              and their relations), i.e. in some  quoted  form,  is  converted
34              into  the equivalent Tcl character. The character is returned as
35              the result of the command.
36
37       ::page::util::quote::quote'tcl char
38              This command takes a Tcl character (internal representation) and
39              converts  it  into a string which is accepted by the Tcl parser,
40              will regenerate the character in question and is 7bit ASCII. The
41              string is returned as the result of this command.
42
43       ::page::util::quote::quote'tclstr char
44              This command takes a Tcl character (internal representation) and
45              converts it into a string which is accepted by  the  Tcl  parser
46              and will generate a human readable representation of the charac‐
47              ter in question.  The string is returned as the result  of  this
48              command.
49
50              The  string  does not use any unprintable characters. It may use
51              backslash-quoting. High UTF characters are quoted to avoid prob‐
52              lems  with  the  still  prevalent ascii terminals. It is assumed
53              that the string will be used in a double-quoted environment.
54
55       ::page::util::quote::quote'tclcom char
56              This command takes a Tcl character (internal representation) and
57              converts  it  into  a string which is accepted by the Tcl parser
58              when used within a Tcl comment. The string is  returned  as  the
59              result of this command.
60

BUGS, IDEAS, FEEDBACK

62       This  document,  and the package it describes, will undoubtedly contain
63       bugs and other problems.  Please report such in the  category  page  of
64       the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].   Please
65       also report any ideas for enhancements you may have for either  package
66       and/or documentation.
67
68       When proposing code changes, please provide unified diffs, i.e the out‐
69       put of diff -u.
70
71       Note further that  attachments  are  strongly  preferred  over  inlined
72       patches.  Attachments  can  be  made  by  going to the Edit form of the
73       ticket immediately after its creation, and  then  using  the  left-most
74       button in the secondary navigation bar.
75

KEYWORDS

77       page, parser generator, quoting, text processing
78

CATEGORY

80       Page Parser Generator
81

83       Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
84
85
86
87
88tcllib                                1.0                   page_util_quote(n)
Impressum